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

Elenca i metadati di tutti i file nella sessione corrente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome della risorsa della sessione. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per il metodo AssistantService.ListSessionFileMetadata.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
Campi
fileMetadata[]

object (FileMetadata)

Gli anni FileMetadata.
totalQuotaPercentage
(deprecated)

number

Obsoleto: questo campo potrebbe non essere impostato o il valore potrebbe non tenere conto di tutti i tipi di file. Da rimuovere.

La percentuale totale di quota utilizzata da tutti i file.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.sessions.listSessionFileMetadata

Per saperne di più, consulta la documentazione di IAM.

FileMetadata

I metadati del file.

Rappresentazione 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
}
Campi
fileId

string

L'ID del file.
name

string

Il nome del file caricato.
mimeType

string

Il tipo di contenuto del file. Vedi https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

Le dimensioni del file di contesto in byte.
tokenCount
(deprecated)

string (int64 format)

Deprecato: questo campo non verrà impostato per tutti i tipi di file e verrà rimosso.

La lunghezza del file misurata in token.
quotaPercentage
(deprecated)

number

Deprecato: questo campo non verrà impostato per tutti i tipi di file e verrà rimosso.

La percentuale della quota utilizzata dal file.
selected

boolean

Se il file è selezionato per essere utilizzato.
usedInConversation

boolean

Se il file è stato utilizzato in precedenza nella sessione (ad es. in una query) e fa parte della cronologia della conversazione oppure è stato solo caricato e non ancora utilizzato.
originalUri

string

Facoltativo. La posizione originale del file. Può essere un percorso di file locale o qualsiasi altro URI che consenta di accedere al file in un sistema esterno. Esistono due scenari in cui questo URL potrebbe essere vuoto: 1. Se il file è stato inviato come dati incorporati (ad es. incollati dagli appunti). 2. Se la posizione originale non è disponibile.

Tieni presente che non è garantito che l'URI rimandi a un file valido o effettivamente esistente. Ad esempio, un file potrebbe essere stato caricato nella sessione e poi eliminato dall'origine originale.
originalSourceType

enum (FileSource)

Facoltativo. Il tipo di origine originale del file.
uploadTime

string (Timestamp format)

Solo output. L'ora in cui è stato caricato il file (se si tratta di un file generato da un processo interno e poi reso disponibile per la sessione, indica il momento in cui è stato generato).

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "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)

Facoltativo. Rappresenta i metadati relativi al file che possono essere adatti a casi d'uso particolari. Il prefisso "google." è riservato alla chiave per l'utilizzo da parte di Google, ma gli altri prefissi possono essere utilizzati liberamente.
session

string

Solo output. Il nome della risorsa della sessione. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.