REST Resource: projects.locations.collections.dataStores.sessions

资源：Session

外部会话 proto 定义。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
字段
name

string

不可变。完全限定名称 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

可选。会话的显示名称。

此字段用于在界面中标识会话。默认情况下，显示名称是会话中的第一个轮次查询文本。
state

enum (State)

会话的状态。
userPseudoId

string

用于跟踪用户的唯一标识符。
turns[]

object (Turn)

圈数。
labels[]

string

可选。会话的标签。可在 ListSessionsRequest 中设置为过滤条件。
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"
isPinned

boolean

可选。会话是否已固定，已固定的会话将显示在会话列表顶部。

州

会话状态的枚举。

枚举
STATE_UNSPECIFIED 状态未指定。
IN_PROGRESS 会话目前处于开放状态。

Turn

表示一个对话轮次，包括用户的查询和服务的回答。

JSON 表示法 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
字段
query

object (Query)

可选。用户查询。如果此轮只是重新生成对另一轮的回答，则可能不会设置
answer

string

可选。用户查询的回答的资源名称。

仅当在此轮中生成了答案（/answer API 调用）时才设置。
assistAnswer

string

仅限输出。针对用户查询的 Google 助理回答的资源名称。

仅当在此轮对话中发生辅助调用（/assist API 调用）时才设置。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}。如需获取会话的所有 AssistAnswer，请将 GetSessionRequest.include_answer_details 设置为 true。或者，如需获取单个 AssistAnswer 资源，请使用 AssistAnswerService.GetAssistAnswer API。
detailedAnswer

object (Answer)

仅限输出。在 ConversationalSearchService.GetSession API 中，如果 GetSessionRequest.include_answer_details 设置为 true，则在获取回答查询会话时，系统会填充此字段。
detailedAssistAnswer

object (AssistAnswer)

仅限输出。在 ConversationalSearchService.GetSession API 中，如果 GetSessionRequest.include_answer_details 设置为 true，则在获取助理会话时，系统会填充此字段。
queryConfig

map (key: string, value: string)

可选。表示与查询配置相关的元数据，例如所用的 LLM 模型和版本、模型参数（温度、接地参数等）。前缀“google.”已预留给 Google 开发的功能。

查询

定义用户输入的查询。

JSON 表示法 
{
  "queryId": string,

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
字段
queryId

string

仅限输出。查询的唯一 ID。
联合字段 content。查询内容。content 只能是下列其中一项：
text

string

纯文本。

方法

create

 创建会话。

delete

 删除会话。

get

 获取会话。

list

 按父级 DataStore 列出所有会话。

patch

 更新会话。