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

Carica un file di contesto da utilizzare come origine per le chiamate di assistenza all'interno della sessione.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Nome della risorsa Session. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Se - viene specificato come ID sessione, viene creata una nuova sessione con un ID generato automaticamente.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "fileName": string,
  "mimeType": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fileContents": string,
  "document": string
  // End of mutually exclusive fields.
}
Campi
fileName

string

Obbligatorio. Nome del file.
mimeType

string

Facoltativo. Il tipo di contenuto del file, vedi https://www.iana.org/assignments/media-types/media-types.xhtml.

Questo campo è obbligatorio quando l'origine dati non fornisce il tipo di contenuto.
I contenuti del file. Di seguito è riportato un elenco di campi che si escludono a vicenda. Nella risposta verrà impostato al massimo uno dei campi:
fileContents

string (bytes format)

Contenuti del file forniti in linea.

Una stringa con codifica in base64.
document

string

Nome della risorsa Document. Il chiamante deve disporre dell'autorizzazione per accedere a Document, altrimenti viene restituito un errore PERMISSION_DENIED.

Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}
Fine dei campi che si escludono a vicenda.

Corpo della risposta

Risposta per il metodo AssistantService.AddContextFile.

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

Rappresentazione JSON 
{
  "session": string,
  "fileId": string,
  "tokenCount": string,
  "mimeType": string,
  "byteCount": string,
  "fileName": string
}
Campi
session

string

Il nome della sessione, quello fornito o quello appena creato.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
fileId

string

L'ID del file caricato.
tokenCount
(deprecated)

string (int64 format)

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

La lunghezza del file misurata in token.
mimeType

string

Solo output. Il tipo di contenuto risolto del file caricato, vedi https://www.iana.org/assignments/media-types/media-types.xhtml.

A differenza di AddContextFileRequest.mime_type, facoltativo e fornito dal chiamante, questo è il tipo di contenuto che il servizio ha effettivamente risolto per il file.
byteCount

string (int64 format)

Solo output. La dimensione del file caricato in byte.
fileName

string

Solo output. Il nome risolto del file caricato, inclusa l'estensione del file.

A differenza di AddContextFileRequest.file_name fornito dal chiamante, il servizio aggiunge l'estensione che corrisponde a mimeType risolto quando il nome fornito dal chiamante non ne ha, in modo che i log di audit sull'utilizzo acquisiscano il tipo di file anche per i file generati dall'AI con nomi generici.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.sessions.addContextFile

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