자동 완성 구성

이 페이지에서는 Vertex AI Search의 기본 자동 완성 기능을 설명합니다. 자동 완성은 쿼리에 입력된 첫 몇 글자를 기반으로 검색어 추천을 생성합니다.

자동 완성에서 생성하는 추천 용어는 검색 앱에서 사용하는 데이터 유형에 따라 다릅니다.

  • 정형 데이터와 비정형 데이터. 기본적으로 자동 완성은 데이터 스토어의 문서 콘텐츠를 기반으로 추천 용어를 생성합니다. 기본적으로 문서를 가져온 후에는 자동 완성은 충분한 품질 데이터가 있을 때까지(일반적으로 며칠) 추천 용어를 생성하지 않습니다. API를 통해 자동 완성 요청을 수행하면 자동 완성에서 검색 기록이나 사용자 이벤트를 기반으로 추천 용어를 생성할 수 있습니다.

  • 웹사이트 데이터. 기본적으로 자동 완성은 검색 기록에서 추천 용어를 생성합니다. 자동 완성을 사용하려면 실제 검색 트래픽이 필요합니다. 검색 트래픽이 시작된 후 자동 완성에서 추천 용어를 생성하는 데 하루나 이틀이 걸립니다. 실험용 고급 문서 데이터 모델을 사용하여 공개 사이트의 웹 크롤링한 데이터에서 추천 용어를 생성할 수 있습니다.

  • 의료 데이터. 기본적으로 표준 의료 데이터 소스는 의료 데이터 스토어의 자동 완성 추천 용어를 생성하는 데 사용됩니다. 의료 검색의 경우 자동 완성은 미리보기 기능입니다.

자동 완성 데이터 모델은 자동 완성이 추천 용어를 생성하는 데 사용하는 데이터 유형을 결정합니다. 자동 완성 모델에는 다음과 같이 4가지가 있습니다.

  • 문서. 문서 모델은 사용자가 가져온 문서에서 추천 용어를 생성합니다. 웹사이트 데이터나 의료 데이터에는 이 모델을 사용할 수 없습니다.

  • 완성 가능 필드. 완성 가능 필드 모델은 정형 데이터 필드에서 직접 가져온 텍스트를 제안합니다. completable로 주석이 달린 필드만 자동 완성 추천 용어에 사용됩니다. 이 모델은 정형 데이터에만 사용 가능합니다.

  • 검색 기록. 검색 기록 모델은 SearchService.search API 호출 기록에서 추천 용어를 생성합니다. servingConfigs.search 메서드에 사용할 수 있는 트래픽이 없는 경우에는 이 모델을 사용하지 마세요. 의료 데이터에는 이 모델을 사용할 수 없습니다.

  • 사용자 이벤트. 사용자 이벤트 모델은 사용자가 가져온 검색 이벤트에서 추천 용어를 생성합니다. 의료 데이터에는 이 모델을 사용할 수 없습니다.

자동 완성 요청은 dataStores.completeQuery 메서드를 통해 전송됩니다.

다음 표에는 각 데이터 유형에 사용할 수 있는 자동 완성 모델 유형이 나와 있습니다.


자동 완성 데이터 모델
데이터 소스
웹사이트 데이터
정형 데이터
비정형 데이터
문서 사용자가 가져온 템플릿 ✔*(기본값) ✔(기본값)
완성 가능 필드 사용자가 가져온 템플릿 ✔
검색 기록 자동 수집 ✔(기본값) ✔ ✔
사용자 이벤트 사용자가 가져오거나 위젯에서 자동으로 수집 ✔ ✔ ✔
웹에서 크롤링되는 콘텐츠 사용자가 지정한 공개 웹사이트의 콘텐츠에서 크롤링됨 ✔†

*: 문서 스키마에 title 또는 description 필드가 포함되어 있거나 title 또는 description 키 속성으로 지정된 필드가 있어야 합니다. 정형 데이터 스키마 업데이트를 참조하세요.

†: 웹 크롤링 콘텐츠는 자동 완성을 위한 실험용 고급 문서 데이터 모델이 사용 설정된 경우에만 데이터 소스로 사용될 수 있습니다. 고급 문서 데이터 모델을 참조하세요.

데이터 유형에 기본 모델을 사용하지 않으려면 자동 완성 요청을 보낼 때 다른 모델을 지정하면 됩니다. 자동 완성 요청은 dataStores.completeQuery 메서드를 통해 전송됩니다. 자세한 내용은 API 안내: 자동 완성 요청을 전송하여 다른 모델 선택을 참조하세요.

자동 완성 기능

Vertex AI Search는 검색 시 가장 유용한 예측이 표시되도록 다음과 같은 자동 완성 기능을 지원합니다.

기능 설명 예시 또는 자세한 정보
특수문자 삭제 추천 데이터 및 입력된 쿼리 모두에서 비표준 문자를 삭제합니다. 대시 -는 추천 데이터와 입력된 검색어에서 유지되는 유일한 표준 문자입니다. Mt. Everest & Mt. Kilimanjaro → Mt Everest Mt Kilimanjaro.
오타 수정 오타인 단어 철자를 수정합니다. Milc → Milk.
안전하지 않은 검색어 삭제
  • Google 세이프서치에서 제공합니다.
  • 부적절한 검색어를 삭제합니다.
  • 영어(en), 프랑스어(fr), 독일어(de), 이탈리아어(it), 폴란드어(pl), 포르투갈어(pt), 러시아어(ru), 스페인어(es), 우크라이나어(uk)를 지원합니다.
 불쾌감을 주는 텍스트(예: 포르노, 선정적, 저속함, 폭력)
차단 목록
  • 차단 목록에 나열된 검색어를 삭제합니다.
 자세한 내용은 자동 완성 차단 목록 사용을 참조하세요.
검색어 중복 삭제
  • AI 기반 시맨틱 이해를 제공합니다.
  • 거의 동일한 검색어의 경우 두 검색어 모두 일치하지만 더 인기 있는 검색어만 추천됩니다.
 Shoes for Women, Womens Shoes, Womans Shoes는 중복 삭제되며 가장 인기 있는 검색어만 추천됩니다.
꼬리말 일치 추천 용어
  • 미국 및 EU 멀티 리전에서는 사용할 수 없습니다.
  • 선택적 설정입니다.
  • 전체 검색어에 대한 자동 완성 일치 항목이 없는 경우 검색어의 마지막 단어에 대한 일치 항목만 제안합니다.
  • 의료 검색에는 사용할 수 없습니다.
 자세한 내용은 꼬리말 일치 추천 용어를 참조하세요.

꼬리말 일치 추천 용어

꼬리말 일치 추천 용어는 쿼리 문자열의 마지막 단어와 정확하게 일치하는 프리픽스를 통해 생성됩니다.

예를 들어 'songs with he'라는 검색어가 자동 완성 요청에 전송되었다고 가정해 보겠습니다. 꼬리말 일치가 사용 설정되면 자동 완성에서 전체 프리픽스 'songs with he'에 일치 항목이 없는 것으로 확인할 수 있습니다. 하지만 검색어의 마지막 단어인 'he'에는 'hello world' 및 'hello kitty'와 정확하게 일치하는 프리픽스가 있습니다. 이 경우 전체 일치 추천 용어가 없으므로 반환된 추천 용어는 'songs with hello world' 및 'songs with hello kitty'입니다.

이 기능을 사용하면 빈 추천 결과를 줄이고 추천 다양성을 높일 수 있습니다. 이는 데이터 소스(사용자 이벤트 수, 검색 기록, 문서 주제 적용 범위)가 제한된 경우에 특히 유용합니다. 하지만 꼬리말 일치 추천 용어를 사용 설정하면 전반적인 추천 용어 품질이 저하될 수 있습니다. 꼬리말 일치는 프리픽스의 끝부분 단어와 일치하므로 반환된 일부 추천 용어가 적절하지 않을 수 있습니다. 예를 들어 'songs with he'와 같은 검색어에 'songs with helpers guide'와 같은 꼬리말 일치 추천 용어가 표시될 수 있습니다.

꼬리말 일치 추천 용어는 다음과 같은 경우에만 반환됩니다.

  1. include_tail_suggestions는 dataStores.completeQuery 요청에서 true로 설정되어 있습니다.

  2. 검색어에 대한 전체 프리픽스 일치 추천 용어가 없습니다.

위젯에서 자동 완성 사용 설정 또는 중지

위젯의 자동 완성을 사용 설정하거나 중지하려면 다음 단계를 수행합니다.

콘솔

  1. Google Cloud 콘솔에서 Agent Builder 페이지로 이동합니다.

    Agent Builder

  2. 수정하려는 앱의 이름을 클릭합니다.

  3. 구성을 클릭합니다.

  4. UI 탭을 클릭합니다.

  5. 자동 완성 추천 용어 표시 옵션을 전환하여 위젯의 자동 완성 추천 용어를 사용 설정하거나 중지합니다. 자동 완성을 사용 설정하면 추천이 시작되는 데 1~2일 정도 걸립니다. 의료 검색의 경우 자동 완성은 미리보기 기능입니다.

자동 완성 설정 업데이트

자동 완성 설정을 구성하려면 다음 단계를 수행합니다.

콘솔

  1. Google Cloud 콘솔에서 Agent Builder 페이지로 이동합니다.

    Agent Builder

  2. 수정하려는 앱의 이름을 클릭합니다.

  3. 구성을 클릭합니다.

  4. 자동 완성 탭을 클릭합니다.

  5. 업데이트하려는 자동 완성 설정의 새 값을 입력하거나 선택합니다.

    • 최대 추천 용어 수: 검색어에 제공할 수 있는 최대 자동 완성 추천 용어 수입니다.
    • 트리거하는 최소 길이: 자동 완성 추천 용어가 제공되기 전에 입력할 수 있는 최소 문자 수입니다.
    • 일치 순서: 자동 완성에서 추천 용어와 일치시킬 수 있는 쿼리 문자열의 위치입니다.
    • 자동 완성 모델: 검색된 추천 용어를 생성하는 데 사용되는 자동 완성 데이터 모델입니다. dataStores.completeQuery에서 queryModel 파라미터를 사용하여 이 옵션을 재정의할 수 있습니다.

    • 자동 완성 사용 설정: 기본적으로 자동 완성은 충분한 품질 데이터(일반적으로 며칠)가 있을 때까지 추천 용어를 생성하지 않습니다. 이 기본값을 재정의하고 일부 자동 완성 추천 용어를 더 일찍 받으려면 지금을 선택합니다.

      지금을 선택해도 추천 용어가 생성되는 데 하루가 걸릴 수 있으며 양질의 데이터가 충분히 있을 때까지 일부 자동 완성 추천 용어가 누락되거나 품질이 나쁠 수 있습니다.

  6. 저장 및 게시를 클릭합니다. 자동 완성이 이미 사용 설정된 엔진의 경우 변경사항이 몇 분 이내에 적용됩니다.

스키마에서 완성 가능 필드 주석 업데이트

정형 데이터 스키마의 필드에 자동 완성을 사용 설정하려면 다음 단계를 수행합니다.

콘솔

  1. Google Cloud 콘솔에서 Agent Builder 페이지로 이동합니다.

    Agent Builder

  2. 수정하려는 앱의 이름을 클릭합니다. 정형 데이터를 사용해야 합니다.

  3. 데이터를 클릭합니다.

  4. 스키마 탭을 클릭합니다.

  5. 수정을 클릭하여 completable로 표시할 스키마 필드를 선택합니다.

  6. 저장을 클릭하여 업데이트된 필드 구성을 저장합니다. 이러한 추천 용어가 생성되고 반환되는 데 약 하루가 걸립니다.

자동 완성 요청 보내기

다음 샘플에서는 자동 완성 요청을 보내는 방법을 보여줍니다.

REST

API를 사용하여 자동 완성 요청을 보내려면 다음 단계를 수행합니다.

  1. 데이터 스토어 ID를 찾습니다. 데이터 스토어 ID가 이미 있는 경우 다음 단계로 건너뜁니다.

    1. Google Cloud 콘솔에서 Agent Builder 페이지로 이동하고 탐색 메뉴에서 데이터 스토어를 클릭합니다.

      데이터 스토어 페이지로 이동

    2. 데이터 스토어 이름을 클릭합니다.

    3. 데이터 스토어의 데이터 페이지에서 데이터 스토어 ID를 가져옵니다.

  2. dataStores.completeQuery 메서드를 호출합니다.

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

    • PROJECT_ID: Google Cloud 프로젝트의 프로젝트 번호나 ID입니다.

    • LOCATION: 데이터 스토어 위치입니다(us, eu 또는 global).

    • DATA_STORE_ID: 앱과 연결된 데이터 스토어의 ID입니다.

    • QUERY_STRING: 추천 용어를 가져오는 데 사용되는 typeahead 입력입니다.

다른 모델에 자동 완성 요청 보내기

다른 자동 완성 데이터 모델을 사용하여 자동 완성 요청을 보내려면 다음 단계를 수행합니다.

  1. 데이터 스토어 ID를 찾습니다. 데이터 스토어 ID가 이미 있는 경우 다음 단계로 건너뜁니다.

    1. Google Cloud 콘솔에서 Agent Builder 페이지로 이동하고 탐색 메뉴에서 데이터 스토어를 클릭합니다.

      데이터 스토어 페이지로 이동

    2. 데이터 스토어 이름을 클릭합니다.

    3. 데이터 스토어의 데이터 페이지에서 데이터 스토어 ID를 가져옵니다.

  2. dataStores.completeQuery 메서드를 호출합니다.

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/dataStores/DATA_STORE_ID:completeQuery?query=QUERY_STRING&query_model=AUTOCOMPLETE_MODEL"
    • PROJECT_ID: Google Cloud 프로젝트의 프로젝트 번호나 ID입니다.
    • LOCATION: 데이터 스토어 위치입니다(us, eu 또는 global).
    • DATA_STORE_ID: 앱과 연결된 데이터 스토어의 고유 ID입니다.
    • QUERY_STRING: 추천 용어를 가져오는 데 사용되는 typeahead 입력입니다.
    • AUTOCOMPLETE_MODEL: 요청에 사용할 자동 완성 데이터 모델입니다(document, document-completable, search-history 또는 user-event). 의료 데이터에는 healthcare-default를 사용합니다.

C#

자세한 내용은 Vertex AI Agent Builder C# API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요. 

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

자세한 내용은 Vertex AI Agent Builder Go API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요. 


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.
	}
	defer c.Close()

	req := &discoveryenginepb.CompleteQueryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb#CompleteQueryRequest.
	}
	resp, err := c.CompleteQuery(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

자세한 내용은 Vertex AI Agent Builder Java API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요. 

import com.google.cloud.discoveryengine.v1.CompleteQueryRequest;
import com.google.cloud.discoveryengine.v1.CompleteQueryResponse;
import com.google.cloud.discoveryengine.v1.CompletionServiceClient;
import com.google.cloud.discoveryengine.v1.DataStoreName;

public class SyncCompleteQuery {

  public static void main(String[] args) throws Exception {
    syncCompleteQuery();
  }

  public static void syncCompleteQuery() throws Exception {
    // 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/java/docs/setup#configure_endpoints_for_the_client_library
    try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
      CompleteQueryRequest request =
          CompleteQueryRequest.newBuilder()
              .setDataStore(
                  DataStoreName.ofProjectLocationDataStoreName(
                          "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                      .toString())
              .setQuery("query107944136")
              .setQueryModel("queryModel-184930495")
              .setUserPseudoId("userPseudoId-1155274652")
              .setIncludeTailSuggestions(true)
              .build();
      CompleteQueryResponse response = completionServiceClient.completeQuery(request);
    }
  }
}

Node.js

자세한 내용은 Vertex AI Agent Builder Node.js API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요. 

/**
 * 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.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent data store resource name for which the completion is
 *  performed, such as
 *  `projects/* /locations/global/collections/default_collection/dataStores/default_data_store`.
 */
// const dataStore = 'abc123'
/**
 *  Required. The typeahead input used to fetch suggestions. Maximum length is
 *  128 characters.
 */
// const query = 'abc123'
/**
 *  Specifies the autocomplete data model. This overrides any model specified
 *  in the Configuration > Autocomplete section of the Cloud console. Currently
 *  supported values:
 *  * `document` - Using suggestions generated from user-imported documents.
 *  * `search-history` - Using suggestions generated from the past history of
 *  SearchService.Search google.cloud.discoveryengine.v1.SearchService.Search 
 *  API calls. Do not use it when there is no traffic for Search API.
 *  * `user-event` - Using suggestions generated from user-imported search
 *  events.
 *  * `document-completable` - Using suggestions taken directly from
 *  user-imported document fields marked as completable.
 *  Default values:
 *  * `document` is the default model for regular dataStores.
 *  * `search-history` is the default model for site search dataStores.
 */
// const queryModel = 'abc123'
/**
 *  A unique identifier for tracking visitors. For example, this could be
 *  implemented with an HTTP cookie, which should be able to uniquely identify
 *  a visitor on a single device. This unique identifier should not change if
 *  the visitor logs in or out of the website.
 *  This field should NOT have a fixed value such as `unknown_visitor`.
 *  This should be the same identifier as
 *  UserEvent.user_pseudo_id google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id 
 *  and
 *  SearchRequest.user_pseudo_id google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id.
 *  The field must be a UTF-8 encoded string with a length limit of 128
 *  characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 */
// const userPseudoId = 'abc123'
/**
 *  Indicates if tail suggestions should be returned if there are no
 *  suggestions that match the full query. Even if set to true, if there are
 *  suggestions that match the full query, those are returned and no
 *  tail suggestions are returned.
 */
// const includeTailSuggestions = true

// Imports the Discoveryengine library
const {CompletionServiceClient} = require('@google-cloud/discoveryengine').v1;

// Instantiates a client
const discoveryengineClient = new CompletionServiceClient();

async function callCompleteQuery() {
  // Construct request
  const request = {
    dataStore,
    query,
  };

  // Run request
  const response = await discoveryengineClient.completeQuery(request);
  console.log(response);
}

callCompleteQuery();

Python

자세한 내용은 Vertex AI Agent Builder Python API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요. 

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1


def sample_complete_query():
    # Create a client
    client = discoveryengine_v1.CompletionServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.CompleteQueryRequest(
        data_store="data_store_value",
        query="query_value",
    )

    # Make the request
    response = client.complete_query(request=request)

    # Handle the response
    print(response)

Ruby

자세한 내용은 Vertex AI Agent Builder Ruby API 참고 문서를 확인하세요.

Vertex AI Agent Builder에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요. 

require "google/cloud/discovery_engine/v1"

##
# Snippet for the complete_query call in the CompletionService service
#
# 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/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#complete_query.
#
def complete_query
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1::CompletionService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest.new

  # Call the complete_query method.
  result = client.complete_query request

  # The returned object is of type Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse.
  p result
end

자동 완성 차단 목록 사용

차단 목록을 사용하여 특정 용어가 자동 완성 추천 용어에 표시되지 않게 할 수 있습니다.

제약회사를 예시로 사용하겠습니다. 더 이상 FDA 승인을 받지 못했지만 데이터 스토어의 문서에 언급된 약물의 경우 추천 검색어로 표시되지 않게 할 수 있습니다. 회사는 해당 약물의 이름이 추천되지 않도록 이 이름을 차단 목록에 추가할 수 있습니다.

적용되는 요청 한도는 다음과 같습니다.

  • 데이터 스토어당 차단 목록 하나
  • 차단 목록을 업로드하면 해당 데이터 스토어의 기존 차단 목록을 덮어씁니다.
  • 차단 목록당 검색어 최대 1,000개
  • 검색어는 대소문자를 구분하지 않습니다.
  • 차단 목록을 가져온 후 적용되는 데 1~2일이 걸립니다.

차단 목록의 각 항목은 blockPhrase 및 matchOperator로 구성됩니다.

  • blockPhrase: 문자열을 차단 목록 검색어로 입력합니다. 검색어는 대소문자를 구분하지 않습니다.
  • matchOperator: 다음 값을 허용합니다.
    • EXACT_MATCH: 차단 목록 검색어 일치검색이 추천 검색어로 표시되지 않게 합니다.
    • CONTAINS: 차단 목록 검색어가 포함된 추천 용어가 표시되지 않게 합니다.

다음은 항목이 4개 있는 차단 목록의 예시입니다.

{
    "entries": [
        {"blockPhrase":"Oranges","matchOperator":"CONTAINS"},
        {"blockPhrase":"bAd apples","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"Cool as A Cucumber","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"cherry pick","matchOperator":"CONTAINS"}
    ]
}

차단 목록을 가져오기 전에 검색 엔진 편집자 액세스에 필요한 액세스 제어가 설정되어 있는지 확인합니다.

로컬 JSON 데이터에서 또는 Cloud Storage에서 차단 목록을 가져올 수 있습니다. 데이터 스토어에서 차단 목록을 삭제하려면 차단 목록을 영구 삭제합니다.

로컬 JSON 데이터에서 차단 목록 가져오기

차단 목록이 포함된 로컬 JSON 파일에서 차단 목록을 가져오려면 다음을 수행합니다.

  1. 다음 형식으로 로컬 JSON 파일에 차단 목록을 만듭니다. 각 차단 목록 항목은 줄바꿈 없이 새 줄에 있어야 합니다.

    {
    "inlineSource": {
        "entries": [
            { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" },
            { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }
        ]
    }
}

  2. POST 요청을 suggestionDenyListEntries:import 메서드에 보내 JSON 파일 이름을 제공합니다. 

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data @DENYLIST_FILE \
  "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
    • DENYLIST_FILE: 차단 목록 검색어가 포함된 JSON 파일의 로컬 경로입니다.
    • PROJECT_ID: Google Cloud 프로젝트의 프로젝트 번호나 ID입니다.
    • LOCATION: 데이터 스토어 위치입니다(us, eu 또는 global).
    • DATA_STORE_ID: 앱과 연결된 데이터 스토어의 ID입니다.

차단 목록을 가져온 후 추천 용어 필터링을 시작하는 데 1~2일이 걸립니다.

Cloud Storage에서 차단 목록 가져오기

Cloud Storage의 JSON 파일에서 차단 목록을 가져오려면 다음을 수행합니다.

  1. 다음 형식으로 JSON 파일에 차단 목록을 만들고 Cloud Storage 버킷으로 가져옵니다. 각 차단 목록 항목은 줄바꿈 없이 새 줄에 있어야 합니다.

    { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" }
{ "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }

  2. gcsSource 객체가 포함된 로컬 JSON 파일을 만듭니다. 이 파일을 사용하여 Cloud Storage 버킷의 차단 목록 파일 위치를 가리킵니다.

    {
    "gcsSource": {
        "inputUris": [ "DENYLIST_STORAGE_LOCATION" ]
    }
}
    • DENYLIST_STORAGE_LOCATION: Cloud Storage의 차단 목록 위치입니다. URI 하나만 입력할 수 있습니다. gs://BUCKET/FILE_PATH 형식으로 URI를 입력해야 합니다.

  3. gcsSource 객체를 포함하여 POST 요청을 suggestionDenyListEntries:import 메서드에 보냅니다. 

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data @GCS_SOURCE_FILE \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
    • GCS_SOURCE_FILE: 차단 목록을 가리키는 gcsSource 객체가 포함된 파일의 로컬 경로입니다.
    • PROJECT_ID: Google Cloud 프로젝트의 프로젝트 번호나 ID입니다.
    • LOCATION: 데이터 스토어 위치입니다(us, eu 또는 global).
    • DATA_STORE_ID: 앱과 연결된 데이터 스토어의 ID입니다.

차단 목록을 가져온 후 추천 용어 필터링을 시작하는 데 1~2일이 걸립니다.

차단 목록 영구 삭제

데이터 스토어에서 차단 목록을 영구 삭제하려면 다음을 수행합니다.

  1. POST 요청을 suggestionDenyListEntries:purge 메서드로 보냅니다. 

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataStores/DATA_STORE_ID/suggestionDenyListEntries:purge"
    • PROJECT_ID: Google Cloud 프로젝트의 프로젝트 번호나 ID입니다.
    • LOCATION: 데이터 스토어 위치입니다(us, eu 또는 global).
    • DATA_STORE_ID: 앱과 연결된 데이터 스토어의 ID입니다.

고급 문서 데이터 모델

Vertex AI Agent Builder는 자동 완성에 사용되는 고급 데이터 모델을 제공합니다. 이 데이터 모델은 가져온 문서를 기반으로 Google 대규모 언어 모델(LLM)을 활용하여 고품질 자동 완성 추천 용어를 생성합니다.

이 기능은 시험용입니다. 이 기능을 사용하려면 Google Cloud 계정팀에 문의하여 허용 목록에 추가해 달라고 요청하세요.

의료 검색이나 미국 및 EU 멀티 리전에서는 이 기능을 사용할 수 없습니다.