Method: projects.locations.collections.engines.sessions.listSessionFileMetadata

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

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:listSessionFileMetadata

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。会话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

请求正文

请求正文必须为空。

响应正文

AssistantService.ListSessionFileMetadata 方法的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
字段
fileMetadata[]

object (FileMetadata)

FileMetadata。
totalQuotaPercentage
(deprecated)

number

已弃用：此字段可能未设置，或者相应值可能未考虑所有文件类型。待移除。

所有文件使用的总配额百分比。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

  • discoveryengine.sessions.listSessionFileMetadata

如需了解详情，请参阅 IAM 文档。

FileMetadata 类中的方法

文件的元数据。

JSON 表示法 
{
  "fileId": string,
  "name": string,
  "mimeType": string,
  "byteSize": string,
  "tokenCount": string,
  "quotaPercentage": number,
  "selected": boolean,
  "usedInConversation": boolean,
  "originalUri": string,
  "originalSourceType": enum (FileSource),
  "uploadTime": string,
  "metadata": {
    string: string,
    ...
  },
  "session": string
}
字段
fileId

string

文件的 ID。
name

string

已上传文件的名称。
mimeType

string

文件的内容类型，请参阅 https://www.iana.org/assignments/media-types/media-types.xhtml。
byteSize

string (int64 format)

上下文文件的大小（以字节为单位）。
tokenCount
(deprecated)

string (int64 format)

已弃用：此字段不会针对所有文件类型进行设置，最终将被移除。

文件长度（以 token 为单位）。
quotaPercentage
(deprecated)

number

已弃用：此字段不会针对所有文件类型进行设置，最终将被移除。

相应文件所用配额的百分比。
selected

boolean

如果已选择使用该文件。
usedInConversation

boolean

相应文件之前是否已在会话中使用过（即已在查询中使用过），并且是否属于对话记录；或者是否仅已上传但尚未使用。
originalUri

string

可选。文件的原始位置。它可以是本地文件路径，也可以是允许访问外部系统中文件的任何其他 URI。在以下两种情况下，此网址可能为空：1. 如果文件是以内嵌数据的形式发送的（例如从剪贴板粘贴）。2. 如果原始位置不可用。

请注意，无法保证 URI 会指向有效或实际存在的文件。例如，某个文件可能已上传到会话，然后从原始来源中删除。
originalSourceType

enum (FileSource)

可选。文件的原始来源的类型。
uploadTime

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

map (key: string, value: string)

可选。表示与文件相关的元数据，可满足特定使用情形。前缀“google.”已预留给 Google 使用，但其他前缀可以随意使用。
session

string

仅限输出。会话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}。