REST Resource: projects.locations.collections.engines.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

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

方法

addContextFile

上传上下文文件,以用作会话中辅助调用的来源。

create

创建会话。

delete

删除会话。

get

获取会话。

list

按父级 DataStore 列出所有会话。

listSessionFileMetadata

列出当前会话中所有文件的元数据。

patch

更新会话。

recommendQuestions

获取指定会话的推荐问题。

removeContextFile

从会话中移除上下文文件。

selectContextFiles

选择要在会话中使用的上下文文件。