高度な予測入力を構成する

REST

API を使用して予測入力リクエストを送信する手順は次のとおりです。

1. アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。

   1. Google Cloud コンソールで、[Agent Builder] ページに移動します。

      [アプリ] に移動

   2. [アプリ] ページでアプリの名前を見つけ、[ID] 列からアプリの ID を取得します。

2. completionConfig.completeQuery メソッドを呼び出します。

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING"
       }'
   

   • PROJECT_ID: Google Cloud プロジェクトの ID。

   • APP_ID: Vertex AI Search アプリの ID。

   • QUERY_STRING: 候補の取得に使用されるタイプアヘッド入力。

REST

言語ブースト値を含むオートコンプリート リクエストを送信する手順は次のとおりです。

1. アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。

   1. Google Cloud コンソールで、[Agent Builder] ページに移動します。

      [アプリ] に移動

   2. [アプリ] ページでアプリの名前を見つけ、[ID] 列からアプリの ID を取得します。

2. completionConfig.completeQuery メソッドを呼び出します。

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "boostSpec": {
            "conditionBoostSpecs": [{
              "condition": "(langCode: ANY(LANG_CODE))",
              "boost": BOOST_VALUE
            }]
         }
       }'
   
   

   • PROJECT_ID: Google Cloud プロジェクトの ID。

   • APP_ID: Vertex AI Search アプリの ID。

   • QUERY_STRING: 候補の取得に使用されるタイプアヘッド入力。

   • LANG_CODE: 1 つ以上の言語の 2 文字コード（エスケープされた引用符で囲む）。たとえば、\"fr\", \"es\" は、スペイン語とフランス語にブースト値を適用します。

   • BOOST_VALUE: -1 から 1 の浮動小数点数。値が負の場合、その言語の予測入力候補は降格されます（候補リストの下位に表示されます）。値が正の場合、結果は昇格されます（リストの上位に表示されます）。

   コマンドの例

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)"
   -H "Content-Type: application/json"
   "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery"
   -d '{
        "query": { "text": "Co"}
        "boostSpec": {
           "conditionBoostSpecs": [{
             "condition": "(langCode: ANY(\"es\", \"fr\"))",
             "boost": 0.75 }, {
             "condition": "(langCode: ANY(\"en\"))",
             "boost": -1
           }]
         }
       }'
    

   この例では、クエリ Co の予測入力の候補は、フランス語またはスペイン語の場合はブーストされ（予測入力リストの上位に表示されます）、英語の場合は非表示になります（予測入力リストの下位に表示されます）。

REST

1. アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。

   1. Google Cloud コンソールで、[Agent Builder] ページに移動します。

      [アプリ] に移動

   2. [アプリ] ページでアプリの名前を見つけ、[ID] 列からアプリの ID を取得します。

2. completionConfig.completeQuery メソッドを呼び出します。

   
   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "suggestionTypes": ["CONTENT"]
       }'
   
   

   • PROJECT_ID: Google Cloud プロジェクトの ID。

   • APP_ID: Vertex AI Search アプリの ID。

   • QUERY_STRING: 候補の取得に使用されるタイプアヘッド入力。

   コマンドの例と結果

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)"
   -H "Content-Type: application/json"
   "https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery"
   - d {
         "query": "C",
         "suggestionTypes": ["CONTENT"]
       }
   
   {
     "contentSuggestions": [{
       "suggestion": "critical crash in payment module",
       "document": {
         "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/10000",
         "derivedStructData": {
           "title": "Critical Crash in Payment Module",
           "uri": "https://cymballabs.atlassian.net/browse/CPT-1",
           "source_type": "jira",
           "entity_type": "issue"
         }
       },
       "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
     }]
   }
   
   

REST

1. アプリ ID を確認します。アプリ ID がすでにある場合は、次のステップに進みます。

   1. Google Cloud コンソールで、[Agent Builder] ページに移動します。

      [アプリ] に移動

   2. [アプリ] ページでアプリの名前を見つけ、[ID] 列からアプリの ID を取得します。

2. completionConfig.completeQuery メソッドを呼び出します。

   
   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId: "USER_PSEUDO_ID"
       }'
   
   

   • PROJECT_ID: Google Cloud プロジェクトの ID。

   • APP_ID: Vertex AI Search アプリの ID。

   • QUERY_STRING: 候補の取得に使用されるタイプアヘッド入力。

   • USER_PSEUDO_ID: ユーザーの仮名化 ID。このフィールドには HTTP Cookie を使用できます。これにより、1 つのデバイス上の訪問者を一意に識別できます。このフィールドを複数のユーザーに対して同じ ID に設定しないでください。これにより、検索履歴が統合されます。このフィールドには、個人を特定できる情報（PII）は含めないでください。

   コマンドの例と結果

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)"
   -H "Content-Type: application/json"
   "https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery"
   - d '{
         "query": "C",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId: "test_user"
       }
   
   {
     "contentSuggestions": [{
       "suggestion": "critical crash in payment module",
       "document": {
         "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/10000",
         "derivedStructData": {
           "title": "Critical Crash in Payment Module",
           "uri": "https://cymballabs.atlassian.net/browse/CPT-1",
           "source_type": "jira",
           "entity_type": "issue"
         }
       },
       "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
     }]
   }