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

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

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de 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 do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

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

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (FileMetadata)

Os anos FileMetadata.
totalQuotaPercentage
(deprecated)

number

Obsoleto: este campo pode não estar definido ou o valor pode não ter em conta todos os tipos de ficheiros. A ser removido.

A percentagem total da quota usada por todos os ficheiros.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.sessions.listSessionFileMetadata

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

FileMetadata

Os metadados do ficheiro.

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 ficheiro.
name

string

O nome do ficheiro carregado.
mimeType

string

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

string (int64 format)

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

string (int64 format)

Descontinuado: este campo não vai ser definido para todos os tipos de ficheiros e vai ser removido futuramente.

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

number

Descontinuado: este campo não vai ser definido para todos os tipos de ficheiros e vai ser removido futuramente.

A percentagem da quota usada pelo ficheiro.
selected

boolean

Se o ficheiro estiver selecionado para utilização.
usedInConversation

boolean

Se o ficheiro foi usado na sessão anteriormente (ou seja, foi usado numa consulta) e faz parte do histórico de conversas, ou se foi apenas carregado e ainda não foi usado.
originalUri

string

Opcional. A localização original do ficheiro. Pode ser um caminho de ficheiro local ou qualquer outro URI que permita aceder ao ficheiro num sistema externo. Existem dois cenários em que este URL pode estar vazio: 1. Se o ficheiro foi enviado como dados inline (por exemplo, colado a partir da área de transferência). 2. Se a localização original não estiver disponível.

Tenha em atenção que não existem garantias de que o URI esteja a apontar para um ficheiro válido ou realmente existente. Por exemplo, um ficheiro pode ter sido carregado para a sessão e, em seguida, eliminado da origem original.
originalSourceType

enum (FileSource)

Opcional. O tipo de fonte original do ficheiro.
uploadTime

string (Timestamp format)

Apenas saída. A hora em que o ficheiro foi carregado (se for um ficheiro gerado por um processo interno e, em seguida, disponibilizado à sessão, isto indica o momento em que ocorreu).

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 com o ficheiro que podem adequar-se a exemplos de utilização específicos. O prefixo "google." está reservado para a chave para utilização pela Google, mas outros prefixos podem ser utilizados livremente.
session

string

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