REST Resource: projects.locations.corpora.searchConfigs

리소스: SearchConfig

SearchConfig는 검색 동작 및 검색 결과에 영향을 미치는 다양한 속성을 저장합니다.

JSON 표현 
{
  "name": string,
  "facetProperty": {
    object (FacetProperty)
  },
  "searchCriteriaProperty": {
    object (SearchCriteriaProperty)
  }
}
필드
name

string

검색 구성의 리소스 이름입니다. CustomSearchCriteria의 경우 searchConfig가 검색 연산자 이름입니다. 패싯의 경우 searchConfig는 패싯 측정기준 이름입니다. 양식: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{searchConfig}
facetProperty

object (FacetProperty)

FacetDimension 및 관련 사양을 설정합니다.
searchCriteriaProperty

object (SearchCriteriaProperty)

맞춤 SearchCriteria와 하나 이상의 UGA 키 간에 매핑을 만듭니다.

FacetProperty

패싯의 중앙 구성입니다.

JSON 표현 
{
  "mappedFields": [
    string
  ],
  "displayName": string,
  "resultSize": string,
  "bucketType": enum (FacetBucketType),

  // Union field range_facet_config can be only one of the following:
  "fixedRangeBucketSpec": {
    object (FixedRangeBucketSpec)
  },
  "customRangeBucketSpec": {
    object (CustomRangeBucketSpec)
  },
  "datetimeBucketSpec": {
    object (DateTimeBucketSpec)
  }
  // End of list of possible types for union field range_facet_config.
}
필드
mappedFields[]

string

사용자가 검색 결과를 세분화하는 데 사용할 측정기준인 상품 속성의 이름입니다. mappedFields는 UserSpecifiedDataSchema 키와 일치합니다.

예를 들어 사용자는 동일한 키(예: player:adam, player:bob, player:charles)를 사용하여 여러 UGA를 추가할 수 있습니다. mappedFields가 여러 개 지정된 경우 값을 최종 패싯 값으로 병합합니다. 예를 들어 home_team: a, home_team:b, away_team:a, away_team:c인 경우 facet_field = [home_team, away_team]이면 facet_value는 [a, b, c]가 됩니다.

1:1 측정기준 측정기준 (mappedFields.size() == 1)이고 mapped_field가 상위 SearchConfig.name과 같은 경우가 아니라면 상위 요소에 동일한 필드에 매핑되는 SearchCriteriaProperty도 포함되어야 합니다. mappedFields는 비어선 안 됩니다.
displayName

string

패싯의 표시 이름입니다. UI에서 측정기준 렌더링에 사용합니다.
resultSize

string (int64 format)

하나의 패싯에 대해 반환할 최대 고유 버킷 수입니다. '선수'와 같이 카디널리티가 높은 측정기준의 경우 버킷 수가 클 수 있습니다. 사용자에게 가장 관련성이 높은 상위 n개만 반환합니다. 0보다 작거나 같은 경우 서버에서 적절한 resultSize를 결정합니다.
bucketType

enum (FacetBucketType)

패싯 버킷 유형(예: 값, 범위)

통합 필드 range_facet_config.

range_facet_config는 다음 중 하나여야 합니다.
fixedRangeBucketSpec

object (FixedRangeBucketSpec)

고정 범위 측정기준 버킷 구성을 수정했습니다.
customRangeBucketSpec

object (CustomRangeBucketSpec)

맞춤 범위 측정기준 버킷 구성
datetimeBucketSpec

object (DateTimeBucketSpec)

기간 측정기준 버킷 구성입니다.

FixedRangeBucketSpec

버킷 유형이 FIXED_RANGE인 경우 값을 버케팅하는 방법을 지정합니다. 동일한 세부사항으로 여러 버킷을 만들려면 FixedRangeBucketSpec을 사용하세요. 정수 버킷 값을 예로 들면 bucketStart = 0, bucketGranularity = 10, bucketCount = 5인 경우 이 패싯은 [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf) 버킷을 통해 집계됩니다. 특히 bucketCount가 1 이하이면 잘못된 사양입니다.

JSON 표현 
{
  "bucketStart": {
    object (FacetValue)
  },
  "bucketGranularity": {
    object (FacetValue)
  },
  "bucketCount": integer
}
필드
bucketStart

object (FacetValue)

버킷의 하한. 참고: 현재 이 필드에는 정수 유형만 지원됩니다.
bucketGranularity

object (FacetValue)

버킷 세부사항 참고: 현재 이 필드에는 정수 유형만 지원됩니다.
bucketCount

integer

총 버킷 수이며

FacetValue

제네릭 유형이 있는 단일 값의 정의입니다.

JSON 표현 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "datetimeValue": {
    object (DateTime)
  }
  // End of list of possible types for union field value.
}
필드

통합 필드 value.

value는 다음 중 하나여야 합니다.
stringValue

string

문자열 유형 값입니다.
integerValue

string (int64 format)

정수 유형 값입니다.
datetimeValue

object (DateTime)

날짜/시간 유형 값입니다.

CustomRangeBucketSpec

버킷 유형이 CUSTOM_RANGE인 경우 값을 버케팅하는 방법을 지정합니다. 정수 버킷 값을 예로 들면 엔드포인트가 0, 10, 100, 1,000인 경우 [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf) 패싯이 생성됩니다. 특히: - 엔드포인트는 오름차순으로 나열해야 합니다. 그러지 않으면 SearchConfig API에서 측정기준 구성을 거부합니다. - 엔드포인트가 1개 미만이면 잘못된 사양입니다.

JSON 표현 
{
  "endpoints": [
    {
      object (FacetValue)
    }
  ]
}
필드
endpoints[]

object (FacetValue)

현재 이 필드에는 정수 유형만 지원됩니다.

DateTimeBucketSpec

버킷 유형이 DATE인 경우 날짜 값을 버케팅하는 방법을 지정합니다.

JSON 표현 
{
  "granularity": enum (Granularity)
}
필드
granularity

enum (Granularity)

날짜 유형 측면의 세부사항입니다.

세부사항

날짜/시간 버킷의 세부사항 열거형입니다.

열거형
GRANULARITY_UNSPECIFIED 지정되지 않은 세부사항입니다.
YEAR 단위는 연도입니다.
MONTH 단위는 월입니다.
DAY 단위는 일입니다.

FacetBucketType

측정기준 버킷의 다양한 유형

열거형
FACET_BUCKET_TYPE_UNSPECIFIED 알 수 없는 유형.
FACET_BUCKET_TYPE_VALUE 값 유형입니다.
FACET_BUCKET_TYPE_DATETIME 날짜/시간 유형입니다.
FACET_BUCKET_TYPE_FIXED_RANGE 범위 유형을 수정했습니다.
FACET_BUCKET_TYPE_CUSTOM_RANGE 맞춤 범위 유형

SearchCriteriaProperty

맞춤 검색 기준의 중앙 구성

JSON 표현 
{
  "mappedFields": [
    string
  ]
}
필드
mappedFields[]

string

각 mapped_field는 UGA 키에 해당합니다. 이 속성의 작동 방식을 이해하려면 다음 예를 살펴보세요. SearchConfig 테이블에서 사용자가 다음 항목을 추가합니다. searchConfig { name: "person" searchCriteriaProperty { mappedFields: "player" mappedFields: "coach" } }

이제 사용자가 다음과 같은 쿼리를 실행하면 됩니다. criteria { field: "person" textArray { txtValues: "Tom Brady" txtValues: "Bill Belichick" } }

MWH 검색은 (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick)인 검색 문서를 반환합니다.

메서드

create

 자료 내에서 검색 구성을 만듭니다.

delete

 자료 내의 검색 구성을 삭제합니다.

get

 코퍼스 내에서 검색 구성을 가져옵니다.

list

 코퍼스 내의 모든 검색 구성을 나열합니다.

patch

 자료 내의 검색 구성을 업데이트합니다.