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

Enumera 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 usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del 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.

Parámetros de consulta

Parámetros
filter

string

Opcional. La sintaxis del filtro consta de un lenguaje de expresión para construir un predicado a partir de uno o más campos de los archivos que se filtran. La expresión del filtro distingue mayúsculas de minúsculas.

Actualmente, se admiten los siguientes nombres de campos:

  • 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 obtener una descripción completa del formato del filtro, consulta https://google.aip.dev/160.
pageSize

integer

Opcional. Es la cantidad máxima de archivos que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 100 archivos. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000. Si el usuario especifica un valor menor o igual que 0, se rechazará la solicitud con un error INVALID_ARGUMENT.
pageToken

string

Opcional. Es un token de página que se recibió de una llamada a files.list anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados a files.list deben coincidir con la llamada que proporcionó el token de la página (excepto pageSize, que puede diferir).
orderBy

string

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

El valor es una cadena de campos separados por comas según los cuales se ordenará.

Para el orden ascendente, solo se usa el nombre del campo. Para el orden descendente, el nombre del campo tiene el sufijo desc. La clasificació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: Es la fecha y hora en que se subió el archivo.
  • file_name: Es el nombre del archivo.
  • mime_type: Es el tipo de MIME del archivo.
  • session_name: Es 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 carga de forma descendente: upload_time desc

  3. Ordenar por nombre de archivo (ascendente), luego por tipo de contenido (tipo de MIME) (descendente) y, por último, por hora de carga (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 para el método SessionService.ListFiles.

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

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

object (FileMetadata)

Los FileMetadata.
nextPageToken

string

Un token para recuperar la siguiente página de resultados. Pasa este valor en el campo ListFilesRequest.page_token en la llamada posterior al método files.list para recuperar la siguiente página de resultados.

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

  • discoveryengine.sessions.listSessionFileMetadata

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

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 salida. Es el ID del archivo.
name

string

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

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

string (Timestamp format)

Solo salida. Fecha y hora en que se agregó el archivo a la sesión. Ten en cuenta que, si se agrega un archivo, luego se modifica de forma externa y, por último, se vuelve a agregar, se actualizará la hora de adición.

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

string

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

enum (FileOriginType)

Opcional. Es el origen del archivo.
views

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

Solo salida. Son las vistas alternativas de este objeto de archivo. Cada vista de archivo se adjunta a un rol específico. Posibles claves de ejemplo: - "thumbnail" - "mobile_thumbnail" - "clip" - "summary" - "translation"

FileOriginType

Es el origen del archivo.

Enums
FILE_ORIGIN_TYPE_UNSPECIFIED Valor predeterminado.
USER_PROVIDED El usuario proporcionó el archivo.
AI_GENERATED El archivo fue generado por un modelo de IA.
INTERNALLY_GENERATED El archivo se generó a partir de otros archivos mediante un proceso interno.

FileView

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

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 salida. Es el ID único global de esta vista específica.
uri

string

Solo salida. Es el URI para acceder a esta vista de medios.
mimeType

string

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

string (int64 format)

Solo salida. Es el tamaño de la vista en bytes.
createTime

string (Timestamp format)

Solo salida. Fecha y hora en que se creó la vista.

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".
Campo de unión characteristics. Son las características de la vista de medios, que permiten extensiones flexibles. Los metadatos siempre se generan internamente a través del proceso que crea la vista. characteristics puede ser solo uno de los siguientes:
imageCharacteristics

object (ImageCharacteristics)

Solo salida. Son las características de una vista de medios de imagen.
videoCharacteristics

object (VideoCharacteristics)

Solo salida. Son las características de una vista de medios de video.
fileCharacteristics

object (FileCharacteristics)

Solo salida. Características de otros tipos de archivos

ImageCharacteristics

Son las características estándar de una vista de medios de imagen.

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

integer

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

integer

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

enum (ColorSpace)

Solo salida. Espacio de color de la imagen (p.ej., "RGB", "CMYK", "Escala de grises").
bitDepth

integer

Solo salida. Profundidad de bits de la imagen (p.ej., 8 bits y 16 bits).

ColorSpace

Espacios de color posibles de una imagen (p.ej., "RGB", "CMYK", "Escala de grises").

Enums
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

Son las características estándar de una vista de medios de video.

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

integer

Solo salida. Ancho del video en píxeles.
height

integer

Solo salida. Altura del video en píxeles.
duration

string (Duration format)

Solo salida. Es la duración del video.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
frameRate

number

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

string

Solo salida. Son los códecs de audio que se usan en el video.
videoCodecs[]

string

Solo salida. Son los códecs de video que se usan en el video.
videoBitrateKbps

integer

Solo salida. Es la tasa de bits del video en kbps.
audioBitrateKbps

integer

Solo salida. Es la tasa de bits del audio en kbps.

FileCharacteristics

Características de otros tipos de archivos

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

map (key: string, value: string)

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