고급 자동 완성 구성

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: 추천 용어를 가져오는 데 사용되는 typeahead 입력입니다.

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: 추천 용어를 가져오는 데 사용되는 typeahead 입력입니다.

   • 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 콘솔에서 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: 추천 용어를 가져오는 데 사용되는 typeahead 입력입니다.

   명령어 및 결과 예시

   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: 추천 용어를 가져오는 데 사용되는 typeahead 입력입니다.

   • USER_PSEUDO_ID: 사용자의 가명 식별자입니다. 이 필드에는 단일 기기의 방문자를 고유하게 식별하는 HTTP 쿠키를 사용할 수 있습니다. 여러 사용자에 대해 이 필드를 동일한 식별자로 설정하지 마세요. 이렇게 하면 쿼리 기록이 결합됩니다. 이 필드에는 개인 식별 정보(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"
       }
     ]
   }