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

Sube un archivo de contexto para usarlo como fuente de las llamadas de asistencia dentro de la sesión.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Es el nombre del recurso de la sesión. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Si se especifica - como el ID de sesión, se crea una sesión nueva con un ID generado automáticamente.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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.
}
Campos
fileName

string

Obligatorio. Es el nombre del archivo.
mimeType

string

Es opcional. Es el tipo de contenido del archivo. Consulta https://www.iana.org/assignments/media-types/media-types.xhtml.

Este campo es obligatorio cuando la fuente de datos no proporciona el tipo de contenido.
Es el contenido del archivo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
fileContents

string (bytes format)

El contenido del archivo se proporciona de forma intercalada.

Es una cadena codificada en Base64.
Fin de los campos mutuamente excluyentes.

Cuerpo de la respuesta

Respuesta para el método AssistantService.AddContextFile.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "session": string,
  "fileId": string,
  "tokenCount": string,
  "mimeType": string,
  "byteCount": string,
  "fileName": string
}
Campos
session

string

Es el nombre de la sesión, ya sea la proporcionada o la recién creada.

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

string

Es el ID del archivo subido.
tokenCount
(deprecated)

string (int64 format)

Obsoleto: Este campo no se establecerá para todos los tipos de archivos y, finalmente, se quitará.

Es la longitud del archivo medida en tokens.
mimeType

string

Solo salida. Es el tipo de contenido resuelto del archivo subido. Consulta https://www.iana.org/assignments/media-types/media-types.xhtml.

A diferencia de AddContextFileRequest.mime_type, que es opcional y lo proporciona la entidad llamadora, este es el tipo de contenido que el servicio resolvió para el archivo.
byteCount

string (int64 format)

Solo salida. Tamaño del archivo subido en bytes.
fileName

string

Solo salida. Es el nombre resuelto del archivo subido, incluida su extensión de archivo.

A diferencia del AddContextFileRequest.file_name proporcionado por la entidad llamadora, la app de servicio agrega la extensión que coincide con el mimeType resuelto cuando el nombre proporcionado por la entidad llamadora no tiene ninguna, por lo que los registros de auditoría de uso capturan el tipo de archivo incluso para los archivos generados por IA con nombres genéricos.

Permisos de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.sessions.addContextFile

Para obtener más información, consulta la documentación de IAM.