Indexes - Analyze
Показывает, как анализатор разбивает текст на лексемы.
POST {endpoint}/indexes('{indexName}')/search.analyze?api-version=2026-04-01Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
URL-адрес конечной точки службы поиска. |
|
index
|
path | True |
string |
Имя индекса. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| Accept |
Заголовок Accept. |
||
| x-ms-client-request-id |
string (uuid) |
Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса. |
Текст запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| text | True |
string |
Текст, который нужно разбить на маркеры. |
| analyzer |
Имя анализатора, используемого для разрыва заданного текста. Если этот параметр не указан, необходимо указать вместо него токенизатор. Параметры токенизатора и анализатора являются взаимоисключающими. |
||
| charFilters |
Необязательный список фильтров символов, используемых при разрыве заданного текста. Этот параметр можно задать только при использовании параметра токенизатора. |
||
| normalizer |
Имя нормализатора, используемого для нормализации заданного текста. |
||
| tokenFilters |
Необязательный список фильтров маркеров, используемых при разрыве заданного текста. Этот параметр можно задать только при использовании параметра токенизатора. |
||
| tokenizer |
Имя токенизатора, используемого для разрыва заданного текста. Если этот параметр не указан, необходимо указать анализатор. Параметры токенизатора и анализатора являются взаимоисключающими. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
api-key
Тип:
apiKey
В:
header
OAuth2Auth
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Области
| Имя | Описание |
|---|---|
| https://search.azure.com/.default |
Примеры
SearchServiceIndexAnalyze
Образец запроса
POST https://exampleservice.search.windows.net/indexes('example-index')/search.analyze?api-version=2026-04-01
{
"text": "Text to analyze",
"analyzer": "ar.lucene"
}
Пример ответа
{
"tokens": [
{
"token": "text",
"startOffset": 0,
"endOffset": 4,
"position": 0
},
{
"token": "to",
"startOffset": 5,
"endOffset": 7,
"position": 1
},
{
"token": "analyze",
"startOffset": 8,
"endOffset": 15,
"position": 2
}
]
}Определения
| Имя | Описание |
|---|---|
| Accept |
Заголовок Accept. |
|
Analyzed |
Сведения о маркере, возвращаемом анализатором. |
|
Analyze |
Указывает некоторые компоненты текста и анализа, используемые для разбиения этого текста на маркеры. |
|
Analyze |
Результат тестирования анализатора на тексте. |
|
Char |
Определяет имена всех фильтров символов, поддерживаемых поисковой системой. |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.). |
|
Lexical |
Определяет имена всех текстовых анализаторов, поддерживаемых поисковой системой. |
|
Lexical |
Определяет имена всех нормализаторов текста, поддерживаемых поисковой системой. |
|
Lexical |
Определяет имена всех токенизаторов, поддерживаемых поисковой системой. |
|
Token |
Определяет имена всех фильтров токенов, поддерживаемых поисковой системой. |
Accept
Заголовок Accept.
| Значение | Описание |
|---|---|
| application/json;odata.metadata=minimal |
AnalyzedTokenInfo
Сведения о маркере, возвращаемом анализатором.
| Имя | Тип | Описание |
|---|---|---|
| endOffset |
integer (int32) |
Индекс последнего символа маркера в входном тексте. |
| position |
integer (int32) |
Позиция маркера в входном тексте относительно других маркеров. Первый маркер в входном тексте имеет позицию 0, следующая имеет позицию 1 и т. д. В зависимости от используемого анализатора некоторые маркеры могут иметь одинаковую позицию, например если они являются синонимами друг друга. |
| startOffset |
integer (int32) |
Индекс первого символа маркера в входном тексте. |
| token |
string |
Маркер, возвращаемый анализатором. |
AnalyzeRequest
Указывает некоторые компоненты текста и анализа, используемые для разбиения этого текста на маркеры.
| Имя | Тип | Описание |
|---|---|---|
| analyzer |
Имя анализатора, используемого для разрыва заданного текста. Если этот параметр не указан, необходимо указать вместо него токенизатор. Параметры токенизатора и анализатора являются взаимоисключающими. |
|
| charFilters |
Необязательный список фильтров символов, используемых при разрыве заданного текста. Этот параметр можно задать только при использовании параметра токенизатора. |
|
| normalizer |
Имя нормализатора, используемого для нормализации заданного текста. |
|
| text |
string |
Текст, который нужно разбить на маркеры. |
| tokenFilters |
Необязательный список фильтров маркеров, используемых при разрыве заданного текста. Этот параметр можно задать только при использовании параметра токенизатора. |
|
| tokenizer |
Имя токенизатора, используемого для разрыва заданного текста. Если этот параметр не указан, необходимо указать анализатор. Параметры токенизатора и анализатора являются взаимоисключающими. |
AnalyzeResult
Результат тестирования анализатора на тексте.
| Имя | Тип | Описание |
|---|---|---|
| tokens |
Список токенов, возвращаемых анализатором, указанный в запросе. |
CharFilterName
Определяет имена всех фильтров символов, поддерживаемых поисковой системой.
| Значение | Описание |
|---|---|
| html_strip |
Фильтр символов, который пытается удалить конструкции HTML. См. https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
Дополнительные сведения. |
|
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
LexicalAnalyzerName
Определяет имена всех текстовых анализаторов, поддерживаемых поисковой системой.
| Значение | Описание |
|---|---|
| ar.microsoft |
Microsoft Analyzer для арабского языка. |
| ar.lucene |
Анализатор Lucene для арабского языка. |
| hy.lucene |
Анализатор Lucene для армянского языка. |
| bn.microsoft |
Microsoft Analyzer для бенгальского языка. |
| eu.lucene |
Анализатор Lucene для баскского языка. |
| bg.microsoft |
Microsoft Analyzer для болгарского языка. |
| bg.lucene |
Анализатор люцин для болгарского языка. |
| ca.microsoft |
Microsoft analyzer для каталонского. |
| ca.lucene |
Анализатор Lucene для каталанского языка. |
| zh-Hans.microsoft |
Microsoft Analyzer для китайского языка (упрощённый). |
| zh-Hans.lucene |
Анализатор Lucene для китайского языка (упрощенный). |
| zh-Hant.microsoft |
Microsoft Analyzer для китайского (традиционный). |
| zh-Hant.lucene |
Анализатор люцин для китайского языка (традиционный). |
| hr.microsoft |
Microsoft analyzer для хорватского языка. |
| cs.microsoft |
Microsoft analyzer для чешского языка. |
| cs.lucene |
Анализатор Lucene для чешского языка. |
| da.microsoft |
Microsoft Analyzer для датского языка. |
| da.lucene |
Анализатор Lucene для датского языка. |
| nl.microsoft |
Microsoft Analyzer для голландского языка. |
| nl.lucene |
Анализатор Lucene для голландского языка. |
| en.microsoft |
Microsoft Analyzer для английского языка. |
| en.lucene |
Анализатор Lucene для английского языка. |
| et.microsoft |
Microsoft analyzer для эстонского. |
| fi.microsoft |
Microsoft analyzer для финского языка. |
| fi.lucene |
Анализатор Lucene для финского языка. |
| fr.microsoft |
Microsoft Analyzer для французского. |
| fr.lucene |
Анализатор Lucene для французского языка. |
| gl.lucene |
Анализатор Lucene для галисийского языка. |
| de.microsoft |
Microsoft Analyzer для немецкого языка. |
| de.lucene |
Анализатор Lucene для немецкого языка. |
| el.microsoft |
Microsoft Analyzer для греческого. |
| el.lucene |
Анализатор Lucene для греческого языка. |
| gu.microsoft |
Microsoft Analyzer для гуджарати. |
| he.microsoft |
Microsoft Analyzer для иврита. |
| hi.microsoft |
Microsoft Analyzer для хинди. |
| hi.lucene |
Анализатор Lucene для хинди. |
| hu.microsoft |
Microsoft Analyzer для венгерского языка. |
| hu.lucene |
Анализатор Lucene для венгерского языка. |
| is.microsoft |
Microsoft Analyzer для исландского. |
| id.microsoft |
Microsoft analyzer для индонезийского языка (Bahasa). |
| id.lucene |
Анализатор Lucene для индонезийского языка. |
| ga.lucene |
Анализатор Lucene для ирландцев. |
| it.microsoft |
Microsoft Analyzer для итальянского. |
| it.lucene |
Анализатор Lucene для итальянского языка. |
| ja.microsoft |
Microsoft Analyzer для японского языка. |
| ja.lucene |
Анализатор Lucene для японского языка. |
| kn.microsoft |
Microsoft analyzer для каннада. |
| ko.microsoft |
Microsoft Analyzer для корейского языка. |
| ko.lucene |
Анализатор Lucene для корейского языка. |
| lv.microsoft |
Microsoft analyzer для латвийского языка. |
| lv.lucene |
Анализатор Lucene для латышского языка. |
| lt.microsoft |
Microsoft analyzer для литовского языка. |
| ml.microsoft |
Microsoft analyzer для малаялам. |
| ms.microsoft |
Microsoft analyzer для малайского языка (латинский). |
| mr.microsoft |
Microsoft Analyzer для маратхи. |
| nb.microsoft |
Microsoft analyzer for Norwegian (Bokmål). |
| no.lucene |
Анализатор Lucene для норвежского языка. |
| fa.lucene |
Анализатор Lucene для персидского языка. |
| pl.microsoft |
Microsoft Analyzer для польского языка. |
| pl.lucene |
Анализатор Lucene для польского языка. |
| pt-BR.microsoft |
Microsoft Analyzer для португальского (Бразилия). |
| pt-BR.lucene |
Анализатор Lucene для португальского языка (Бразилия). |
| pt-PT.microsoft |
Microsoft analyzer для португальского языка (Португалия). |
| pt-PT.lucene |
Анализатор Lucene для португальского языка (Португалия). |
| pa.microsoft |
Microsoft analyzer for Punjabi. |
| ro.microsoft |
Microsoft Analyzer для румынского. |
| ro.lucene |
Анализатор Lucene для румынского языка. |
| ru.microsoft |
Microsoft Analyzer для русского языка. |
| ru.lucene |
Анализатор люцин для русского языка. |
| sr-cyrillic.microsoft |
Microsoft analyzer для сербского языка (кириллица). |
| sr-latin.microsoft |
Microsoft analyzer для сербского (латинского). |
| sk.microsoft |
Microsoft analyzer для словацкого. |
| sl.microsoft |
Microsoft analyzer for Slovenian. |
| es.microsoft |
Microsoft Analyzer для испанского. |
| es.lucene |
Анализатор Lucene для испанского языка. |
| sv.microsoft |
Microsoft Analyzer для шведского языка. |
| sv.lucene |
Анализатор Lucene для шведского языка. |
| ta.microsoft |
Microsoft Analyzer для тамильского языка. |
| te.microsoft |
Microsoft analyzer для телугу. |
| th.microsoft |
Microsoft analyzer для тайского языка. |
| th.lucene |
Анализатор Lucene для тайского языка. |
| tr.microsoft |
Microsoft Analyzer для турецкого языка. |
| tr.lucene |
Анализатор Lucene для турецкого языка. |
| uk.microsoft |
Microsoft Analyzer для украинского языка. |
| ur.microsoft |
Microsoft analyzer для урду. |
| vi.microsoft |
Microsoft Analyzer для вьетнамского языка. |
| standard.lucene |
Стандартный анализатор люцина. |
| standardasciifolding.lucene |
Стандартный ASCII Folding Lucene analyzer. См. https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers |
| keyword |
Обрабатывает все содержимое поля как один маркер. Это полезно для таких данных, как zip-коды, идентификаторы и некоторые имена продуктов. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html |
| pattern |
Гибко разделяет текст на термины с помощью шаблона регулярного выражения. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html |
| simple |
Разбивает текст по небуквенным знакам и преобразует его в нижний регистр. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html |
| stop |
Делит текст на небуквенный; Применяет фильтры маркеров стоп-слов и строчных регистров. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html |
| whitespace |
Анализатор, использующий токенизатор пробелов. См. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html |
LexicalNormalizerName
Определяет имена всех нормализаторов текста, поддерживаемых поисковой системой.
LexicalTokenizerName
Определяет имена всех токенизаторов, поддерживаемых поисковой системой.
TokenFilterName
Определяет имена всех фильтров токенов, поддерживаемых поисковой системой.