REST Resource: projects.locations.brands.sessionRecords

资源:SessionRecord

表示单个会话记录。

JSON 表示法
{
  "name": string,
  "sessionStartTime": string,
  "storeId": string,
  "laneId": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "outcomeLabel": string,
  "outcomeGroupLabel": string,
  "audioRecordingPath": string,
  "order": {
    object (Order)
  },
  "sessionDuration": string,
  "upsellAttemptRecords": [
    {
      object (UpsellAttemptRecord)
    }
  ],
  "audioRecording": string,
  "trafficType": enum (TrafficType),
  "channelType": enum (ChannelType)
}
字段
name

string

标识符。SessionRecord 的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}

sessionStartTime

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"。

storeId

string

不可变。下单商店的 ID。

laneId

string

不可变。订单会话的车道 ID。

interactions[]

object (Interaction)

仅限输出。对话轮次。

outcomeLabel

string

仅限输出。订单的最终结果标签。

outcomeGroupLabel

string

仅限输出。成果的组标签。

audioRecordingPath

string

仅限输出。完整录音的路径。

order

object (Order)

仅限输出。与会话记录关联的订单。

sessionDuration

string (Duration format)

仅限输出。会话的总时长。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"。

upsellAttemptRecords[]

object (UpsellAttemptRecord)

仅限输出。在会话期间执行的追加销售。

audioRecording

string (bytes format)

仅限输出。会话的录音。仅在调用 sessionRecords.get 时,系统才会填充此字段。

使用 base64 编码的字符串。

trafficType

enum (TrafficType)

仅限输出。会话的流量类型。

channelType

enum (ChannelType)

仅限输出。会话使用的渠道类型(例如免下车、移动应用、手机)。

互动

表示对话中一轮内的单次互动。

JSON 表示法
{
  "turnPosition": string,

  // Union field interaction can be only one of the following:
  "userUtterance": {
    object (UserUtterance)
  },
  "agentUtterance": {
    object (AgentUtterance)
  },
  "resolveOrder": {
    object (ResolveOrder)
  },
  "submitOrder": {
    object (SubmitOrder)
  },
  "matchIntent": {
    object (MatchIntent)
  },
  "clientExecution": {
    object (ClientExecution)
  },
  "clientOrderUpdate": {
    object (ClientOrderUpdate)
  }
  // End of list of possible types for union field interaction.
}
字段
turnPosition

string (int64 format)

仅限输出。对话中的轮次位置。

联合字段 interaction。互动类型。interaction 只能是下列其中一项:
userUtterance

object (UserUtterance)

用户话语。

agentUtterance

object (AgentUtterance)

客服人员话语。

resolveOrder

object (ResolveOrder)

智能体执行的 ResolveOrder 调用

submitOrder

object (SubmitOrder)

智能体执行的 SubmitOrder 调用

matchIntent

object (MatchIntent)

智能体执行的 MatchIntent 调用

clientExecution

object (ClientExecution)

智能体执行的 ClientExecution 调用

clientOrderUpdate

object (ClientOrderUpdate)

由客户端发起的订单状态更新

UserUtterance

用户话语。

JSON 表示法
{
  "text": string,
  "createTime": string
}
字段
text

string

用户话语的文本。

createTime

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"。

AgentUtterance

智能体话语。

JSON 表示法
{
  "text": string,
  "createTime": string
}
字段
text

string

代理话语的文本。

createTime

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"。

ResolveOrder

解析订单互动。

JSON 表示法
{
  "input": {
    object (ResolveOrderInput)
  },
  "output": {
    object (ResolveOrderOutput)
  }
}
字段
input

object (ResolveOrderInput)

“解决订单”操作的输入。

output

object (ResolveOrderOutput)

“解决订单问题”操作的输出。

ResolveOrderInput

“解决订单问题”互动的输入。

JSON 表示法
{
  "payload": {
    object
  }
}
字段
payload

object (Struct format)

解析订单互动的载荷。

ResolveOrderOutput

订单解决互动的输出。

JSON 表示法
{
  "payload": {
    object
  }
}
字段
payload

object (Struct format)

解析订单互动输出的载荷。

SubmitOrder

此类型没有字段。

提交订单互动。

MatchIntent

匹配 intent 互动。

JSON 表示法
{
  "input": {
    object (MatchIntentInput)
  },
  "output": {
    object (MatchIntentOutput)
  }
}
字段
input

object (MatchIntentInput)

匹配 intent 互动的输入。

output

object (MatchIntentOutput)

匹配 intent 互动的输出。

MatchIntentInput

匹配 intent 互动的输入。

JSON 表示法
{
  "payload": {
    object
  }
}
字段
payload

object (Struct format)

匹配 intent 互动输入的载荷。

MatchIntentOutput

匹配 intent 互动的输出。

JSON 表示法
{
  "payload": {
    object
  }
}
字段
payload

object (Struct format)

匹配 intent 互动输出的载荷。

ClientExecution

客户端执行互动。

JSON 表示法
{
  "toolName": string,
  "input": {
    object (ClientExecutionInput)
  },
  "output": {
    object (ClientExecutionOutput)
  }
}
字段
toolName

string

客户端执行互动的工具名称。

input

object (ClientExecutionInput)

客户端执行互动的输入。

output

object (ClientExecutionOutput)

客户端执行互动的输出。

ClientExecutionInput

客户端执行互动的输入。

JSON 表示法
{
  "payload": {
    object
  }
}
字段
payload

object (Struct format)

客户端执行互动输入的载荷。

ClientExecutionOutput

客户端执行互动的输出。

JSON 表示法
{
  "payload": {
    object
  }
}
字段
payload

object (Struct format)

客户端执行互动输出的载荷。

ClientOrderUpdate

由客户端发起的订单状态更新。

JSON 表示法
{
  "order": {
    object (Order)
  }
}
字段
order

object (Order)

客户端发送的订单状态更新。

UpsellAttemptRecord

表示追加销售尝试。这些数据用于在控制台订单记录中显示追加销售信息,即追加销售类型、轮次 ID 以及追加销售是否被接受,并根据处理后的日志从 Spanner 中填充。

JSON 表示法
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean
}
字段
turnId

integer

仅限输出。出现追加销售机会的对话轮次的 ID。

upsellType

string

仅限输出。追加销售事件的类型。

accepted

boolean

仅限输出。是否接受了追加销售。

TrafficType

会话的流量类型。这用于标记监控、日志记录和可观测性指标。

枚举
TRAFFIC_TYPE_UNSPECIFIED 未指定流量类型。
EXTERNAL 流量来自外部客户端。
INTEGRATION_TEST 流量来自集成测试。
EVAL 流量来自评估工具。
PROBER 流量来自探测器。
MANUAL_TEST 流量来自手动测试。
INTERNAL_TOOL 流量来自内部工具。
CONSOLE 流量来自 Food AI 控制台。

方法

delete

删除 SessionRecord。

get

获取特定 SessionRecord。

list

列出指定品牌的 SessionRecord。