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

Führt eine Unterhaltung.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Ressourcenname der abzurufenden Unterhaltung. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}. Verwenden Sie projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/-, um den automatischen Sitzungsmodus zu aktivieren. Dadurch wird in einer „conversations.converse“-Sitzung automatisch eine neue Unterhaltung erstellt.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (TextInput)

Erforderlich. Aktuelle Nutzereingabe.
servingConfig

string

Der Ressourcenname der zu verwendenden Bereitstellungskonfiguration. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId} Wenn dies nicht festgelegt ist, wird die Standardkonfiguration für die Bereitstellung verwendet.
conversation

object (Conversation)

Die Unterhaltung, die nur für die automatische Sitzung verwendet werden soll. Das Namensfeld wird ignoriert, da der Unterhaltung in der automatischen Sitzung automatisch ein neuer Name zugewiesen wird.
userLabels

map (key: string, value: string)

Für die auf Ressourcen angewendeten Nutzerlabels gilt Folgendes:

  • Jede Ressource kann bis zu 64 Labels haben.
  • Jedes Label muss ein Schlüssel/Wert-Paar sein.
  • Schlüssel sind mindestens 1 Zeichen und höchstens 63 Zeichen lang und dürfen nicht leer sein. Die Werte können leer sein und haben eine maximale Länge von 63 Zeichen.
  • Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig.
  • Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden.
  • Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen.

Weitere Informationen finden Sie im Google Cloud-Dokument.
summarySpec

object (SummarySpec)

Eine Spezifikation zum Konfigurieren der Zusammenfassung, die in der Antwort zurückgegeben wird.
filter

string

Die Filtersyntax besteht aus einer Ausdruckssprache, mit der ein Prädikat aus einem oder mehreren Feldern der gefilterten Dokumente erstellt wird. Bei Filterausdrücken muss die Groß- und Kleinschreibung beachtet werden. Sie werden verwendet, um Suchergebnisse zu filtern, was sich auf die Zusammenfassung auswirken kann.

Wenn dieses Feld nicht erkannt wird, wird INVALID_ARGUMENT zurückgegeben.

In Vertex AI Search wird über das Zuordnen des LHS-Filterschlüssels zu einem Schlüsselattribut, das im Vertex AI Search-Backend definiert ist, gefiltert. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Medienkunde hat in seinem Schema möglicherweise das Feld „name“. In diesem Fall würde der Filter so aussehen: filter --> name:'ANY("king kong")'

Weitere Informationen zum Filtern, einschließlich Syntax und Filteroperatoren, finden Sie unter Filter.
boostSpec

object (BoostSpec)

Mit der Boost-Spezifikation können Sie bestimmte Dokumente in den Suchergebnissen hervorheben, was sich auf die Antwort auswirken kann. Weitere Informationen zum Boosten.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ConverseConversationResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.conversations.converse

Weitere Informationen finden Sie in der IAM-Dokumentation.