Method: projects.locations.collections.dataStores.servingConfigs.streamAnswer

Methode zum Beantworten von Anfragen (Streaming).

Es wird eine AnswerQueryRequest verwendet und es werden mehrere AnswerQueryResponse-Nachrichten in einem Stream zurückgegeben.

HTTP-Anfrage

POST https://discoveryengine.googleapis.com/v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:streamAnswer

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.

Oder der Ressourcenname der Bereitstellungskonfiguration der Agent Engine, z. B. projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer. (Verwenden Sie diese Option, wenn enableAgentInvocation auf „true“ gesetzt ist und Sie eine benutzerdefinierte Agent Engine mit AI_MODE konfiguriert haben)

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

Verworfen: Dieses Feld wird nicht mehr unterstützt. 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 Polling 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. Die eindeutige Kennung sollte sich nicht ändern, wenn sich Besucher bei der Website an- oder abmelden.

Dieses Feld sollte KEINEN festen Wert wie unknown_visitor enthalten.

Das Feld muss einen UTF-8-codierten String mit maximal 128 Zeichen enthalten. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
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. 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 in diesem Google Cloud-Dokument.
endUserSpec

object (EndUserSpec)

Optional. Spezifikation für Endnutzer

Antworttext

Bei Erfolg enthält der Antworttext einen Stream von AnswerQueryResponse-Instanzen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.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.