Method: projects.locations.dataStores.conversations.converse

Avvia una conversazione.

Richiesta HTTP

POST https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome della risorsa della conversazione da ottenere. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}. Utilizza projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- per attivare la modalità di sessione automatica, che crea automaticamente una nuova conversazione all'interno di una sessione di conversazioni.converse.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
Campi
query

object (TextInput)

Obbligatorio. Input utente corrente.
servingConfig

string

Il nome della risorsa della configurazione di pubblicazione da utilizzare. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId} Se non è impostato, verrà utilizzata la configurazione di pubblicazione predefinita.
conversation

object (Conversation)

La conversazione da utilizzare solo dalla sessione automatica. Il campo name verrà ignorato perché assegniamo automaticamente un nuovo nome alla conversazione nella sessione automatica.
userLabels

map (key: string, value: string)

Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti:

  • Ogni risorsa può avere più etichette, fino a un massimo di 64.
  • Ogni etichetta deve essere una coppia chiave/valore.
  • Le chiavi devono avere una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri.
  • Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8; sono consentiti i caratteri internazionali.
  • La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse.
  • Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale.

Per maggiori dettagli, consulta la documentazione di Google Cloud.
summarySpec

object (SummarySpec)

Una specifica per la configurazione del riepilogo restituito nella risposta.
filter

string

La sintassi del filtro è costituita da un linguaggio di espressione per costruire un predicato da uno o più campi dei documenti filtrati. L'espressione di filtro fa distinzione tra maiuscole e minuscole. Verrà utilizzato per filtrare i risultati di ricerca, il che potrebbe influire sulla risposta del riepilogo.

Se questo campo non è riconoscibile, viene restituito un INVALID_ARGUMENT.

Il filtraggio in Vertex AI Search viene eseguito mappando la chiave del filtro LHS a una proprietà chiave definita nel backend di Vertex AI Search. Questa mappatura viene definita dal cliente nello schema. Ad esempio, un cliente di contenuti multimediali potrebbe avere un campo "name" nello schema. In questo caso, il filtro sarebbe simile al seguente: filter --> name:'ANY("king kong")'

Per ulteriori informazioni sul filtraggio, inclusi la sintassi e gli operatori di filtro, consulta Filtra
boostSpec

object (BoostSpec)

Specifica di aumento per aumentare determinati documenti nei risultati di ricerca, il che potrebbe influire sulla risposta di conversazione. Per ulteriori informazioni sull'aumento, consulta Aumento

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di ConverseConversationResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.conversations.converse

Per saperne di più, consulta la documentazione di IAM.