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

Lista metadados de todos os arquivos na sessão atual.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da sessão. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} nome do recurso de sessão a que o arquivo pertence.

Parâmetros de consulta

Parâmetros
filter

string

Opcional. A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado a partir de um ou mais campos dos arquivos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas.

No momento, os nomes de campo compatíveis são:

  • upload_time
  • last_add_time
  • last_use_time
  • file_name
  • mime_type

Alguns exemplos de filtros:

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

Para uma descrição completa do formato do filtro, consulte https://google.aip.dev/160.
pageSize

integer

Opcional. O número máximo de arquivos a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 100 arquivos serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. Se o usuário especificar um valor menor ou igual a 0, a solicitação será rejeitada com um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Um token de página recebido de uma chamada files.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para files.list precisam corresponder à chamada que forneceu o token da página (exceto pageSize, que pode ser diferente).
orderBy

string

Opcional. Especifica a ordem em que os arquivos são retornados.

O valor é uma string separada por vírgulas de campos para classificação.

Para ordem crescente, apenas o nome do campo é usado. Para ordem decrescente, o nome do campo recebe o sufixo desc. A classificação é estável e aplicada sequencialmente de acordo com a ordem dos campos fornecidos na string.

Campos compatíveis com a ordenação:

  • upload_time: o horário em que o arquivo foi enviado.
  • file_name: o nome do arquivo.
  • mime_type: o tipo MIME do arquivo.
  • session_name: o nome da sessão a que o arquivo pertence.

Comportamento padrão:

Se o campo orderBy não for especificado, os arquivos serão retornados classificados por hora de criação em ordem decrescente.

Exemplos:

  1. Classificar por nome do arquivo em ordem crescente: file_name

  2. Classificar por horário de envio em ordem decrescente: upload_time desc

  3. Classifique por nome de arquivo (crescente), depois por tipo de conteúdo (tipo MIME) (decrescente) e, por fim, por hora de upload (crescente): file_name, mime_type desc, upload_time

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método SessionService.ListFiles.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "files": [
    {
      object (FileMetadata)
    }
  ],
  "nextPageToken": string
}
Campos
files[]

object (FileMetadata)

Os FileMetadatas.
nextPageToken

string

Token para recuperar a próxima página de resultados. Transmita esse valor no campo ListFilesRequest.page_token na chamada subsequente ao método files.list para recuperar a próxima página de resultados.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.sessions.listSessionFileMetadata

Para mais informações, consulte a documentação do IAM.

FileMetadata

Representa um arquivo anexado a uma sessão (arquivo de contexto).

Representação 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

Apenas saída. O ID do arquivo.
name

string

Apenas saída. O nome do arquivo enviado por upload.
mimeType

string

O tipo de conteúdo do arquivo. Consulte https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

Apenas saída. O tamanho do arquivo de contexto em bytes.
originalUri

string

Opcional. O local original do arquivo. Pode ser um caminho de arquivo local ou qualquer outro URI que permita acessar o arquivo em um sistema externo. Há dois cenários em que esse URL pode estar vazio: 1. Se o arquivo foi enviado como dados inline (por exemplo, colado da área de transferência). 2. Se o local original não estiver disponível.

Não há garantia de que o URI vai apontar para um arquivo válido ou que realmente existe. Por exemplo, um arquivo pode ter sido enviado para a sessão e depois excluído da fonte original.
originalSourceType

enum (FileSource)

Opcional. O tipo da fonte original do arquivo.
uploadTime

string (Timestamp format)

Apenas saída. O horário em que o arquivo foi enviado (se for um arquivo gerado por um processo interno e disponibilizado para a sessão, isso indica o momento em que aconteceu).

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
lastAddTime

string (Timestamp format)

Apenas saída. O momento em que o arquivo foi adicionado à sessão. Se um arquivo foi adicionado, modificado externamente e adicionado novamente, a hora de adição será atualizada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
metadata

map (key: string, value: string)

Opcional. Representa metadados relacionados ao arquivo que podem ser adequados para casos de uso específicos. O prefixo "google." é reservado para uso do Google, mas outros prefixos podem ser usados livremente.
downloadUri

string

Apenas saída. O URL AssistantService.DownloadSessionFile para fazer o download do arquivo. Esse URL vai precisar das mesmas credenciais que o método AssistantService.ListSessionFileMetadata e vai fornecer o recurso.
fileOriginType

enum (FileOriginType)

Opcional. A origem do arquivo.
views

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

Apenas saída. Visualizações alternativas desse objeto de arquivo. Cada visualização de arquivo é anexada a uma função específica. Possíveis chaves de exemplo: - "thumbnail" - "mobile_thumbnail" - "clip" - "summary" - "translation"

FileOriginType

A origem do arquivo.

Tipos enumerados
FILE_ORIGIN_TYPE_UNSPECIFIED Valor padrão.
USER_PROVIDED O arquivo foi fornecido pelo usuário.
AI_GENERATED O arquivo foi gerado por um modelo de IA.
INTERNALLY_GENERATED O arquivo foi gerado de outros arquivos por um processo interno.

FileView

Representa uma versão alternativa específica ou uma "visualização" de um objeto de arquivo, como um resumo, uma miniatura, uma versão traduzida etc.

Representação 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

Apenas saída. ID globalmente exclusivo para essa visualização específica.
uri

string

Apenas saída. O URI para acessar essa visualização de mídia.
mimeType

string

Apenas saída. Tipo MIME (por exemplo, "image/jpeg", "image/png", "text/plain", "video/mp4")
byteSize

string (int64 format)

Apenas saída. O tamanho da visualização em bytes.
createTime

string (Timestamp format)

Apenas saída. A hora em que a visualização foi criada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Campo de união characteristics. Características da visualização de mídia, permitindo extensões flexíveis. Os metadados são sempre gerados internamente pelo processo que cria a visualização. characteristics pode ser apenas de um dos tipos a seguir:
imageCharacteristics

object (ImageCharacteristics)

Apenas saída. Características de uma visualização de mídia de imagem.
videoCharacteristics

object (VideoCharacteristics)

Apenas saída. Características de uma visualização de mídia de vídeo.
fileCharacteristics

object (FileCharacteristics)

Apenas saída. Características de outros tipos de arquivo.

ImageCharacteristics

Características padrão de uma visualização de mídia de imagem.

Representação JSON 
{
  "width": integer,
  "height": integer,
  "colorSpace": enum (ColorSpace),
  "bitDepth": integer
}
Campos
width

integer

Apenas saída. Largura da imagem em pixels.
height

integer

Apenas saída. Altura da imagem em pixels.
colorSpace

enum (ColorSpace)

Somente saída. Espaço de cores da imagem (por exemplo, "RGB", "CMYK", "Grayscale").
bitDepth

integer

Apenas saída. Profundidade de bits da imagem (por exemplo, 8 bits, 16 bits).

ColorSpace

Possíveis espaços de cor de uma imagem (por exemplo, "RGB", "CMYK", "Grayscale").

Tipos enumerados
COLOR_SPACE_UNSPECIFIED Valor padrão. Espaço de cores desconhecido.
RGB Espaço de cores vermelho, verde e azul.
CMYK Espaço de cores ciano, magenta, amarelo e preto.
GRAYSCALE Espaço de cores em escala de cinza.
YUV Espaço de cores YUV.
OTHER_COLOR_SPACE Outro espaço de cor.

VideoCharacteristics

Características padrão de uma visualização de mídia de vídeo.

Representação JSON 
{
  "width": integer,
  "height": integer,
  "duration": string,
  "frameRate": number,
  "audioCodecs": [
    string
  ],
  "videoCodecs": [
    string
  ],
  "videoBitrateKbps": integer,
  "audioBitrateKbps": integer
}
Campos
width

integer

Apenas saída. Largura do vídeo em pixels.
height

integer

Apenas saída. Altura do vídeo em pixels.
duration

string (Duration format)

Apenas saída. Duração do vídeo.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
frameRate

number

Apenas saída. Frame rate (frames por segundo).
audioCodecs[]

string

Apenas saída. Codecs de áudio usados no vídeo.
videoCodecs[]

string

Apenas saída. Codecs de vídeo usados no vídeo.
videoBitrateKbps

integer

Apenas saída. Taxa de bits do vídeo em kbps.
audioBitrateKbps

integer

Apenas saída. Taxa de bits do áudio em kbps.

FileCharacteristics

Características de outros tipos de arquivo.

Representação JSON 
{
  "characteristics": {
    string: string,
    ...
  }
}
Campos
characteristics

map (key: string, value: string)

Apenas saída. Mapa genérico de características.