設定進階自動完成功能

REST

如要使用 API 傳送自動完成要求，請按照下列步驟操作：

1. 找出應用程式 ID。如果您已取得應用程式 ID，請直接跳到下一個步驟。

   1. 前往 Google Cloud 控制台的「AI Applications」頁面。

      前往「應用程式」

   2. 在「Apps」頁面中找出應用程式名稱，然後從「ID」欄取得應用程式 ID。

1. 呼叫 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：用於擷取建議的 typeahead 輸入內容。

REST

如要傳送包含語言加權值的自動完成要求，請按照下列步驟操作：

1. 找出應用程式 ID。如果您已取得應用程式 ID，請直接跳到下一個步驟。

   1. 前往 Google Cloud 控制台的「AI Applications」頁面。

      前往「應用程式」

   2. 在「Apps」頁面中找出應用程式名稱，然後從「ID」欄取得應用程式 ID。

1. 呼叫 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：一或多種語言的雙字母代碼，以經過轉義的引號表示。例如 \"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 控制台的「AI Applications」頁面。

      前往「應用程式」

   2. 在「Apps」頁面中找出應用程式名稱，然後從「ID」欄取得應用程式 ID。

1. 呼叫 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 填入這個欄位，這樣系統就能唯一識別單一裝置上的訪客。請勿為多位使用者將這個欄位設為相同的 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": "hol",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId": "test_user"
       }'
   
   {
     "recentSearchSuggestions": [
       {
         "suggestion": "holiday readiness",
         "recentSearchTime": "2024-11-19T18:27:07.261698Z"
       },
       {
         "suggestion": "holiday freeze",
         "recentSearchTime": "2024-11-19T18:25:45.744021Z"
       },
       {
         "suggestion": "holiday",
         "recentSearchTime": "2024-11-19T18:20:08.916884Z"
       }
     ]
   }