REST Resource: projects.locations.apps.assistantSessions

资源:AssistantSession

助理会话表示用户与助理智能体之间的对话。

JSON 表示法
{
  "name": string,
  "requestor": string,
  "messages": [
    {
      object (AssistantMessage)
    }
  ],
  "state": enum (AssistantSessionState),
  "createTime": string,
  "updateTime": string,
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  },
  "displayName": string,
  "artifacts": [
    {
      object (AssistantSessionArtifact)
    }
  ],
  "sessionCheckpoint": {
    object (SessionCheckpoint)
  },
  "activeTurn": {
    object (ActiveTurnInfo)
  },
  "touchedApps": [
    string
  ]
}
字段
name

string

必需。标识符。会话的唯一标识符。格式:projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}

requestor

string

仅限输出。发起会话的用户。

messages[]

object (AssistantMessage)

可选。会话中的消息记录。

state

enum (AssistantSessionState)

仅限输出。助理会话的状态。

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

updateTime

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

userResponseSuggestions

object (UserResponseSuggestions)

仅限输出。助理智能体提供的建议用户回答。

displayName

string

可选。助理会话的显示名称。

artifacts[]

object (AssistantSessionArtifact)

仅限输出。助理在此会话中生成的文档制品(例如,以 Markdown 格式生成的技术设计文档 [TDD])。仅指针;文件内容位于客户的 Cloud Storage 存储桶中。

sessionCheckpoint

object (SessionCheckpoint)

仅限输出。包含用户意图和滚动历史记录摘要的会话检查点。

activeTurn

object (ActiveTurnInfo)

仅限输出。此会话当前正在运行的回合的附件信息。未运行任何回合时,此字段处于未设置状态。

touchedApps[]

string

仅限输出。此会话已定位或更改的应用(仅限项目级会话),用于历史记录标记。格式:projects/{project}/locations/{location}/apps/{app}

AssistantMessage

Google 助理会话中的消息。

JSON 表示法
{
  "role": string,
  "chunks": [
    {
      object (AssistantChunk)
    }
  ],
  "eventTime": string,
  "attachedGcsUris": [
    string
  ]
}
字段
role

string

必需。对话中的角色“user”或“model”。

chunks[]

object (AssistantChunk)

可选。消息内容(以分块形式)。

eventTime

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

attachedGcsUris[]

string

可选。用户在此轮对话中上传的文件的 Cloud Storage URI。这样,附件就可以在会话历史记录界面中保留和呈现。示例:“gs://cxas-transient-uploads/uuid/prd.pdf”

AssistantChunk

助理消息中的数据块。

JSON 表示法
{
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "thought": string,
  "payload": {
    object
  },
  "typedPayload": {
    object (TypedPayload)
  }
  // End of mutually exclusive fields.
}
字段
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"。

数据块中的数据。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
text

string

可选。文本数据。

thought

string

可选。模型生成的思考过程。

payload

object (Struct format)

可选。包含结构化回答(例如质量报告、智能体版本名称、建议的回答等)的载荷。

typedPayload

object (TypedPayload)

可选。包含结构化回答的类型化载荷。

互斥字段结束。

TypedPayload

具有类型的载荷。由 Google 助理历史记录 (AssistantChunk) 和流式 typedPayload 事件使用;之所以位于此处,是因为 assistant_service.proto 和 session_service.proto 都需要它。

JSON 表示法
{
  "displayName": string,
  "type": string,
  "value": {
    object
  },
  "metadata": {
    object
  }
}
字段
displayName

string

必需。载荷的显示名称。

type

string

必需。载荷的类型。

value

object (Struct format)

必需。载荷的值。

metadata

object (Struct format)

可选。载荷的元数据。

AssistantSessionState

助理会话的状态。

枚举
ASSISTANT_SESSION_STATE_UNSPECIFIED 默认值。如果未指定状态,则使用此值。
PROCESSING 助理智能体正在将请求作为长时间运行的任务进行处理。
IDLE 助理代理处于空闲状态,没有任何待处理的请求或响应。
PENDING_REVIEW 助理智能体已完成长时间运行的任务,并已准备好向用户提供回答。

UserResponseSuggestions

助理智能体提供的建议用户回答。

JSON 表示法
{
  "suggestions": [
    string
  ]
}
字段
suggestions[]

string

必需。助理建议的用户回复。这些是关于用户如何与助理互动的建议。

AssistantSessionArtifact

助理在会话中生成的文档工件,以文件形式存储在客户的 Cloud Storage 存储桶中。

JSON 表示法
{
  "id": string,
  "displayName": string,
  "gcsUri": string,
  "mimeType": string,
  "createTime": string,
  "turnIndex": integer
}
字段
id

string

仅限输出。会话中工件的唯一标识符。

displayName

string

仅限输出。向用户显示的文件名,例如“hotel_booking_tdd.md”。

gcsUri

string

仅限输出。包含制品内容的 Cloud Storage 对象。示例:“gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md”

mimeType

string

仅限输出。制品内容的 IANA 媒体类型,例如“text/markdown”。

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

turnIndex

integer

仅限输出。[AssistantSession.messages] 中消息的索引,该消息的轮次生成了工件,用于在恢复历史记录时放置工件条状标签。

SessionCheckpoint

包含会话标题和界面的推断用户意图的会话检查点。

JSON 表示法
{
  "userIntent": string
}
字段
userIntent

string

推断出的会话用户目标或主题(例如“构建电子商务支持代理”)。

ActiveTurnInfo

当前正在运行、已与其客户端断开连接或已停放以供其他服务器任务提取的会话轮次的实时连接信息。

JSON 表示法
{
  "turnId": string,
  "status": enum (ActiveTurnInfo.Status),
  "startTime": string,
  "lastProgressTime": string,
  "orphanDeadlineTime": string
}
字段
turnId

string

标识轮次;由流式 API 上的恢复快照回显。

status

enum (ActiveTurnInfo.Status)

当前附件状态。

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

lastProgressTime

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

orphanDeadlineTime

string (Timestamp format)

仅限输出。如果没有客户端连接,则关闭该 TURN 服务器。

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

ActiveTurnInfo.Status

当前运行的回合与客户端和服务器任务的关系。

枚举
STATUS_UNSPECIFIED 未指定。
RUNNING 该回合正在执行,且至少有一个客户端已连接。
DISCONNECTED 该回合正在执行,但没有附加客户端。
RESUMING 该回合已暂停,等待接续:下次附加时将继续该回合。
ABANDONED 该轮次的服务器租约已失效,并且没有任务在驱动它;下一次读取会将其封存为已提交的部分。无法附加。

方法

cancelAssistantTurn

取消助理会话正在进行的轮次(如果有):用户明确停止与任何数据流分离运行的轮次。

create

在给定应用中创建新的助理会话。

delete

删除指定的助理会话。

get

获取指定助理会话的详细信息。

list

列出指定应用中的所有助理会话。

streamChatAiAssistant

以流式传输的方式为指定的助理会话运行 AI 助理 Arc。