SimpleField interface

Пакет:

@azure/search-documents

Представляет поле в определении индекса, описывающее имя, тип данных и поведение поиска поля.

Свойства

analyzerName	Имя анализатора, используемого для поля. Этот параметр можно использовать только с полями, доступными для поиска, и его нельзя задать вместе с searchAnalyzer или indexAnalyzer. После выбора анализатора его нельзя изменить для поля.
facetable	Значение, указывающее, следует ли указывать поле в запросах аспектов. Обычно используется в презентации результатов поиска, включающих количество попаданий по категориям (например, поиск цифровых камер и просмотр хитов по бренду, по мегапикселям, по цене и т. д.). Поля типа Edm.GeographyPoint или Collection(Edm.GeographyPoint) не могут быть аспектируемыми. Значение по умолчанию — false.
filterable	Значение, указывающее, следует ли указывать поле в $filter запросах. Фильтрация отличается от способа обработки строк поиска. Поля типа Edm.String или Collection(Edm.String), которые можно фильтровать, не проходят разбиение слов, поэтому сравнения предназначены только для точных совпадений. Например, если задать такое поле f на "солнечный день", $filter=fq "солнечный" не будет найти совпадений, но $filter=fq "солнечный день". Значение по умолчанию — false.
hidden	Значение, указывающее, можно ли возвращать поле в результатах поиска. Этот параметр можно отключить, если вы хотите использовать поле (например, поле) в качестве фильтра, сортировки или механизма оценки, но не хотите, чтобы поле отображалось для конечного пользователя. Это свойство должно быть false для полей ключей. Это свойство можно изменить в существующих полях. Включение этого свойства не приводит к увеличению требований к хранилищу индексов. Значение по умолчанию имеет значение true для полей векторов, значение false в противном случае.
indexAnalyzerName	Имя анализатора, используемого во время индексирования поля. Этот параметр можно использовать только с полями, доступными для поиска. Он должен быть установлен вместе с searchAnalyzer, и его нельзя задать вместе с параметром анализатора. Это свойство нельзя задать для имени анализатора языка; используйте свойство анализатора вместо этого, если вам нужен анализатор языка. После выбора анализатора его нельзя изменить для поля.
key	Значение, указывающее, однозначно ли поле идентифицирует документы в индексе. В качестве ключевого поля необходимо выбрать ровно одно поле верхнего уровня в каждом индексе, и оно должно иметь тип Edm.String. Ключевые поля можно использовать для поиска документов напрямую и обновления или удаления определенных документов. Значение по умолчанию — false.
name	Имя поля, которое должно быть уникальным в коллекции полей индекса или родительского поля.
normalizerName	Имя нормализатора, используемого для поля. Эту опцию можно использовать только с полями с включенными фильтруемыми, сортируемыми или фасетными таблицами. После выбора нормализатора его нельзя изменить для поля. Должно быть null для сложных полей.
searchable	Значение, указывающее, доступно ли поле для полнотекстового поиска. Это означает, что он будет проходить анализ, например критические слова во время индексирования. Если вы устанавливаете для поиска значение, например "солнечный день", внутренне оно будет разделено на отдельные токены "солнечный" и "день". Это позволяет выполнять полнотекстовый поиск этих терминов. Поля типа Edm.String или Collection(Edm.String) доступны для поиска по умолчанию. Это свойство должно быть ложным для простых полей других типов данных, не являющихся строковыми. Примечание. Поля, доступные для поиска, используют дополнительное пространство в индексе для размещения дополнительных маркеризованных версий значения поля для полнотекстового поиска. Если вы хотите сэкономить место в индексе и не требуется, чтобы поле было включено в поиск, задайте для поиска значение false. Значение по умолчанию — false.
searchAnalyzerName	Имя анализатора, используемого во время поиска поля. Этот параметр можно использовать только с полями, доступными для поиска. Он должен быть установлен вместе с indexAnalyzerName и не может быть установлен вместе с параметром analyzerName. Это свойство нельзя задать для имени анализатора языка; используйте вместо этого свойство analyzerName, если вам нужен анализатор языка. Этот анализатор можно обновить в существующем поле.
sortable	Значение, указывающее, следует ли ссылаться на поле в выражениях $orderby. По умолчанию поисковая система сортирует результаты по оценке, но во многих интерфейсах пользователи хотят отсортировать поля в документах. Простое поле может быть сортировано только в том случае, если оно имеет одно значение в области родительского документа. Простые поля коллекции не могут быть сортируемыми, так как они имеют многозначное значение. Простые вложенные поля сложных коллекций также являются многозначными и поэтому не могут быть сортируемыми. Это верно, является ли это немедленное родительское поле или поле предка, это сложная коллекция. Значение по умолчанию — false.
stored	Неизменяемое значение, указывающее, будет ли поле сохраняться отдельно на диске, возвращаемое в результатах поиска. Этот параметр можно отключить, если вы не планируете возвращать содержимое поля в ответе поиска, чтобы сэкономить на затратах на хранение. Это можно задать только во время создания индекса и только для полей векторов. Это свойство нельзя изменить для существующих полей или задать значение false для новых полей. Если это свойство задано как false, свойство "скрыто" должно иметь значение true. Это свойство должно иметь значение true или unset для ключевых полей, для новых полей и для невекторных полей. Отключение этого свойства приведет к снижению требований к хранилищу индексов. Значение по умолчанию имеет значение true для полей векторов.
synonymMapNames	Список имен синонимов сопоставляется с этим полем. Этот параметр можно использовать только с полями, доступными для поиска. В настоящее время поддерживается только одна карта синонимов на поле. Назначение сопоставления синонимов полю гарантирует, что условия запроса, предназначенные для этого поля, развертываются во время запроса с помощью правил в карте синонимов. Этот атрибут можно изменить в существующих полях.
type	Тип данных поля.
vectorEncodingFormat	Формат кодирования для интерпретации содержимого поля.
vectorSearchDimensions	Размерность поля вектора.
vectorSearchProfileName	Имя профиля векторного поиска, указывающего алгоритм и векторизатор для использования при поиске поля вектора.

Сведения о свойстве

analyzerName

Имя анализатора, используемого для поля. Этот параметр можно использовать только с полями, доступными для поиска, и его нельзя задать вместе с searchAnalyzer или indexAnalyzer. После выбора анализатора его нельзя изменить для поля.

analyzerName?: string

Значение свойства

string

facetable

Значение, указывающее, следует ли указывать поле в запросах аспектов. Обычно используется в презентации результатов поиска, включающих количество попаданий по категориям (например, поиск цифровых камер и просмотр хитов по бренду, по мегапикселям, по цене и т. д.). Поля типа Edm.GeographyPoint или Collection(Edm.GeographyPoint) не могут быть аспектируемыми. Значение по умолчанию — false.

facetable?: boolean

Значение свойства

boolean

filterable

Значение, указывающее, следует ли указывать поле в $filter запросах. Фильтрация отличается от способа обработки строк поиска. Поля типа Edm.String или Collection(Edm.String), которые можно фильтровать, не проходят разбиение слов, поэтому сравнения предназначены только для точных совпадений. Например, если задать такое поле f на "солнечный день", $filter=fq "солнечный" не будет найти совпадений, но $filter=fq "солнечный день". Значение по умолчанию — false.

filterable?: boolean

Значение свойства

boolean

hidden

Значение, указывающее, можно ли возвращать поле в результатах поиска. Этот параметр можно отключить, если вы хотите использовать поле (например, поле) в качестве фильтра, сортировки или механизма оценки, но не хотите, чтобы поле отображалось для конечного пользователя. Это свойство должно быть false для полей ключей. Это свойство можно изменить в существующих полях. Включение этого свойства не приводит к увеличению требований к хранилищу индексов. Значение по умолчанию имеет значение true для полей векторов, значение false в противном случае.

hidden?: boolean

Значение свойства

boolean

indexAnalyzerName

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

indexAnalyzerName?: string

Значение свойства

string

key

Значение, указывающее, однозначно ли поле идентифицирует документы в индексе. В качестве ключевого поля необходимо выбрать ровно одно поле верхнего уровня в каждом индексе, и оно должно иметь тип Edm.String. Ключевые поля можно использовать для поиска документов напрямую и обновления или удаления определенных документов. Значение по умолчанию — false.

key?: boolean

Значение свойства

boolean

name

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

name: string

Значение свойства

string

normalizerName

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

normalizerName?: string

Значение свойства

string

searchable

Значение, указывающее, доступно ли поле для полнотекстового поиска. Это означает, что он будет проходить анализ, например критические слова во время индексирования. Если вы устанавливаете для поиска значение, например "солнечный день", внутренне оно будет разделено на отдельные токены "солнечный" и "день". Это позволяет выполнять полнотекстовый поиск этих терминов. Поля типа Edm.String или Collection(Edm.String) доступны для поиска по умолчанию. Это свойство должно быть ложным для простых полей других типов данных, не являющихся строковыми. Примечание. Поля, доступные для поиска, используют дополнительное пространство в индексе для размещения дополнительных маркеризованных версий значения поля для полнотекстового поиска. Если вы хотите сэкономить место в индексе и не требуется, чтобы поле было включено в поиск, задайте для поиска значение false. Значение по умолчанию — false.

searchable?: boolean

Значение свойства

boolean

searchAnalyzerName

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

searchAnalyzerName?: string

Значение свойства

string

sortable

Значение, указывающее, следует ли ссылаться на поле в выражениях $orderby. По умолчанию поисковая система сортирует результаты по оценке, но во многих интерфейсах пользователи хотят отсортировать поля в документах. Простое поле может быть сортировано только в том случае, если оно имеет одно значение в области родительского документа. Простые поля коллекции не могут быть сортируемыми, так как они имеют многозначное значение. Простые вложенные поля сложных коллекций также являются многозначными и поэтому не могут быть сортируемыми. Это верно, является ли это немедленное родительское поле или поле предка, это сложная коллекция. Значение по умолчанию — false.

sortable?: boolean

Значение свойства

boolean

stored

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

stored?: boolean

Значение свойства

boolean

synonymMapNames

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

synonymMapNames?: string[]

Значение свойства

string[]

type

Тип данных поля.

type: SearchFieldDataType

Значение свойства

SearchFieldDataType

vectorEncodingFormat

Формат кодирования для интерпретации содержимого поля.

vectorEncodingFormat?: string

Значение свойства

string

vectorSearchDimensions

Размерность поля вектора.

vectorSearchDimensions?: number

Значение свойства

number

vectorSearchProfileName

Имя профиля векторного поиска, указывающего алгоритм и векторизатор для использования при поиске поля вектора.

vectorSearchProfileName?: string

Значение свойства

string