Method: projects.locations.collections.engines.servingConfigs.answer

Methode zum Beantworten von Anfragen.

HTTP-Anfrage

POST https://discoveryengine.googleapis.com/v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:answer

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
servingConfig

string

Erforderlich. Der Ressourcenname der Bereitstellungskonfiguration „servingConfigs.search“, z. B. projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config oder projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config. Dieses Feld wird verwendet, um den Namen der Bereitstellungskonfiguration zu identifizieren, also die Gruppe von Modellen, die für die Suche verwendet werden.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
Felder
query

object (Query)

Erforderlich. Aktuelle Nutzeranfrage.
session

string

Der Name der Sitzungsressource. Nicht erforderlich.

Wenn das Sitzungsfeld nicht festgelegt ist, befindet sich die API im sitzungslosen Modus.

Wir unterstützen den automatischen Sitzungsmodus: Nutzer können das Platzhaltersymbol - als Sitzungs-ID verwenden. Eine neue ID wird automatisch generiert und zugewiesen.
safetySpec

object (SafetySpec)

Modellspezifikation.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Spezifikation ähnlicher Fragen
groundingSpec

object (GroundingSpec)

Optional. Spezifikation für die Fundierung.
answerGenerationSpec

object (AnswerGenerationSpec)

Spezifikation für die Antwortgenerierung.
searchSpec

object (SearchSpec)

Spezifikation für servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

Spezifikation der Interpretation von Anfragen.
asynchronousMode
(deprecated)

boolean

Eingestellt: Dieses Feld wurde eingestellt. Die Streaming Answer API wird unterstützt.

Steuerung des asynchronen Modus.

Wenn diese Option aktiviert ist, wird die Antwort mit dem Antwort-/Sitzungsressourcennamen ohne endgültige Antwort zurückgegeben. API-Nutzer müssen den neuesten Status der Antwort/Sitzung durch Aufrufen der Methode ConversationalSearchService.GetAnswer oder ConversationalSearchService.GetSession abrufen.
userPseudoId

string

Eine eindeutige Kennung für das Tracking von Besuchern. Dies kann beispielsweise mit einem HTTP-Cookie implementiert werden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert werden kann. Diese eindeutige Kennung sollte sich nicht ändern, wenn sich der Besucher auf der Website an- oder abmeldet.

Dieses Feld sollte KEINEN festen Wert wie unknown_visitor haben.

Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
userLabels

map (key: string, value: string)

Die Nutzerlabels, die auf eine Ressource angewendet werden, müssen die folgenden Anforderungen erfüllen:

  • Jede Ressource kann bis zu 64 Labels haben.
  • Jedes Label muss ein Schlüssel/Wert-Paar sein.
  • Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen 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.
endUserSpec

object (EndUserSpec)

Optional. Spezifikation für Endnutzer.

Antworttext

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

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 servingConfig:

  • discoveryengine.servingConfigs.answer

Weitere Informationen finden Sie in der IAM-Dokumentation.