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), которые в данный момент выполняются для этой схемы. Поле только для вывода.

enableAuditLog

boolean

Указывает, включено или выключено ведение журнала аудита для запросов, сделанных для приложения поиска в API запросов.

queryInterpretationConfig

object ( QueryInterpretationConfig )

Параметры по умолчанию для интерпретации запроса

Ограничение источника данных

Ограничение источника данных.

JSON-представление 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Поля
source

object ( Source )

Источник ограничения.

filterOptions[]

object ( FilterOptions )

Параметры фильтра, ограничивающие результаты. Если присутствует несколько фильтров, перед объединением они группируются по типу объекта. Фильтры с одинаковым типом объекта соединяются конъюнктивно, затем полученные выражения соединяются дизъюнктивно.

Максимальное количество элементов — 20.

ПРИМЕЧАНИЕ. На данный момент API предложения поддерживает только несколько фильтров: «тип объекта», «тип» и «тип MIME». На данный момент фильтры, специфичные для схемы, нельзя использовать для фильтрации предложений.

Источник

Определяет источники для 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.

Источник.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 (Filter)
  }
}
Поля
objectType

string

Если установлен objectType, возвращаются только объекты этого типа. Оно должно соответствовать имени объекта, зарегистрированного в определении схемы. Максимальная длина — 256 символов.

filter

object ( Filter )

Общий фильтр для ограничения поиска, например lang:en , site:xyz .

Фильтр

Общий способ выражения фильтров в запросе, который поддерживает два подхода:

1. Установка фильтра значений. Имя должно соответствовать имени оператора, определенному в схеме вашего источника данных.

2. Установка CompositeFilter. Фильтры оцениваются с помощью логического оператора. Операторами верхнего уровня могут быть только И или НЕ. 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 )

Фильтр.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 «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "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 можно применить только к одному подфильтру.

Исходная конфигурация

Конфигурации источника при обработке запроса 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

ИсточникCrowdingConfig

Установите ограничения на переполненность результатов поиска. Краудинг – это ситуация, в которой несколько результатов из одного и того же источника или хоста "вытесняют" другие результаты, снижая качество поиска для пользователей. Чтобы повысить качество поиска и разнообразие источников в результатах поиска, вы можете установить условие для уменьшения повторяющихся результатов по источникам.

JSON-представление 
{
  "numResults": integer,
  "numSuggestions": integer
}
Поля
numResults

integer

Максимальное количество результатов, разрешенное из источника данных на странице результатов, если не исчерпаны результаты из других источников. Указанное значение не должно быть отрицательным. Используется значение по умолчанию, если это значение равно 0. Чтобы отключить скопление, установите значение больше 100.

numSuggestions

integer

Максимально допустимое количество предложений от источника. Никакие ограничения не будут установлены на результаты, если это значение меньше или равно 0.

Конфигурация оценки

Оценка конфигураций источника при обработке запроса query.search или query.suggest .

JSON-представление 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Поля
disableFreshness

boolean

Использовать ли свежесть в качестве сигнала ранжирования. По умолчанию свежесть используется в качестве сигнала ранжирования. Обратите внимание, что этот параметр недоступен в пользовательском интерфейсе администратора.

disablePersonalization

boolean

Персонализировать ли результаты. По умолчанию для повышения результатов будут использоваться личные сигналы.

Параметры сортировки

JSON-представление 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Поля
operatorName

string

Имя оператора, соответствующего полю для сортировки. Соответствующее свойство должно быть помечено как sortable .

sortOrder

enum ( SortOptions.SortOrder )

По возрастанию — порядок сортировки по умолчанию.

SortOptions.SortOrder

Перечисления
ASCENDING
DESCENDING

Параметры Facet

Указывает операторов, для которых возвращаются результаты фасета. Для каждой комбинации 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.

Целочисленные параметры Faceting

Используется для указания целочисленных параметров фасета.

JSON-представление 
{
  "integerBuckets": [
    string
  ]
}
Поля
integerBuckets[]

string ( Int64Value format)

Сегменты для заданных целочисленных значений должны располагаться строго в порядке возрастания. Например, если предоставлены значения (1,5,10,100), будут сформированы следующие сегменты фасетов {<1, [1,5), [5-10), [10-100), >=100}.

Конфигурация запросаинтерпретации

Параметры по умолчанию для интерпретации запроса пользователя.

JSON-представление 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Поля
forceVerbatimMode

boolean

Включите этот флаг, чтобы отключить все внутренние оптимизации, такие как интерпретация запросов на естественном языке (NL), получение дополнительных результатов и использование синонимов, включая пользовательские. Если для этого флага установлено значение True, он будет иметь приоритет над параметром, установленным на уровне запроса. При значении по умолчанию False флаг уровня запроса установит правильную интерпретацию для дословного режима.

forceDisableSupplementalResults

boolean

Установите этот флаг, чтобы отключить получение дополнительных результатов. Установка флага здесь не приведет к получению дополнительных результатов для запросов, связанных с данным поисковым приложением. Если для этого флага установлено значение True, он будет иметь приоритет над параметром, установленным на уровне запроса. При значении по умолчанию False флаг уровня запроса установит правильную интерпретацию дополнительных результатов.

Методы

create

 Создает поисковое приложение.

delete

 Удаляет приложение поиска.

get

 Получает указанное приложение поиска.

list

 Перечисляет все поисковые приложения.

patch

 Обновляет приложение поиска.

reset

 Сбрасывает приложение поиска к настройкам по умолчанию.

update

 Обновляет приложение поиска.