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

Faz upload de um arquivo de contexto para usar como origem das chamadas de assistência na sessão.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso da sessão. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Se - for especificado como o ID da sessão, uma nova sessão será criada com um ID gerado automaticamente.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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.
}
Campos
fileName

string

Obrigatório. O nome do arquivo.
mimeType

string

Opcional. O tipo de conteúdo do arquivo. Consulte https://www.iana.org/assignments/media-types/media-types.xhtml.

Esse campo é obrigatório quando a fonte de dados não fornece o tipo de conteúdo.
Campo de união file. O conteúdo do arquivo. file pode ser apenas de um dos tipos a seguir:
fileContents

string (bytes format)

Conteúdo do arquivo fornecido inline.

Uma string codificada em base64.

Corpo da resposta

Resposta para o método AssistantService.AddContextFile.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "session": string,
  "fileId": string,
  "tokenCount": string
}
Campos
session

string

O nome da sessão, seja a fornecida ou a recém-criada.

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

string

O ID do arquivo enviado por upload.
tokenCount
(deprecated)

string (int64 format)

Descontinuado: esse campo não será definido para todos os tipos de arquivo e será removido em breve.

O comprimento do arquivo medido em tokens.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.sessions.addContextFile

Para mais informações, consulte a documentação do IAM.