서빙 컨트롤 (컨트롤이라고도 함)은 결과가 반환될 때 요청이 제공되는 방식의 기본 동작을 변경합니다. 게재 제어는 데이터 스토어 수준에서 작동합니다.
예를 들어 컨트롤은 결과를 상단에 표시하거나 하단에 표시할 수 있으며, 반환된 결과에서 항목을 필터링하거나, 문자열을 동의어로 서로 연결하거나, 결과를 지정된 URI로 리디렉션할 수 있습니다.
이 페이지에서는 검색 앱의 게재 컨트롤을 설명합니다. 미디어 추천과 함께 서빙 컨트롤을 사용하는 방법에 관한 자세한 내용은 미디어 서빙 구성 만들기 및 관리를 참고하세요.
서빙 컨트롤 정보
요청 결과를 변경하려면 먼저 서빙 컨트롤을 만듭니다. 그런 다음 검색 앱의 서빙 구성에 이 컨트롤을 연결합니다. 서빙 구성은 검색 결과 또는 답변과 같은 게재 시간 결과를 생성하는 데 사용되는 메타데이터를 구성합니다. 게재 관리는 앱의 게재 구성에 연결된 경우에만 앱에서 게재하는 요청에 영향을 미칩니다.
부스트 컨트롤과 같은 일부 컨트롤은 데이터 스토어에 종속됩니다. 데이터 스토어가 앱에서 삭제되면 데이터 스토어 종속 컨트롤도 해당 앱에서 삭제되고 비활성화되지만 삭제되지는 않습니다.
서빙 컨트롤 유형
다음과 같은 유형의 서빙 컨트롤을 사용할 수 있습니다.
| 컨트롤 | 설명 | 적용 대상 |
|---|---|---|
| 부스트 컨트롤 | 반환된 결과 순서를 변경합니다. | 구조화된 데이터가 포함된 데이터 스토어, 구조화된 데이터가 포함된 웹사이트 (고급 웹사이트 색인 생성), 메타데이터가 포함된 비정형 데이터 또는 미디어 데이터와 같이 스키마를 지원하는 데이터 스토어가 있는 검색 앱 |
| 필터 컨트롤 | 반환된 결과에서 항목을 삭제합니다. | 구조화된 데이터가 포함된 데이터 스토어, 웹사이트 (고급 웹사이트 색인 생성), 메타데이터가 포함된 비정형 데이터 또는 미디어 데이터와 같이 스키마를 지원하는 데이터 스토어가 있는 검색 앱 |
| 동의어 컨트롤 | 쿼리를 서로 연결 | 웹사이트 (고급 웹사이트 색인 생성), 정형, 비정형 또는 미디어 데이터 스토어가 있는 검색 앱 |
| 리디렉션 제어 | 지정된 URI로 리디렉션 | 모든 검색 앱 |
| 관리자 승격 | 검색어에 대해 지정된 링크를 승격합니다. | 모든 검색 앱 |
조건 정보
컨트롤을 만들 때 원하는 경우 컨트롤이 적용되는 시점을 결정하는 조건을 정의할 수 있습니다. 조건은 조건 필드를 사용하여 정의됩니다. 다음과 같은 조건 필드를 사용할 수 있습니다.
검색어 (
queryTerms). 특정 검색어를 검색할 때 적용되는 선택적 컨트롤입니다.queryTerms조건이 사용되면queryTerms값이SearchRequest.query의 검색어와 일치할 때 컨트롤이 적용됩니다. 검색어는Control.searchUseCase가SOLUTION_TYPE_SEARCH로 설정된 경우에만 사용할 수 있습니다. 단일Control.condition에 최대 10개의 서로 다른queryTerms를 지정할 수 있습니다. 검색어가 지정되지 않으면queryTerms필드가 무시됩니다.기본 웹사이트 검색에만 적용되는
queryRegex조건을 지정하는 경우, 게재 조건을 올리기 위한 컨트롤에는queryTerms를 지정할 수 없습니다. 또한 기본 웹사이트 검색의fullMatch필드는queryTerms가 지정된 경우true로 설정해야 합니다. 다른 모든 검색 앱의 경우queryTerms만 지원되며fullMatch는true또는false로 설정할 수 있습니다.기간 (
activeTimeRange). 요청이 지정된 기간 내에 발생할 때 적용되는 선택적 컨트롤입니다. 요청이 수신된 시간이activeTimeRange.startTime와activeTimeRange.endTime사이인지 확인합니다. 단일Control.condition에 최대 10개의activeTimeRange범위를 지정할 수 있습니다.activeTimeRange필드가 지정되지 않으면 필드가 무시됩니다.queryRegex. 기본 웹사이트 검색의 게재 조정 홍보에만 사용할 수 있습니다. 쿼리가 지정된 정규 표현식과 일치할 때 컨트롤을 적용하는 선택적 조건입니다.queryTerms조건을 지정하는 경우 이 조건을 지정할 수 없습니다.
컨트롤에 여러 조건이 지정된 경우 두 조건 유형이 모두 충족되면 컨트롤이 검색 요청에 적용됩니다. 동일한 조건에 여러 값이 지정된 경우 해당 조건이 충족되려면 값 중 하나만 일치하면 됩니다.
예를 들어 두 개의 검색어를 지정한 다음 조건을 고려해 보겠습니다.
"queryTerms": [
{
"value": "gShoe",
"fullMatch": true
},
{
"value": "gBoot",
"fullMatch": true
}
]
이 조건은 SearchRequest.query="gShoe"가 포함된 요청 또는 SearchRequest.query="gBoot"가 포함된 요청에 대해 충족되지만 SearchRequest.query="gSandal" 또는 다른 문자열의 경우 충족되지 않습니다.
조건을 지정하지 않으면 컨트롤이 항상 적용됩니다.
자세한 내용은 API 참조의 Condition 필드를 참고하세요.
게재 신청 컨트롤 만들기 및 연결
부스트 게재 컨트롤은 적용된 조건에 따라 결과를 승격 또는 강등하여 재정렬합니다. 부스트는 부스트 조건을 충족하는 문서의 순위에 배수를 적용하여 작동합니다.
부스트 제어를 만들고 연결하려면 다음 단계를 따르세요.
콘솔
Google Cloud 콘솔에서 AI 애플리케이션 페이지로 이동합니다.
부스트 제어를 만들 앱을 선택합니다.
앱의 개요 페이지에서 신호 단계에 나열된 부스트/숨기기를 선택합니다.
신호 페이지에서 컨트롤 만들기를 클릭합니다.
컨트롤 만들기 창에서 다음을 수행합니다.
최적화/숨기기 관리의 이름을 입력하고 계속을 클릭합니다.
컨트롤을 트리거하는 다음 조건을 설정합니다. 조건이 구성되지 않으면 컨트롤이 항상 적용됩니다.
부분 일치 검색어를 추가합니다. 이러한 검색어와 부분적으로 일치하는 경우 컨트롤이 적용됩니다.
정확한 검색어를 추가합니다. 이러한 검색어와 정확하게 일치하는 경우 컨트롤이 적용됩니다.
활성 시간 범위를 추가하려면 시간 범위 추가를 클릭하고 시작 시간 1 및 종료 시간 1을 설정합니다. 이는 조건이 활성 상태인 기간을 정의합니다. 시간 범위는 최대 10개까지 추가할 수 있습니다.
계속을 클릭합니다.
이 컨트롤로 트리거할 작업을 정의합니다.
목록에서 데이터 스토어를 선택합니다. 작업을 여러 데이터 스토어에 적용하려면 각 데이터 스토어의 컨트롤을 만듭니다.
필터를 추가합니다.
문서에서 충족해야 하는 요구사항을 지정하는 문자열입니다. 문서가 모든 요구사항과 일치하는 경우에만 부스트 조건이 적용됩니다. 그렇지 않으면 변경되지 않습니다. 필터를 지정하지 않으면 데이터 스토어의 모든 문서에 향상이 적용됩니다.
슬라이더를 사용하여 [-1, 1] 범위의 부스트/하강 값을 선택합니다. 슬라이더는 0.01단위로 이동합니다.
계속을 클릭합니다.
컨트롤이 생성되는 즉시 적용하려면 이 컨트롤 즉시 게시를 사용 설정하고 계속을 클릭합니다.
제출을 클릭합니다.
컨트롤의 구성을 수정하려면 다음 단계를 따르세요.
신호 페이지의 앱 부스트/버리 컨트롤 목록에서 수정하려는 컨트롤의 아이콘을 클릭하고 수정을 클릭합니다.
컨트롤 수정 창에서 컨트롤을 수정합니다.
컨트롤을 사용 설정하거나 사용 중지하려면 신호 페이지의 앱 부스트/숨기기 컨트롤 목록에서 사용 설정하거나 사용 중지하려는 컨트롤의 아이콘을 클릭하고 각각 사용 설정 또는 사용 중지를 클릭합니다.
컨트롤을 삭제하려면 신호 페이지의 앱 부스트/버리 컨트롤 목록에서 삭제하려는 컨트롤의 아이콘을 클릭하고 삭제를 클릭합니다.
REST
부스트 서빙 컨트롤은 boostAction이 있는 컨트롤로 정의됩니다.
다음 안내에 따라 게재 조정 부스트를 만듭니다.
필드 세부정보는 engines.controls API 참조 및 engines.controls.create API 참조를 확인하세요.
앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.
Google Cloud 콘솔에서 AI 애플리케이션 페이지로 이동합니다.
앱 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.
다음 curl 명령어를 실행하여 컨트롤을 만듭니다.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": [ "USE_CASE" ], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "boostAction": { "boost": BOOST_VALUE, "filter": "FILTER", "dataStore": "DATA_STORE_RESOURCE_PATH" } }'
다음을 바꿉니다.
PROJECT_ID: Google Cloud 프로젝트의 번호 또는 ID입니다.APP_ID: Vertex AI Search 앱의 ID입니다.CONTROL_ID: 컨트롤의 고유 식별자입니다. ID는 문자, 숫자, 하이픈, 밑줄을 포함할 수 있는 [1~63] 자의 문자열입니다.DISPLAY_NAME: 인간이 읽을 수 있는 컨트롤 이름입니다. 이 이름을 통해 컨트롤을 사용해야 하는 경우나 이유에 대한 정보를 제공하는 것이 좋습니다. 길이가 [1,128]인 UTF-8로 인코딩된 문자열이어야 합니다.USE_CASE:SEARCH_USE_CASE_SEARCH또는SEARCH_USE_CASE_BROWSE여야 합니다.SEARCH_USE_CASE_BROWSE가 지정된 경우 조건에Condition.queryTerms를 사용할 수 없습니다.CONDITION: 컨트롤을 적용해야 하는 시기를 정의하는 선택적 필드입니다. 다음 필드가 포함됩니다.VALUE: 일치시킬 특정 쿼리 값입니다. 길이가[1, 5000]인 소문자 UTF-8 문자열입니다.FULL_MATCH_1이true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.FULL_MATCH: 검색어와 검색어가 정확하게 일치해야 하는지 여부를 나타내는 불리언입니다.true로 설정하면SearchRequest.query가queryTerm.value와 완전히 일치해야 합니다.false로 설정하면SearchRequest.query에queryTerm.value가 하위 문자열로 포함되어야 합니다.START_TIMESTAMP: 기간의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
BOOST_VALUE: [-1,1] 범위의 부동 소수점 숫자입니다. 값이 음수이면 결과가 강등되어 결과 하단에 표시됩니다. 값이 양수이면 결과가 승격하여 결과 상단에 표시됩니다. 자세한 내용은boostAction를 참조하세요.FILTER: 문서에서 충족해야 하는 요구사항을 지정하는 문자열입니다. 문서가 모든 요구사항과 일치하면 부스트가 적용됩니다. 그렇지 않으면 변경되지 않습니다. 이 필드가 비어 있으면 데이터 스토어의 모든 문서에 부스트가 적용됩니다. 필터링 문법은 필터 표현식 문법을 참고하세요. 참고: 문서 필드title는 필터링할 수 없습니다.DATA_STORE_RESOURCE_PATH: 이 컨트롤로 문서가 부스팅되어야 하는 데이터 스토어의 전체 리소스 경로입니다. 전체 리소스 경로의 형식은projects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID입니다. 이 데이터 스토어는 요청에 지정된 엔진에 연결되어야 합니다.
engines.servingConfigs.patch메서드를 사용하여 컨트롤을 앱의 서빙 구성에 연결합니다.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/engines/APP_ID/servingConfigs/default_search?update_mask=boost_control_ids" \ -d '{ "boostControlIds": ["BOOST_ID_1", "BOOST_ID_2"] }'
BOOST_ID_N를 이전 단계에서 만든 제어 ID로 바꿉니다.
필터 게재 컨트롤 만들기 및 연결
필터 서빙 컨트롤은 filterAction이 있는 컨트롤로 정의됩니다.
다음 안내에 따라 필터 게재 컨트롤을 만듭니다.
필드 세부정보는 engines.controls API 참조 및 engines.controls.create API 참조를 확인하세요.
앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.
Google Cloud 콘솔에서 AI 애플리케이션 페이지로 이동합니다.
앱 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.
다음 curl 명령어를 실행하여 컨트롤을 만듭니다.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "filterAction": { "filter": "FILTER" } }'
다음을 바꿉니다.
PROJECT_ID: Google Cloud 프로젝트의 번호 또는 ID입니다.APP_ID: Vertex AI Search 앱의 ID입니다.CONTROL_ID: 컨트롤의 고유 식별자입니다. ID는 문자, 숫자, 하이픈, 밑줄을 포함할 수 있는 [1~63] 자의 문자열입니다.DISPLAY_NAME: 인간이 읽을 수 있는 컨트롤 이름입니다. 이 이름을 통해 컨트롤을 사용해야 하는 경우나 이유에 대한 정보를 제공하는 것이 좋습니다. 길이가 [1,128]인 UTF-8로 인코딩된 문자열이어야 합니다.USE_CASE:SEARCH_USE_CASE_SEARCH또는SEARCH_USE_CASE_BROWSE여야 합니다.SEARCH_USE_CASE_BROWSE가 지정된 경우 조건에Condition.queryTerms를 사용할 수 없습니다.CONDITION: 컨트롤을 적용해야 하는 시기를 정의하는 선택적 필드입니다. 다음 필드가 포함됩니다.VALUE: 일치시킬 특정 쿼리 값입니다. 길이가[1, 5000]인 소문자 UTF-8 문자열입니다.FULL_MATCH_1이true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.FULL_MATCH: 검색어와 검색어가 정확하게 일치해야 하는지 여부를 나타내는 불리언입니다.true로 설정하면SearchRequest.query가queryTerm.value와 완전히 일치해야 합니다.false로 설정하면SearchRequest.query에queryTerm.value가 하위 문자열로 포함되어야 합니다.START_TIMESTAMP: 기간의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
FILTER: 문서에서 충족해야 하는 요구사항을 지정하는 문자열입니다. 문서가 모든 요구사항과 일치하면 문서가 결과로 반환됩니다. 그렇지 않으면 문서가 결과에 포함되지 않습니다. 필터링 문법은 필터 표현식 문법을 참조하세요. 자세한 내용은filterAction를 참조하세요. 참고: 문서 필드title는 필터링할 수 없습니다.
engines.servingConfigs.patch메서드를 사용하여 컨트롤을 앱의 서빙 구성에 연결합니다.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/engines/APP_ID/servingConfigs/default_search?update_mask=filter_control_ids" \ -d '{ "filterControlIds": ["FILTER_ID_1", "FILTER_ID_2"] }'
FILTER_ID_N를 이전 단계에서 만든 제어 ID로 바꿉니다.
동의어 서빙 컨트롤 만들기 및 연결
동의어 서빙 컨트롤은 synonymsAction이 있는 컨트롤로 정의됩니다.
다음 안내에 따라 동의어 게재 컨트롤을 만듭니다.
필드 세부정보는 engines.controls API 참조 및 engines.controls.create API 참조를 확인하세요.
앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.
Google Cloud 콘솔에서 AI 애플리케이션 페이지로 이동합니다.
앱 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.
다음 curl 명령어를 실행하여 컨트롤을 만듭니다.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "synonymsAction": { "synonyms": ["SYNONYMS_1","SYNONYMS_2"] } }'
다음을 바꿉니다.
PROJECT_ID: Google Cloud 프로젝트의 번호 또는 ID입니다.APP_ID: Vertex AI Search 앱의 ID입니다.CONTROL_ID: 컨트롤의 고유 식별자입니다. ID는 문자, 숫자, 하이픈, 밑줄을 포함할 수 있는 [1~63] 자의 문자열입니다.DISPLAY_NAME: 인간이 읽을 수 있는 컨트롤 이름입니다. 이 이름을 통해 컨트롤을 사용해야 하는 경우나 이유에 대한 정보를 제공하는 것이 좋습니다. 길이가 [1,128]인 UTF-8로 인코딩된 문자열이어야 합니다.USE_CASE:SEARCH_USE_CASE_SEARCH또는SEARCH_USE_CASE_BROWSE여야 합니다.SEARCH_USE_CASE_BROWSE가 지정된 경우 조건에Condition.queryTerms를 사용할 수 없습니다.CONDITION: 컨트롤을 적용해야 하는 시기를 정의하는 선택적 필드입니다. 다음 필드가 포함됩니다.VALUE: 일치시킬 특정 쿼리 값입니다. 길이가[1, 5000]인 소문자 UTF-8 문자열입니다.FULL_MATCH_1이true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.FULL_MATCH: 검색어와 검색어가 정확하게 일치해야 하는지 여부를 나타내는 불리언입니다.true로 설정하면SearchRequest.query가queryTerm.value와 완전히 일치해야 합니다.false로 설정하면SearchRequest.query에queryTerm.value가 하위 문자열로 포함되어야 합니다.START_TIMESTAMP: 기간의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
SYNONYMS_N: 서로 연결되어 비슷한 결과를 더 많이 보여줄 가능성이 높은 문자열 목록입니다. 비슷한 결과가 표시될 가능성이 높지만 각 동의어 항목을 검색할 때는 연결된 모든 동의어에 관한 관련 검색 결과가 모두 표시되지 않을 수 있습니다. 동의어를 2개 이상 지정해야 하며 최대 100개까지 지정할 수 있습니다. 각 동의어는 UTF-8로 인코딩되어야 하며 소문자로 표시해야 합니다. 중복 문자열은 허용되지 않습니다. 예를 들어 'pixel', 'android phone', 'google phone'을 동의어로 추가할 수 있습니다. 자세한 내용은synonymsAction를 참조하세요.
engines.servingConfigs.patch메서드를 사용하여 컨트롤을 앱의 서빙 구성에 연결합니다.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/engines/APP_ID/servingConfigs/default_search?update_mask=synonyms_control_ids" \ -d '{ "synonymsControlIds": ["SYNONYMS_ID_1", "SYNONYMS_ID_2"] }'
SYNONYMS_ID_N를 이전 단계에서 만든 제어 ID로 바꿉니다.
리디렉션 게재 컨트롤 만들기 및 연결
리디렉션 서빙 컨트롤을 사용하면 사용자를 제공된 URI로 리디렉션할 수 있습니다.
리디렉션 컨트롤은 redirectAction이 있는 컨트롤로 정의됩니다.
다음 안내에 따라 리디렉션 게재 컨트롤을 만듭니다.
필드 세부정보는 engines.controls API 참조 및 engines.controls.create API 참조를 확인하세요.
앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.
Google Cloud 콘솔에서 AI 애플리케이션 페이지로 이동합니다.
앱 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.
다음 curl 명령어를 실행하여 컨트롤을 만듭니다.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": FULL_MATCH } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ] }, "redirectAction": { "redirectURI": "REDIRECT_URI" } }'
다음을 바꿉니다.
PROJECT_ID: Google Cloud 프로젝트의 번호 또는 ID입니다.APP_ID: Vertex AI Search 앱의 ID입니다.CONTROL_ID: 컨트롤의 고유 식별자입니다. ID는 문자, 숫자, 하이픈, 밑줄을 포함할 수 있는 [1~63] 자의 문자열입니다.DISPLAY_NAME: 인간이 읽을 수 있는 컨트롤 이름입니다. 이 이름을 통해 컨트롤을 사용해야 하는 경우나 이유에 대한 정보를 제공하는 것이 좋습니다. 길이가 [1,128]인 UTF-8로 인코딩된 문자열이어야 합니다.USE_CASE:SEARCH_USE_CASE_SEARCH또는SEARCH_USE_CASE_BROWSE여야 합니다.SEARCH_USE_CASE_BROWSE가 지정된 경우 조건에Condition.queryTerms를 사용할 수 없습니다.CONDITION: 컨트롤을 적용해야 하는 시기를 정의하는 선택적 필드입니다. 다음 필드가 포함됩니다.VALUE: 일치시킬 특정 쿼리 값입니다. 길이가[1, 5000]인 소문자 UTF-8 문자열입니다.FULL_MATCH_1이true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.FULL_MATCH: 검색어와 검색어가 정확하게 일치해야 하는지 여부를 나타내는 불리언입니다.true로 설정하면SearchRequest.query가queryTerm.value와 완전히 일치해야 합니다.false로 설정하면SearchRequest.query에queryTerm.value가 하위 문자열로 포함되어야 합니다.START_TIMESTAMP: 기간의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
REDIRECT_URI_N: 리디렉션되는 URI입니다. 최대 길이는 2,000자(영문 기준)입니다. 예를 들어 검색어 값이 '지원'인 경우 '지원' 검색 결과를 반환하거나 반환하지 않는 대신 기술 지원 페이지로 리디렉션을 설정할 수 있습니다. 이 예에서 리디렉션 URI는"https://www.example.com/support"가 됩니다. 자세한 내용은redirectAction를 참조하세요.
engines.servingConfigs.patch메서드를 사용하여 컨트롤을 앱의 서빙 구성에 연결합니다.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/engines/APP_ID/servingConfigs/default_search?update_mask=redirect_control_ids" \ -d '{ "redirectControlIds": ["REDIRECT_ID_1", "REDIRECT_ID_2"] }'
REDIRECT_ID_N를 이전 단계에서 만든 제어 ID로 바꿉니다.
게재 신청 서빙 컨트롤 만들기 및 연결
게재 컨트롤을 사용하면 링크를 추천 결과로 표시할 수 있으며 다음 유형의 검색 데이터 스토어에 사용할 수 있습니다.
기본 웹사이트 검색이 있는 웹사이트 데이터 스토어: 이러한 데이터 스토어의 경우 앱의 게재 구성에 승격 컨트롤을 연결할 필요가 없습니다. 승격 컨트롤을 만들고 사용 설정하면 승격 컨트롤이 활성화됩니다. 승격 컨트롤을 사용 설정하거나 사용 중지하여 사용 또는 사용 중지할 수 있습니다.
정형 및 비정형 데이터가 있는 데이터 스토어, 고급 웹사이트 색인 생성이 적용된 웹사이트 데이터, 혼합 검색 앱: 이러한 데이터 스토어의 경우 게재 구성에 승격 컨트롤을 연결해야 합니다.
승격 컨트롤은 promoteAction를 사용하여 정의됩니다.
승격 관리를 만들려면 생성 요청에 다음 필드 중 하나가 필요합니다.
queryTerms: 기본 웹사이트 검색에만 적용되는queryRegex조건을 지정하는 경우 이 조건을 지정할 수 없습니다. 기본 웹사이트 검색의 경우queryTerms가 지정된 경우fullMatch을true로 설정해야 합니다. 다른 모든 검색 앱의 경우queryTerms만 지원되며fullMatch는true또는false로 설정할 수 있습니다.queryRegex. 기본 웹사이트 검색의 게재 조정 홍보에만 사용할 수 있습니다. 이 조건은 검색어가 지정된 정규 표현식과 일치할 때 컨트롤을 적용합니다.queryTerms조건을 지정하는 경우 이 조건을 지정할 수 없습니다.
즉, 기본 웹사이트 검색의 경우 fullMatch를 true로 설정하여 queryTerms 필드를 지정하거나 queryRegex 필드를 지정해야 합니다. 다른 모든 유형의 검색의 경우 fullMatch을 true 또는 false로 설정하여 queryTerms 필드를 지정합니다.
다음 안내에 따라 게재 컨트롤을 승격합니다.
필드 세부정보는 engines.controls API 참조 및 engines.controls.create API 참조를 확인하세요.
앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.
Google Cloud 콘솔에서 AI 애플리케이션 페이지로 이동합니다.
앱 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.
다음 curl 명령어를 실행하여 컨트롤을 만듭니다.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls?controlId=CONTROL_ID" \ -d '{ "displayName": "DISPLAY_NAME", "solutionType": "SOLUTION_TYPE_SEARCH", "useCases": ["USE_CASE"], "conditions": { "queryTerms": [ { "value": "VALUE", "fullMatch": true } ], "activeTimeRange": [ { "startTime": "START_TIMESTAMP", "endTime": "END_TIMESTAMP" } ], "queryRegex": "VALUE_REGEX" }, "promoteAction": { "dataStore": "DATA_STORE_RESOURCE_PATH", "searchLinkPromotion": { "document": "DOCUMENT_RESOURCE_PATH", "title": "TITLE", "uri": "URI", "description": "DESCRIPTION", "enabled": ENABLED_TRUE|FALSE, } } }'
다음을 바꿉니다.
PROJECT_ID: Google Cloud 프로젝트의 번호 또는 ID입니다.APP_ID: Vertex AI Search 앱의 ID입니다.CONTROL_ID: 컨트롤의 고유 식별자입니다. ID는 문자, 숫자, 하이픈, 밑줄을 포함할 수 있는 [1~63] 자의 문자열입니다.DISPLAY_NAME: 인간이 읽을 수 있는 컨트롤 이름입니다. 이 이름을 통해 컨트롤을 사용해야 하는 경우나 이유에 대한 정보를 제공하는 것이 좋습니다. 길이가 [1,128]인 UTF-8로 인코딩된 문자열이어야 합니다.USE_CASE:SEARCH_USE_CASE_SEARCH또는SEARCH_USE_CASE_BROWSE여야 합니다.SEARCH_USE_CASE_BROWSE가 지정된 경우 조건에Condition.queryTerms를 사용할 수 없습니다.Condition: 컨트롤을 적용해야 하는 시기를 정의하는 선택적 객체입니다. 다음 필드가 포함됩니다.queryTerms:queryRegex필드와 함께 사용할 수 없습니다.VALUE: 일치시킬 특정 쿼리 값입니다. 길이가[1, 5000]인 소문자 UTF-8 문자열입니다.
activeTimeRange:START_TIMESTAMP: 기간의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
queryRegex: 기본 웹사이트 검색이 있는 데이터 스토어에서만 사용할 수 있습니다. 이 필드는queryTerms필드와 함께 사용할 수 없습니다.VALUE_REGEX: 쿼리를 일치시킬 정규 표현식입니다.
DATA_STORE_RESOURCE_PATH: 검색 결과에 추천 URL이 포함된 데이터 스토어의 전체 리소스 경로입니다. 전체 리소스 경로의 형식은projects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID입니다. 이 데이터 스토어는 요청에 지정된 엔진에 연결되어야 합니다.DOCUMENT_RESOURCE_PATH: 승격할 문서의 문서 리소스 경로를 지정하는 필드입니다.- 정형 데이터와 비정형 데이터가 있는 검색 데이터 스토어의 경우 DOCUMENT_RESOURCE_PATH 필드에 문서 리소스 경로를, URI 필드에 URI를 제공하거나 둘 다 제공해야 합니다. 전체 리소스 경로의 형식은
projects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID/branches/0/documents/DOCUMENT_ID입니다. - 웹사이트 데이터 스토어의 경우 이 필드를 설정 해제하고 대신 URI 필드를 설정해야 합니다.
- 정형 데이터와 비정형 데이터가 있는 검색 데이터 스토어의 경우 DOCUMENT_RESOURCE_PATH 필드에 문서 리소스 경로를, URI 필드에 URI를 제공하거나 둘 다 제공해야 합니다. 전체 리소스 경로의 형식은
TITLE: 홍보할 문서 또는 웹페이지의 제목을 지정하는 필수 입력란입니다. 이 제목은 검색 결과에 표시됩니다.URI: 검색 결과가 사용자를 안내하는 URI 링크를 지정하는 필수 입력란입니다. 이 URI는 데이터 스토어에 포함할 필요가 없습니다.- 정형 데이터와 비정형 데이터가 있는 검색 데이터 스토어의 경우 DOCUMENT_RESOURCE_PATH 필드에 문서 리소스 경로를, URI 필드에 URI를 제공하거나 둘 다 제공해야 합니다.
- 웹사이트 데이터 스토어의 경우 이 필드는 필수 필드이므로 설정해야 합니다.
DESCRIPTION: 검색 결과에 표시되는, 홍보할 문서 또는 웹페이지를 설명하는 선택적 필드입니다.ENABLED_TRUE|FALSE: 승격 제어가 사용 설정되어 앱에 연결되어 있는지 나타내는 선택적 불리언 필드입니다. 이 필드는 기본 웹사이트 검색이 있는 웹사이트 데이터 스토어에만 적용됩니다. 이 필드를false로 설정하면 게재 조정 컨트롤이 사용 중지되며 컨트롤이 적용되려면 다음 단계에 설명된 대로 컨트롤을 사용 설정하여 업데이트해야 합니다. 자세한 내용은promoteAction를 참조하세요.
기본 웹사이트 검색을 제외한 모든 검색 앱의 경우
engines.servingConfigs.patch메서드를 사용하여 앱의 서빙 구성에 컨트롤을 연결합니다. 다음 요청에서promoteControlIds가 첨부되는 순서는 승격된 결과가 반환되는 순서입니다.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/engines/APP_ID/servingConfigs/default_search?update_mask=promote_control_ids" \ -d '{ "promoteControlIds": ["PROMOTE_ID_1", "PROMOTE_ID_2"] }'
PROMOTE_ID_N를 이전 단계에서 만든 제어 ID로 바꿉니다.선택사항: 기본 웹사이트 검색의 경우 앱의 서빙 구성에 컨트롤을 연결할 필요가 없습니다. 그러나 기본 웹사이트 검색의 경우 컨트롤이 생성된 후
engines.control.patch메서드를 호출하여 컨트롤을 사용 설정 또는 중지할 수 있습니다.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/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/controls/CONTROL_ID?updateMask=promoteAction.searchLinkPromotion.enabled" \ -d '{ "promoteAction": { "searchLinkPromotion": { "enabled": ENABLED_TRUE|FALSE, } } }'
예
앱에 검색 요청을 보내고 프로모션 컨트롤에 지정된 쿼리 또는 쿼리 정규 표현식과 일치하는 쿼리를 사용하면 응답에 프로모션된 링크가 표시됩니다.
예를 들어 기본 웹사이트 검색이 있는 데이터 스토어에서 다음 구성으로 승격 컨트롤을 만든다고 가정해 보겠습니다.
{
"conditions": [
{
"queryTerms": [
{
"value": "artificial intelligence",
"fullMatch": true
}
]
}
]"
...
promoteAction": {
"dataStore": "https://discoveryengine.googleapis.com/v1alpha/projects/123456/locations/us/collections/default_collection/dataStores/basic-website-data-store" \
"searchLinkPromotion": {
"title": "What is AI?",
"uri": "https://cloud.google.com/learn/what-is-artificial-intelligence",
"description": "Explain what is AI"
"enabled": true
}
}
}
그런 다음 다음 검색 요청을 전송합니다.
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1alpha/projects/123456/locations/us/collections/default_collection/engines/basic-website-app/servingConfigs/default_search:search" \
-d '{
"query": "artificial intelligence"
}'
다음과 같이 잘린 응답과 비슷한 JSON 응답이 수신됩니다.
응답에는 추천 링크가 포함된 searchLinkPromotions 필드가 포함됩니다.
{
"results": [...],
"totalSize": 3,
"attributionToken": "_gHw_QoMCMSbhboGELuI1qwCEiQ2NzQwYmYzYi0wMDAwLTJmYTctYTk1OC0yNDA1ODg4MzZmYjgiB0dFTkVSSUMqvAGrxIotzua1L5neqC_n7YgtxPzLMIOymiK0kq4wxPi8MPn2sy3LmrQw6d3EMNSynRWc1rctnN3YMOuCsS3ogrEto4CXIsLwnhX89rMtkKS0MJbeqC-jibMtkPeyMMTGsTCZ3dgw5O2ILa7Eii2NpLQw5t3EMN6PmiKOvp0VwfzLMICymiKq-LMt0ea1L634sy3Fy_MXtreMLbeSrjDHxrEwzpq0MMH4vDCgibMtn9a3LZSSxTCOkckw24-aIjAB",
"guidedSearchResult": {},
"summary": {},
"searchLinkPromotions": [
{
"title": "What is AI?",
"uri": "https://cloud.google.com/learn/what-is-artificial-intelligence",
"description": "Explain what is AI"
}
]
}
다음 단계
- 서빙 컨트롤이 맞춤 검색 앱의 검색 품질에 미치는 영향을 파악하려면 검색 품질을 평가하세요. 자세한 내용은 검색 품질 평가를 참조하세요.