配置自动补全

REST

1. 更新 CompletionConfig.queryFrequencyThreshold 字段：

   curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json" \
     -H "X-Goog-User-Project: PROJECT_ID" \
     https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig?updateMask=queryFrequencyThreshold \
     -d '{
       "name": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig",
       "queryFrequencyThreshold": QUERY_FREQUENCY_THRESHOLD
     }'
   

   替换以下内容：

   • PROJECT_ID：您的 Google Cloud 项目的编号或 ID。

   • DATA_STORE_ID：与您的应用关联的数据存储区 ID。

   • QUERY_FREQUENCY_THRESHOLD：一个整数值，表示搜索查询必须输入的最小次数，之后才能作为自动补全建议返回。该计数是在一个为期数月的滚动时间窗口内汇总的。默认值为 8。

   命令和结果示例

   curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json" \$ curl -X PATCH \
     -H "X-Goog-User-Project: my-project-123" \t-access-token)" \
     https://discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/dataStores/my-data-store/completionConfig?updateMask=queryFrequencyThreshold \
     -d '{
     "name": "projects/my-project-123/locations/global/collections/default_collection/dataStores/my-data-store/completionConfig",
     "queryFrequencyThreshold": 30
     }'
     
   
   {
     "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/completionConfig",
     "matchingOrder": "exact-prefix",
     "maxSuggestions": 20,
     "minPrefixLength": 1,
     "queryModel": "automatic",
     "enableMode": "AUTOMATIC",
     "queryFrequencyThreshold": 30
   }
   

2. 更新 CompletionConfig.numUniqueUsersThreshold 字段：

   curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json" \
     -H "X-Goog-User-Project: PROJECT_ID" \
     https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig?updateMask=numUniqueUsersThreshold \
     -d '{
       "name": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig",
       "numUniqueUsersThreshold": UNIQUE_USERS
     }'
   

   将 UNIQUE_USERS 替换为一个整数值，该值表示必须输入指定搜索查询的唯一用户数量下限，达到该下限后，系统才能将该搜索查询作为自动补全建议返回。该计数是在一个为期数月的滚动时间窗口内汇总的。默认值为 3。

   命令和结果示例

   curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json" \
     -H "X-Goog-User-Project: my-project-123" \
     https://discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/dataStores/my-data-store/completionConfig?updateMask=numUniqueUsersThreshold \
     -d '{
     "name": "projects/my-project-123/locations/global/collections/default_collection/dataStores/my-data-store/completionConfig",
       "numUniqueUsersThreshold": 6
     }'
     
   
   {
   "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/completionConfig",
     "matchingOrder": "exact-prefix",
     "maxSuggestions": 20,
     "minPrefixLength": 1,
     "queryModel": "automatic",
     "enableMode": "AUTOMATIC",
     "numUniqueUsersThreshold": 6,
     "queryFrequencyThreshold": 30
   }
   

REST

如需使用 API 发送自动补全请求，请按以下步骤操作：

1. 查找数据存储区 ID。如果您已有数据存储区 ID，请跳至下一步。

   1. 在 Google Cloud 控制台中，前往 AI Applications 页面，然后在导航菜单中点击数据存储区。

      前往“数据存储区”页面

   2. 点击您的数据存储区的名称。

   3. 在数据存储区的数据页面上，获取数据存储区 ID。

2. 调用 dataStores.completeQuery 方法。

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID:completeQuery?query=QUERY_STRING"
   

   替换以下内容：

   • PROJECT_ID：您的 Google Cloud 项目的编号或 ID。

   • DATA_STORE_ID：与您的应用关联的数据存储区 ID。

   • QUERY_STRING：用于获取建议的已输入内容。

向其他模型发送自动补全请求

如需使用其他查询建议模型发送自动补全请求，请按以下步骤操作：

1. 查找您的数据存储区 ID。如果您已有数据存储区 ID，请跳至下一步。

   1. 在 Google Cloud 控制台中，前往 AI Applications 页面，然后在导航菜单中点击数据存储区。

      前往“数据存储区”页面

   2. 点击您的数据存储区的名称。

   3. 在数据存储区的数据页面上，获取数据存储区 ID。

2. 调用 dataStores.completeQuery 方法。

   curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID:completeQuery?query=QUERY_STRING&query_model=QUERY_SUGGESTIONS_MODEL"
   

   替换以下内容：

   • PROJECT_ID：您的 Google Cloud 项目的编号或 ID。

   • DATA_STORE_ID：与您的应用相关联的数据存储区的唯一 ID。

   • QUERY_STRING：用于获取建议的已输入内容。

   • QUERY_SUGGESTIONS_MODEL：用于请求的查询建议模型：document、document-completable、search-history 或 user-event。对于医疗保健数据，请使用 healthcare-default。

C#

如需了解详情，请参阅 Agent Search C# API 参考文档。

如需向 Agent Search 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。

using Google.Cloud.DiscoveryEngine.V1;

public sealed partial class GeneratedCompletionServiceClientSnippets
{
    /// <summary>Snippet for CompleteQuery</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CompleteQueryRequestObject()
    {
        // Create client
        CompletionServiceClient completionServiceClient = CompletionServiceClient.Create();
        // Initialize request argument(s)
        CompleteQueryRequest request = new CompleteQueryRequest
        {
            DataStoreAsDataStoreName = DataStoreName.FromProjectLocationDataStore("[PROJECT]", "[LOCATION]", "[DATA_STORE]"),
            Query = "",
            QueryModel = "",
            UserPseudoId = "",
            IncludeTailSuggestions = false,
        };
        // Make the request
        CompleteQueryResponse response = completionServiceClient.CompleteQuery(request);
    }
}

Go

如需了解详情，请参阅 Agent Search Go API 参考文档。

如需向 Agent Search 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。

//go:build examples

package main

import (
	"context"

	discoveryengine "cloud.google.com/go/discoveryengine/apiv1"
	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := discoveryengine.NewCompletionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}