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

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

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

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

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método AssistantService.ListSessionFileMetadata.

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

Representação JSON 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
Campos
fileMetadata[]

object (FileMetadata)

Os FileMetadatas.
totalQuotaPercentage
(deprecated)

number

Descontinuado: esse campo pode não ser definido ou o valor pode não considerar todos os tipos de arquivo. A ser removido.

A porcentagem total da cota usada por todos os arquivos.

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

  • discoveryengine.sessions.listSessionFileMetadata

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

FileMetadata

Os metadados do arquivo.

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

O ID do arquivo.
name

string

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)

O tamanho do arquivo de contexto em bytes.
tokenCount
(deprecated)

string (int64 format)

Descontinuado: esse campo não será definido para todos os tipos de arquivo e será removido em breve.

O comprimento do arquivo medido em tokens.
quotaPercentage
(deprecated)

number

Descontinuado: esse campo não será definido para todos os tipos de arquivo e será removido em breve.

A porcentagem da cota usada pelo arquivo.
selected

boolean

Se o arquivo estiver selecionado para uso.
usedInConversation

boolean

Se o arquivo foi usado na sessão anteriormente (ou seja, em uma consulta) e faz parte do histórico de conversas ou se foi apenas enviado e ainda não foi usado.
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".
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.
session

string

Apenas saída. O nome do recurso da sessão. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.