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

Importe un fichier de contexte à utiliser comme source pour les appels d'assistance au cours de la session.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource de la session. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Si - est spécifié comme ID de session, une nouvelle session est créée avec un ID généré automatiquement.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "fileName": string,
  "mimeType": string,

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

string

Obligatoire. Nom du fichier.
mimeType

string

Facultatif. Type de contenu du fichier. Pour en savoir plus, consultez https://www.iana.org/assignments/media-types/media-types.xhtml.

Ce champ est obligatoire lorsque la source de données ne fournit pas le type de contenu.
Champ d'union file. Contenu du fichier. file ne peut être qu'un des éléments suivants :
fileContents

string (bytes format)

Contenu du fichier fourni de manière intégrée.

Chaîne encodée en base64.

Corps de la réponse

Réponse pour la méthode AssistantService.AddContextFile.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "session": string,
  "fileId": string,
  "tokenCount": string
}
Champs
session

string

Nom de la session, qu'il s'agisse de celle fournie ou de celle nouvellement créée.

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

string

ID du fichier importé.
tokenCount
(deprecated)

string (int64 format)

Obsolète : ce champ ne sera pas défini pour tous les types de fichiers et sera supprimé à terme.

Longueur du fichier mesurée en jetons.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.sessions.addContextFile

Pour en savoir plus, consultez la documentation IAM.