Method: projects.locations.collections.engines.sessions.files.list

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

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

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

Los parámetros de consulta

Parámetros
filter

string

Opcional. La sintaxis del filtro consta de un lenguaje de expresiones para crear un predicado a partir de uno o varios campos de los archivos que se están filtrando. La expresión de filtro distingue entre mayúsculas y minúsculas.

Los nombres de campo admitidos actualmente son los siguientes:

  • upload_time
  • last_add_time
  • last_use_time
  • file_name
  • mime_type

Estos son algunos ejemplos de filtros:

  • "file_name = 'file_1'"
  • "file_name = 'file_1' AND mime_type = 'text/plain'"
  • "last_use_time > '2025-06-14T12:00:00Z'"

Para ver una descripción completa del formato de filtro, consulta https://google.aip.dev/160.
pageSize

integer

Opcional. Número máximo de archivos que se devolverán. Es posible que el servicio devuelva un número inferior a este valor. Si no se especifica, se devolverán 100 archivos como máximo. El valor máximo es 1000; los valores superiores a este límite se convertirán a 1000. Si el usuario especifica un valor igual o inferior a 0, la solicitud se rechazará con un error INVALID_ARGUMENT.
pageToken

string

Opcional. Un token de página recibido de una llamada files.list anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a files.list deben ser los mismos que aparecen en la llamada que proporcionó el token de la página (excepto pageSize, que puede ser diferente).
orderBy

string

Opcional. Especifica el orden en el que se devuelven los archivos.

El valor es una cadena de campos separados por comas por los que se debe ordenar.

Para el orden ascendente, solo se usa el nombre del campo. Para el orden descendente, el nombre del campo lleva el sufijo desc. La ordenación es estable y se aplica de forma secuencial según el orden de los campos proporcionados en la cadena.

Campos admitidos para ordenar:

  • upload_time: la hora en la que se subió el archivo.
  • file_name: nombre del archivo.
  • mime_type: el tipo MIME del archivo.
  • session_name: el nombre de la sesión a la que pertenece el archivo.

Comportamiento predeterminado:

Si no se especifica el campo orderBy, los archivos se devolverán ordenados por hora de creación en orden descendente.

Ejemplos:

  1. Ordenar por nombre de archivo en orden ascendente: file_name

  2. Ordenar por hora de subida en orden descendente: upload_time desc

  3. Ordenar por nombre de archivo (ascendente), después por tipo de contenido (tipo MIME) (descendente) y, por último, por hora de subida (ascendente): file_name, mime_type desc, upload_time

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta del método SessionService.ListFiles.

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

Representación JSON 
{
  "files": [
    {
      object (FileMetadata)
    }
  ],
  "nextPageToken": string
}
Campos
files[]

object (FileMetadata)

Los FileMetadata.
nextPageToken

string

Token para obtener la siguiente página de resultados. Transfiere este valor al campo ListFilesRequest.page_token en la siguiente llamada al método files.list para obtener la siguiente página de resultados.

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 parent:

  • discoveryengine.sessions.listSessionFileMetadata

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

FileMetadata

Representa un archivo adjunto a una sesión (archivo de contexto).

Representación JSON 
{
  "fileId": string,
  "name": string,
  "mimeType": string,
  "byteSize": string,
  "originalUri": string,
  "originalSourceType": enum (FileSource),
  "uploadTime": string,
  "lastAddTime": string,
  "metadata": {
    string: string,
    ...
  },
  "downloadUri": string,
  "fileOriginType": enum (FileOriginType),
  "views": {
    string: {
      object (FileView)
    },
    ...
  }
}
Campos
fileId

string

Solo de salida. El ID del archivo.
name

string

Solo de salida. 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)

Solo de salida. Tamaño del archivo de contexto en bytes.
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".
lastAddTime

string (Timestamp format)

Solo de salida. La hora a la que se añadió el archivo a la sesión. Ten en cuenta que, si se añade un archivo, se modifica externamente y se vuelve a añadir, se actualizará la hora de adición.

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.
downloadUri

string

Solo de salida. La AssistantService.DownloadSessionFile URL para descargar el archivo. Esta URL necesitará las mismas credenciales que el método AssistantService.ListSessionFileMetadata y proporcionará el recurso.
fileOriginType

enum (FileOriginType)

Opcional. El origen del archivo.
views

map (key: string, value: object (FileView))

Solo de salida. Vistas alternativas de este objeto de archivo. Cada vista de archivo está asociada a un rol específico. Posibles claves de ejemplo: - "thumbnail" - "mobile_thumbnail" - "clip" - "summary" - "translation"

FileOriginType

El origen del archivo.

Enumeraciones
FILE_ORIGIN_TYPE_UNSPECIFIED Valor predeterminado.
USER_PROVIDED El usuario ha proporcionado el archivo.
AI_GENERATED El archivo se ha generado con un modelo de IA.
INTERNALLY_GENERATED El archivo se ha generado a partir de otros archivos mediante un proceso interno.

FileView

Representa una versión alternativa específica de un objeto de archivo, como un resumen, una miniatura, una versión traducida, etc.

Representación JSON 
{
  "viewId": string,
  "uri": string,
  "mimeType": string,
  "byteSize": string,
  "createTime": string,

  // Union field characteristics can be only one of the following:
  "imageCharacteristics": {
    object (ImageCharacteristics)
  },
  "videoCharacteristics": {
    object (VideoCharacteristics)
  },
  "fileCharacteristics": {
    object (FileCharacteristics)
  }
  // End of list of possible types for union field characteristics.
}
Campos
viewId

string

Solo de salida. ID único global de esta vista específica.
uri

string

Solo de salida. URI para acceder a esta vista de contenido multimedia.
mimeType

string

Solo de salida. Tipo MIME (por ejemplo, "image/jpeg", "image/png", "text/plain", "video/mp4")
byteSize

string (int64 format)

Solo de salida. Tamaño de la vista en bytes.
createTime

string (Timestamp format)

Solo de salida. Hora a la que se creó la vista.

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".
Campo de unión characteristics. Características de la vista de contenido multimedia, que permiten extensiones flexibles. Los metadatos siempre los genera internamente el proceso que crea la vista. characteristics solo puede ser una de estas dos opciones:
imageCharacteristics

object (ImageCharacteristics)

Solo de salida. Características de una vista de contenido multimedia de imagen.
videoCharacteristics

object (VideoCharacteristics)

Solo de salida. Características de una vista de medio de vídeo.
fileCharacteristics

object (FileCharacteristics)

Solo de salida. Características de otros tipos de archivo.

ImageCharacteristics

Características estándar de una vista de medio de imagen.

Representación JSON 
{
  "width": integer,
  "height": integer,
  "colorSpace": enum (ColorSpace),
  "bitDepth": integer
}
Campos
width

integer

Solo de salida. Ancho de la imagen en píxeles
height

integer

Solo de salida. Altura de la imagen en píxeles
colorSpace

enum (ColorSpace)

Solo de salida. Espacio de color de la imagen (por ejemplo, "RGB", "CMYK" o "Grayscale").
bitDepth

integer

Solo de salida. Profundidad de bits de la imagen (por ejemplo, 8 bits o 16 bits.

ColorSpace

Posibles espacios de color de una imagen (por ejemplo, "RGB", "CMYK" o "Grayscale").

Enumeraciones
COLOR_SPACE_UNSPECIFIED Valor predeterminado. Espacio de color desconocido.
RGB Espacio de color rojo, verde y azul.
CMYK Espacio de color cian, magenta, amarillo y negro.
GRAYSCALE Espacio de color en escala de grises.
YUV Espacio de color YUV.
OTHER_COLOR_SPACE Otro espacio de color.

VideoCharacteristics

Características estándar de una vista de medio de vídeo.

Representación JSON 
{
  "width": integer,
  "height": integer,
  "duration": string,
  "frameRate": number,
  "audioCodecs": [
    string
  ],
  "videoCodecs": [
    string
  ],
  "videoBitrateKbps": integer,
  "audioBitrateKbps": integer
}
Campos
width

integer

Solo de salida. Anchura del vídeo en píxeles.
height

integer

Solo de salida. Altura del vídeo en píxeles.
duration

string (Duration format)

Solo de salida. Duración del vídeo.

Duración en segundos con hasta nueve decimales, que termina con "s". Por ejemplo: "3.5s".
frameRate

number

Solo de salida. Velocidad de fotogramas (fotogramas por segundo).
audioCodecs[]

string

Solo de salida. Códecs de audio utilizados en el vídeo.
videoCodecs[]

string

Solo de salida. Códecs de vídeo utilizados en el vídeo.
videoBitrateKbps

integer

Solo de salida. Tasa de bits del vídeo en kbps.
audioBitrateKbps

integer

Solo de salida. Tasa de bits del audio en kbps.

FileCharacteristics

Características de otros tipos de archivo.

Representación JSON 
{
  "characteristics": {
    string: string,
    ...
  }
}
Campos
characteristics

map (key: string, value: string)

Solo de salida. Mapa genérico de características.