- 资源:SessionRecord
- 互动
- UserUtterance
- AgentUtterance
- ResolveOrder
- ResolveOrderInput
- ResolveOrderOutput
- SubmitOrder
- MatchIntent
- MatchIntentInput
- MatchIntentOutput
- ClientExecution
- ClientExecutionInput
- ClientExecutionOutput
- ClientOrderUpdate
- UpsellAttemptRecord
- TrafficType
- 方法
资源:SessionRecord
表示单个会话记录。
| JSON 表示法 |
|---|
{ "name": string, "sessionStartTime": string, "storeId": string, "laneId": string, "interactions": [ { object ( |
| 字段 | |
|---|---|
name |
标识符。SessionRecord 的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord} |
sessionStartTime |
仅限输出。会话开始时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
storeId |
不可变。下单的商店的 ID。 |
laneId |
不可变。订单会话的通道 ID。 |
interactions[] |
仅限输出。话题回合。 |
outcomeLabel |
仅限输出。订单的最终结果标签。 |
outcomeGroupLabel |
仅限输出。相应结果的组标签。 |
audioRecordingPath |
仅限输出。完整录音的路径。 |
order |
仅限输出。与会话记录关联的订单。 |
sessionDuration |
仅限输出。会话的总时长。 该时长以秒为单位,最多包含九个小数位,以“ |
upsellAttemptRecords[] |
仅限输出。在会话期间执行的追加销售。 |
audioRecording |
仅限输出。会话的录音。仅在调用 sessionRecords.get 时填充此字段。 使用 base64 编码的字符串。 |
trafficType |
仅限输出。相应会话的流量类型。 |
channelType |
仅限输出。会话所用的渠道类型(例如,得来速、移动应用、手机)。 |
互动
表示对话中一个回合中的单次互动。
| JSON 表示法 |
|---|
{ "turnPosition": string, // Union field |
| 字段 | |
|---|---|
turnPosition |
仅限输出。在对话中轮流发言。 |
联合字段 interaction。互动类型。interaction 只能是下列其中一项: |
|
userUtterance |
用户话语。 |
agentUtterance |
智能体话语。 |
resolveOrder |
代理执行的 ResolveOrder 调用 |
submitOrder |
由代理执行的 SubmitOrder 调用 |
matchIntent |
智能体执行的 MatchIntent 调用 |
clientExecution |
智能体执行的 ClientExecution 调用 |
clientOrderUpdate |
由客户端启动的订单状态更新 |
UserUtterance
用户话语。
| JSON 表示法 |
|---|
{ "text": string, "createTime": string } |
| 字段 | |
|---|---|
text |
用户话语的文本。 |
createTime |
仅限输出。用户话语发生时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
AgentUtterance
智能体话语。
| JSON 表示法 |
|---|
{ "text": string, "createTime": string } |
| 字段 | |
|---|---|
text |
代理话语的文本。 |
createTime |
仅限输出。代理话语发生时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
ResolveOrder
解决订单互动。
| JSON 表示法 |
|---|
{ "input": { object ( |
| 字段 | |
|---|---|
input |
用于解决订单操作的输入。 |
output |
解决顺序操作的输出。 |
ResolveOrderInput
用于解决订单交互的输入。
| JSON 表示法 |
|---|
{ "payload": { object } } |
| 字段 | |
|---|---|
payload |
用于解决订单互动问题的载荷。 |
ResolveOrderOutput
解决订单互动时的输出。
| JSON 表示法 |
|---|
{ "payload": { object } } |
| 字段 | |
|---|---|
payload |
用于解决订单互动输出的载荷。 |
SubmitOrder
此类型没有字段。
提交订单互动。
MatchIntent
匹配意图互动。
| JSON 表示法 |
|---|
{ "input": { object ( |
| 字段 | |
|---|---|
input |
匹配意图互动的输入。 |
output |
匹配意图互动的输出。 |
MatchIntentInput
匹配意图互动的输入。
| JSON 表示法 |
|---|
{ "payload": { object } } |
| 字段 | |
|---|---|
payload |
匹配 intent 互动输入的载荷。 |
MatchIntentOutput
匹配意图互动的输出。
| JSON 表示法 |
|---|
{ "payload": { object } } |
| 字段 | |
|---|---|
payload |
匹配意图互动输出的载荷。 |
ClientExecution
客户端执行互动。
| JSON 表示法 |
|---|
{ "toolName": string, "input": { object ( |
| 字段 | |
|---|---|
toolName |
客户端执行互动的工具名称。 |
input |
客户端执行互动的输入。 |
output |
客户端执行互动的输出。 |
ClientExecutionInput
客户端执行互动的输入。
| JSON 表示法 |
|---|
{ "payload": { object } } |
| 字段 | |
|---|---|
payload |
客户端执行互动输入的载荷。 |
ClientExecutionOutput
客户端执行互动的输出。
| JSON 表示法 |
|---|
{ "payload": { object } } |
| 字段 | |
|---|---|
payload |
客户端执行互动输出的载荷。 |
ClientOrderUpdate
由客户端发起的订单状态更新。
| JSON 表示法 |
|---|
{
"order": {
object ( |
| 字段 | |
|---|---|
order |
由客户端发送的订单状态更新。 |
UpsellAttemptRecord
表示追加销售尝试。此数据用于在控制台订单历史记录中显示追加销售信息,即追加销售类型、turn id 和追加销售是否被接受,并且根据处理后的日志从 Spanner 中填充。
| JSON 表示法 |
|---|
{ "turnId": integer, "upsellType": string, "accepted": boolean } |
| 字段 | |
|---|---|
turnId |
仅限输出。出现追加销售机会的对话轮次的 ID。 |
upsellType |
仅限输出。追加销售事件的类型。 |
accepted |
仅限输出。追加销售是否已被接受。 |
TrafficType
相应会话的流量类型。用于标记监控、日志记录和可观测性指标。
| 枚举 | |
|---|---|
TRAFFIC_TYPE_UNSPECIFIED |
未指定流量类型。 |
EXTERNAL |
流量来自外部客户端。 |
INTEGRATION_TEST |
流量来自集成测试。 |
EVAL |
流量来自评估工具。 |
PROBER |
流量来自探测器。 |
MANUAL_TEST |
流量来自手动测试。 |
INTERNAL_TOOL |
流量来自内部工具。 |
CONSOLE |
流量来自食品 AI 控制台。 |
方法 |
|
|---|---|
|
删除 SessionRecord。 |
|
获取特定的 SessionRecord。 |
|
列出指定品牌的 SessionRecord。 |