REST Resource: settings.searchapplications

리소스: 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

Query API에서 검색 애플리케이션 요청에 대한 감사 로깅 사용/사용 중지 여부를 나타냅니다.

queryInterpretationConfig

object (QueryInterpretationConfig)

검색어 해석의 기본 옵션

데이터 소스 제한

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

JSON 표현
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
입력란
source

object (Source)

제한 출처입니다.

filterOptions[]

object (FilterOptions)

결과를 제한하는 필터 옵션입니다. 여러 필터가 있는 경우 조인하기 전에 객체 유형별로 그룹화됩니다. 동일한 객체 유형을 가진 필터는 결합으로 결합되고, 그 결과 표현식은 분리됩니다.

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

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

소스

추천 API/검색 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 Apps용 사전 정의된 콘텐츠 소스

소스.사전 정의된 소스

사전 정의된 소스:

열거형
NONE
QUERY_HISTORY 사용자가 이전에 실행한 검색어를 제안합니다. 추천 API와 함께 사용하는 경우에만 유효합니다. 쿼리 API에서 사용될 경우 무시됩니다.
PERSON 조직의 사용자를 제안합니다. 추천 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 하나의 하위 필터에만 적용할 수 없습니다.

SourceConfig

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

JSON 표현
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
입력란
source

object (Source)

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

scoringConfig

object (SourceScoringConfig)

소스 점수 구성입니다.

crowdingConfig

object (SourceCrowdingConfig)

소스의 크라우딩 구성입니다.

소스 점수 구성

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

JSON 표현
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
입력란
sourceImportance

enum (SourceScoringConfig.SourceImportance)

소스의 중요성

SourceScoringConfig.SourceImportance:

특정 소스가 다른 소스보다 순위가 더 높아야 하는지 여부를 나타내는 데 사용할 수 있는 소스의 중요성입니다.

열거형
DEFAULT
LOW
HIGH

소스CrowdingConfig

검색결과 크라우딩 한도 설정 크라우딩은 동일한 소스 또는 호스트의 여러 결과가 다른 결과로 인해 발생하여 사용자의 검색 품질을 저하시키는 상황입니다. 검색결과의 검색 품질과 소스 다양성을 높이려면 조건을 설정하여 소스별 반복 검색결과를 줄일 수 있습니다.

JSON 표현
{
  "numResults": integer,
  "numSuggestions": integer
}
입력란
numResults

integer

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

numSuggestions

integer

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

점수 구성

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/연산자 이름 조합에 하나의 FacetResult가 있습니다.

JSON 표현
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer
}
입력란
sourceName

string

상품 속성을 적용할 소스 이름입니다. 형식: datasources/{source_id} 비워 두면 모든 데이터 소스가 사용됩니다.

objectType

string

objectType이 설정된 경우 해당 유형의 객체만 상품 속성을 계산하는 데 사용됩니다. 비워 두면 모든 객체가 속성을 계산하는 데 사용됩니다.

operatorName

string

패싯용으로 선택된 연산자의 이름입니다. @see cloudsearch.SchemaPropertyOptions

numFacetBuckets

integer

이 속성에 대해 반환해야 하는 최대 속성 버킷 수입니다. 기본값은 10입니다. 최댓값은 100입니다.

QueryMessagingationConfig

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

JSON 표현
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
입력란
forceVerbatimMode

boolean

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

forceDisableSupplementalResults

boolean

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

메서드

create

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

delete

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

get

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

list

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

reset

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

update

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