- 리소스: SearchApplication
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- DataSourceRestriction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- 출처
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- Source.PredefinedSource
- FilterOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- 필터
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- Filter.ValueFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- Value
- Filter.CompositeFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- Filter.CompositeFilter.LogicOperator
- SourceConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- SourceScoringConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- ScoringConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- SortOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- SortOptions.SortOrder
- FacetOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- IntegerFacetingOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- QueryInterpretationConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON 표현
- 메서드
리소스: SearchApplication
SearchApplication
JSON 표현 |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
필드 | |
---|---|
name |
검색 애플리케이션의 이름입니다. 형식: searchapplications/{applicationId}. |
displayName |
검색 애플리케이션의 표시 이름입니다. 최대 길이는 300자(영문 기준)입니다. |
dataSourceRestrictions[] |
구성에 적용된 제한입니다. 최대 요소 수는 10개입니다. |
sourceConfig[] |
dataSourceRestrictions에 지정된 소스의 구성입니다. |
scoringConfig |
결과의 순위 지정을 위한 구성입니다. |
defaultSortOptions |
검색 결과 정렬을 위한 기본 옵션 |
defaultFacetOptions[] |
패싯 결과를 반환하는 기본 필드입니다. 여기에 지정된 소스는 위의 |
returnResultThumbnailUrls |
각 결과와 함께 썸네일의 URI (해당하는 경우)를 반환해야 합니다. |
operationIds[] |
출력 전용입니다. 현재 이 스키마에 대해 실행 중인 장기 실행 작업 (LRO)의 ID입니다. 출력 전용 필드입니다. |
enableAuditLog |
쿼리 API의 검색 애플리케이션에 대한 요청에 대해 감사 로깅의 사용 설정 여부를 나타냅니다. |
queryInterpretationConfig |
검색어 해석의 기본 옵션 |
DataSourceRestriction
데이터 소스에 대한 제한.
JSON 표현 |
---|
{ "source": { object ( |
필드 | |
---|---|
source |
제한 소스입니다. |
filterOptions[] |
결과를 제한하는 필터 옵션입니다. 필터가 여러 개 있는 경우 조인하기 전에 객체 유형별로 그룹화됩니다. 객체 유형이 동일한 필터는 결합 방식으로 조인되고, 결과 표현식은 분리적으로 조인됩니다. 요소의 최대 개수는 20개입니다. 참고: suggest API는 현재 "objecttype", "type"과 같은 몇 가지 필터만 지원합니다. 'mimetype'이 포함됩니다. 지금은 스키마별 필터를 사용하여 추천을 필터링할 수 없습니다. |
소스
추천/검색 API의 소스를 정의합니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드
|
|
name |
|
predefinedSource |
Google Apps용으로 미리 정의된 콘텐츠 소스입니다. |
Source.PredefinedSource
사전 정의된 소스:
열거형 | |
---|---|
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 ( |
필드 | |
---|---|
objectType |
ObjectType이 설정되면 해당 유형의 객체만 반환됩니다. 스키마 정의 내에 등록된 객체의 이름과 일치해야 합니다. 최대 길이는 256자(영문 기준)입니다. |
filter |
검색을 제한하는 일반 필터(예: |
필터
쿼리에서 필터를 표현하는 일반적인 방법으로, 두 가지 접근 방식을 지원합니다.
1. ValueFilter 설정 이름은 데이터 소스의 스키마에 정의된operatorName과 일치해야 합니다.
2. CompositeFilter 설정 필터는 논리 연산자를 사용하여 평가됩니다. 최상위 연산자는 AND 또는 NOT 중 하나여야 합니다. AND는 최상위 수준에만 표시될 수 있습니다. OR은 최상위 AND 아래에만 표시될 수 있습니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
JSON 표현 |
---|
{
"operatorName": string,
"value": {
object ( |
필드 | |
---|---|
operatorName |
쿼리에 적용된
|
value |
비교할 값입니다. |
값
일반 유형을 사용한 단일 값의 정의입니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드 value . 이름이 지정된 속성의 값입니다. value 은 다음 중 하나여야 합니다. |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
JSON 표현 |
---|
{ "logicOperator": enum ( |
필드 | |
---|---|
logicOperator |
하위 필터의 논리 연산자입니다. |
subFilters[] |
하위 필터 |
Filter.CompositeFilter.LogicOperator
열거형 | |
---|---|
AND |
하위 필터에만 적용할 수 있는 논리 연산자 |
OR |
|
NOT |
단일 하위 필터에만 적용할 수 없습니다. |
SourceConfig
query.search
또는 query.suggest
요청을 처리하는 동안의 소스 구성입니다.
JSON 표현 |
---|
{ "source": { object ( |
필드 | |
---|---|
source |
이 구성이 사용될 소스입니다. |
scoringConfig |
소스의 점수 구성입니다. |
crowdingConfig |
소스의 크라우딩 구성입니다. |
SourceScoringConfig
점수 구성을 설정합니다. 이렇게 하면 소스에 대한 결과의 순위를 수정할 수 있습니다.
JSON 표현 |
---|
{
"sourceImportance": enum ( |
필드 | |
---|---|
sourceImportance |
소스의 중요성입니다. |
SourceScoringConfig.SourceImportance
소스의 중요도로, 소스를 다른 소스보다 더 높은 순위로 표시해야 하는지 여부를 나타내는 데 사용할 수 있습니다.
열거형 | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
검색결과 크라우딩 한도를 설정합니다. 크라우딩은 동일한 소스 또는 호스트의 여러 결과가 '크라우딩'되는 상황입니다. 사용자의 검색 품질이 저하될 수 있습니다. 검색 결과에서 검색 품질과 소스 다양성을 높이기 위해 소스별로 반복되는 결과를 줄이는 조건을 설정할 수 있습니다.
JSON 표현 |
---|
{ "numResults": integer, "numSuggestions": integer } |
필드 | |
---|---|
numResults |
다른 소스의 결과가 소진되지 않는 한 결과 페이지의 데이터 소스에서 허용되는 최대 결과 수입니다. 지정된 값은 음수일 수 없습니다. 이 값이 0과 같으면 기본값이 사용됩니다. 크라우딩을 사용 중지하려면 100보다 큰 값을 설정합니다. |
numSuggestions |
소스에서 허용되는 최대 추천 수입니다. 이 값이 0 이하인 경우 결과에 제한이 설정되지 않습니다. |
ScoringConfig
query.search
또는 query.suggest
요청을 처리하는 동안 소스의 점수 구성
JSON 표현 |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
필드 | |
---|---|
disableFreshness |
최신성을 순위 결정 신호로 사용할지 여부입니다. 기본적으로 최신성은 순위 결정 신호로 사용됩니다. 관리 UI에서는 이 설정을 사용할 수 없습니다. |
disablePersonalization |
결과를 맞춤설정할지 여부입니다. 기본적으로 개인 신호는 검색 결과를 개선하는 데 사용됩니다. |
SortOptions
JSON 표현 |
---|
{
"operatorName": string,
"sortOrder": enum ( |
필드 | |
---|---|
operatorName |
정렬할 필드에 해당하는 연산자의 이름입니다. 관련 속성은 |
sortOrder |
오름차순이 기본 정렬 순서임 |
SortOptions.SortOrder
열거형 | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
패싯 결과를 반환할 연산자를 지정합니다. 모든 sourceName/objectType/operatorName 조합에 대해 하나의 FacetResult가 있습니다.
JSON 표현 |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
필드 | |
---|---|
sourceName |
패싯할 소스 이름입니다. 형식: datasources/{sourceId} 비어 있으면 모든 데이터 소스가 사용됩니다. |
objectType |
ObjectType이 설정되면 해당 유형의 객체만 패싯 계산에 사용됩니다. 비어 있으면 모든 객체가 패싯을 계산하는 데 사용됩니다. |
operatorName |
패싯 생성에 선택된 연산자의 이름입니다. @cloudsearch.SchemaPropertyOptions 참조 |
numFacetBuckets |
이 상품 속성에 대해 반환해야 하는 최대 상품 속성 버킷 수입니다. 기본값은 10입니다. 최댓값은 100입니다. |
integerFacetingOptions |
설정하는 경우 지정된 정수 속성의 정수 패싯 생성 옵션을 설명합니다. 스키마의 해당 정수 속성이 isFacetable로 표시되어야 합니다. 반환되는 버킷 수는 최소 이 및 numFacetBuckets입니다. |
IntegerFacetingOptions
정수 패싯 생성 옵션을 지정하는 데 사용됩니다.
JSON 표현 |
---|
{ "integerBuckets": [ string ] } |
필드 | |
---|---|
integerBuckets[] |
지정된 정수 값의 버킷은 엄격하게 오름차순이어야 합니다. 예를 들어 제공된 값이 (1,5,10,100)이면 다음 패싯 버킷은 {<1, [1,5), [5-10), [10-100), >=100}으로 구성됩니다. |
QueryInterpretationConfig
사용자 검색어를 해석하는 기본 옵션입니다.
JSON 표현 |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
필드 | |
---|---|
forceVerbatimMode |
이 플래그를 사용 설정하면 검색어의 자연어 (NL) 해석, 보조 결과 검색, 커스텀 동의어를 포함한 동의어 사용과 같은 모든 내부 최적화를 사용 중지할 수 있습니다. 이 플래그를 True로 설정하면 쿼리 수준에서 설정된 옵션보다 우선 적용됩니다. 기본값인 False인 경우 검색어 수준 플래그는 그대로의 올바른 해석을 설정합니다. |
forceDisableSupplementalResults |
보조 결과 검색을 사용하지 않으려면 이 플래그를 설정합니다. 여기에 플래그를 설정해도 지정된 검색 애플리케이션과 관련된 검색어에 대한 보충 결과는 검색되지 않습니다. 이 플래그를 True로 설정하면 쿼리 수준에서 설정된 옵션보다 우선 적용됩니다. 기본값인 False인 경우 검색어 수준 플래그가 추가 결과에 대한 올바른 해석을 설정합니다. |
메서드 |
|
---|---|
|
검색 애플리케이션을 만듭니다. |
|
검색 애플리케이션을 삭제합니다. |
|
지정된 검색 애플리케이션을 가져옵니다. |
|
모든 검색 애플리케이션을 나열합니다. |
|
검색 애플리케이션을 업데이트합니다. |
|
검색 애플리케이션을 기본 설정으로 재설정합니다. |
|
검색 애플리케이션을 업데이트합니다. |