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

Ajuda o usuário com uma consulta.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

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

Corpo da solicitação

O corpo da solicitação 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 usuário atual.

Uma consulta vazia só é aceita se fileIds forem fornecidos. Nesse caso, a resposta será gerada com base nesses arquivos de contexto.
session

string

Opcional. A sessão a ser usada na solicitação. Se especificado, o assistente terá acesso ao histórico da sessão, e a consulta e a resposta serão armazenadas lá.

Se - for especificado como o ID da sessão ou ficar em branco, uma nova sessão será criada 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 vai responder à consulta. Se a resposta for ignorada, os motivos serão listados em AssistAnswer.assist_skipped_reasons dentro de AssistResponse.answer.
fileIds[]

string

Opcional. Os IDs dos arquivos a serem usados para responder à solicitação. Ao fazer upload de um arquivo, o ID dele é retornado em AddContextFileResponse.file_id.
userMetadata

object (AssistUserMetadata)

Opcional. Informações sobre o usuário que iniciou a consulta.
languageCode

string

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

boolean

Opcional. Se definido como "true", ativa o embasamento com a pesquisa na Web. Funciona apenas 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 em uma chamada de pesquisa e configurações para esses repositórios de dados. Isso só é considerado para Engines com vários repositórios de dados.

Se você não definir esse campo, todos os repositórios de dados no mecanismo serão usados, exceto quando ignoreDataStores estiver definido como "true".
assistGenerationConfig

object (AssistGenerationConfig)

Opcional. Configuração de geração no nível da solicitação. Isso é usado para substituir a configuração de geração padrão no nível do mecanismo.
googleSearchGroundingEnabled
(deprecated)

boolean

Opcional. Obsoleto. Use webGroundingEnabled.

Corpo da resposta

Resposta para o método AssistantService.Assist.

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

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 global exclusivo que identifica o par solicitação-resposta atual. Usado para feedback e suporte.

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

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

AssistSkippingMode

Comportamentos de pular disponíveis para solicitações de assistência.

Tipos enumerados
ASSIST_SKIPPING_MODE_UNSPECIFIED Valor padrão. A resposta pode ser ignorada se a consulta não estiver buscando ajuda.
REQUEST_ASSIST Pedir resposta do Google Assistente. A resposta ainda pode ser ignorada se a consulta não passar nas verificações de política.

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 de API de assistência. Uma sessão pode ter vários turnos, cada um com um ID de consulta exclusivo.

Ao especificar o nome da sessão e o ID da consulta na chamada de API assistants.assist, a solicitação de assistência acontece no contexto dos resultados da pesquisa dessa chamada.