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

Les URL utilisent 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fileContents": string
  // End of mutually exclusive fields.
}
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.
Contenu du fichier. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
fileContents

string (bytes format)

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

Chaîne encodée en base64.
Fin des champs qui s'excluent mutuellement.

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,
  "mimeType": string,
  "byteCount": string,
  "fileName": string
}
Champs
session

string

Nom de la session (celui fourni ou celui nouvellement créé).

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 en jetons.
mimeType

string

Uniquement en sortie. Type de contenu résolu du fichier importé. Pour en savoir plus, consultez https://www.iana.org/assignments/media-types/media-types.xhtml.

Contrairement à AddContextFileRequest.mime_type, qui est facultatif et fourni par l'appelant, il s'agit du type de contenu que le service a réellement résolu pour le fichier.
byteCount

string (int64 format)

Uniquement en sortie. Taille du fichier importé en octets.
fileName

string

Uniquement en sortie. Nom résolu du fichier importé, y compris son extension.

Contrairement à AddContextFileRequest.file_name fourni par l'appelant, l'application de service ajoute l'extension correspondant à mimeType résolu lorsque le nom fourni par l'appelant n'en comporte pas. Ainsi, les journaux d'audit d'utilisation capturent le type de fichier, même pour les fichiers générés par IA portant un nom générique.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • 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

Pour plus d'informations, consultez la page 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.