REST Resource: projects.locations.collections.engines.controls

리소스: Control

서빙 중에 사용할 조건부 동작을 정의합니다. 게재 시간에 고려되려면 ServingConfig에 연결되어야 합니다. SolutionType에 따라 허용되는 작업

JSON 표현 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
필드
name

string

변경할 수 없습니다. 정규화된 이름 projects/*/locations/global/dataStore/*/controls/*
displayName

string

필수 항목입니다. 사람이 읽을 수 있는 이름입니다. UI 뷰에서 사용되는 식별자입니다.

UTF-8로 인코딩된 문자열이어야 합니다. 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
associatedServingConfigIds[]

string

출력 전용입니다. 이 컨트롤이 연결된 모든 ServingConfig ID의 목록입니다. 변경 후 업데이트되는 데 최대 10분이 걸릴 수 있습니다.
solutionType

enum (SolutionType)

필수 항목입니다. 변경할 수 없습니다. 컨트롤이 속한 솔루션입니다.

리소스의 업종과 호환되어야 합니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.
useCases[]

enum (SearchUseCase)

제어의 사용 사례를 지정합니다. 설정할 수 있는 조건 필드에 영향을 미칩니다. SOLUTION_TYPE_SEARCH에만 적용됩니다. 현재 컨트롤당 하나의 사용 사례만 허용됩니다. solutionType이 SolutionType.SOLUTION_TYPE_SEARCH인 경우 설정해야 합니다.
conditions[]

object (Condition)

연결된 작업이 트리거되는 시점을 결정합니다.

항상 작업을 적용하려면 생략하세요. 현재는 단일 조건만 지정할 수 있습니다. 그렇지 않으면 INVALID ARGUMENT 오류가 발생합니다.

통합 필드 action. 작업이 업종 및 솔루션에 따라 제한됨

필수 항목입니다. action는 다음 중 하나여야 합니다.
boostAction

object (BoostAction)

부스트 유형 컨트롤을 정의합니다.
filterAction

object (FilterAction)

필터 유형 컨트롤을 정의합니다. 현재 추천에서 지원되지 않습니다.
redirectAction

object (RedirectAction)

리디렉션 유형 컨트롤을 정의합니다.
synonymsAction

object (SynonymsAction)

일련의 용어를 서로의 동의어로 취급합니다.
promoteAction

object (PromoteAction)

사전 정의된 트리거 쿼리를 기반으로 특정 링크를 홍보합니다.

메서드

create

 컨트롤을 만듭니다.

delete

 컨트롤을 삭제합니다.

get

 컨트롤을 가져옵니다.

list

 상위 DataStore별로 모든 컨트롤을 나열합니다.

patch

 Control을 업데이트합니다.