서빙 컨트롤 구성

서빙 컨트롤 (컨트롤이라고도 함)은 결과가 반환될 때 요청이 처리되는 기본 동작을 변경합니다. 제공 컨트롤은 데이터 스토어 수준에서 작동합니다.

예를 들어 컨트롤은 결과를 증폭하거나 숨길 수 있으며, 반환된 결과에서 항목을 필터링하거나, 문자열을 동의어로 서로 연결하거나, 결과를 지정된 URI로 리디렉션할 수 있습니다.

서빙 컨트롤 정보

요청 결과를 변경하려면 먼저 서빙 컨트롤을 만듭니다. 그런 다음 해당 컨트롤을 앱의 서빙 구성에 연결합니다. 서빙 구성은 검색 결과 또는 답변과 같은 서빙 시간 결과를 생성하는 데 사용되는 메타데이터를 구성합니다. 서빙 컨트롤은 컨트롤이 앱의 서빙 구성에 연결된 경우에만 앱에서 서빙하는 요청에 영향을 미칩니다.

부스트 컨트롤과 같은 일부 컨트롤은 데이터 스토어에 종속됩니다. 데이터 스토어가 앱에서 삭제되면 데이터 스토어 종속 컨트롤도 해당 앱에서 삭제되고 비활성화되지만 삭제되지는 않습니다.

서빙 컨트롤 유형

다음과 같은 유형의 서빙 컨트롤을 사용할 수 있습니다.

컨트롤 설명 적용 대상
부스트 컨트롤 반환된 결과의 순서를 변경합니다. 구조화된 데이터가 포함된 데이터 스토어 또는 메타데이터가 포함된 비정형 데이터와 같이 스키마를 지원하는 데이터 스토어가 있는 검색 앱
필터 컨트롤 반환된 결과에서 항목을 삭제합니다. 구조화된 데이터가 포함된 데이터 스토어 또는 메타데이터가 포함된 비정형 데이터와 같이 스키마를 지원하는 데이터 스토어가 있는 검색 앱
동의어 컨트롤 쿼리를 서로 연결합니다. 정형 또는 비정형 데이터 스토어가 있는 앱 검색
리디렉션 제어 지정된 URI로 리디렉션 모든 검색 앱
홍보 컨트롤 질문에 대해 지정된 링크를 홍보합니다. 정형 또는 비정형 데이터 스토어가 있는 앱 검색

조건 정보

컨트롤을 만들 때 컨트롤이 적용되는 시점을 결정하는 조건을 선택적으로 정의할 수 있습니다. 조건은 조건 필드를 사용하여 정의됩니다. 사용 가능한 조건 필드는 다음과 같습니다.

  • queryTerms. 특정 쿼리를 검색할 때 적용되는 선택적 컨트롤입니다. queryTerms 조건이 사용되면 queryTerms 값이 SearchRequest.query의 용어와 일치할 때 컨트롤이 적용됩니다. 쿼리 용어는 Control.searchUseCaseSOLUTION_TYPE_SEARCH로 설정된 경우에만 사용할 수 있습니다. 단일 Control.condition에 최대 10개의 서로 다른 queryTerms를 지정할 수 있습니다. 쿼리 용어가 지정되지 않으면 queryTerms 필드가 무시됩니다.

    프로모션 컨트롤을 성공적으로 만들려면 fullMatchtrue 또는 false로 설정된 queryTerms 필드를 지정해야 합니다.

  • activeTimeRange. 지정된 시간 범위 내에서 요청이 발생할 때 적용되는 선택적 컨트롤입니다. 요청이 수신된 시간이 activeTimeRange.startTimeactiveTimeRange.endTime 사이인지 확인합니다. 단일 Control.condition에서 최대 10개의 activeTimeRange 범위를 지정할 수 있습니다. activeTimeRange 필드가 지정되지 않으면 필드가 무시됩니다.

하나의 컨트롤에 여러 조건이 지정된 경우 두 조건 유형이 모두 충족되면 컨트롤이 검색 요청에 적용됩니다. 동일한 조건에 여러 값이 지정된 경우 해당 조건이 충족되려면 값 중 하나만 일치하면 됩니다.

예를 들어 쿼리 용어가 두 개 지정된 다음 조건을 고려해 보세요.

"queryTerms": [
  {
    "value": "gShoe",
    "fullMatch": true
  },
  {
    "value": "gBoot",
    "fullMatch": true
  }
]

이 조건은 SearchRequest.query="gShoe"가 포함된 요청 또는 SearchRequest.query="gBoot"가 포함된 요청에 대해 충족되지만 SearchRequest.query="gSandal" 또는 다른 문자열의 경우 충족되지 않습니다.

조건을 지정하지 않으면 컨트롤이 항상 적용됩니다.

자세한 내용은 API 참조에서 Condition 필드를 참고하세요.

부스트 서빙 컨트롤 만들기 및 연결

부스트 서빙 컨트롤은 boostAction이 있는 컨트롤로 정의됩니다.

다음 안내에 따라 부스트 서빙 컨트롤을 만듭니다.

필드 세부정보는 engines.controls API 참조engines.controls.create API 참조를 확인하세요.

  1. 앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.

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

      앱으로 이동

    2. 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.

  2. 다음 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: 앱의 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_1true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.
      • FULL_MATCH: 검색어가 검색어와 정확히 일치해야 하는지 여부를 나타내는 불리언입니다. true로 설정된 경우 SearchRequest.queryqueryTerm.value와 완전히 일치해야 합니다. false로 설정하면 SearchRequest.queryqueryTerm.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입니다. 이 데이터 스토어는 요청에서 지정된 엔진에 연결되어야 합니다.
  3. 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 참조를 확인하세요.

  1. 앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.

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

      앱으로 이동

    2. 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.

  2. 다음 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: 앱의 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_1true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.
      • FULL_MATCH: 검색어가 검색어와 정확히 일치해야 하는지 여부를 나타내는 불리언입니다. true로 설정된 경우 SearchRequest.queryqueryTerm.value와 완전히 일치해야 합니다. false로 설정하면 SearchRequest.queryqueryTerm.value이 하위 문자열로 포함되어야 합니다.
      • START_TIMESTAMP: 시간 범위의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
      • END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
    • FILTER: 문서에서 충족해야 하는 요구사항을 지정하는 문자열입니다. 문서가 모든 요구사항과 일치하면 문서가 결과에 반환됩니다. 그렇지 않으면 문서가 결과에 표시되지 않습니다. 필터링 문법은 필터 표현식 문법을 참조하세요. 자세한 내용은 filterAction를 참조하세요. 참고: 문서 필드 title는 필터링할 수 없습니다.
  3. 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 참조를 확인하세요.

  1. 앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.

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

      앱으로 이동

    2. 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.

  2. 다음 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: 앱의 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_1true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.
      • FULL_MATCH: 검색어가 검색어와 정확히 일치해야 하는지 여부를 나타내는 불리언입니다. true로 설정된 경우 SearchRequest.queryqueryTerm.value와 완전히 일치해야 합니다. false로 설정하면 SearchRequest.queryqueryTerm.value이 하위 문자열로 포함되어야 합니다.
      • START_TIMESTAMP: 시간 범위의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
      • END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
    • SYNONYMS_N: 서로 연결되어 비슷한 결과를 더 많이 보여줄 가능성이 높은 문자열 목록입니다. 동의어 항목을 각각 검색하면 유사한 결과가 표시될 가능성이 높지만, 연결된 모든 동의어에 대한 관련 결과가 모두 표시되지는 않을 수 있습니다. 동의어를 2개 이상 지정해야 하며 최대 100개의 동의어를 지정할 수 있습니다. 각 동의어는 UTF-8로 인코딩되어야 하며 소문자여야 합니다. 중복 문자열은 허용되지 않습니다. 예를 들어 'Pixel', 'Android 휴대전화', 'Google 휴대전화'를 동의어로 추가할 수 있습니다. 자세한 내용은 synonymsAction를 참조하세요.
  3. 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 참조를 확인하세요.

  1. 앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.

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

      앱으로 이동

    2. 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.

  2. 다음 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: 앱의 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_1true이면 이 필드에는 공백으로 구분된 최대 3개의 용어가 있을 수 있습니다.
      • FULL_MATCH: 검색어가 검색어와 정확히 일치해야 하는지 여부를 나타내는 불리언입니다. true로 설정된 경우 SearchRequest.queryqueryTerm.value와 완전히 일치해야 합니다. false로 설정하면 SearchRequest.queryqueryTerm.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를 참조하세요.
  3. 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을 사용하여 정의됩니다.

프로모션 컨트롤을 성공적으로 만들려면 fullMatchtrue 또는 false로 설정된 queryTerms 필드를 지정해야 합니다.

다음 안내에 따라 프로모션 서빙 컨트롤을 만듭니다.

필드 세부정보는 engines.controls API 참조engines.controls.create API 참조를 확인하세요.

  1. 앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.

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

      앱으로 이동

    2. 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.

  2. 다음 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_TRUE|FALSE
        }
      ],
      "activeTimeRange": [
        {
          "startTime": "START_TIMESTAMP",
          "endTime": "END_TIMESTAMP"
        }
      ],
    },
    "promoteAction": {
      "dataStore": "DATA_STORE_RESOURCE_PATH",
      "searchLinkPromotion": {
         "document": "DOCUMENT_RESOURCE_PATH",
         "title": "TITLE",
         "uri": "URI",
         "description": "URI_DESCRIPTION",
      }
     }
    }'

    다음을 바꿉니다.

    • PROJECT_ID: Google Cloud 프로젝트의 번호 또는 ID입니다.
    • APP_ID: 앱의 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:
        • VALUE: 일치시킬 특정 쿼리 값입니다. 길이가 [1, 5000]인 소문자 UTF-8 문자열입니다.
        • FULL_MATCH_TRUE|FALSE: 쿼리 용어가 완전히 일치해야 하는지 여부를 나타내는 불리언입니다.
      • activeTimeRange:
        • START_TIMESTAMP: 시간 범위의 시작을 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
        • END_TIMESTAMP: 기간의 종료를 나타내는 RFC 3339 UTC 'Zulu' 형식의 타임스탬프입니다.
    • DATA_STORE_RESOURCE_PATH: 검색 결과에 프로모션 URL이 포함된 데이터 스토어의 전체 리소스 경로입니다. 전체 리소스 경로의 형식은 projects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID입니다. 이 데이터 스토어는 요청에서 지정된 엔진에 연결되어야 합니다.
    • DOCUMENT_RESOURCE_PATH: 승격할 문서의 리소스 경로를 지정하는 필드입니다. DOCUMENT_RESOURCE_PATH 필드에 문서 ID를 제공하거나 URI 필드에 URI를 제공하거나 둘 다 제공해야 합니다.

      전체 리소스 경로의 형식은 projects/PROJECT_NUMBER/locations/LOCATION_ID/collections/default_collection/dataStores/DATA_STORE_ID/branches/0/documents/DOCUMENT_ID입니다.

    • TITLE: 홍보할 문서 또는 웹페이지의 제목을 지정하는 필수 필드입니다. 이 제목은 검색 결과에 표시됩니다.

    • URI: 검색 결과가 사용자를 안내하는 URI를 지정하는 필드입니다. DOCUMENT_RESOURCE_PATH 필드에 문서 ID를 제공하거나 URI 필드에 URI를 제공하거나 둘 다 제공해야 합니다.

    • URI_DESCRIPTION: 검색 결과에 표시되는 URI를 설명하는 선택적 필드입니다.

    대답에는 검색 앱에 프로모션 컨트롤을 연결하는 데 필요한 프로모션 컨트롤 ID가 포함되어 있습니다.

  3. 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로 바꿉니다.

다음 단계

  • 서빙 컨트롤이 앱의 검색 품질에 미치는 영향을 파악하려면 검색 품질을 평가하세요.