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

HTTP リクエスト
パスパラメータ
リクエストの本文
- JSON 表現
レスポンスの本文
認可スコープ
IAM 権限

会話を変換します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ

パラメータ
`name`	`string` 必須。取得する Conversation のリソース名。形式: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}`。`projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/-` を使用して自動セッションモードを有効にします。これにより、conversations.converse セッション内に新しい会話が自動的に作成されます。

name

string

必須。取得する Conversation のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}。projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- を使用して自動セッションモードを有効にします。これにより、conversations.converse セッション内に新しい会話が自動的に作成されます。

リクエストの本文

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

JSON 表現

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

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

フィールド
`query`	`object (TextInput)` 必須。現在のユーザー入力。
`servingConfig`	`string` 使用するサービング構成のリソース名。形式: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId}` 設定されていない場合は、デフォルトのサービング構成が使用されます。
`conversation`	`object (Conversation)` 自動セッションでのみ使用される会話。自動セッションでは会話に新しい名前が自動的に割り当てられるため、名前フィールドは無視されます。
`safeSearch`	`boolean` セーフサーチをオンにするかどうか。
`userLabels`	`map (key: string, value: string)` リソースに適用するユーザータラベルは、次の要件を満たす必要があります。 1 つのリソースには、最大 64 個のラベルを適用できます。ラベルは、Key-Value ペアでなければなりません。キーは 1 文字以上、63 文字以下にする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。キーは、小文字または国際文字で始める必要があります。詳細については、Google Cloud ドキュメントをご覧ください。
`summarySpec`	`object (SummarySpec)` レスポンスで返される概要を構成するための仕様。
`filter`	`string` フィルタの構文は、フィルタされるオブジェクトの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。フィルタ式では大文字と小文字が区別されます。これは検索結果のフィルタに使用され、要約のレスポンスに影響する可能性があります。このフィールドが認識できない場合は、`INVALID_ARGUMENT` が返されます。 Vertex AI Search でのフィルタは、LHS フィルタキーを Vertex AI Search バックエンドで定義されたキープロパティにマッピングすることによって行われます。このマッピングは、スキーマでユーザーが定義します。たとえば、メディアのお客様のスキーマに「name」というフィールドがあるとします。この場合、フィルタは filter --> name:'ANY("king kong")' のようになります。構文やフィルタオペレータなどのフィルタの詳細については、フィルタをご覧ください。
`boostSpec`	`object (BoostSpec)` 検索結果で特定のドキュメントをブーストするブースト仕様。これにより、会話のレスポンスに影響が及ぶ可能性があります。ブーストの詳細については、ブーストをご覧ください。

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

discoveryengine.conversations.converse

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