@azure/search-documents package

Классы

AzureKeyCredential

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

GeographyPoint

Представляет географическую точку в глобальных координатах.

IndexDocumentsBatch

Класс, используемый для выполнения пакетных операций с несколькими документами в индекс.

KnowledgeRetrievalClient

Класс, используемый для выполнения операций с базой знаний.

SearchClient

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

SearchIndexClient

Класс для управления (создание, обновление, удаление) индексов, & синонимов.

SearchIndexerClient

Класс для управления (создание, обновление, удаление) индексаторов, источников данных & наборов навыков.

SearchIndexingBufferedSender

Класс, используемый для выполнения буферизованных операций с индексом поиска, включая добавление, обновление и удаление.

Интерфейсы

AIServices

Параметры для сервисов ИИ.

AIServicesAccountIdentity

Мультирегиональный аккаунт сервисного ресурса Azure AI, привязанного к набору навыков.

AIServicesAccountKey

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

AnalyzeRequest

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

AnalyzeResult

Результат тестирования анализатора на тексте.

AnalyzedTokenInfo

Сведения о маркере, возвращаемом анализатором.

AsciiFoldingTokenFilter

Преобразует алфавитные, числовые и символьные символы Юникода, которые не находятся в первых 127 символах ASCII (блок Юникода "Базовый латиница") в эквиваленты ASCII, если такие эквиваленты существуют. Этот фильтр маркеров реализуется с помощью Apache Lucene.

AutocompleteItem

Результат запросов автозавершения.

AutocompleteRequest

Параметры для нечеткого сопоставления и других поведения запросов автозаполнения.

AutocompleteResult

Результат запроса автозаполнения.

AzureActiveDirectoryApplicationCredentials

Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для проверки подлинности доступа к ключам шифрования, хранящимся в Azure Key Vault.

AzureBlobKnowledgeSource

Конфигурация для источника знаний Хранилище BLOB-объектов Azure.

AzureBlobKnowledgeSourceParameters

Параметры для источника знаний Хранилище BLOB-объектов Azure.

AzureBlobKnowledgeSourceParams

Указывает параметры среды выполнения для источника знаний о BLOB-объектах Azure

AzureMachineLearningVectorizer

Задаёт Машинное обучение Azure endpoint, развернутый через Azure AI Foundry Model Catalog для генерации векторного вложения строки запроса.

AzureOpenAIEmbeddingSkill

Позволяет создать вектор внедрения для заданного текстового ввода с помощью ресурса Azure OpenAI.

AzureOpenAIParameters

Задает параметры для подключения к ресурсу Azure OpenAI.

AzureOpenAIVectorizer

Содержит параметры, относящиеся к использованию службы Azure Open AI для векторизации во время запроса.

BM25Similarity

Функция ранжирования на основе алгоритма сходства Okapi BM25. BM25 — это алгоритм TF-IDF, включающий нормализацию длины (контролируемый параметром B), а также насыщенность терминов (контролируемый параметром k1).

BaseAzureMachineLearningVectorizerParameters

Задает свойства, общие для всех типов проверки подлинности векторизатора AML.

BaseCharFilter

Базовый тип для фильтров символов.

BaseCognitiveServicesAccount

Базовый тип для описания любого ресурса службы искусственного интеллекта Azure, подключенного к набору навыков.

BaseDataChangeDetectionPolicy

Базовый тип политик обнаружения изменений данных.

BaseDataDeletionDetectionPolicy

Базовый тип политик обнаружения удаления данных.

BaseKnowledgeBaseActivityRecord

Тип базы для записей о действиях. Отслеживает детали выполнения, тайминг и ошибки для операций базы знаний.

BaseKnowledgeBaseMessageContent

Указывает тип содержимого сообщения.

BaseKnowledgeBaseModel

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

BaseKnowledgeBaseReference

Тип основания для ссылок.

BaseKnowledgeRetrievalReasoningEffort

Базовый тип для усилия рассуждения.

BaseKnowledgeSource

Представляет определение источника знаний.

BaseKnowledgeSourceParams

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

BaseKnowledgeSourceVectorizer

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

BaseLexicalAnalyzer

Базовый тип для анализаторов.

BaseLexicalNormalizer

Базовый тип для нормализаторов.

BaseLexicalTokenizer

Базовый тип для токенизаторов.

BaseScoringFunction

Базовый тип функций, которые могут изменять оценки документов во время ранжирования.

BaseSearchIndexerDataIdentity

Абстрактный базовый тип для удостоверений данных.

BaseSearchIndexerSkill

Базовый тип для навыков.

BaseSearchRequestOptions

Параметры фильтрации, сортировки, фасетирования, разбиения по страницам и других поведении поисковых запросов.

BaseSimilarityAlgorithm

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

BaseTokenFilter

Базовый тип для фильтров маркеров.

BaseVectorQuery

Параметры запроса для векторных и гибридных поисковых запросов.

BaseVectorSearchAlgorithmConfiguration

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

BaseVectorSearchCompression

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

BaseVectorSearchVectorizer

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

BinaryQuantizationCompression

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

ChatCompletionResponseFormat

Определяет, как должна быть сериализована реакция языковой модели. По умолчанию используется 'text'.

ChatCompletionResponseFormatJsonSchemaProperties

Свойства формата отклика схемы JSON.

ChatCompletionSchema

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

ChatCompletionSkill

Навык, который вызывает языковую модель через конечную точку Chat Completions Azure AI Foundry.

CjkBigramTokenFilter

Формирует большие кадры терминов CJK, созданных из стандартного токенизатора. Этот фильтр маркеров реализуется с помощью Apache Lucene.

ClassicSimilarity

Устаревший алгоритм сходства, использующий реализацию TF-IDF Lucene TFIDFSimilarity. Этот вариант TF-IDF представляет нормализацию статического длины документа, а также координирующие факторы, которые наказывают документы, которые частично соответствуют поисковым запросам.

ClassicTokenizer

Токенизатор на основе грамматики, подходящий для обработки большинства европейских языковых документов. Этот токенизатор реализуется с помощью Apache Lucene.

CognitiveServicesAccountKey

Ключ учетной записи с несколькими регионами ресурса службы искусственного интеллекта Azure, подключенного к набору навыков.

CommonGramTokenFilter

Создавайте bigrams для часто встречающихся терминов при индексировании. Отдельные термины по-прежнему индексируются слишком, при наложении bigrams. Этот фильтр маркеров реализуется с помощью Apache Lucene.

CommonModelParameters

Общие параметры языковой модели для завершения чата. Если они опущены, используются значения по умолчанию.

CompletedSynchronizationState

Представляет собой завершенное состояние последней синхронизации.

ComplexField

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

ConditionalSkill

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

ContentUnderstandingSkill

Это навык, который использует Azure AI Content Understanding для обработки и извлечения структурированных инсайтов из документов, позволяя создавать обогащённый, доступный для поиска контент для улучшения индексации и поиска документов.

ContentUnderstandingSkillChunkingProperties

Управляет кратностью для разбивки содержимого.

CorsOptions

Определяет параметры управления общим доступом к ресурсам между источниками (CORS) для индекса.

CreateKnowledgeBaseOptions
CreateKnowledgeSourceOptions
CreateOrUpdateAliasOptions

Параметры для операции создания или обновления псевдонима.

CreateOrUpdateIndexOptions

Параметры операции создания и обновления индекса.

CreateOrUpdateKnowledgeBaseOptions
CreateOrUpdateKnowledgeSourceOptions
CreateOrUpdateSkillsetOptions

Параметры операции создания и обновления набора навыков.

CreateOrUpdateSynonymMapOptions

Параметры операции создания и обновления карты синонимов.

CreateorUpdateDataSourceConnectionOptions

Параметры для операции создания и обновления источника данных.

CreateorUpdateIndexerOptions

Параметры операции создания и обновления индексатора.

CustomAnalyzer

Позволяет контролировать процесс преобразования текста в индексируемые и поисковые маркеры. Это определяемая пользователем конфигурация, состоящая из одного предопределенного токенизатора и одного или нескольких фильтров. Маркеризатор отвечает за разбиение текста в маркеры и фильтры для изменения маркеров, создаваемых токенизатором.

CustomEntity

Объект, содержащий сведения о найденных совпадениях и связанных метаданных.

CustomEntityAlias

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

CustomEntityLookupSkill

Навык ищет текст из пользовательского пользовательского списка слов и фраз.

CustomLexicalNormalizer

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

DefaultCognitiveServicesAccount

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

DeleteAliasOptions

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

DeleteDataSourceConnectionOptions

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

DeleteIndexOptions

Параметры операции удаления индекса.

DeleteIndexerOptions

Параметры операции удаления индексатора.

DeleteKnowledgeBaseOptions
DeleteKnowledgeSourceOptions
DeleteSkillsetOptions

Параметры удаления оперы набора навыков.

DeleteSynonymMapOptions

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

DictionaryDecompounderTokenFilter

Раскомпозирует составные слова, найденные во многих немецких языках. Этот фильтр маркеров реализуется с помощью Apache Lucene.

DistanceScoringFunction

Определяет функцию, которая повышает оценки на основе расстояния от географического расположения.

DistanceScoringParameters

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

DocumentDebugInfo

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

DocumentExtractionSkill

Навык, извлекающий содержимое из файла в конвейере обогащения.

DocumentIntelligenceLayoutSkill

Навык, который извлекает сведения о содержимом и макете (как markdown) через службы ИИ Azure из файлов в конвейере обогащения.

DocumentIntelligenceLayoutSkillChunkingProperties

Управляет кратностью для разбивки содержимого.

EdgeNGramTokenFilter

Создает n-граммы заданных размеров, начиная с передней или задней части входного маркера. Этот фильтр маркеров реализуется с помощью Apache Lucene.

EdgeNGramTokenizer

Маркеризирует входные данные из края в n-граммы заданных размеров. Этот токенизатор реализуется с помощью Apache Lucene.

ElisionTokenFilter

Удаляет излизии. Например, "l'avion" (плоскость) преобразуется в "avion" (плоскость). Этот фильтр маркеров реализуется с помощью Apache Lucene.

EntityLinkingSkill

Используя API анализа текста, извлекает связанные сущности из текста.

EntityRecognitionSkill

Распознавание сущностей анализа текста.

EntityRecognitionSkillV3

С помощью API анализа текста извлекает сущности различных типов из текста.

ExhaustiveKnnParameters

Содержит параметры, относящиеся к исчерпывающим алгоритмам KNN.

ExtractiveQueryAnswer

Извлекает кандидатов ответов из содержимого документов, возвращаемых в ответ на запрос, выраженный как вопрос на естественном языке.

ExtractiveQueryCaption

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

FacetResult

Один контейнер результата запроса аспектов. Сообщает количество документов со значением поля, которое попадает в определенный диапазон или имеет определенное значение или интервал.

FieldMapping

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

FieldMappingFunction

Представляет функцию, которая преобразует значение из источника данных перед индексированием.

FreshnessScoringFunction

Определяет функцию, которая повышает оценки на основе значения поля даты и времени.

FreshnessScoringParameters

Предоставляет значения параметров функции оценки свежести.

GenerativeQueryRewrites

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

GetDocumentOptions

Параметры получения одного документа.

GetKnowledgeBaseOptions
GetKnowledgeSourceOptions
GetKnowledgeSourceStatusOptions
HighWaterMarkChangeDetectionPolicy

Определяет политику обнаружения изменений данных, которая фиксирует изменения в зависимости от значения столбца высокой водяной отметки.

HnswParameters

Содержит параметры, относящиеся к алгоритму hnsw.

ImageAnalysisSkill

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

IndexDocumentsClient

Клиент индексирования документов

IndexDocumentsOptions

Параметры пакетной операции изменения индекса.

IndexDocumentsResult

Ответ, содержащий состояние операций для всех документов в запросе индексирования.

IndexedOneLakeKnowledgeSource

Конфигурация для источника знаний OneLake.

IndexedOneLakeKnowledgeSourceParameters

Параметры для источника знаний OneLake.

IndexedOneLakeKnowledgeSourceParams

Указывает параметры среды выполнения для индексированного источника знаний OneLake

IndexerExecutionResult

Представляет результат выполнения отдельного индексатора.

IndexingParameters

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

IndexingParametersConfiguration

Словарь свойств конфигурации для индексатора. Каждое имя — это имя определенного свойства. Каждое значение должно быть примитивным типом.

IndexingResult

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

IndexingSchedule

Представляет расписание выполнения индексатора.

InputFieldMappingEntry

Сопоставление полей ввода для навыка.

KeepTokenFilter

Фильтр маркеров, который сохраняет только маркеры с текстом, содержащимся в указанном списке слов. Этот фильтр маркеров реализуется с помощью Apache Lucene.

KeyAuthAzureMachineLearningVectorizerParameters

Задает свойства для подключения к векторизатору AML с помощью ключа проверки подлинности.

KeyPhraseExtractionSkill

Навык, использующий анализ текста для извлечения ключевых фраз.

KeywordMarkerTokenFilter

Помечает термины как ключевые слова. Этот фильтр маркеров реализуется с помощью Apache Lucene.

KeywordTokenizer

Выводит все входные данные в виде одного маркера. Этот токенизатор реализуется с помощью Apache Lucene.

KnowledgeBase
KnowledgeBaseAgenticReasoningActivityRecord

Представляет собой запись активности агентного рассуждения.

KnowledgeBaseAzureBlobReference

Представляет собой справочник по документам хранилища BLOB-объектов Azure.

KnowledgeBaseAzureOpenAIModel

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

KnowledgeBaseErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

KnowledgeBaseErrorDetail

Сведения об ошибке.

KnowledgeBaseIndexedOneLakeReference

Представляет индексированную ссылку на документ OneLake.

KnowledgeBaseMessage

Объект стиля сообщения на естественном языке.

KnowledgeBaseMessageImageContent

Тип графического сообщения.

KnowledgeBaseMessageImageContentImage

Содержание изображений.

KnowledgeBaseMessageTextContent

Тип текстового сообщения.

KnowledgeBaseModelWebSummarizationActivityRecord

Представляет запись активности по суммаризации веба в LLM.

KnowledgeBaseRetrievalRequest

Входной контракт для запроса на извлечение.

KnowledgeBaseRetrievalResponse

Выходной контракт для ответа на извлечение.

KnowledgeBaseSearchIndexReference

Представляет ссылку на документ Поиска Azure.

KnowledgeBaseWebReference

Представляет собой ссылку на веб-документ.

KnowledgeRetrievalClientOptions

Параметры клиента, используемые для настройки запросов API Когнитивного поиска.

KnowledgeRetrievalIntent

Предназначенный запрос для выполнения без планирования запроса модели.

KnowledgeRetrievalMinimalReasoningEffort

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

KnowledgeRetrievalSemanticIntent

Семантический запрос.

KnowledgeSourceAzureOpenAIVectorizer

Указывает ресурс Azure OpenAI, используемый для векторизации строки запроса.

KnowledgeSourceIngestionParameters

Консолидирует все общие параметры приема для источников знаний.

KnowledgeSourceReference

Ссылка на источник знаний.

KnowledgeSourceStatistics

Статистическая информация об истории синхронизации источников знаний.

KnowledgeSourceStatus

Представляет состояние и историю синхронизации источника знаний.

KnowledgeSourceSynchronizationError

Представляет ошибку индексации на уровне документа, возникшую при выполнении синхронизации источника знаний.

LanguageDetectionSkill

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

LengthTokenFilter

Удаляет слова, слишком длинные или слишком короткие. Этот фильтр маркеров реализуется с помощью Apache Lucene.

LimitTokenFilter

Ограничивает количество маркеров при индексировании. Этот фильтр маркеров реализуется с помощью Apache Lucene.

ListKnowledgeBasesOptions
ListKnowledgeSourcesOptions
ListSearchResultsPageSettings

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

LuceneStandardAnalyzer

Стандартный анализатор Apache Lucene; Состоит из стандартного токенизатора, нижнего регистра фильтра и фильтра остановки.

LuceneStandardTokenizer

Разбивает текст в соответствии с правилами сегментации текста Юникода. Этот токенизатор реализуется с помощью Apache Lucene.

MagnitudeScoringFunction

Определяет функцию, которая повышает оценки на основе величины числового поля.

MagnitudeScoringParameters

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

MappingCharFilter

Фильтр символов, который применяет сопоставления, определенные с параметром сопоставления. Сопоставление жадно (самый длинный шаблон сопоставления в заданной точке выигрывает). Допускается замена пустой строки. Этот фильтр символов реализуется с помощью Apache Lucene.

MergeSkill

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

MicrosoftLanguageStemmingTokenizer

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

MicrosoftLanguageTokenizer

Делит текст с помощью правил, относящихся к языку.

NGramTokenFilter

Создает n-граммы заданного размера. Этот фильтр маркеров реализуется с помощью Apache Lucene.

NGramTokenizer

Маркеризирует входные данные в n-граммах заданных размеров. Этот токенизатор реализуется с помощью Apache Lucene.

NativeBlobSoftDeleteDeletionDetectionPolicy

Определяет политику обнаружения удаления данных, используюющую собственную функцию обратимого удаления хранилища BLOB-объектов Azure для обнаружения удаления.

NoAuthAzureMachineLearningVectorizerParameters

Задает свойства для подключения к векторизатору AML без проверки подлинности.

OcrSkill

Навык, извлекающий текст из файлов изображений.

OutputFieldMappingEntry

Сопоставление полей вывода для навыка.

PIIDetectionSkill

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

PageSettings

Параметры метода byPage

PagedAsyncIterableIterator

Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.

PathHierarchyTokenizer

Токенизатор для иерархий, похожих на пути. Этот токенизатор реализуется с помощью Apache Lucene.

PatternAnalyzer

Гибкий разделяет текст на термины с помощью шаблона регулярного выражения. Этот анализатор реализуется с помощью Apache Lucene.

PatternCaptureTokenFilter

Использует регрессии Java для выдачи нескольких маркеров — по одному для каждой группы захвата в одном или нескольких шаблонах. Этот фильтр маркеров реализуется с помощью Apache Lucene.

PatternReplaceCharFilter

Фильтр символов, заменяющий символы во входной строке. Он использует регулярное выражение для идентификации последовательностей символов для сохранения и замены шаблона для определения символов для замены. Например, учитывая входной текст "aa bb aa bb", шаблон "(aa)\s+(bb)" и замену "$1#2", результатом будет "aa#bb aa#bb". Этот фильтр символов реализуется с помощью Apache Lucene.

PatternReplaceTokenFilter

Фильтр символов, заменяющий символы во входной строке. Он использует регулярное выражение для идентификации последовательностей символов для сохранения и замены шаблона для определения символов для замены. Например, учитывая входной текст "aa bb aa bb", шаблон "(aa)\s+(bb)" и замену "$1#2", результатом будет "aa#bb aa#bb". Этот фильтр маркеров реализуется с помощью Apache Lucene.

PatternTokenizer

Токенизатор, использующий сопоставление шаблонов regex для создания уникальных маркеров. Этот токенизатор реализуется с помощью Apache Lucene.

PhoneticTokenFilter

Создайте маркеры для фонетических совпадений. Этот фильтр маркеров реализуется с помощью Apache Lucene.

QueryAnswerResult

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

QueryCaptionResult

Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Заголовки возвращаются только для запросов типа semantic.

QueryResultDocumentSemanticField

Описание полей, отправленных в процесс семантического обогащения, а также способ их использования

QueryResultDocumentSubscores

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

RescoringOptions

Содержит параметры для перезаписи.

ResourceCounter

Представляет использование и квоту ресурса.

RetrieveOptions
ScalarQuantizationCompression

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

ScalarQuantizationParameters

Содержит параметры, относящиеся к скалярной квантизации.

ScoringProfile

Определяет параметры индекса поиска, влияющего на оценку в поисковых запросах.

SearchAlias

Представляет псевдоним индекса, описывающий сопоставление с именем псевдонима с индексом. Имя псевдонима можно использовать вместо имени индекса для поддерживаемых операций.

SearchClientOptions

Параметры клиента, используемые для настройки запросов API AI Search.

SearchDocumentsPageResult

Ответ, содержащий результаты страницы поиска из индекса.

SearchDocumentsResult

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

SearchDocumentsResultBase

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

SearchIndex

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

SearchIndexClientOptions

Параметры клиента, используемые для настройки запросов API AI Search.

SearchIndexFieldReference

Поле для поискового индекса.

SearchIndexKnowledgeSource

Источник знаний, нацеленный на индекс поиска.

SearchIndexKnowledgeSourceParameters

Параметры для источника знаний по индексу поиска.

SearchIndexKnowledgeSourceParams

Задает параметры времени выполнения для источника знаний индекса поиска

SearchIndexStatistics

Статистика по заданному индексу. Статистика собирается периодически и не гарантируется всегда быть up-to-date.

SearchIndexer

Представляет индексатор.

SearchIndexerClientOptions

Параметры клиента, используемые для настройки запросов API AI Search.

SearchIndexerDataContainer

Представляет сведения о сущности (например, таблице SQL Azure или коллекции CosmosDB), которая будет индексирована.

SearchIndexerDataNoneIdentity

Очищает свойство удостоверения источника данных.

SearchIndexerDataSourceConnection

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

SearchIndexerDataUserAssignedIdentity

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

SearchIndexerError

Представляет ошибку индексирования на уровне элемента или документа.

SearchIndexerIndexProjection

Определение дополнительных проекций для вторичных индексов поиска.

SearchIndexerIndexProjectionParameters

Словарь свойств конфигурации для проекции индекса. Каждое имя — это имя определенного свойства. Каждое значение должно быть примитивным типом.

SearchIndexerIndexProjectionSelector

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

SearchIndexerKnowledgeStore

Определение дополнительных проекций для больших двоичных объектов Azure, таблиц или файлов, обогащенных данных.

SearchIndexerKnowledgeStoreBlobProjectionSelector

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

SearchIndexerKnowledgeStoreFileProjectionSelector

Определение проекции для хранения данных в файлах Azure.

SearchIndexerKnowledgeStoreObjectProjectionSelector

Определение проекции для хранения данных в BLOB-объекте Azure.

SearchIndexerKnowledgeStoreParameters

Словарь свойств конфигурации для конкретного хранилища знаний. Каждое имя — это имя определенного свойства. Каждое значение должно быть примитивным типом.

SearchIndexerKnowledgeStoreProjection

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

SearchIndexerKnowledgeStoreProjectionSelector

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

SearchIndexerKnowledgeStoreTableProjectionSelector

Описание того, какие данные следует хранить в таблицах Azure.

SearchIndexerLimits

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

SearchIndexerSkillset

Список навыков.

SearchIndexerStatus

Представляет текущее состояние и журнал выполнения индексатора.

SearchIndexerWarning

Представляет предупреждение уровня элемента.

SearchIndexingBufferedSenderOptions

Параметры searchIndexingBufferedSender.

SearchResourceEncryptionKey

Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки неактивных данных в Поиске Azure AI, таких как индексы и сопоставления синонимов.

SearchServiceStatistics

Ответ от запроса статистики службы. В случае успешного выполнения он включает счетчики уровня обслуживания и ограничения.

SemanticConfiguration

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

SemanticDebugInfo

Параметры отладки для запросов семантического поиска.

SemanticField

Поле, используемое в рамках семантической конфигурации.

SemanticPrioritizedFields

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

SemanticSearch

Определяет параметры индекса поиска, влияющего на семантические возможности.

SemanticSearchOptions

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

SentimentSkill

Анализ положительных отрицательных тональности текста, оцененный как значение с плавающей запятой в диапазоне от нуля до 1.

SentimentSkillV3

Используя API анализа текста, вычисляет неструктурированный текст и для каждой записи предоставляет метки тональности (например, "отрицательные", "нейтральные" и "положительные") на основе самой высокой оценки достоверности, найденной службой на уровне предложения и документа.

ServiceCounters

Представляет счетчики ресурсов уровня обслуживания и квоты.

ServiceLimits

Представляет различные ограничения уровня обслуживания.

ShaperSkill

Навык изменения выходных данных. Он создает сложный тип для поддержки составных полей (также известных как многопартийные поля).

ShingleTokenFilter

Создает сочетания маркеров в виде одного маркера. Этот фильтр маркеров реализуется с помощью Apache Lucene.

SimpleField

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

SingleVectorFieldResult

Результат одного векторного поля. Both

SnowballTokenFilter

Фильтр, который стебляет слова с помощью созданного сноубола стебля. Этот фильтр маркеров реализуется с помощью Apache Lucene.

SoftDeleteColumnDeletionDetectionPolicy

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

SplitSkill

Навык разделения строки на фрагменты текста.

SqlIntegratedChangeTrackingPolicy

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

StemmerOverrideTokenFilter

Предоставляет возможность переопределить другие фильтры с использованием пользовательских фильтров на основе словаря. Все термины, связанные с словарем, будут помечены как ключевые слова, чтобы они не были стеблированы с помощью стволовых модулей вниз по цепочке. Необходимо поместить перед любыми фильтрами с использованием стволовых элементов. Этот фильтр маркеров реализуется с помощью Apache Lucene. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html

StemmerTokenFilter

Фильтр для конкретного языка. Этот фильтр маркеров реализуется с помощью Apache Lucene. См. https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters

StopAnalyzer

Делит текст на небуквенный; Применяет фильтры маркеров стоп-слов и строчных регистров. Этот анализатор реализуется с помощью Apache Lucene.

StopwordsTokenFilter

Удаляет слова остановки из потока маркеров. Этот фильтр маркеров реализуется с помощью Apache Lucene. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html

SuggestDocumentsResult

Ответ, содержащий результаты запроса предложения из индекса.

SuggestRequest

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

Suggester

Определяет, как API предложения должен применяться к группе полей в индексе.

SynchronizationState

Представляет текущее состояние текущей синхронизации, охватывающей несколько запусков индексатора.

SynonymMap

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

SynonymTokenFilter

Соответствует синонимам одного или нескольких слов в потоке маркеров. Этот фильтр маркеров реализуется с помощью Apache Lucene.

TagScoringFunction

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

TagScoringParameters

Предоставляет значения параметров функции оценки тегов.

TextResult

Оценка BM25 или Классическая оценка для текстовой части запроса.

TextTranslationSkill

Навык перевода текста с одного языка на другой.

TextWeights

Определяет весы в полях индекса, для которых совпадения должны повысить оценку в поисковых запросах.

TokenAuthAzureMachineLearningVectorizerParameters

Задает свойства для подключения к векторизатору AML с управляемым удостоверением.

TruncateTokenFilter

Усечение терминов до определенной длины. Этот фильтр маркеров реализуется с помощью Apache Lucene.

UaxUrlEmailTokenizer

Маркеризирует URL-адреса и сообщения электронной почты в виде одного маркера. Этот токенизатор реализуется с помощью Apache Lucene.

UniqueTokenFilter

Фильтрует маркеры с тем же текстом, что и предыдущий маркер. Этот фильтр маркеров реализуется с помощью Apache Lucene.

VectorSearch

Содержит параметры конфигурации, связанные с векторным поиском.

VectorSearchOptions

Определяет параметры запросов поиска векторов

VectorSearchProfile

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

VectorizableImageBinaryQuery

Параметры запроса, используемые для векторного поиска, когда предоставляется векторный двоичный файл в кодировке base 64 изображения, который необходимо векторизировать.

VectorizableImageUrlQuery

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

VectorizableTextQuery

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

VectorizedQuery

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

VectorsDebugInfo

«Содержит отладочную информацию, специфичную для векторного и гибридного поиска.»)

WebApiParameters

Задает свойства для подключения к определяемой пользователем векторизаторе.

WebApiSkill

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

WebApiVectorizer

Задает определяемый пользователем векторизатор для создания векторного внедрения строки запроса. Интеграция внешнего векторизатора достигается с помощью пользовательского интерфейса веб-API набора навыков.

WebKnowledgeSource

Источник знаний с таргетингом на веб-результаты.

WebKnowledgeSourceDomain

Конфигурация для домена источника знаний в Интернете.

WebKnowledgeSourceDomains

Конфигурация разрешения/блокировки домена для веб-источника знаний.

WebKnowledgeSourceParameters

Параметры для веб-источника знаний.

WebKnowledgeSourceParams

Задает параметры времени выполнения для веб-источника знаний

WordDelimiterTokenFilter

Разбивает слова на вложенные слова и выполняет необязательные преобразования в группах подслугов. Этот фильтр маркеров реализуется с помощью Apache Lucene.

Псевдонимы типа

AIFoundryModelCatalogName

Название модели вложения из каталога Azure AI Foundry, который будет называться.
KnownAIFoundryModelCatalogName можно использовать взаимозаменяемо с AIFoundryModelCatalogName, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32: OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32
OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336: OpenAI-CLIP-Image-Text-Embeddings-ViT-large-Patch14-336
Facebook-DinoV2-Image-Embeddings-ViT-Base: Facebook-DinoV2-Image-Embeddings-ViT-Base
Facebook-DinoV2-Image-Embeddings-ViT-Giant: Facebook-DinoV2-Image-Embeddings-ViT-Giant
Cohere-embed-v3-english: Cohere-embed-v3-english
Cohere-embed-v3-multilingual: Cohere-embed-v3-multilingual
Cohere-embed-v4: модель Cohere embed v4 для создания встраиваемых файлов как из текста, так и из изображений.

AliasIterator

Итератор для перечисления псевдонимов, существующих в службе поиска. При этом запросы будут выполняться по мере необходимости во время итерации. Используйте .byPage() для выполнения одного запроса к серверу на итерацию.

AnalyzeTextOptions

Параметры анализа текстовой операции.

AutocompleteMode

Задает режим автозаполнения. Значение по умолчанию — oneTerm. Используйте 'twoTerms' для получения битумной черепицы и 'oneTermWithContext' для использования текущего контекста при создании автозаполнения терминов.

AutocompleteOptions

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

AzureMachineLearningVectorizerParameters

Задает свойства для подключения к векторизатору AML.

AzureOpenAIModelName

Имя модели Azure Open AI, которое будет вызываться.
KnownAzureOpenAIModelName можно использовать взаимозаменяемо с AzureOpenAIModelName, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

text-embedding-ada-002: модель TextEmbeddingAda002.
text-embedding-3-large: TextEmbedding3Large model.
text-embedding-3-small: TextEmbedding3Small model.
GPT-5-Mini: модель Gpt5Mini.
gpt-5-nano: модель Gpt5Nano.
gpt-5.4-mini: модель Gpt54Mini.
gpt-5.4-nano: модель Gpt54Nano.

BaseKnowledgeRetrievalIntent

Alias for KnowledgeRetrievalIntentUnion

BlobIndexerDataToExtract
BlobIndexerImageAction
BlobIndexerPDFTextRotationAlgorithm
BlobIndexerParsingMode
CharFilter

Содержит возможные случаи для CharFilter.

CharFilterName

Определяет имена всех фильтров символов, поддерживаемых поисковой системой.
<xref:KnownCharFilterName> можно использовать взаимозаменяемо с CharFilterName, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

html_strip: фильтр символов, который пытается удалить конструкции HTML. См. https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html

ChatCompletionExtraParametersBehavior

Указывает, как должен работать 'extraParameters' в Azure AI Foundry. По умолчанию 'error'.
KnownChatCompletionExtraParametersBehavior можно использовать взаимозаменяемо с ChatCompletionExtraParametersBehavior, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

passThrough: Передает любые дополнительные параметры непосредственно в модель.
drop: Удаляет все дополнительные параметры.
error: Вызывает ошибку, если присутствует какой-либо дополнительный параметр.

ChatCompletionResponseFormatType

Указывает, как LLM должен форматировать ответ.
KnownChatCompletionResponseFormatType можно использовать взаимозаменяемо с ChatCompletionResponseFormatType, это перечисление содержит известные значения, которые поддерживает сервис.

Известные значения, поддерживаемые службой

текст: Формат ответа в виде обычного текста.
jsonObject: произвольный формат отклика объекта JSON.
jsonSchema: формат ответа, привязанный к схеме JSON.

CjkBigramTokenFilterScripts

Скрипты, которые могут быть проигнорированы CjkBigramTokenFilter.

CognitiveServicesAccount

Содержит возможные случаи для CognitiveServicesAccount.

ComplexDataType

Определяет значения для ComplexDataType. Возможные значения: "Edm.ComplexType", "Collection(Edm.ComplexType)"

ContentUnderstandingSkillChunkingUnit

Управляет кратностью единицы блока. По умолчанию — это «персонажи»
KnownContentUnderstandingSkillChunkingUnit может использоваться взаимозаменяемо с ContentUnderstandingSkillChunkingUnit, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

characters: Указывает фрагмент по символам.

ContentUnderstandingSkillExtractionOptions

Управляет кратностью содержимого, извлекаемого из документа с помощью навыка.
KnownContentUnderstandingSkillExtractionOptions может использоваться взаимозаменяемо с ContentUnderstandingSkillExtractionOptions, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

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

ContinuablePage

Интерфейс, описывающий страницу результатов.

CountDocumentsOptions

Параметры выполнения операции подсчета в индексе.

CreateAliasOptions

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

CreateDataSourceConnectionOptions

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

CreateIndexOptions

Параметры создания операции индекса.

CreateIndexerOptions

Параметры создания операции индексатора.

CreateSkillsetOptions

Параметры для создания операции набора навыков.

CreateSynonymMapOptions

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

CustomEntityLookupSkillLanguage
DataChangeDetectionPolicy

Содержит возможные случаи для DataChangeDetectionPolicy.

DataDeletionDetectionPolicy

Содержит возможные случаи для DataDeletionDetectionPolicy.

DeleteDocumentsOptions

Параметры операции удаления документов.

DocumentIntelligenceLayoutSkillChunkingUnit

Управляет кратностью единицы блока. По умолчанию — это «персонажи»
KnownDocumentIntelligenceLayoutSkillChunkingUnit можно использовать взаимозаменяемо с DocumentIntelligenceLayoutSkillChunkingUnit, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

characters: Указывает фрагмент по символам.

DocumentIntelligenceLayoutSkillExtractionOptions

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

Известные значения, поддерживаемые службой

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

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

Глубина заголовков в выходных данных markdown. Значение по умолчанию — h6.
KnownDocumentIntelligenceLayoutSkillMarkdownHeaderDepth можно использовать взаимозаменяемо с DocumentIntelligenceLayoutSkillMarkdownHeaderDepth, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

h1: Уровень заголовка 1.
h2: Уровень заголовка 2.
h3: Уровень заголовка 3.
h4: Уровень заголовка 4.
h5: Уровень заголовка 5.
h6: Уровень заголовка 6.

DocumentIntelligenceLayoutSkillOutputFormat

Управляет кратностью выходного формата. По умолчанию используется 'markdown'.
KnownDocumentIntelligenceLayoutSkillOutputFormat можно использовать взаимозаменяемо с DocumentIntelligenceLayoutSkillOutputFormat, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

text: Укажите формат вывода в виде текста.
markdown: Укажите формат вывода в виде markdown.

DocumentIntelligenceLayoutSkillOutputMode

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

Известные значения, поддерживаемые службой

oneToMany: Укажите, что вывод должен быть проанализирован как 'oneToMany'.

EdgeNGramTokenFilterSide

Указывает, с какой стороны входных данных должна быть сгенерирована n-грамма.

EntityCategory

Строка, указывающая, какие категории сущностей следует вернуть.
KnownEntityCategory может использоваться взаимозаменяемо с EntityCategory, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

местоположение: Сущности, описывающие физическое местоположение.
организация: Сущности, описывающие организацию.
человек: Сущности, описывающие человека.
Количество: Сущности, описывающие количество.
datetime: Сущности, описывающие дату и время.
url: Сущности, описывающие URL.
email: Сущности, описывающие адрес электронной почты.

EntityRecognitionSkillLanguage

Коды языков, поддерживаемые для вводимого текста EntityRecognitionSkill.
KnownEntityRecognitionSkillLanguage может использоваться как синонимы с EntityRecognitionSkillLanguage, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

ar: арабский
cs: Czech
ж-Ханс: Chinese-Simplified
zh-Hant: Chinese-Traditional
да: датский
nl: Dutch
английский: английский
fi: финский
фр.: французский
de: немецкий
el: греческая
hu: венгерский
это: итальянский
ja: японская
ko: корейский
нет: норвежский (Bokmaal)
pl: польский
pt-PT: Португальский (Португалия)
pt-BR: Португальский (Бразилия)
ru: Русский
es: Испанский
sv: шведский
tr: турецкий

ExcludedODataTypes
ExhaustiveKnnAlgorithmConfiguration

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

ExtractDocumentKey
GetAliasOptions

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

GetDataSourceConnectionOptions

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

GetIndexOptions

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

GetIndexStatisticsOptions

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

GetIndexerOptions

Параметры для операции индексатора.

GetIndexerStatusOptions

Параметры для операции состояния индексатора.

GetServiceStatisticsOptions

Параметры получения статистики службы.

GetSkillSetOptions

Параметры для операции набора навыков.

GetSynonymMapsOptions

Параметры операции получения карт синонимов.

HnswAlgorithmConfiguration

Содержит параметры конфигурации, относящиеся к алгоритму hnsw, приблизительному ближайшему алгоритму соседей, используемому во время индексирования.

ImageAnalysisSkillLanguage
ImageDetail
IndexActionType

Операция, выполняемая с документом в пакете индексирования.

IndexDocumentsAction

Представляет действие индекса, которое работает с документом.

IndexIterator

Итератор для перечисления индексов, существующих в службе поиска. Будет выполнять запросы по мере необходимости во время итерации. Используйте .byPage() для выполнения одного запроса к серверу на итерацию.

IndexNameIterator

Итератор для перечисления индексов, существующих в службе поиска. Будет выполнять запросы по мере необходимости во время итерации. Используйте .byPage() для выполнения одного запроса к серверу на итерацию.

IndexProjectionMode

Определяет поведение проекций индекса по отношению к остальной части индексатора.
KnownIndexProjectionMode можно использовать взаимозаменяемо с IndexProjectionMode, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

skipIndexingParentDocuments: исходный документ будет пропущен из записи в целевой индекс индексатора.
включаютIndexingParentDocuments: исходный документ будет записан в целевой индекс индексатора. Это шаблон по умолчанию.

IndexerExecutionEnvironment
IndexerExecutionStatus

Представляет состояние выполнения отдельного индексатора.

IndexerResyncOption

Варианты с различными типами разрешений на индексирование.
KnownIndexerResyncOption можно использовать взаимозаменяемо с IndexerResyncOption, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

permissions: индексатор для повторного приема предварительно выбранных данных разрешений из источника данных в индекс.

IndexerStatus

Представляет общее состояние индексатора.

KeyPhraseExtractionSkillLanguage
KnowledgeBaseActivityRecord

Псевдоним для KnowledgeBaseActivityRecordUnion

KnowledgeBaseActivityRecordType

Тип записи активности.
<xref:KnownKnowledgeBaseActivityRecordType> может использоваться взаимозаменяемо с KnowledgeBaseActivityRecordType, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

searchIndex: Поисковая активность по поиску индекса.
azureBlob: Azure Blob retrieval activity.
indexedOneLake: Индексированная активность по поиску OneLake.
веб: Активность по поиску веба.
modelWebSummarization: деятельность по веб-суммаризации LLM.
agenticReasoning: Деятельность агентного рассуждения.

KnowledgeBaseIterator

Итератор для перечисления баз знаний, существующих в сервисе поиска. Будет выполнять запросы по мере необходимости во время итерации. Используйте .byPage() для выполнения одного запроса к серверу на итерацию.

KnowledgeBaseMessageContent

Псевдоним для KnowledgeBaseMessageContentUnion

KnowledgeBaseMessageContentType

Тип содержимого сообщения.
<xref:KnownKnowledgeBaseMessageContentType> может использоваться взаимозаменяемо с KnowledgeBaseMessageContentType, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

текст: Контент текстового сообщения.
изображение: Содержимое изображения.

KnowledgeBaseModel
KnowledgeBaseModelKind

Модель ИИ, которая будет использоваться для планирования запросов.
KnownKnowledgeBaseModelKind может использоваться взаимозаменяемо с KnowledgeBaseModelKind, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

azureOpenAI: Используйте Azure модели Open AI для планирования запросов.

KnowledgeBaseReference

Псевдоним для KnowledgeBaseReferenceUnion

KnowledgeBaseReferenceType

Тип ссылки.
<xref:KnownKnowledgeBaseReferenceType> может использоваться взаимозаменяемо с KnowledgeBaseReferenceType, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

searchIndex: Поиск по ссылке на документ индекса.
azureBlob: Azure Ссылка на документы Blob.
indexedOneLake: Индексированная ссылка на документ OneLake.
веб: Ссылка на веб-документ.

KnowledgeRetrievalIntentType

Тип используемой конфигурации базы знаний.
<xref:KnownKnowledgeRetrievalIntentType> может использоваться взаимозаменяемо с KnowledgeRetrievalIntentType, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

Семантическая: Семантический запрос в естественном языке.

KnowledgeRetrievalReasoningEffortKind

Количество усилий, затрачиваемых во время извлечения.
<xref:KnownKnowledgeRetrievalReasoningEffortKind> может использоваться взаимозаменяемо с KnowledgeRetrievalReasoningEffortKind, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

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

KnowledgeRetrievalReasoningEffortUnion

Alias for KnowledgeRetrievalReasoningEffortUnion

KnowledgeSource
KnowledgeSourceContentExtractionMode

Дополнительный режим извлечения контента. Значение по умолчанию — «минимальный».
<xref:KnownKnowledgeSourceContentExtractionMode> может использоваться взаимозаменяемо с KnowledgeSourceContentExtractionMode, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

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

KnowledgeSourceIterator

Итератор для перечисления источников знаний, существующих в сервисе поиска. Будет выполнять запросы по мере необходимости во время итерации. Используйте .byPage() для выполнения одного запроса к серверу на итерацию.

KnowledgeSourceKind

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

Известные значения, поддерживаемые службой

searchIndex: источник знаний, который считывает данные из индекса поиска.
azureBlob — источник знаний, который считывает и принимает данные из хранилища BLOB-объектов Azure в индекс поиска.
indexedOneLake: источник знаний, считывающий данные из индексируемого OneLake.
веб: источник знаний, который читает данные из интернета.

KnowledgeSourceParams

Псевдоним для KnowledgeSourceParamsUnion

KnowledgeSourceSynchronizationStatus

Текущее состояние синхронизации источника знаний.
<xref:KnownKnowledgeSourceSynchronizationStatus> может использоваться взаимозаменяемо с KnowledgeSourceSynchronizationStatus, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

создание: Источник знаний предоставляется.
активен: Источник знаний активен, и происходят синхронизационные запуски.
удаление: Источник знаний удаляется, синхронизация приостановлена.

KnowledgeSourceVectorizer
LexicalAnalyzer

Содержит возможные случаи для анализатора.

LexicalAnalyzerName

Определяет имена всех текстовых анализаторов, поддерживаемых поисковой системой.
KnownLexicalAnalyzerName можно использовать взаимозаменяемо с LexicalAnalyzerName, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

ar.microsoft: анализатор Майкрософт для арабского языка.
ar.lucene: анализатор Lucene для арабского языка.
hy.lucene: Анализатор Lucene для армян.
bn.microsoft: анализатор Microsoft для Bangla.
eu.lucene: Анализатор Lucene для Баска.
bg.microsoft: анализатор Microsoft для болгарии.
bg.lucene: Анализатор Lucene для Болгарии.
ca.microsoft: анализатор Microsoft для каталонца.
ca.lucene: Анализатор Lucene для Каталонца.
zh-Hans.microsoft: анализатор Microsoft для китайского (упрощенное письмо).
zh-Hans.lucene: анализатор Lucene для китайского (упрощенное письмо).
zh-Hant.microsoft: Анализатор Майкрософт для китайского (традиционного языка).
zh-Hant.lucene: Анализатор Lucene для китайского (традиционного).
hr.microsoft: анализатор Майкрософт для хорватского языка.
cs.microsoft: анализатор Microsoft для Чехии.
cs.lucene: Анализатор Lucene для Чехии.
da.microsoft: анализатор Майкрософт для датского языка.
da.lucene: Анализатор Lucene для датского языка.
nl.microsoft: анализатор Microsoft для нидерландов.
nl.lucene: Анализатор Lucene для нидерландов.
en.microsoft: анализатор Microsoft для английского языка.
en.lucene: Анализатор Lucene для английского языка.
et.microsoft: анализатор Microsoft для Эстонии.
fi.microsoft: анализатор Microsoft для финляндии.
fi.lucene: Анализатор Lucene для финляндии.
fr.microsoft: анализатор Майкрософт для французского языка.
fr.lucene: Анализатор Lucene для французского языка.
gl.lucene: Анализатор Lucene для Галисиана.
de.microsoft: анализатор Майкрософт для немецкого языка.
de.lucene: анализатор Lucene для немецкого языка.
el.microsoft: анализатор Microsoft для греции.
el.lucene: Анализатор Lucene для греческого языка.
gu.microsoft: анализатор Microsoft для Gujarati.
he.microsoft: анализатор Microsoft для иврита.
hi.microsoft: анализатор Microsoft для Хинди.
hi.lucene: Анализатор Lucene для Хинди.
hu.microsoft: анализатор Майкрософт для венгерского.
hu.lucene: Анализатор Lucene для венгерского.
is.microsoft: анализатор Microsoft для Исландии.
id.microsoft: анализатор Майкрософт для индонезийского (Бахаса).
id.lucene: анализатор Lucene для Индонезии.
ga.lucene: Анализатор Lucene для ирландских.
it.microsoft: анализатор Майкрософт для итальянского языка.
it.lucene: Анализатор Lucene для итальянского языка.
ja.microsoft: анализатор Microsoft для японского языка.
ja.lucene: Анализатор Lucene для японского языка.
kn.microsoft: анализатор Microsoft для Kannada.
ko.microsoft: анализатор Майкрософт для корейского языка.
ko.lucene: Анализатор Lucene для корейского языка.
lv.microsoft: анализатор Microsoft для Латвии.
lv.lucene: Анализатор Lucene для Латвии.
lt.microsoft: анализатор Майкрософт для Литвы.
ml.microsoft: анализатор Microsoft для Малаялам.
ms.microsoft: анализатор Майкрософт для Малайского (латиница).
mr.microsoft: анализатор Microsoft для Маратхи.
nb. microsoft: Microsoft анализатор для норвежского языка (Bokmã¥l).
no.lucene: Анализатор Lucene для норвежского языка.
fa.lucene: Анализатор Lucene для персидского языка.
pl.microsoft: анализатор Майкрософт для польского.
pl.lucene: Анализатор Lucene для польского.
pt-BR.microsoft: анализатор Microsoft для португальского языка (Бразилия).
pt-BR.lucene: анализатор Lucene для португальского (Бразилия).
pt-PT.microsoft: анализатор Microsoft для португальского языка (Португалия).
pt-PT.lucene: анализатор Lucene для португальского (Португалия).
pa.microsoft: анализатор Microsoft для Пенджаби.
ro.microsoft: анализатор Microsoft для румынии.
ro.lucene: Анализатор Lucene для румынии.
ru.microsoft: анализатор Майкрософт для русского языка.
ru.lucene: Анализатор Lucene для россии.
sr-cyrillic.microsoft: Анализатор Майкрософт для сербских (кириллица).
sr-latin.microsoft: анализатор Microsoft для сербских (латиница).
sk.microsoft: анализатор Microsoft для словацких.
sl.microsoft: анализатор Майкрософт для словенцев.
es.microsoft: анализатор Майкрософт для испанского языка.
es.lucene: Анализатор Lucene для испанского языка.
sv.microsoft: анализатор Майкрософт для шведского языка.
sv.lucene: Анализатор Lucene для шведского языка.
ta.microsoft: анализатор Майкрософт для Тамил.
te.microsoft: анализатор Microsoft для Telugu.
th.microsoft: анализатор Майкрософт для тайского языка.
th.lucene: Lucene анализатор для тайского языка.
tr.microsoft: анализатор Microsoft для турецкого языка.
tr.lucene: Анализатор Lucene для турецкого языка.
uk.microsoft: анализатор Майкрософт для украины.
your.microsoft: анализатор Microsoft для Urdu.
vi.microsoft: анализатор Майкрософт для вьетнамцев.
standard.lucene: стандартный анализатор Lucene.
standardasciifolding.lucene: Стандартный анализатор ASCII Folding Lucene. См. https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers
ключевое слово: обрабатывает все содержимое поля как один маркер. Это полезно для таких данных, как zip-коды, идентификаторы и некоторые имена продуктов. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html
шаблон: гибкий разделяет текст на термины с помощью шаблона регулярного выражения. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html
простые: делит текст на небуквенный и преобразует их в нижний регистр. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html
остановить: делит текст на небуквенный; Применяет фильтры маркеров стоп-слов и строчных регистров. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html
пробелов: анализатор, использующий токенизатор пробелов. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html

LexicalNormalizer

Содержит возможные случаи для LexicalNormalizer.

LexicalNormalizerName

Определяет имена всех нормализаторов текста, поддерживаемых поисковой системой.
KnownLexicalNormalizerName может использоваться взаимозаменяемо с LexicalNormalizerName, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

asciifolding: преобразует алфавитные, числовые и символьные символы Юникода, которые не находятся в первых 127 символах ASCII (блок Юникода "Базовый латиница") в эквиваленты ASCII, если такие эквиваленты существуют. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html
: удаляет elisions. Например, "l'avion" (плоскость) преобразуется в "avion" (плоскость). См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html
lowercase: Нормализует текст токена в нижний регистр. См. https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html
standard: Стандартный нормализатор, который состоит из строчных и асцифульдинговых. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html
uppercase: нормализует текст токена в верхний регистр. См. https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html

LexicalTokenizer

Содержит возможные варианты для токенизатора.

LexicalTokenizerName

Определяет имена всех токенизаторов, поддерживаемых поисковой системой.
<xref:KnownLexicalTokenizerName> можно использовать взаимозаменяемо с LexicalTokenizerName, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

классический: токенизатор на основе грамматики, подходящий для обработки большинства документов на языке Европы. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html
edgeNGram: маркеризирует входные данные из края в n-граммы заданных размеров. См. https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html
keyword_v2: выводит весь вход в виде одного маркера. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html
буквы: делит текст на небуквенный. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html
строчные: делит текст на небуквенный и преобразует их в нижний регистр. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html
microsoft_language_tokenizer: разделяет текст с помощью правил, относящихся к языку.
microsoft_language_stemming_tokenizer: разделяет текст с помощью правил, относящихся к языку, и сокращает их базовые формы.
nGram: маркеризирует входные данные в n-граммах заданных размеров. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html
path_hierarchy_v2: токенизатор для иерархий, похожих на путь. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html
шаблон: токенизатор, использующий шаблон регулярного выражения для создания уникальных маркеров. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html
standard_v2: анализатор Standard Lucene; Состоит из стандартного токенизатора, нижнего регистра фильтра и фильтра остановки. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html
uax_url_email: маркеризирует URL-адреса и сообщения электронной почты в виде одного маркера. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html
пробелов: делит текст на пробелы. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html

ListAliasesOptions

Параметры операции псевдонимов списка.

ListDataSourceConnectionsOptions

Параметры операции источников данных списка.

ListIndexersOptions

Параметры операции индексаторов списка.

ListIndexesOptions

Параметры операции индексов списка.

ListSkillsetsOptions

Параметры операции набора навыков списка.

ListSynonymMapsOptions

Параметры операции сопоставления синонимов списка.

MarkdownHeaderDepth

Указывает максимальную глубину заголовка, которая будет учитываться при группировке содержимого Markdown. По умолчанию — h6.
KnownMarkdownHeaderDepth можно использовать взаимозаменяемо с MarkdownHeaderDepth, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

h1: Указывает, что заголовки до уровня h1 будут учитываться при группировке содержимого Markdown.
h2: Указывает, что заголовки до уровня h2 будут учитываться при группировании содержимого Markdown.
h3: Указывает, что заголовки до уровня h3 будут учитываться при группировании содержимого Markdown.
h4: Указывает, что заголовки до уровня h4 будут учитываться при группировке содержимого Markdown.
h5: Указывает, что заголовки до уровня h5 будут учитываться при группировании содержимого Markdown.
h6: Указывает, что заголовки до уровня h6 будут учитываться при группировании содержимого Markdown. Это значение по умолчанию.

MarkdownParsingSubmode

Указывает подрежим, который будет определять, будет ли файл Markdown разбираться ровно на один документ поиска или на несколько документов поиска. По умолчанию — oneToMany.
KnownMarkdownParsingSubmode можно использовать взаимозаменяемо с MarkdownParsingSubmode, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

oneToMany: указывает, что каждый раздел файла Markdown (до указанной глубины) будет проанализирован в отдельные документы поиска. Это может привести к созданию нескольких документов поиска в одном файле markdown. Это вложенный режим по умолчанию.
oneToOne: указывает, что каждый файл Markdown будет проанализирован в один документ поиска.

MergeDocumentsOptions

Параметры операции слияния документов.

MergeOrUploadDocumentsOptions

Параметры операции слияния или отправки документов.

MicrosoftStemmingTokenizerLanguage

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

MicrosoftTokenizerLanguage

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

NarrowedModel

Сужает тип модели, чтобы включить только выбранные поля

OcrLineEnding

Определяет последовательность символов, используемых между строками текста, распознаваемыми навыком OCR. Значением по умолчанию является пробел.
KnownOcrLineEnding можно использовать взаимозаменяемо с OcrLineEnding, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

пробел: линии разделяются одним символом пробела.
кареткиReturn: линии разделяются символом возврата каретки ("\r").
lineFeed: линии разделяются одним каналом строк ("\n") символом.
кареткиReturnLineFeed: линии разделяются возвратом каретки и символом строки (\r\n').

OcrSkillLanguage
PIIDetectionSkillMaskingMode
PhoneticEncoder

Определяет тип фонетического кодировщика, используемого с PhoneticTokenFilter.

QueryAnswer

Значение, указывающее, следует ли возвращать ответы как часть ответа поиска. Этот параметр действителен только в том случае, если тип запроса имеет значение "семантика". Если задано значение extractive, запрос возвращает ответы, извлеченные из ключевых проходов в документах с наивысшим рейтингом.

QueryCaption

Значение, указывающее, должны ли возвращаться заголовки в ответе на поиск. Этот параметр действителен только в том случае, если тип запроса имеет значение "семантика". Если задано, запрос возвращает заголовки, извлеченные из ключевых проходов в документах с наивысшим рейтингом. Если субтитры являются извлечением, выделение включается по умолчанию. Значение по умолчанию — none.

QueryDebugMode

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска. Вы можете включить несколько режимов отладки одновременно, разделив их с помощью | , например: semantic|queryRewrites.
KnownQueryDebugMode может использоваться взаимозаменяемо с QueryDebugMode, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

disabled: Информация об отладке запроса не возвращается.
семантический: позволяет пользователю дополнительно изучить свои результаты с переранжированным рейтингом.
vector: позволяет пользователю дополнительно изучить результаты гибридных и векторных запросов.
queryRewrites: Позволяет пользователю изучить список переписанных запросов, созданных для его поискового запроса.
innerHits: Позволяет пользователю получать информацию об оценках векторов, сопоставленных в коллекции сложных типов.
all: Включить все параметры отладки.

QueryRewrites

Определяет параметры для переписывания запросов.

QueryType

Указывает синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте 'full', если в вашем запросе используется синтаксис запроса Lucene, и 'semantic', если синтаксис запроса не нужен.
<xref:KnownQueryType> может использоваться взаимозаменяемо с QueryType, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

просто: Использует простой синтаксис запросов для поиска. Текст поиска интерпретируется с помощью простого языка запросов, который позволяет использовать такие символы, как +, * и "". По умолчанию запросы оцениваются по всем полям, доступным для поиска, если не указан параметр searchFields.
full: Использует полный синтаксис запросов Lucene для поиска. Текст поиска интерпретируется с помощью языка запросов Lucene, который позволяет выполнять поиск по конкретным полям и взвешенный поиск, а также использовать другие расширенные функции.
Семантика: лучше всего подходит для запросов, выраженных на естественном языке, а не на ключевых словах. Повышает точность результатов поиска за счет повторного ранжирования верхних результатов поиска с помощью модели ранжирования, обученной на веб-корпусе.

RankingOrder

Представляет оценку, используемую для сортировки документов.
KnownRankingOrder может использоваться взаимозаменяемо с RankingOrder, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

BoostedRerankerScore: устанавливает порядок сортировки как BoostedRerankerScore
RerankerScore: Устанавливает порядок сортировки как ReRankerScore

RegexFlags
ResetIndexerOptions

Параметры операции индексатора сброса.

RunIndexerOptions

Параметры выполнения операции индексатора.

ScoringFunction

Содержит возможные случаи оценкиFunction.

ScoringFunctionAggregation

Определяет функцию агрегирования, используемую для объединения результатов всех функций оценки в профиле оценки.

ScoringFunctionInterpolation

Определяет функцию, используемую для интерполяции повышения балла по ряду документов.

ScoringStatistics

Значение, указывающее, хотим ли мы вычислять статистику оценки (например, частоту выпуска документов) глобально для более стабильной оценки или локально для более низкой задержки. Значение по умолчанию — 'local'. Используйте 'global' для агрегирования статистики подсчета очков глобально перед подсчетом очков. Использование глобальной статистики скоринга может увеличить задержку поисковых запросов.

SearchField

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

SearchFieldArray

Если TModel является нетипизированным объектом, нетипизированный массив строк в противном случае — поля с разделителями косой черты TModel.

SearchFieldDataType

Определяет значения для SearchFieldDataType.

Известные значения, поддерживаемые службой:

Edm.String: указывает, что поле содержит строку.

Edm.Int32: указывает, что поле содержит 32-разрядное целое число со знаком.

Edm.Int64: указывает, что поле содержит 64-разрядное целое число со знаком.

Edm.Double: указывает, что поле содержит число с плавающей запятой двойной точности IEEE.

Edm.Boolean: указывает, что поле содержит логическое значение (true или false).

Edm.DateTimeOffset: указывает, что поле содержит значение даты и времени, включая сведения о часовом поясе.

Edm.GeographyPoint: указывает, что поле содержит географическое расположение с точки зрения долготы и широты.

Edm.ComplexType: указывает, что поле содержит один или несколько сложных объектов, которые, в свою очередь, имеют под поля других типов.

Edm.Single: указывает, что поле содержит число с плавающей запятой с одной точностью. Это допустимо только при использовании в составе типа коллекции, т. е. Collection(Edm.Single).

Edm.Half: указывает, что поле содержит полуточие с плавающей запятой. Это допустимо только при использовании в составе типа коллекции, т. е. Collection(Edm.Half).

Edm.Int16: указывает, что поле содержит 16-разрядное целое число со знаком. Это допустимо только при использовании в составе типа коллекции, т. е. Collection(Edm.Int16).

Edm.SByte: указывает, что поле содержит 8-разрядное целое число со знаком. Это допустимо только при использовании в составе типа коллекции, т. е. Collection(Edm.SByte).

Edm.Byte: указывает, что поле содержит 8-разрядное целое число без знака. Это допустимо только при использовании в составе типа коллекции, т. е. Collection(Edm.Byte).

SearchIndexAlias

Объект Alias поиска.

SearchIndexerDataIdentity

Содержит возможные случаи для SearchIndexerDataIdentity.

SearchIndexerDataSourceType
SearchIndexerSkill

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

SearchIndexingBufferedSenderDeleteDocumentsOptions

Параметры searchIndexingBufferedSenderDeleteDocuments.

SearchIndexingBufferedSenderFlushDocumentsOptions

Параметры поиска SearchIndexingBufferedSenderFlushDocuments.

SearchIndexingBufferedSenderMergeDocumentsOptions

Параметры поиска SearchIndexingBufferedSenderMergeDocuments.

SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions

Параметры поиска SearchIndexingBufferedSenderMergeOrUploadDocuments.

SearchIndexingBufferedSenderUploadDocumentsOptions

Параметры searchIndexingBufferedSenderUploadDocuments.

SearchIterator

Итератор для результатов поиска патикулярного запроса. Будет выполнять запросы по мере необходимости во время итерации. Используйте .byPage() для выполнения одного запроса к серверу на итерацию.

SearchMode

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

SearchOptions

Параметры фиксации полного запроса поиска.

SearchPick

Глубокий выбор полей T с помощью допустимых путей OData AI Search $select.

SearchRequestOptions

Параметры фильтрации, сортировки, фасетирования, разбиения по страницам и других поведении поисковых запросов.

SearchRequestQueryTypeOptions
SearchResult

Содержит документ, найденный поисковым запросом, а также связанные метаданные.

SelectFields

Создает объединение допустимых путей OData AI Search $select для T с использованием обхода дерева поля, корневого в T.

SemanticErrorMode
SemanticErrorReason
SemanticSearchResultsType

Тип частичного ответа, который был возвращен для запроса семантического ранжирования.
KnownSemanticSearchResultsType может использоваться взаимозаменяемо с SemanticSearchResultsType, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

baseResults: Результаты без семантического обогащения или перераспределения.
rerankedResults: Результаты были переранжированы с моделью реранкера и будут включать семантические подписи. Они не будут включать в себя ответы, основные моменты ответов или подписи.

SentimentSkillLanguage

Коды языков, поддерживаемые SentimentSkill для вводимого текста.
KnownSentimentSkillLanguage может использоваться как синонимы с SentimentSkillLanguage, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

да: датский
nl: Dutch
английский: английский
fi: финский
фр.: французский
de: немецкий
el: греческая
это: итальянский
нет: норвежский (Bokmaal)
pl: польский
pt-PT: Португальский (Португалия)
ru: Русский
es: Испанский
sv: шведский
tr: турецкий

Similarity

Псевдоним для SimilarityAlgorithmUnion

SimilarityAlgorithm

Содержит возможные случаи сходства.

SnowballTokenFilterLanguage

Язык, используемый для фильтра маркеров Snowball.

SplitSkillLanguage
StemmerTokenFilterLanguage

Язык, используемый для фильтра маркеров парадигматического модуля.

StopwordsList

Определяет предопределенный список стоп-слов для конкретного языка.

SuggestNarrowedModel
SuggestOptions

Параметры получения предложений на основе searchText.

SuggestResult

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

TextSplitMode
TextTranslationSkillLanguage
TokenCharacterKind

Представляет классы символов, над которыми может работать фильтр маркеров.

TokenFilter

Содержит возможные случаи для TokenFilter.

TokenFilterName

Определяет имена всех фильтров токенов, поддерживаемых поисковой системой.
<xref:KnownTokenFilterName> можно использовать взаимозаменяемо с TokenFilterName, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

arabic_normalization: фильтр маркеров, который применяет арабский нормализатор для нормализации ортографии. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html
apostrophe: полосит все символы после апострофа (включая сам апостроф). См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html
asciifolding: преобразует алфавитные, числовые и символьные символы Юникода, которые не находятся в первых 127 символах ASCII (блок Юникода "Базовый латиница") в эквиваленты ASCII, если такие эквиваленты существуют. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html
cjk_bigram: формирует большие кадры терминов CJK, созданных из стандартного токенизатора. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html
cjk_width: нормализует различия ширины CJK. Складывает варианты ASCII полной ширины в эквивалентный базовый латинский язык, а полуширинные варианты катаканы — в эквивалентный кану. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html
классических: удаляет английские пристрастия и точки из акронимов. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html
common_grams. Создание больших рам для часто возникающих терминов при индексировании. Отдельные термины по-прежнему индексируются слишком, при наложении bigrams. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html
edgeNGram_v2: создает n-граммы заданных размеров, начиная с передней или задней части входного маркера. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html
: удаляет elisions. Например, "l'avion" (плоскость) преобразуется в "avion" (плоскость). См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html
german_normalization: нормализует немецкие символы в соответствии с эвристиками алгоритма снежного шара германии 2. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html
hindi_normalization: нормализует текст в Хинди, чтобы удалить некоторые различия в вариантах орфографии. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html
indic_normalization: нормализует представление текста Юникода на индийских языках. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html
keyword_repeat: дважды выдает каждый входящий маркер, один раз в качестве ключевого слова и один раз как не ключевое слово. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html
kstem: высокопроизводительный фильтр kstem для английского языка. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html
длину: удаляет слова, слишком длинные или слишком короткие. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html
ограничение: ограничивает количество маркеров при индексировании. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html
строчные: нормализует текст маркера в нижнем регистре. См. https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html
nGram_v2: создает n-граммы заданных размеров. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html
persian_normalization: применяет нормализацию для персидского языка. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html
фонетические: создание маркеров для фонетических совпадений. См. https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html
porter_stem. Использует алгоритм стебля портера для преобразования потока маркеров. См. http://tartarus.org/~martin/PorterStemmer
обратной: отменяет строку токена. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html
scandinavian_normalization: нормализует использование взаимозаменяемых скандинавских символов. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html
scandinavian_folding: Складывает скандинавские иероглифы Ã¥Ã... äæÃ"Æ->a и ã¶Ã–ã ̧à ̃-o>. Он также дискриминирует использование двойных гласных aa, ae, ao, oe и oo, оставляя только первый. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html
сияние: создает сочетания маркеров в виде одного маркера. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html
снежная: фильтр, который стебляет слова с помощью созданного сноубола стебля. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html
sorani_normalization: нормализует представление текста Sorani в Юникоде. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html
стеммера: фильтр для конкретного языка. См. https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters
стоп-слов: удаляет слова остановки из потока маркеров. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html
обрезать: обрезает начальные и конечные пробелы из маркеров. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html
усечение: усечение терминов до определенной длины. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html
уникальные: отфильтровывает маркеры с тем же текстом, что и предыдущий маркер. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html
верхнем регистре: нормализует текст маркера в верхний регистр. См. https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html
word_delimiter: разбивает слова на вложенные слова и выполняет необязательные преобразования в группах подслугов.

UnionToIntersection
UploadDocumentsOptions

Параметры операции отправки документов.

VectorEncodingFormat

Формат кодировки для интерпретации содержимого векторных полей.
KnownVectorEncodingFormat можно использовать взаимозаменяемо с VectorEncodingFormat, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

упакованные биты: формат кодирования, представляющий биты, упакованные в более широкий тип данных.

VectorFilterMode
VectorQuery

Параметры запроса для векторных и гибридных поисковых запросов.

VectorQueryKind
VectorSearchAlgorithmConfiguration

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

VectorSearchAlgorithmKind
VectorSearchAlgorithmMetric
VectorSearchCompression

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

VectorSearchCompressionKind

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

Известные значения, поддерживаемые службой

скалярная квантизация: Скалярная квантизация, тип метода сжатия. В скалярной квантизации исходные значения векторов сжимаются до более узкого типа путем дискретизации и представления каждого компонента вектора с помощью сокращенного набора квантизованных значений, тем самым уменьшая общий размер данных.
binaryQuantization: Binary Quantization, тип метода сжатия. В двоичном квантизации исходные значения векторов сжимаются до более узкого двоичного типа путем дискретизации и представления каждого компонента вектора с использованием двоичных значений, тем самым уменьшая общий размер данных.

VectorSearchCompressionRescoreStorageMethod

Метод хранения исходных векторов полной точности, используемых для восстановления и операций с внутренними индексами.
KnownVectorSearchCompressionRescoreStorageMethod можно использовать взаимозаменяемо с VectorSearchCompressionRescoreStorageMethod, это перечисление содержит известные значения, которые поддерживает сервис.

Известные значения, поддерживаемые службой

preserveOriginals: Этот параметр сохраняет исходные векторы полной точности. Выберите этот параметр для максимальной гибкости и высокого качества сжатых результатов поиска. Это использует больше хранилища, но позволяет переопределять и перезагрегать.
discardOriginals: Этот параметр отбрасывает исходные векторы полной точности. Выберите этот параметр для максимальной экономии хранилища. Так как этот параметр не допускает перезаписи и чрезмерного масштабирования, он часто вызывает небольшое снижение качества.

VectorSearchCompressionTarget

Квантованный тип данных сжатых векторных значений.
KnownVectorSearchCompressionTarget можно использовать взаимозаменяемо с VectorSearchCompressionTarget, эта перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

int8: 8-битное знаковатое целое число.

VectorSearchVectorizer

Содержит параметры конфигурации по векторным запросам вектора текста.

VectorSearchVectorizerKind

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

Известные значения, поддерживаемые службой

azureOpenAI. Создание внедрения с помощью ресурса Azure OpenAI во время запроса.
customWebApi: создание внедрения с помощью пользовательской веб-конечной точки во время запроса.
aiServicesVision: создание встраиваемых изображений для ввода изображения или текста во время запроса с помощью API Vision Vectorize служб Azure AI.
aml: создание внедрений с помощью конечной точки Машинного обучения Azure, развернутой через каталог моделей Azure AI Foundry во время запроса.

VisualFeature
WebApiSkills

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

KnownAIFoundryModelCatalogName

Название модели вложения из каталога Azure AI Foundry, который будет называться.

KnownAnalyzerNames

Определяет значения для AnalyzerName. См. https://learn.microsoft.com/rest/api/searchservice/Language-support

KnownAzureOpenAIModelName

Имя модели Azure Open AI, которое будет вызываться.

KnownBlobIndexerDataToExtract

Указывает данные для извлечения из хранилища BLOB-объектов Azure и сообщает индексатору, какие данные следует извлечь из содержимого изображения, если для параметра imageAction задано значение, отличное от none. Это относится к содержимому внедренного изображения в .PDF или другом приложении, а также к файлам изображений, таким как .jpg и .png, в больших двоичных объектах Azure.

KnownBlobIndexerImageAction

Определяет способ обработки внедренных образов и файлов изображений в хранилище BLOB-объектов Azure. Чтобы задать для конфигурации "imageAction" любое значение, отличное от "none", требуется, чтобы к этому индексатору также был прикреплен набор навыков.

KnownBlobIndexerPDFTextRotationAlgorithm

Определяет алгоритм извлечения текста из PDF-файлов в хранилище BLOB-объектов Azure.

KnownBlobIndexerParsingMode

Представляет режим синтаксического анализа для индексирования из источника данных BLOB-объектов Azure.

KnownCharFilterNames

Определяет значения для CharFilterName.

KnownChatCompletionExtraParametersBehavior

Указывает, как должен работать 'extraParameters' в Azure AI Foundry. По умолчанию 'error'.

KnownChatCompletionResponseFormatType

Указывает, как LLM должен форматировать ответ.

KnownContentUnderstandingSkillChunkingUnit

Управляет кратностью единицы блока. По умолчанию — 'characters'

KnownContentUnderstandingSkillExtractionOptions

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

KnownCustomEntityLookupSkillLanguage

Коды языков, поддерживаемые для ввода текста CustomEntityLookupSkill.

KnownDocumentIntelligenceLayoutSkillChunkingUnit

Управляет кратностью единицы блока. По умолчанию — 'characters'

KnownDocumentIntelligenceLayoutSkillExtractionOptions

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

KnownDocumentIntelligenceLayoutSkillMarkdownHeaderDepth

Глубина заголовков в выходных данных markdown. Значение по умолчанию — h6.

KnownDocumentIntelligenceLayoutSkillOutputFormat

Управляет кратностью выходного формата. По умолчанию используется 'markdown'.

KnownDocumentIntelligenceLayoutSkillOutputMode

Управляет кратностью выходных данных, созданных навыком. Значение по умолчанию — oneToMany.

KnownEntityCategory

Строка, указывающая, какие категории сущностей следует вернуть.

KnownEntityRecognitionSkillLanguage

Коды языков, поддерживаемые для вводимого текста EntityRecognitionSkill.

KnownImageAnalysisSkillLanguage

Коды языков, поддерживаемые для ввода ImageAnalysisSkill.

KnownImageDetail

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

KnownIndexProjectionMode

Определяет поведение проекций индекса по отношению к остальной части индексатора.

KnownIndexerExecutionEnvironment

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

KnownIndexerResyncOption

Варианты с различными типами разрешений на индексирование.

KnownKeyPhraseExtractionSkillLanguage

Коды языков, поддерживаемые для ввода текста KeyPhraseExtractionSkill.

KnownKnowledgeBaseModelKind

Модель ИИ, которая будет использоваться для планирования запросов.

KnownKnowledgeSourceKind

Вид источника знаний.

KnownLexicalAnalyzerName

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

KnownLexicalNormalizerName

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

KnownMarkdownHeaderDepth

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

KnownMarkdownParsingSubmode

Указывает подрежим, который будет определять, будет ли файл Markdown разбираться ровно на один документ поиска или на несколько документов поиска. По умолчанию — oneToMany.

KnownOcrLineEnding

Определяет последовательность символов, используемых между строками текста, распознаваемыми навыком OCR. Значением по умолчанию является пробел.

KnownOcrSkillLanguage

Коды языков, поддерживаемые для ввода OcrSkill.

KnownPIIDetectionSkillMaskingMode

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

KnownQueryDebugMode

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска. Вы можете включить несколько режимов отладки одновременно, разделив их с помощью | , например: semantic|queryRewrites.

KnownRankingOrder

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

KnownRegexFlags

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

KnownSearchAudience

Известные значения для аудитории поиска

KnownSearchFieldDataType

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

KnownSearchIndexerDataSourceType

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

KnownSemanticErrorMode

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

KnownSemanticErrorReason

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

KnownSemanticSearchResultsType

Тип частичного ответа, который был возвращен для запроса семантического ранжирования.

KnownSentimentSkillLanguage

Коды языков, поддерживаемые SentimentSkill для вводимого текста.

KnownSplitSkillLanguage

Коды языков, поддерживаемые SplitSkill для ввода текста.

KnownTextSplitMode

Значение, указывающее, какой режим разделения для выполнения.

KnownTextTranslationSkillLanguage

Коды языков, поддерживаемые TextTranslationSkill для вводимого текста.

KnownTokenFilterNames

Определяет значения для TokenFilterName.

KnownTokenizerNames

Определяет значения для TokenizerName.

KnownVectorEncodingFormat

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

KnownVectorFilterMode

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

KnownVectorQueryKind

Тип выполняемого векторного запроса.

KnownVectorSearchAlgorithmKind

Алгоритм, используемый для индексирования и запросов.

KnownVectorSearchAlgorithmMetric

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

KnownVectorSearchCompressionKind

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

KnownVectorSearchCompressionRescoreStorageMethod

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

KnownVectorSearchCompressionTarget

Квантованный тип данных сжатых векторных значений.

KnownVectorSearchVectorizerKind

Метод векторизации, который будет использоваться во время запроса.

KnownVisualFeature

Строки, указывающие, какие типы визуальных элементов следует возвращать.

Функции

createSynonymMapFromFile(string, string)

Вспомогательный метод для создания объекта SynonymMap. Это единственный метод NodeJS.

odata(TemplateStringsArray, unknown[])

Экранирует выражение фильтра odata, чтобы избежать ошибок с помощью строковых литерала. Пример использования:

import { odata } from "@azure/search-documents";

const baseRateMax = 200;
const ratingMin = 4;
const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;

Дополнительные сведения о поддерживаемом синтаксисе см. в статье https://learn.microsoft.com/azure/search/search-query-odata-filter

Переменные

DEFAULT_BATCH_SIZE

Стандартный размер пакета

DEFAULT_FLUSH_WINDOW

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

DEFAULT_RETRY_COUNT

По умолчанию количество повторных попыток.

Сведения о функции

createSynonymMapFromFile(string, string)

Вспомогательный метод для создания объекта SynonymMap. Это единственный метод NodeJS.

function createSynonymMapFromFile(name: string, filePath: string): Promise<SynonymMap>

Параметры

name

string

Имя Синоним-карты.

filePath

string

Путь к файлу, который содержит синонимы (разделяется новыми строками)

Возвращаемое значение

Promise<SynonymMap>

Объект SynonymMap

odata(TemplateStringsArray, unknown[])

Экранирует выражение фильтра odata, чтобы избежать ошибок с помощью строковых литерала. Пример использования:

import { odata } from "@azure/search-documents";

const baseRateMax = 200;
const ratingMin = 4;
const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;

Дополнительные сведения о поддерживаемом синтаксисе см. в статье https://learn.microsoft.com/azure/search/search-query-odata-filter

function odata(strings: TemplateStringsArray, values: unknown[]): string

Параметры

strings

TemplateStringsArray

Массив строк для выражения

values

unknown[]

Массив значений для выражения

Возвращаемое значение

string

Сведения об переменной

DEFAULT_BATCH_SIZE

Стандартный размер пакета

DEFAULT_BATCH_SIZE: number

Тип

number

DEFAULT_FLUSH_WINDOW

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

DEFAULT_FLUSH_WINDOW: number

Тип

number

DEFAULT_RETRY_COUNT

По умолчанию количество повторных попыток.

DEFAULT_RETRY_COUNT: number

Тип

number