对话中的消息。
| JSON 表示法 |
|---|
{
"role": string,
"chunks": [
{
object ( |
| 字段 | |
|---|---|
role |
可选。对话中的角色,例如用户、代理。 |
chunks[] |
可选。消息的内容,以一系列块的形式呈现。 |
eventTime |
可选。消息的发送或接收时间。如果消息是 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
块
消息中的内容块。
| JSON 表示法 |
|---|
{ // Union field |
| 字段 | |
|---|---|
联合字段 data。数据块数据。data 只能是下列其中一项: |
|
text |
可选。文本数据。 |
transcript |
可选。与音频关联的转写内容。 |
blob |
可选。Blob 数据。 |
payload |
可选。自定义载荷数据。 |
image |
可选。图片数据。 |
toolCall |
可选。工具执行请求。 |
toolResponse |
可选。工具执行响应。 |
agentTransfer |
可选。代理转移事件。 |
updatedVariables |
一个结构体,表示对话中更新的变量,按变量名称键控。 |
defaultVariables |
结构体表示对话开始时的默认变量,按变量名称键控。 |
Blob
表示对话中的 blob 输入或输出。
| JSON 表示法 |
|---|
{ "mimeType": string, "data": string } |
| 字段 | |
|---|---|
mimeType |
必需。来源数据的 IANA 标准 MIME 类型。 |
data |
必需。相应 blob 的原始字节。 使用 base64 编码的字符串。 |
图片
表示对话中的图片输入或输出。
| JSON 表示法 |
|---|
{ "mimeType": string, "data": string } |
| 字段 | |
|---|---|
mimeType |
必需。来源数据的 IANA 标准 MIME 类型。支持的图片类型包括: * image/png * image/jpeg * image/webp |
data |
必需。图片的原始字节。 使用 base64 编码的字符串。 |
ToolCall
请求客户端或代理执行指定工具。
| JSON 表示法 |
|---|
{ "id": string, "displayName": string, "args": { object }, // Union field |
| 字段 | |
|---|---|
id |
可选。工具调用的唯一标识符。如果填充了此字段,客户端应返回执行结果,并在 |
displayName |
仅限输出。工具的显示名称。 |
args |
可选。以 JSON 对象格式表示的工具的输入参数和值。 |
联合字段 tool_identifier。要执行的工具的标识符。它可以是持久化工具,也可以是工具集中的工具。tool_identifier 只能是下列其中一项: |
|
tool |
可选。要执行的工具的名称。格式: |
toolsetTool |
可选。要执行的工具集工具。 |
ToolsetTool
根据工具集创建的工具。
| JSON 表示法 |
|---|
{ "toolset": string, "toolId": string } |
| 字段 | |
|---|---|
toolset |
必需。相应工具所源自的 Toolset 的资源名称。格式: |
toolId |
可选。用于过滤工具的工具 ID,以检索相应工具的架构。 |
ToolResponse
客户端或代理的特定工具的执行结果。
| JSON 表示法 |
|---|
{ "id": string, "displayName": string, "response": { object }, // Union field |
| 字段 | |
|---|---|
id |
可选。相应回答所针对的匹配项的 ID。 |
displayName |
仅限输出。工具的显示名称。 |
response |
必需。以 JSON 对象格式表示的工具执行结果。使用“output”键指定工具响应,使用“error”键指定错误详情(如有)。如果未指定“output”和“error”键,则整个“response”都被视为工具执行结果。 |
联合字段 tool_identifier。已执行的工具的标识符。它可以是持久化工具,也可以是工具集中的工具。tool_identifier 只能是下列其中一项: |
|
tool |
可选。要执行的工具的名称。格式: |
toolsetTool |
可选。已执行的工具集工具。 |
AgentTransfer
表示将对话转移给其他客服人员的事件。
| JSON 表示法 |
|---|
{ "targetAgent": string, "displayName": string } |
| 字段 | |
|---|---|
targetAgent |
必需。对话要转移到的代理。智能体将从这一刻起接管对话。格式: |
displayName |
仅限输出。代理的显示名称。 |