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

Carrega um ficheiro de contexto para usar como origem para as chamadas de assistência na sessão.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de 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, é criada uma nova sessão com um ID gerado automaticamente.

Corpo do pedido

O corpo do pedido 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 ficheiro.
mimeType

string

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

Este campo é obrigatório quando a origem de dados não fornece o tipo de conteúdo.
Campo de união file. O conteúdo do ficheiro. file só pode ser uma das seguintes opções:
fileContents

string (bytes format)

O conteúdo do ficheiro é fornecido inline.

Uma string codificada em Base64.

Corpo da resposta

Resposta para o método AssistantService.AddContextFile.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

string

O nome da sessão, o fornecido ou o recém-criado.

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

string

O ID do ficheiro carregado.
tokenCount
(deprecated)

string (int64 format)

Descontinuado: este campo não vai ser definido para todos os tipos de ficheiros e vai ser removido futuramente.

O comprimento do ficheiro medido em tokens.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.sessions.addContextFile

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