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. Il nome della risorsa della sessione. 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,

  // Union field file can be only one of the following:
  "fileContents": string,
  "document": string
  // End of list of possible types for union field file.
}
Campi
fileName

string

Obbligatorio. Il 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.
Campo unione file. I contenuti del file. file può essere solo uno dei seguenti:
fileContents

string (bytes format)

Contenuti del file forniti in linea.

Una stringa con codifica Base64.
document

string

Nome risorsa di 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}

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
}
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)

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

La lunghezza del file misurata in token.

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.addContextFile

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