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

クエリへの回答メソッド（ストリーミング）。

1 つの AnswerQueryRequest を受け取り、ストリームで複数の AnswerQueryResponse メッセージを返します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
servingConfig

string

必須。servingConfigs.search サービス構成のリソース名（projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config、projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config など）。このフィールドは、検索に使用されるサービス構成名とモデルのセットを識別するために使用されます。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "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)
  }
}
フィールド
query

object (Query)

必須。現在のユーザークエリ。
session

string

セッション リソース名。不要。

セッション フィールドが設定されていない場合、API はセッションレス モードになります。

自動セッション モードがサポートされています。ユーザーはワイルドカード記号 - をセッション ID として使用できます。新しい ID が自動的に生成され、割り当てられます。
safetySpec

object (SafetySpec)

モデル仕様。
relatedQuestionsSpec

object (RelatedQuestionsSpec)

関連する質問の仕様。
groundingSpec

object (GroundingSpec)

省略可。グラウンディングの仕様。
answerGenerationSpec

object (AnswerGenerationSpec)

回答生成の仕様。
searchSpec

object (SearchSpec)

servingConfigs.search の仕様。
queryUnderstandingSpec

object (QueryUnderstandingSpec)

クエリの理解の仕様。
asynchronousMode
(deprecated)

boolean

非推奨: このフィールドは非推奨になりました。Streaming Answer API がサポートされます。

非同期モード制御。

有効にすると、最終的な回答なしで回答/セッション リソース名を含むレスポンスが返されます。API ユーザーは、ConversationalSearchService.GetAnswer メソッドまたは ConversationalSearchService.GetSession メソッドを呼び出して、回答/セッションの最新のステータスを取得するためにポーリングを行う必要があります。
userPseudoId

string

訪問者をトラッキングするための一意の識別子。たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。

このフィールドには、unknown_visitor などの固定値は設定しないでください。

このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
userLabels

map (key: string, value: string)

リソースに適用するユーザーラベルは、次の要件を満たす必要があります。

  • 1 つのリソースには、最大 64 個のラベルを適用できます。
  • ラベルは、Key-Value ペアでなければなりません。
  • キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。
  • キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。
  • ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。
  • キーは、小文字または国際文字で始める必要があります。

詳細については、Google Cloud ドキュメントをご覧ください。
endUserSpec

object (EndUserSpec)

省略可。エンドユーザーの仕様。

レスポンスの本文

成功した場合、レスポンスの本文には AnswerQueryResponse インスタンスのストリームが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

servingConfig リソースに対する次の IAM 権限が必要です。

  • discoveryengine.servingConfigs.answer

詳細については、IAM のドキュメントをご覧ください。