Method: projects.locations.collections.engines.assistants.assist

Ajuda o utilizador com uma consulta.

Pedido HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso de Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
Campos
query

object (Query)

Opcional. Consulta do utilizador atual.

A consulta vazia só é suportada se forem fornecidos fileIds. Neste caso, a resposta é gerada com base nesses ficheiros de contexto.
session

string

Opcional. A sessão a usar para o pedido. Se for especificado, o assistente tem acesso ao histórico da sessão, e a consulta e a resposta são armazenadas aí.

Se - for especificado como o ID da sessão ou for deixado em branco, é criada uma nova sessão com um ID gerado automaticamente.

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

enum (AssistSkippingMode)

Opcional. Determina os casos em que o assistente não responde à consulta. Se a resposta for ignorada, os motivos são apresentados em AssistAnswer.assist_skipped_reasons no prazo de AssistResponse.answer.
fileIds[]

string

Opcional. Os IDs dos ficheiros a usar para responder ao pedido. Quando carrega um ficheiro, o respetivo ID é devolvido em AddContextFileResponse.file_id.
userMetadata

object (AssistUserMetadata)

Opcional. Informações sobre o utilizador que inicia a consulta.
languageCode

string

Opcional. Idioma a usar para responder se a deteção de idioma falhar. Também usado como o idioma das mensagens de erro criadas por ações, independentemente dos resultados da deteção de idioma.
webGroundingEnabled

boolean

Opcional. Se estiver definida como verdadeira, ativa o fundamento com a pesquisa Web. Só funciona se Assistant.web_grounding_type for [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] ou [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
dataStoreSpecs[]

object (DataStoreSpec)

Opcional. Especificações que definem DataStores para filtrar numa chamada de pesquisa e configurações para esses armazenamentos de dados. Isto só é considerado para Engines com várias lojas de dados.

Se não definir este campo, vai usar todos os arquivos de dados no motor, exceto quando ignoreDataStores estiver definido como verdadeiro.
assistGenerationConfig

object (AssistGenerationConfig)

Opcional. Configuração de geração ao nível do pedido. Isto é usado para substituir a configuração de geração predefinida ao nível do motor.
googleSearchGroundingEnabled
(deprecated)

boolean

Opcional. Descontinuado. Em alternativa, use webGroundingEnabled.

Corpo da resposta

Resposta para o método AssistantService.Assist.

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

Representação JSON 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string
}
Campos
answer

object (AssistAnswer)

O recurso AssistAnswer gerado em resposta à consulta.
sessionInfo

object (SessionInfo)

Informações da sessão.
assistToken

string

Um ID exclusivo global que identifica o par pedido-resposta atual. Usado para feedback e apoio técnico.

Â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.assistants.assist

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

AssistSkippingMode

Comportamentos de ignorar disponíveis para pedidos de assistência.

Enumerações
ASSIST_SKIPPING_MODE_UNSPECIFIED Valor predefinido. A resposta pode ser ignorada se a consulta não estiver a pedir assistência.
REQUEST_ASSIST Pedir resposta ao Assistente. A resposta pode continuar a ser ignorada se a consulta falhar nas verificações de políticas.

SessionInfo

Informações sobre a sessão.

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

string

Nome da sessão recém-gerada ou continuada.

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

string

ID da consulta que corresponde a esta chamada API Assist. Uma sessão pode ter vários turnos, cada um com um ID de consulta exclusivo.

Ao especificar o nome da sessão e este ID de consulta na chamada da API assistants.assist, o pedido de assistência ocorre no contexto dos resultados da pesquisa desta chamada de pesquisa.