REST Resource: projects.locations.apps.conversations

资源:对话

对话表示最终用户与 CES 应用之间的互动。

JSON 表示法
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "turns": [
    {
      object (Conversation.Turn)
    }
  ],
  "turnCount": integer,
  "channelType": enum (Conversation.ChannelType),
  "source": enum (Conversation.Source),
  "inputTypes": [
    enum (Conversation.InputType)
  ],
  "entryAgent": string,
  "deployment": string,
  "appVersion": string,
  "languageCode": string,
  "messages": [
    {
      object (Message)
    }
  ]
}
字段
name

string

标识符。对话的唯一标识符。格式:projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

startTime

string (Timestamp format)

仅限输出。对话的创建时间戳。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

仅限输出。对话结束时的时间戳。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

turns[]

object (Conversation.Turn)

必需。对话中的回合。

turnCount

integer

仅限输出。对话中的回合数。

channelType
(deprecated)

enum (Conversation.ChannelType)

已弃用。请改用 inputTypes

source

enum (Conversation.Source)

仅限输出。指明对话的来源。

inputTypes[]

enum (Conversation.InputType)

仅限输出。对话的输入类型。

entryAgent

string

仅限输出。最初处理对话的客服人员。如果未指定,则对话由根代理处理。格式:projects/{project}/locations/{location}/apps/{app}/agents/{agent}

deployment

string

仅限输出。用于处理对话的应用的部署。格式:projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

appVersion

string

仅限输出。用于处理对话的应用版本。格式:projects/{project}/locations/{location}/apps/{app}/versions/{version}

languageCode

string

仅限输出。对话的语言代码。

messages[]
(deprecated)

object (Message)

已弃用。请改用圈数。

Conversation.Turn

对话中单个轮次的所有信息。

JSON 表示法
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  },
  "userIntendedText": string
}
字段
messages[]

object (Message)

可选。对话回合中的消息列表,包括用户输入、代理响应和处理期间的中间事件。

rootSpan

object (Span)

可选。操作处理的根 span。

userIntendedText

string

可选。来自模拟来电者 (Polysynth) 的预期标准答案文本。仅在启用字词错误率指标时填充。

Conversation.ChannelType

对话的渠道类型。

枚举
CHANNEL_TYPE_UNSPECIFIED 未指定渠道类型。
TEXT 对话仅包含最终用户与代理之间的文本消息。
AUDIO 对话包含最终用户与代理之间的音频消息。
MULTIMODAL 最终用户与代理之间的对话多模态消息(例如图片)。

Conversation.Source

话题的来源。

枚举
SOURCE_UNSPECIFIED 未指定来源。
LIVE 对话来自实时最终用户。
SIMULATOR 对话来自模拟器。
EVAL 对话来自评估。
AGENT_TOOL 对话来自智能体工具。代理工具会在单独的会话中运行代理,该会话会保留下来,以用于测试和调试。

Conversation.InputType

输入消息的类型。

枚举
INPUT_TYPE_UNSPECIFIED 未指定输入类型。
INPUT_TYPE_TEXT 文本输入。
INPUT_TYPE_EVENT 活动输入。
INPUT_TYPE_AUDIO 音频输入。
INPUT_TYPE_IMAGE 图片输入。
INPUT_TYPE_BLOB Blob 输入。
INPUT_TYPE_TOOL_RESPONSE 客户端函数工具响应输入。
INPUT_TYPE_VARIABLES 变量输入。

方法

batchDelete

批量删除指定的对话。

delete

删除指定的对话。

generateEvaluation

根据对话创建黄金评估。

get

获取指定对话的详细信息。

list

列出给定应用中的对话。