Schema

Определение схемы для источника данных.

JSON-представление 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Поля
objectDefinitions[]

object ( ObjectDefinition )

Список объектов верхнего уровня для источника данных. Максимальное количество элементов — 10.

operationIds[]

string

Идентификаторы длительных операций (LRO), которые в данный момент выполняются для этой схемы. После изменения схемы дождитесь завершения операций, прежде чем индексировать дополнительный контент.

Определение объекта

Определение объекта в источнике данных.

JSON-представление 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Поля
name

string

Имя объекта, которое затем определяет его тип. Запросы на индексирование элементов должны устанавливать поле objectType равным этому значению. Например, если name — Document , то запросы индексации для элементов типа Document должны устанавливать objectType равным Document . Каждое определение объекта должно иметь уникальное имя в схеме. Имя должно начинаться с буквы и может содержать только буквы (AZ, az) или цифры (0–9). Максимальная длина — 256 символов.

options

object ( ObjectOptions )

Дополнительные параметры, специфичные для объекта.

propertyDefinitions[]

object ( PropertyDefinition )

Определения свойств объекта. Максимальное количество элементов — 1000.

Параметры объекта

Варианты объекта.

JSON-представление 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Поля
freshnessOptions

object ( ObjectOptions.FreshnessOptions )

Параметры свежести объекта.

displayOptions

object ( ObjectDisplayOptions )

Параметры, определяющие способ отображения объекта на странице результатов Cloud Search.

suggestionFilteringOperators[]

string

Операторы, которые можно использовать для фильтрации предложений. Для API query.suggest в FilterOptions будут учитываться только операторы, упомянутые здесь. Поддерживаются только операторы TEXT и ENUM.

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

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

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

ObjectOptions.FreshnessOptions

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

JSON-представление 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Поля
freshnessProperty

string

Это свойство указывает уровень актуальности объекта в индексе. Если установлено, это свойство должно быть свойством верхнего уровня в property definitions и должно быть timestamp type или date type . В противном случае API индексирования использует updateTime в качестве индикатора актуальности. Максимальная длина — 256 символов.

Когда свойство используется для расчета актуальности, значение по умолчанию составляет 2 года с текущего времени.

freshnessDuration

string ( Duration format)

Продолжительность, по истечении которой объект следует считать устаревшим. Значение по умолчанию — 180 дней (в секундах).

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Параметры объектадисплея

Параметры отображения объекта.

JSON-представление 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Поля
objectDisplayLabel

string

Удобная для пользователя метка, отображаемая в результатах поиска и указывающая тип элемента. Это НЕОБЯЗАТЕЛЬНО; если он не указан, метка объекта не отображается в контекстной строке результатов поиска. Максимальная длина — 64 символа.

metalines[]

object ( ObjectDisplayOptions.Metaline )

Определяет свойства, отображаемые в металиниях результатов поиска. Значения свойств отображаются в указанном здесь порядке. Если свойство содержит несколько значений, все значения отображаются перед следующими свойствами. По этой причине рекомендуется указывать единичные свойства перед повторяющимися свойствами в этом списке. Для всех свойств необходимо установить для isReturnable значение true. Максимальное количество металинов — 3.

ObjectDisplayOptions.Metaline

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

JSON-представление 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Поля
properties[]

object ( ObjectDisplayOptions.DisplayedProperty )

Список отображаемых свойств металина. Максимальное количество объектов — 5.

ObjectDisplayOptions.DisplayedProperty

Ссылка на свойство верхнего уровня внутри объекта, которое должно отображаться в результатах поиска. Значения выбранных свойств отображаются в результатах поиска вместе с display label для этого свойства, если она указана. Если метка отображения не указана, отображаются только значения.

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

string

Имя свойства верхнего уровня, определенное в определении свойства объекта. Если имя не является определенным свойством в схеме, при попытке обновления схемы выдается ошибка.

Определение свойства

Определение свойства внутри объекта.

JSON-представление 
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
Поля
name

string

Название объекта недвижимости. Запросы на индексирование элементов, отправленные в API индексирования, должны устанавливать property name , равное этому значению. Например, если имя — subject_line , то запросы индексирования для элементов документа с полями темы должны устанавливать name для этого поля равным subject_line . Используйте имя в качестве идентификатора свойства объекта. После регистрации в качестве свойства объекта вы не сможете повторно использовать это имя для другого свойства внутри этого объекта. Имя должно начинаться с буквы и может содержать только буквы (AZ, az) или цифры (0–9). Максимальная длина — 256 символов.

isReturnable

boolean

Указывает, что свойство идентифицирует данные, которые должны быть возвращены в результатах поиска через API запросов. Если установлено значение true , это означает, что пользователи Query API могут использовать в результатах соответствующие поля свойств. Однако для хранения полей требуется больше места и используется большая пропускная способность для поисковых запросов, что влияет на производительность при работе с большими наборами данных. Установите здесь значение true , только если поле необходимо для результатов поиска. Не может быть истиной для свойств, тип которых является объектом.

isRepeatable

boolean

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

isSortable

boolean

Указывает, что свойство можно использовать для сортировки. Не может быть верным для повторяющихся свойств. Не может быть истиной для свойств, тип которых — объект. Чтобы установить эту опцию, IsReturnable должно иметь значение true. Поддерживается только для логических свойств, свойств даты, двойного значения, целого числа и метки времени.

isFacetable

boolean

Указывает, что свойство можно использовать для создания фасетов. Не может быть истинным для свойств, тип которых — объект. Чтобы установить эту опцию, IsReturnable должно иметь значение true. Поддерживается только для логических, перечислимых, целочисленных и текстовых свойств.

isSuggestable

boolean

Указывает, что свойство можно использовать для создания предложений запроса.

isWildcardSearchable

boolean

Указывает, что пользователи могут выполнять поиск по подстановочным знакам для этого свойства. Поддерживается только для свойств текста. Чтобы установить эту опцию, IsReturnable должно иметь значение true. В данном источнике данных максимум 5 свойств могут быть помечены как isWildcardSearchable. Дополнительные сведения см. в разделе Определение свойств объекта.

displayOptions

object ( PropertyDisplayOptions )

Параметры, определяющие способ отображения свойства на странице результатов Cloud Search, если его отображение указано в display options объекта.

Поле объединения property_options . Параметры, зависящие от типа, которые определяют, как свойство индексируется и используется. В случае, когда параметры должны быть параметрами по умолчанию для типа, в этом поле все равно должен быть установлен один из типов. Если это поле не установлено, обновления схемы отклоняются. property_options может быть только одним из следующих:
integerPropertyOptions

object ( IntegerPropertyOptions )

doublePropertyOptions

object ( DoublePropertyOptions )

timestampPropertyOptions

object ( TimestampPropertyOptions )

booleanPropertyOptions

object ( BooleanPropertyOptions )

objectPropertyOptions

object ( ObjectPropertyOptions )

enumPropertyOptions

object ( EnumPropertyOptions )

datePropertyOptions

object ( DatePropertyOptions )

textPropertyOptions

object ( TextPropertyOptions )

htmlPropertyOptions

object ( HtmlPropertyOptions )

Целочисленные свойстваварианты

Параметры целочисленных свойств.

JSON-представление 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Поля
orderedRanking

enum ( IntegerPropertyOptions.OrderedRanking )

Используется для указания упорядоченного ранга целого числа. Можно использовать только в том случае, если isRepeatable имеет значение false.

minimumValue

string ( Int64Value format)

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

maximumValue

string ( Int64Value format)

Максимальная стоимость недвижимости. Минимальное и максимальное значения свойства используются для ранжирования результатов в соответствии с ordered ranking . Запросы на индексирование со значениями, превышающими максимальное, принимаются и ранжируются с тем же весом, что и элементы, проиндексированные с максимальным значением.

operatorOptions

object ( IntegerPropertyOptions.IntegerOperatorOptions )

Если установлено, описывает, как целое число следует использовать в качестве оператора поиска.

integerFacetingOptions

object ( IntegerFacetingOptions )

Если установлено, описывает параметры целочисленного фасета для данного целочисленного свойства. Соответствующее целочисленное свойство должно быть помечено isFacetable.

IntegerPropertyOptions.OrderedRanking

Используется для указания ранжирования целочисленного значения относительно других значений. Целое число с более высоким рангом предполагает большую важность. Например, в некоторых источниках данных более низкий приоритет указывает на более высокую важность, а в других более высокий приоритет указывает на более высокую важность.

Перечисления
NO_ORDER Для объекта нет ранжирования. Результаты не корректируются по значению этого свойства.
ASCENDING Это свойство ранжируется в порядке возрастания. Более низкие значения указывают на более низкий рейтинг.
DESCENDING Это свойство ранжируется в порядке убывания. Более низкие значения указывают на более высокий рейтинг.

IntegerPropertyOptions.IntegerOperatorOptions

Используется для предоставления оператора поиска для целочисленных свойств. Это необязательно. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента.

JSON-представление 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Поля
operatorName

string

Указывает имя оператора, необходимое в запросе для изоляции целочисленного свойства. Например, если имя оператора имеет значение Priority , а имя свойства — PriorityVal , то запросы типа Priority:<value> отображают результаты только в том случае, если значение свойства с именем PriorityVal соответствует <value> . Напротив, поиск, использующий одно и то же <value> без оператора, возвращает все элементы, где <value> соответствует значению любых строковых свойств или текста в поле содержимого для элемента. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

lessThanOperatorName

string

Указывает имя оператора, необходимое в запросе для изоляции целочисленного свойства с помощью оператора «меньше». Например, если lessThanOperatorName имеет значение PriorityBelow , а имя свойства — PriorityVal , то такие запросы, как Prioritybelow:<value>, отображают результаты только в том случае, если значение свойства с именем PriorityVal меньше, чем <value> . Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

greaterThanOperatorName

string

Указывает имя оператора, необходимое в запросе для изоляции целочисленного свойства с помощью оператора «больше». Например, если значение greatThanOperatorName имеет значение PriorityAbove , а имя свойства — PriorityVal , то такие запросы, как Priorityabove:<value>, отображают результаты только в том случае, если значение свойства с именем PriorityVal больше, чем <value> . Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

Даблпропертиоптионс

Варианты для двойных свойств.

JSON-представление 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Поля
operatorOptions

object ( DoublePropertyOptions.DoubleOperatorOptions )

Если установлено, описывает, как двойной оператор следует использовать в качестве оператора поиска.

DoublePropertyOptions.DoubleOperatorOptions

Используется для предоставления оператора поиска для двойных свойств. Это необязательно. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента.

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

string

Указывает имя оператора, необходимое в запросе для использования свойства double при сортировке или в качестве фасета. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

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

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

JSON-представление 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Поля
operatorOptions

object ( TimestampPropertyOptions.TimestampOperatorOptions )

Если установлено, описывает, как метка времени должна использоваться в качестве оператора поиска.

TimestampPropertyOptions.TimestampOperatorOptions

Используется для предоставления оператора поиска для свойств метки времени. Это необязательно. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента.

JSON-представление 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Поля
operatorName

string

Указывает имя оператора, необходимое в запросе для изоляции свойства отметки времени. Например, если имя оператора — closeon , а имя свойства — closeDate , то запросы типа closeon:<value> отображают результаты только в том случае, если значение свойства с именем closeDate соответствует <value> . Напротив, поиск, использующий одно и то же <value> без оператора, возвращает все элементы, где <value> соответствует значению любых строковых свойств или текста в поле содержимого для элемента. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

lessThanOperatorName

string

Указывает имя оператора, необходимое в запросе для изоляции свойства отметки времени с помощью оператора «меньше». Например, если lessThanOperatorName закрыто до и имя свойства — closeDate , то запросы типа closebefore:<value> отображают результаты только в том случае, если значение свойства с именем closeDate раньше, чем <value> . Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

greaterThanOperatorName

string

Указывает имя оператора, необходимое в запросе для изоляции свойства отметки времени с помощью оператора «больше». Например, если значение GreatThanOperatorName закрыто , а имя свойства — closeDate , то такие запросы, как closeafter:<value>, отображают результаты только в том случае, если значение свойства с именем closeDate позже, чем <value> . Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

BooleanPropertyOptions

Параметры логических свойств.

JSON-представление 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Поля
operatorOptions

object ( BooleanPropertyOptions.BooleanOperatorOptions )

Если установлено, описывает, как логическое значение следует использовать в качестве оператора поиска.

BooleanPropertyOptions.BooleanOperatorOptions

Используется для предоставления оператора поиска для логических свойств. Это необязательно. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента.

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

string

Указывает имя оператора, необходимое в запросе для изоляции логического свойства. Например, если имя оператора закрыто , а имя свойства — isClosed , то запросы вида close:<value> отображают результаты только в том случае, если значение свойства с именем isClosed соответствует <value> . Напротив, поиск, использующий одно и то же <value> без оператора, возвращает все элементы, где <value> соответствует значению любых строковых свойств или текста в поле содержимого для элемента. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

Параметры объектасвойства

Параметры свойств объекта.

JSON-представление 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Поля
subobjectProperties[]

object ( PropertyDefinition )

Свойства подобъекта. Эти свойства представляют собой вложенный объект. Например, если это свойство представляет почтовый адрес, подобъектProperties может называться street , city и state . Максимальное количество элементов — 1000.

EnumPropertyOptions

Параметры свойств перечисления, которые позволяют вам определить ограниченный набор строк для соответствия запросам пользователей, установить ранжирование для этих строковых значений и определить имя оператора, которое будет сочетаться с этими строками, чтобы пользователи могли сузить результаты до элементов с конкретная ценность. Например, для элементов в системе отслеживания запросов с информацией о приоритете вы можете определить p0 как допустимое значение перечисления и связать это перечисление с приоритетом имени оператора, чтобы пользователи поиска могли добавлять Priority:p0 в свой запрос, чтобы ограничить набор результатов. только к тем элементам, которые проиндексированы значением p0 .

JSON-представление 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Поля
possibleValues[]

object ( EnumPropertyOptions.EnumValuePair )

Список возможных значений свойства перечисления. Все EnumValuePairs должны предоставлять строковое значение. Если вы указываете целочисленное значение для одной EnumValuePair, то все возможные EnumValuePairs должны предоставлять целочисленное значение. И строковое, и целочисленное значение должны быть уникальными среди всех возможных значений. После установки возможные значения не могут быть удалены или изменены. Если вы предоставляете упорядоченный ранжирование и думаете, что в будущем вы можете вставить дополнительные значения перечисления, оставьте пробелы в исходных целочисленных значениях, чтобы можно было добавить значение между ранее зарегистрированными значениями. Максимальное количество элементов — 100.

orderedRanking

enum ( EnumPropertyOptions.OrderedRanking )

Используется для указания упорядоченного ранжирования перечисления, которое определяет, как целочисленные значения, представленные в возможных EnumValuePairs, используются для ранжирования результатов. Если указано, целочисленные значения должны быть предоставлены для всех возможных значений EnumValuePair, заданных для этого свойства. Можно использовать только в том случае, если isRepeatable имеет значение false.

operatorOptions

object ( EnumPropertyOptions.EnumOperatorOptions )

Если установлено, описывает, как перечисление следует использовать в качестве оператора поиска.

EnumPropertyOptions.EnumValuePair

Пара значений перечисления определяет две вещи: обязательное строковое значение и необязательное целочисленное значение. Строковое значение определяет необходимый термин запроса, необходимый для получения этого элемента, например p0 для приоритетного элемента. Целочисленное значение определяет ранг этого строкового значения относительно других перечисляемых значений того же свойства. Например, вы можете связать p0 с 0 и определить другую пару перечислений, например p1 и 1 . Вы должны использовать целочисленное значение в сочетании с ordered ranking , чтобы установить рейтинг данного значения относительно других перечисляемых значений для того же имени свойства. Здесь порядок ранжирования ПО УБЫТКУ для приоритетных свойств приводит к повышению рейтинга для элементов, индексированных значением p0 , по сравнению с элементами, индексированными значением p1 . Без определенного порядка ранжирования целочисленное значение не влияет на ранжирование элемента.

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

string

Строковое значение EnumValuePair. Максимальная длина — 32 символа.

integerValue

integer

Целочисленное значение EnumValuePair, которое должно быть неотрицательным. Необязательный.

EnumPropertyOptions.OrderedRanking

Используется для указания направления ранжирования целого числа EnumValuePair относительно других целочисленных значений EnumValuePair. Для некоторых свойств более низкие целые значения указывают на более высокую важность, тогда как для других более высокие целые числа указывают на более высокую важность.

Перечисления
NO_ORDER Для объекта нет ранжирования. Результаты не корректируются по значению этого свойства.
ASCENDING Это свойство ранжируется в порядке возрастания. Более низкие значения указывают на более низкий рейтинг.
DESCENDING Это свойство ранжируется в порядке убывания. Более низкие значения указывают на более высокий рейтинг.

EnumPropertyOptions.EnumOperatorOptions

Используется для предоставления оператора поиска для свойств перечисления. Это необязательно. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента. Например, если вы не предоставляете оператор для свойства перечисления приоритета с возможными значениями p0 и p1 , запрос, содержащий термин p0, возвращает элементы, у которых p0 является значением свойства приоритета , а также любые элементы, содержащие строку p0. в других областях. Если вы укажете имя оператора для перечисления, например, Priority , то пользователи поиска смогут использовать этот оператор для уточнения результатов только для элементов, которые имеют p0 в качестве значения этого свойства, с помощью запроса Priority:p0 .

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

string

Указывает имя оператора, необходимое в запросе для изоляции свойства перечисления. Например, если имя оператора имеет значение Priority , а имя свойства — PriorityVal , то запросы типа Priority:<value> отображают результаты только в том случае, если значение свойства с именем PriorityVal соответствует <value> . Напротив, поиск, использующий одно и то же <value> без оператора, возвращает все элементы, где <value> соответствует значению любых свойств String или тексту в поле содержимого для элемента. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

Параметры датысвойства

Параметры свойств даты.

JSON-представление 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Поля
operatorOptions

object ( DatePropertyOptions.DateOperatorOptions )

Если установлено, описывает, как дату следует использовать в качестве оператора поиска.

DatePropertyOptions.DateOperatorOptions

Необязательный. Предоставляет оператор поиска для свойств даты. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента.

JSON-представление 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Поля
operatorName

string

Указывает фактическую строку, необходимую в запросе для изоляции свойства даты. Например, предположим, что объект схемы отслеживания проблем имеет свойство с именем closeDate , которое определяет оператор с именем оператора closeon . При поиске по этим данным такие запросы, как closeon:<value>, показывают результаты только в том случае, если значение свойства closeDate соответствует <value> . Напротив, поиск, в котором используется одно и то же <value> без оператора, возвращает все элементы, где <value> соответствует значению любых строковых свойств или текста в поле содержимого для индексированного источника данных. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

lessThanOperatorName

string

Указывает имя оператора, необходимое в запросе для изоляции свойства даты с помощью оператора «меньше». Например, если lessThanOperatorName закрыто до и имя свойства — closeDate , то запросы типа closebefore:<value> отображают результаты только в том случае, если значение свойства с именем closeDate раньше, чем <value> . Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

greaterThanOperatorName

string

Указывает имя оператора, необходимое в запросе для изоляции свойства даты с помощью оператора «больше». Например, если moreThanOperatorName закрыто после и имя свойства — closeDate , то такие запросы, как closeafter:<value>, отображают результаты только в том случае, если значение свойства с именем closeDate позже, чем <value> . Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

Текстпропертиварианты

Параметры свойств текста.

JSON-представление 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Поля
retrievalImportance

object ( RetrievalImportance )

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

operatorOptions

object ( TextPropertyOptions.TextOperatorOptions )

Если установлено, описывает, как свойство следует использовать в качестве оператора поиска.

ИзвлечениеВажность

JSON-представление 
{
  "importance": enum (RetrievalImportance.Importance)
}
Поля
importance

enum ( RetrievalImportance.Importance )

Указывает ранжирующую важность, придаваемую свойству при его сопоставлении во время поиска. После установки важность токена свойства не может быть изменена.

ПолучениеImportance.Importance

Перечисления
DEFAULT Рассматривайте совпадение как совпадение основного текста.
HIGHEST Рассматривайте совпадение как совпадение с названием элемента.
HIGH Относитесь к совпадению более важно, чем к основному тексту.
LOW Относитесь к совпадению с меньшей важностью, чем к основному тексту.
NONE Не сопоставляйте это поле во время извлечения. Свойство по-прежнему можно использовать для сопоставления операторов, фасетирования и предложения, если это необходимо.

TextPropertyOptions.TextOperatorOptions

Используется для предоставления оператора поиска для текстовых свойств. Это необязательно. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента.

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

string

Указывает имя оператора, необходимое в запросе для изоляции текстового свойства. Например, если имя оператора — subject , а имя свойства — subjectLine , то запросы типа subject:<value> отображают результаты только в том случае, если значение свойства с именем subjectLine соответствует <value> . Напротив, поиск, в котором используется одно и то же <значение> без оператора, возвращает все элементы, где <значение> соответствует значению любых текстовых свойств или текста в поле содержимого для элемента. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

exactMatchWithOperator

boolean

Если это правда, текстовое значение маркируется как одно атомарное значение при поиске операторов и сопоставлении фасетов. Например, если имя оператора — «жанр», а значение — «научная фантастика», ограничения запроса «жанр: наука» и «жанр: фантастика» не соответствуют элементу; «Жанр: научная фантастика» да. Сопоставление текстовых значений учитывает регистр и не удаляет специальные символы. Если false, текст токенизируется. Например, если значением является «научная фантастика», запросы «жанр:наука» и «жанр:фантастика» соответствуют элементу.

Хтмлсвойствоварианты

Параметры свойств HTML.

JSON-представление 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Поля
retrievalImportance

object ( RetrievalImportance )

Указывает важность качества поиска токенов в поле при их использовании для поиска. Можно установить только значение DEFAULT или NONE.

operatorOptions

object ( HtmlPropertyOptions.HtmlOperatorOptions )

Если установлено, описывает, как свойство следует использовать в качестве оператора поиска.

HtmlPropertyOptions.HtmlOperatorOptions

Используется для предоставления оператора поиска для свойств HTML. Это необязательно. Операторы query.search позволяют пользователям ограничивать запрос определенными полями, соответствующими типу искомого элемента.

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

string

Указывает имя оператора, необходимое в запросе для изоляции свойства html. Например, если имя оператора — subject , а имя свойства — subjectLine , то запросы типа subject:<value> отображают результаты только в том случае, если значение свойства с именем subjectLine соответствует <value> . Напротив, поиск, в котором используется одно и то же <value> без оператора, возвращает все элементы, где <value> соответствует значению любых свойств HTML или текста в поле содержимого для элемента. Имя оператора может содержать только строчные буквы (az). Максимальная длина — 32 символа.

Свойствадисплейварианты

Параметры отображения свойства.

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

string

Удобная для пользователя метка свойства, которая используется, если свойство указано для отображения в ObjectDisplayOptions. Если это предусмотрено, метка отображения отображается перед значениями свойства, когда свойство является частью параметров отображения объекта. Например, если значение свойства равно «1», это значение само по себе может быть бесполезным для пользователя. Если задано отображаемое имя «приоритет», то пользователь увидит в результатах поиска «приоритет: 1», что обеспечивает понятный контекст для пользователей поиска. Это НЕОБЯЗАТЕЛЬНО; если не задано, отображаются только значения свойств. Максимальная длина — 64 символа.