REST Resource: settings.searchapplications

리소스: SearchApplication

SearchApplication

JSON 표현 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
필드
name

string

검색 애플리케이션의 이름입니다.

형식: searchapplications/{applicationId}.
displayName

string

검색 애플리케이션의 표시 이름입니다. 최대 길이는 300자(영문 기준)입니다.
dataSourceRestrictions[]

object (DataSourceRestriction)

구성에 적용된 제한사항 최대 요소 수는 10개입니다.
sourceConfig[]

object (SourceConfig)

dataSourceRestrictions에 지정된 소스의 구성입니다.
scoringConfig

object (ScoringConfig)

순위 결과의 구성입니다.
defaultSortOptions

object (SortOptions)

검색 결과 정렬을 위한 기본 옵션
defaultFacetOptions[]

object (FacetOptions)

측정기준 결과를 반환하기 위한 기본 필드입니다. 여기에 지정된 소스는 위의 dataSourceRestrictions에도 포함되어 있습니다.
returnResultThumbnailUrls

boolean

각 결과와 함께 썸네일의 URI를 반환해야 합니다 (해당하는 경우).
operationIds[]

string

출력 전용입니다. 이 스키마에 대해 현재 실행 중인 장기 실행 작업 (LRO)의 ID입니다. 출력 전용 필드입니다.
enableAuditLog

boolean

쿼리 API의 검색 애플리케이션에 대한 요청에 대해 감사 로깅이 사용 설정되어 있는지 여부를 나타냅니다.
queryInterpretationConfig

object (QueryInterpretationConfig)

검색어 해석의 기본 옵션

DataSourceRestriction

데이터 소스에 대한 제한사항

JSON 표현 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
필드
source

object (Source)

제한의 소스입니다.
filterOptions[]

object (FilterOptions)

결과를 제한하는 필터 옵션 필터가 여러 개 있는 경우 조인하기 전에 객체 유형별로 그룹화됩니다. 객체 유형이 동일한 필터는 공합으로 조인된 후 결과 표현식이 교집합으로 조인됩니다.

요소의 최대 개수는 20개입니다.

참고: Suggest API는 현재 'objecttype', 'type', 'mimetype' 등 몇 가지 필터만 지원합니다. 현재 스키마별 필터를 사용하여 추천을 필터링할 수는 없습니다.

소스

추천/검색 API의 소스를 정의합니다.

JSON 표현 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
필드

통합 필드 source.

source는 다음 중 하나여야 합니다.
name

string

Indexing API로 색인이 생성된 콘텐츠의 소스 이름입니다.
predefinedSource

enum (Source.PredefinedSource)

Google 앱용 사전 정의된 콘텐츠 소스입니다.

Source.PredefinedSource

사전 정의된 소스:

열거형
NONE
QUERY_HISTORY 사용자가 이전에 실행한 검색어를 추천합니다. suggest API와 함께 사용할 때만 유효합니다. 쿼리 API에서 사용하면 무시됩니다.
PERSON 조직 내 사용자를 추천합니다. suggest API와 함께 사용할 때만 유효합니다. 쿼리 API에서 사용하면 오류가 발생합니다.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

쿼리에 적용할 필터 옵션입니다.

JSON 표현 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
필드
objectType

string

objectType이 설정된 경우 해당 유형의 객체만 반환됩니다. 이는 스키마 정의 내에 등록된 객체의 이름과 일치해야 합니다. 최대 길이는 256자(영문 기준)입니다.
filter

object (Filter)

검색을 제한하는 일반 필터(예: lang:en, site:xyz)

필터

쿼리에서 필터를 표현하는 일반적인 방법으로 다음 두 가지 접근 방식을 지원합니다.

1. ValueFilter 설정 이름은 데이터 소스의 스키마에 정의된 operatorName과 일치해야 합니다.

2. CompositeFilter 설정 필터는 논리 연산자를 사용하여 평가됩니다. 최상위 연산자는 AND 또는 NOT만 될 수 있습니다. AND는 최상위 수준에만 표시될 수 있습니다. OR는 최상위 AND 아래에만 표시될 수 있습니다.

JSON 표현 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
필드

통합 필드 filter.

filter는 다음 중 하나여야 합니다.
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

JSON 표현 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
필드
operatorName

string

쿼리에 적용된 operatorName입니다(예: price_greater_than). 이 필터는 데이터 소스의 스키마에 정의된 두 가지 유형의 필터에 모두 적용할 수 있습니다.

  1. operatorName: 값과 일치하는 속성별로 결과를 필터링하는 쿼리입니다.

  2. greaterThanOperatorName 또는 lessThanOperatorName입니다. 쿼리는 쿼리에 제공된 값보다 크거나 작은 속성 값의 결과를 필터링합니다.
value

object (Value)

비교할 값입니다.

값

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

JSON 표현 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
필드
통합 필드 value. 이름이 지정된 속성의 값입니다. value은 다음 중 하나여야 합니다.
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

JSON 표현 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
필드
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

하위 필터의 로직 연산자입니다.
subFilters[]

object (Filter)

하위 필터

Filter.CompositeFilter.LogicOperator

열거형
AND 하위 필터에만 적용할 수 있는 논리 연산자
OR
NOT NOT은 단일 하위 필터에만 적용할 수 있습니다.

SourceConfig

query.search 또는 query.suggest 요청을 처리하는 동안 소스의 구성입니다.

JSON 표현 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
필드
source

object (Source)

이 구성을 사용할 소스입니다.
scoringConfig

object (SourceScoringConfig)

소스의 점수 구성입니다.
crowdingConfig

object (SourceCrowdingConfig)

소스의 혼잡도 구성입니다.

SourceScoringConfig

점수 구성을 설정합니다. 이렇게 하면 소스의 결과 순위를 수정할 수 있습니다.

JSON 표현 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
필드
sourceImportance

enum (SourceScoringConfig.SourceImportance)

소스의 중요도입니다.

SourceScoringConfig.SourceImportance

소스의 중요도입니다. 이 값은 다른 소스와 비교하여 소스에 더 높은 순위 우선순위를 부여해야 하는지 나타내는 데 사용할 수 있습니다.

열거형
DEFAULT
LOW
HIGH

SourceCrowdingConfig

검색 결과 크라우딩 한도를 설정합니다. 과잉 노출은 동일한 소스 또는 호스트의 여러 검색 결과가 다른 검색 결과를 '가려' 사용자의 검색 품질을 저하시키는 상황을 말합니다. 검색 결과의 검색 품질과 소스 다양성을 개선하려면 소스별로 중복되는 결과를 줄이는 조건을 설정할 수 있습니다.

JSON 표현 
{
  "numResults": integer,
  "numSuggestions": integer
}
필드
numResults

integer

다른 소스의 결과가 소진되지 않는 한 결과 페이지에서 데이터 소스에서 허용되는 최대 결과 수입니다. 지정된 값은 음수여서는 안 됩니다. 이 값이 0이면 기본값이 사용됩니다. 크라우딩을 사용 중지하려면 값을 100보다 크게 설정합니다.
numSuggestions

integer

소스에서 허용되는 최대 추천 수입니다. 이 값이 0 이하이면 결과에 제한이 설정되지 않습니다.

ScoringConfig

query.search 또는 query.suggest 요청을 처리하는 동안 소스의 점수 구성

JSON 표현 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
필드
disableFreshness

boolean

업데이트 빈도를 순위 결정 신호로 사용할지 여부입니다. 기본적으로 최신성은 순위 신호로 사용됩니다. 이 설정은 관리자 UI에서 사용할 수 없습니다.
disablePersonalization

boolean

결과를 맞춤설정할지 여부입니다. 기본적으로 개인 신호는 검색 결과를 개선하는 데 사용됩니다.

SortOptions

JSON 표현 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
필드
operatorName

string

정렬할 필드에 해당하는 연산자의 이름입니다. 상응하는 속성은 sortable로 표시되어야 합니다.
sortOrder

enum (SortOptions.SortOrder)

오름차순이 기본 정렬 순서입니다.

SortOptions.SortOrder

열거형
ASCENDING
DESCENDING

FacetOptions

상품 속성 결과를 반환할 연산자를 지정합니다. sourceName/objectType/operatorName 조합마다 FacetResult가 하나씩 있습니다.

JSON 표현 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
필드
sourceName

string

측정기준을 적용할 소스 이름입니다. 형식: datasources/{sourceId} 비어 있으면 모든 데이터 소스가 사용됩니다.
objectType

string

objectType이 설정된 경우 해당 유형의 객체만 면을 계산하는 데 사용됩니다. 비어 있으면 모든 객체가 패싯을 계산하는 데 사용됩니다.
operatorName

string

면 분할에 선택된 연산자의 이름입니다. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

이 패싯에서 반환될 최대 패싯 버킷 수입니다. 기본값은 10입니다. 최대값은 100입니다.
integerFacetingOptions

object (IntegerFacetingOptions)

설정된 경우 지정된 정수 속성에 대한 정수 면 분할 옵션을 설명합니다. 스키마의 해당 정수 속성은 isFacetable로 표시되어야 합니다. 반환되는 버킷 수는 이 값과 numFacetBuckets 중 최솟값입니다.

IntegerFacetingOptions

정수 측정기준 옵션을 지정하는 데 사용됩니다.

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

string (Int64Value format)

주어진 정수 값의 버킷은 엄격히 오름차순이어야 합니다. 예를 들어 제공된 값이 (1,5,10,100)인 경우 다음과 같은 패싯 버킷이 생성됩니다. {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

사용자 쿼리를 해석하는 기본 옵션입니다.

JSON 표현 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
필드
forceVerbatimMode

boolean

이 플래그를 사용 설정하면 쿼리의 자연어 (NL) 해석, 보조 결과 검색, 맞춤 동의어를 포함한 동의어 사용과 같은 모든 내부 최적화가 사용 중지됩니다. 이 플래그가 true로 설정되면 쿼리 수준에서 설정된 옵션보다 우선 적용됩니다. 기본값인 False의 경우 쿼리 수준 플래그가 verbatim 모드에 올바른 해석을 설정합니다.
forceDisableSupplementalResults

boolean

이 플래그를 설정하면 보조 결과 검색을 사용 중지할 수 있습니다. 여기에서 플래그를 설정하면 특정 검색 애플리케이션과 연결된 검색어의 보조 결과가 검색되지 않습니다. 이 플래그가 true로 설정되면 쿼리 수준에서 설정된 옵션보다 우선 적용됩니다. 기본값인 False의 경우 쿼리 수준 플래그가 보조 결과에 대한 올바른 해석을 설정합니다.

메서드

create

 검색 애플리케이션을 만듭니다.

delete

 검색 애플리케이션을 삭제합니다.

get

 지정된 검색 애플리케이션을 가져옵니다.

list

 모든 검색 애플리케이션을 나열합니다.

patch

 검색 애플리케이션을 업데이트합니다.

reset

 검색 애플리케이션을 기본 설정으로 재설정합니다.

update

 검색 애플리케이션을 업데이트합니다.