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

Muestra 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 utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Nombre de 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 del método AssistantService.ListSessionFileMetadata.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (FileMetadata)

Los FileMetadata.
totalQuotaPercentage
(deprecated)

number

Obsoleto: puede que este campo no se defina o que el valor no tenga en cuenta todos los tipos de archivo. Se eliminará.

El porcentaje total de cuota utilizado por todos los archivos.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.sessions.listSessionFileMetadata

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

FileMetadata

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

El ID del archivo.
name

string

El nombre del archivo subido.
mimeType

string

El 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 definirá para todos los tipos de archivo y, con el tiempo, se eliminará.

La longitud del archivo medida en tokens.
quotaPercentage
(deprecated)

number

Obsoleto: este campo no se definirá para todos los tipos de archivo y, con el tiempo, se eliminará.

Porcentaje de la cuota que ocupa el archivo.
selected

boolean

Si se selecciona el archivo para usarlo.
usedInConversation

boolean

Indica si el archivo se ha usado en la sesión anteriormente (es decir, si se ha usado en una consulta) y forma parte del historial de la conversación, o si solo se ha subido y aún no se ha usado.
originalUri

string

Opcional. Ubicación original del archivo. Puede ser una ruta de archivo local o cualquier otro URI que permita acceder al archivo en un sistema externo. Hay dos casos en los que esta URL puede estar vacía: Si el archivo se ha enviado como datos insertados (por ejemplo, pegado desde el portapapeles). 2. Si la ubicación original no está disponible.

Tenga en cuenta que no hay ninguna garantía de que el URI apunte a un archivo válido o que exista. Por ejemplo, puede que se haya subido un archivo a la sesión y, después, se haya eliminado de la fuente original.
originalSourceType

enum (FileSource)

Opcional. El tipo de la fuente original del archivo.
uploadTime

string (Timestamp format)

Solo de salida. La hora en la que se subió el archivo (si se trata de un archivo generado por un proceso interno y, a continuación, se pone a disposición de la sesión, se indica el momento en el que se produjo).

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 se pueden adaptar a casos prácticos concretos. El prefijo "google." está reservado para la clave que usa Google, pero se pueden usar otros prefijos libremente.
session

string

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