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

Enumera los metadatos de todos los archivos de la sesión actual.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Es el nombre del recurso de la sesión. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para el método AssistantService.ListSessionFileMetadata.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
Campos
fileMetadata[]

object (FileMetadata)

Los FileMetadata.
totalQuotaPercentage
(deprecated)

number

Obsoleto: Es posible que este campo no esté configurado o que el valor no tenga en cuenta todos los tipos de archivos. Se quitará.

Es el porcentaje total de la cuota que usan todos los archivos.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.sessions.listSessionFileMetadata

Para obtener más información, consulta la documentación de IAM.

FileMetadata

Son los metadatos del archivo.

Representación 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
}
Campos
fileId

string

Es el ID del archivo.
name

string

Nombre del archivo subido.
mimeType

string

Tipo de contenido del archivo. Consulta https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

Tamaño del archivo de contexto en bytes.
tokenCount
(deprecated)

string (int64 format)

Obsoleto: Este campo no se establecerá para todos los tipos de archivo y, finalmente, se quitará.

Es la longitud del archivo medida en tokens.
quotaPercentage
(deprecated)

number

Obsoleto: Este campo no se establecerá para todos los tipos de archivo y, finalmente, se quitará.

Es el porcentaje de la cuota que usa el archivo.
selected

boolean

Indica si el archivo está seleccionado para usarse.
usedInConversation

boolean

Indica si el archivo se usó en la sesión anteriormente (es decir, se usó en una búsqueda) y forma parte del historial de conversación, o si solo se subió y aún no se usó.
originalUri

string

Opcional. Ubicación original del archivo. Puede ser una ruta de acceso a un archivo local o cualquier otro URI que permita acceder al archivo en un sistema externo. Hay dos situaciones en las que esta URL puede estar vacía: 1. Si el archivo se envió como datos intercalados (p.ej., se pegó desde el portapapeles). 2. Si la ubicación original no está disponible

Ten en cuenta que no hay garantía de que el URI apunte a un archivo válido o existente. Por ejemplo, es posible que se haya subido un archivo a la sesión y, luego, se haya borrado de la fuente original.
originalSourceType

enum (FileSource)

Opcional. Es el tipo de fuente original del archivo.
uploadTime

string (Timestamp format)

Solo salida. Fecha y hora en que se subió el archivo (si se trata de un archivo generado por un proceso interno y luego disponible para la sesión, esto indica el momento en que ocurrió).

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
metadata

map (key: string, value: string)

Opcional. Representa los metadatos relacionados con el archivo que pueden adaptarse a casos de uso particulares. El prefijo "google." está reservado para la clave que usa Google, pero se pueden usar otros prefijos libremente.
session

string

Solo salida. Es el nombre del recurso de la sesión. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.