- Ресурс: SearchApplication
- Ограничение источника данных
- Источник
- Источник.PredefineSource
- Параметры фильтра
- Фильтр
- Фильтр.ValueFilter
- Ценить
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- Исходная конфигурация
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- ИсточникCrowdingConfig
- Конфигурация оценки
- Параметры сортировки
- SortOptions.SortOrder
- Параметры Facet
- Целочисленные параметры Faceting
- Конфигурация запросаинтерпретации
- Методы
Ресурс: SearchApplication
ПоискПриложения
JSON-представление |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Поля | |
---|---|
name | Имя приложения поиска. Формат: searchapplications/{applicationId}. |
displayName | Отображаемое имя приложения поиска. Максимальная длина — 300 символов. |
dataSourceRestrictions[] | К конфигурациям применяются ограничения. Максимальное количество элементов — 10. |
sourceConfig[] | Конфигурация источников, указанных в dataSourceRestrictions. |
scoringConfig | Конфигурация для ранжирования результатов. |
defaultSortOptions | Параметры по умолчанию для сортировки результатов поиска |
defaultFacetOptions[] | Поля по умолчанию для возврата результатов фасета. Указанные здесь источники также были включены в |
returnResultThumbnailUrls | С каждым результатом мы должны возвращать URI для его миниатюры (если применимо). |
operationIds[] | Только вывод. Идентификаторы длительных операций (LRO), которые в данный момент выполняются для этой схемы. Поле только для вывода. |
enableAuditLog | Указывает, включено или выключено ведение журнала аудита для запросов, сделанных для приложения поиска в API запросов. |
queryInterpretationConfig | Параметры по умолчанию для интерпретации запроса |
Ограничение источника данных
Ограничение источника данных.
JSON-представление |
---|
{ "source": { object ( |
Поля | |
---|---|
source | Источник ограничения. |
filterOptions[] | Параметры фильтра, ограничивающие результаты. Если присутствует несколько фильтров, перед объединением они группируются по типу объекта. Фильтры с одинаковым типом объекта соединяются конъюнктивно, затем полученные выражения соединяются дизъюнктивно. Максимальное количество элементов — 20. ПРИМЕЧАНИЕ. На данный момент API предложения поддерживает только несколько фильтров: «тип объекта», «тип» и «тип MIME». На данный момент фильтры, специфичные для схемы, нельзя использовать для фильтрации предложений. |
Источник
Определяет источники для API предложения/поиска.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
name | Имя источника контента, проиндексированного |
predefinedSource | Предопределенный источник контента для Google Apps. |
Источник.PredefineSource
Предопределенные источники:
Перечисления | |
---|---|
NONE | |
QUERY_HISTORY | Предлагает запросы, заданные пользователем в прошлом. Действует только при использовании с API предложения. Игнорируется при использовании в API запросов. |
PERSON | Предлагает людей в организации. Действует только при использовании с API предложения. Приводит к ошибке при использовании в API запроса. |
GOOGLE_DRIVE | |
GOOGLE_GMAIL | |
GOOGLE_SITES | |
GOOGLE_GROUPS | |
GOOGLE_CALENDAR | |
GOOGLE_KEEP |
Параметры фильтра
Параметры фильтра, которые будут применяться к запросу.
JSON-представление |
---|
{
"objectType": string,
"filter": {
object ( |
Поля | |
---|---|
objectType | Если установлен objectType, возвращаются только объекты этого типа. Оно должно соответствовать имени объекта, зарегистрированного в определении схемы. Максимальная длина — 256 символов. |
filter | Общий фильтр для ограничения поиска, например |
Фильтр
Общий способ выражения фильтров в запросе, который поддерживает два подхода:
1. Установка фильтра значений. Имя должно соответствовать имени оператора, определенному в схеме вашего источника данных.
2. Установка CompositeFilter. Фильтры оцениваются с помощью логического оператора. Операторами верхнего уровня могут быть только И или НЕ. AND может появиться только на самом верхнем уровне. OR может появляться только под оператором AND верхнего уровня.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
valueFilter | |
compositeFilter | |
Фильтр.ValueFilter
JSON-представление |
---|
{
"operatorName": string,
"value": {
object ( |
Поля | |
---|---|
operatorName |
|
value | Значение, с которым необходимо сравнить. |
Ценить
Определение одного значения универсального типа.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
value поля объединения. Значение именованного свойства. value может быть только одним из следующих: | |
stringValue | |
integerValue | |
doubleValue | |
timestampValue | Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
booleanValue | |
dateValue | |
Filter.CompositeFilter
JSON-представление |
---|
{ "logicOperator": enum ( |
Поля | |
---|---|
logicOperator | Логический оператор подфильтра. |
subFilters[] | Подфильтры. |
Filter.CompositeFilter.LogicOperator
Перечисления | |
---|---|
AND | Логические операторы, которые можно применять только к подфильтрам. |
OR | |
NOT | NOT можно применить только к одному подфильтру. |
Исходная конфигурация
Конфигурации источника при обработке запроса query.search
или query.suggest
.
JSON-представление |
---|
{ "source": { object ( |
Поля | |
---|---|
source | Источник, для которого будет использоваться эта конфигурация. |
scoringConfig | Конфигурация оценки для источника. |
crowdingConfig | Конфигурация переполнения для источника. |
SourceScoringConfig
Установите конфигурацию оценки. Это позволяет изменить рейтинг результатов для источника.
JSON-представление |
---|
{
"sourceImportance": enum ( |
Поля | |
---|---|
sourceImportance | Важность источника. |
SourceScoringConfig.SourceImportance
Важность источника, которую можно использовать, чтобы указать, следует ли дать источнику больший приоритет в рейтинге по сравнению с другим источником.
Перечисления | |
---|---|
DEFAULT | |
LOW | |
HIGH |
ИсточникCrowdingConfig
Установите ограничения на переполненность результатов поиска. Краудинг – это ситуация, в которой несколько результатов из одного и того же источника или хоста "вытесняют" другие результаты, снижая качество поиска для пользователей. Чтобы повысить качество поиска и разнообразие источников в результатах поиска, вы можете установить условие для уменьшения повторяющихся результатов по источникам.
JSON-представление |
---|
{ "numResults": integer, "numSuggestions": integer } |
Поля | |
---|---|
numResults | Максимальное количество результатов, разрешенное из источника данных на странице результатов, если не исчерпаны результаты из других источников. Указанное значение не должно быть отрицательным. Используется значение по умолчанию, если это значение равно 0. Чтобы отключить скопление, установите значение больше 100. |
numSuggestions | Максимально допустимое количество предложений от источника. Никакие ограничения не будут установлены на результаты, если это значение меньше или равно 0. |
Конфигурация оценки
Оценка конфигураций источника при обработке запроса query.search
или query.suggest
.
JSON-представление |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
Поля | |
---|---|
disableFreshness | Стоит ли использовать свежесть в качестве сигнала ранжирования. По умолчанию свежесть используется в качестве сигнала ранжирования. Обратите внимание, что этот параметр недоступен в пользовательском интерфейсе администратора. |
disablePersonalization | Персонализировать ли результаты. По умолчанию для повышения результатов будут использоваться личные сигналы. |
Параметры сортировки
JSON-представление |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Поля | |
---|---|
operatorName | Имя оператора, соответствующего полю для сортировки. Соответствующее свойство должно быть помечено как |
sortOrder | По возрастанию — порядок сортировки по умолчанию. |
SortOptions.SortOrder
Перечисления | |
---|---|
ASCENDING | |
DESCENDING |
Параметры Facet
Указывает операторов, для которых возвращаются результаты фасета. Для каждой комбинации sourceName/objectType/operatorName будет один FacetResult.
JSON-представление |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Поля | |
---|---|
sourceName | Имя источника для фасета. Формат: datasources/{sourceId} Если пусто, будут использоваться все источники данных. |
objectType | Если параметр objectType установлен, для вычисления фасетов будут использоваться только объекты этого типа. Если пусто, то для вычисления фасетов будут использоваться все объекты. |
operatorName | Имя оператора, выбранного для фасетирования. @see Cloudsearch.SchemaPropertyOptions |
numFacetBuckets | Максимальное количество сегментов фасета, которое должно быть возвращено для этого фасета. По умолчанию — 10. Максимальное значение — 100. |
integerFacetingOptions | Если установлено, описывает параметры целочисленного фасета для данного целочисленного свойства. Соответствующее целочисленное свойство в схеме должно быть помечено isFacetable. Количество возвращаемых сегментов будет минимальным из этого и numFacetBuckets. |
Целочисленные параметры Faceting
Используется для указания целочисленных параметров фасета.
JSON-представление |
---|
{ "integerBuckets": [ string ] } |
Поля | |
---|---|
integerBuckets[] | Сегменты для заданных целочисленных значений должны располагаться строго в порядке возрастания. Например, если предоставлены значения (1,5,10,100), будут сформированы следующие сегменты фасетов {<1, [1,5), [5-10), [10-100), >=100}. |
Конфигурация запросаинтерпретации
Параметры по умолчанию для интерпретации запроса пользователя.
JSON-представление |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
Поля | |
---|---|
forceVerbatimMode | Включите этот флаг, чтобы отключить все внутренние оптимизации, такие как интерпретация запросов на естественном языке (NL), получение дополнительных результатов и использование синонимов, включая пользовательские. Если для этого флага установлено значение True, он будет иметь приоритет над параметром, установленным на уровне запроса. При значении по умолчанию False флаг уровня запроса установит правильную интерпретацию для дословного режима. |
forceDisableSupplementalResults | Установите этот флаг, чтобы отключить получение дополнительных результатов. Установка флага здесь не приведет к получению дополнительных результатов для запросов, связанных с данным поисковым приложением. Если для этого флага установлено значение True, он будет иметь приоритет над параметром, установленным на уровне запроса. При значении по умолчанию False флаг уровня запроса установит правильную интерпретацию дополнительных результатов. |
Методы | |
---|---|
| Создает поисковое приложение. |
| Удаляет приложение поиска. |
| Получает указанное приложение поиска. |
| Перечисляет все поисковые приложения. |
| Обновляет приложение поиска. |
| Сбрасывает приложение поиска к настройкам по умолчанию. |
| Обновляет приложение поиска. |