Method: projects.locations.collections.engines.conversations.converse

Conversa uma conversa.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso da conversa a ser recebida. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}. Use projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- para ativar o modo de sessão automática, que cria uma nova conversa em uma sessão "conversations.converse".

Corpo da solicitação

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

Representação JSON 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
Campos
query

object (TextInput)

Obrigatório. Entrada do usuário atual.
servingConfig

string

O nome do recurso da configuração de exibição a ser usada. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId}. Se não for definido, a configuração de veiculação padrão será usada.
conversation

object (Conversation)

A conversa a ser usada apenas pela sessão automática. O campo de nome será ignorado, já que atribuímos automaticamente um novo nome para a conversa na sessão automática.
userLabels

map (key: string, value: string)

Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos:

  • Cada recurso pode ter vários rótulos, até um máximo de 64.
  • Cada rótulo precisa ser um par de chave-valor.
  • As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres.
  • As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos.
  • A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos.
  • As chaves precisam começar com uma letra minúscula ou um caractere internacional.

Consulte o documento do Google Cloud para mais detalhes.
summarySpec

object (SummarySpec)

Uma especificação para configurar o resumo retornado na resposta.
filter

string

A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado a partir de um ou mais campos dos documentos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas. Isso será usado para filtrar os resultados da pesquisa, o que pode afetar a resposta do resumo.

Se esse campo não for reconhecido, um INVALID_ARGUMENT será retornado.

A filtragem na Vertex AI para Pesquisa é feita mapeando a chave de filtro do lado esquerdo (LHS, na sigla em inglês) para uma propriedade de chave definida no back-end da Vertex AI para Pesquisa. Esse mapeamento é definido pelo cliente no esquema dele. Por exemplo, um cliente de mídia pode ter um campo "name" no esquema. Nesse caso, o filtro ficaria assim: filter --> name:'ANY("king kong")'

Para mais informações sobre filtragem, incluindo sintaxe e operadores de filtro, consulte Filtrar.
boostSpec

object (BoostSpec)

Aumentar a especificação para impulsionar determinados documentos nos resultados da pesquisa, o que pode afetar a resposta inversa. Para mais informações sobre o aumento, consulte Aumento.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ConverseConversationResponse.

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

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

  • discoveryengine.conversations.converse

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