Indexes - Analyze
Visar hur ett analysverktyg delar upp text i token.
POST {endpoint}/indexes('{indexName}')/search.analyze?api-version=2026-04-01
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Slutpunkts-URL:en för söktjänsten. |
|
index
|
path | True |
string |
Namnet på indexet. |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| Accept |
Acceptera-rubriken. |
||
| x-ms-client-request-id |
string (uuid) |
En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran. |
Begärandetext
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| text | True |
string |
Texten som ska delas in i token. |
| analyzer |
Namnet på analysatorn som ska användas för att bryta den angivna texten. Om den här parametern inte har angetts måste du ange en tokenizer i stället. Parametrarna tokenizer och analyzer är ömsesidigt uteslutande. |
||
| charFilters |
En valfri lista med teckenfilter som ska användas när du bryter den angivna texten. Den här parametern kan bara anges när du använder parametern tokenizer. |
||
| normalizer |
Namnet på normaliseraren som ska användas för att normalisera den angivna texten. |
||
| tokenFilters |
En valfri lista över tokenfilter som ska användas när du bryter den angivna texten. Den här parametern kan bara anges när du använder parametern tokenizer. |
||
| tokenizer |
Namnet på tokenizern som ska användas för att bryta den angivna texten. Om den här parametern inte har angetts måste du ange en analysator i stället. Parametrarna tokenizer och analyzer är ömsesidigt uteslutande. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Begäran har slutförts. |
|
| Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
api-key
Typ:
apiKey
I:
header
OAuth2Auth
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Omfattningar
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Exempel
SearchServiceIndexAnalyze
Exempelbegäran
POST https://exampleservice.search.windows.net/indexes('example-index')/search.analyze?api-version=2026-04-01
{
"text": "Text to analyze",
"analyzer": "ar.lucene"
}
Exempelsvar
{
"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
}
]
}
Definitioner
| Name | Description |
|---|---|
| Accept |
Acceptera-rubriken. |
|
Analyzed |
Information om en token som returneras av en analysator. |
|
Analyze |
Anger vissa text- och analyskomponenter som används för att dela upp texten i token. |
|
Analyze |
Resultatet av att testa en analysator på text. |
|
Char |
Definierar namnen på alla teckenfilter som stöds av sökmotorn. |
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Error |
Felinformationen. |
|
Error |
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.). |
|
Lexical |
Definierar namnen på alla textanalysverktyg som stöds av sökmotorn. |
|
Lexical |
Definierar namnen på alla textnormaliserare som stöds av sökmotorn. |
|
Lexical |
Definierar namnen på alla tokeniserare som stöds av sökmotorn. |
|
Token |
Definierar namnen på alla tokenfilter som stöds av sökmotorn. |
Accept
Acceptera-rubriken.
| Värde | Description |
|---|---|
| application/json;odata.metadata=minimal |
AnalyzedTokenInfo
Information om en token som returneras av en analysator.
| Name | Typ | Description |
|---|---|---|
| endOffset |
integer (int32) |
Indexet för tokens sista tecken i indatatexten. |
| position |
integer (int32) |
Tokens position i indatatexten i förhållande till andra token. Den första token i indatatexten har position 0, nästa har position 1 och så vidare. Beroende på vilken analysator som används kan vissa token ha samma position, till exempel om de är synonymer till varandra. |
| startOffset |
integer (int32) |
Indexet för tokens första tecken i indatatexten. |
| token |
string |
Token som returneras av analysatorn. |
AnalyzeRequest
Anger vissa text- och analyskomponenter som används för att dela upp texten i token.
| Name | Typ | Description |
|---|---|---|
| analyzer |
Namnet på analysatorn som ska användas för att bryta den angivna texten. Om den här parametern inte har angetts måste du ange en tokenizer i stället. Parametrarna tokenizer och analyzer är ömsesidigt uteslutande. |
|
| charFilters |
En valfri lista med teckenfilter som ska användas när du bryter den angivna texten. Den här parametern kan bara anges när du använder parametern tokenizer. |
|
| normalizer |
Namnet på normaliseraren som ska användas för att normalisera den angivna texten. |
|
| text |
string |
Texten som ska delas in i token. |
| tokenFilters |
En valfri lista över tokenfilter som ska användas när du bryter den angivna texten. Den här parametern kan bara anges när du använder parametern tokenizer. |
|
| tokenizer |
Namnet på tokenizern som ska användas för att bryta den angivna texten. Om den här parametern inte har angetts måste du ange en analysator i stället. Parametrarna tokenizer och analyzer är ömsesidigt uteslutande. |
AnalyzeResult
Resultatet av att testa en analysator på text.
| Name | Typ | Description |
|---|---|---|
| tokens |
Listan över token som returneras av analysatorn som anges i begäran. |
CharFilterName
Definierar namnen på alla teckenfilter som stöds av sökmotorn.
| Värde | Description |
|---|---|
| html_strip |
Ett teckenfilter som försöker ta bort HTML-konstruktioner. Se https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
Den ytterligare informationen. |
|
| type |
string |
Typen av ytterligare information. |
ErrorDetail
Felinformationen.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Felet ytterligare information. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
ErrorResponse
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
| Name | Typ | Description |
|---|---|---|
| error |
Felet objektet. |
LexicalAnalyzerName
Definierar namnen på alla textanalysverktyg som stöds av sökmotorn.
| Värde | Description |
|---|---|
| ar.microsoft |
Microsoft-analysator för arabiska. |
| ar.lucene |
Lucene-analysator för arabiska. |
| hy.lucene |
Lucene-analysator för armeniska. |
| bn.microsoft |
Microsoft-analysator för bangla. |
| eu.lucene |
Lucene analysator för baskiska. |
| bg.microsoft |
Microsoft analyzer för bulgariska. |
| bg.lucene |
Lucene-analysator för bulgariska. |
| ca.microsoft |
Microsoft-analysator för katalanska. |
| ca.lucene |
Lucene-analysator för katalanska. |
| zh-Hans.microsoft |
Microsoft-analysator för kinesiska (förenklad). |
| zh-Hans.lucene |
Lucene-analysator för kinesiska (förenklad). |
| zh-Hant.microsoft |
Microsoft-analysator för kinesiska (traditionella). |
| zh-Hant.lucene |
Lucene-analysator för kinesiska (traditionell). |
| hr.microsoft |
Microsoft analyzer för kroatiska. |
| cs.microsoft |
Microsoft-analysator för tjeckiska. |
| cs.lucene |
Lucene-analysator för tjeckiska. |
| da.microsoft |
Microsoft-analysator för danska. |
| da.lucene |
Lucene-analysator för danska. |
| nl.microsoft |
Microsoft-analysator för nederländska. |
| nl.lucene |
Lucene-analysator för nederländska. |
| en.microsoft |
Microsoft-analysator för engelska. |
| en.lucene |
Lucene-analysator för engelska. |
| et.microsoft |
Microsoft analyzer för estniska. |
| fi.microsoft |
Microsoft-analysator för finska. |
| fi.lucene |
Lucene-analysator för finska. |
| fr.microsoft |
Microsoft-analysator för franska. |
| fr.lucene |
Lucene-analysator för franska. |
| gl.lucene |
Lucene-analysator för galiciska. |
| de.microsoft |
Microsoft-analysator för tyska. |
| de.lucene |
Lucene-analysator för tyska. |
| el.microsoft |
Microsoft-analysator för Grekiska. |
| el.lucene |
Lucene-analysator för grekiska. |
| gu.microsoft |
Microsoft-analysator för gujarati. |
| he.microsoft |
Microsoft-analysator för hebreiska. |
| hi.microsoft |
Microsoft-analysator för hindi. |
| hi.lucene |
Lucene-analysator för hindi. |
| hu.microsoft |
Microsoft-analysator för ungerska. |
| hu.lucene |
Lucene-analysator för ungerska. |
| is.microsoft |
Microsoft-analysator för isländska. |
| id.microsoft |
Microsoft-analysator för indonesiska (Bahasa). |
| id.lucene |
Lucene-analysator för indonesiska. |
| ga.lucene |
Lucene-analysator för irländska. |
| it.microsoft |
Microsoft analyzer för italienska. |
| it.lucene |
Lucene-analysator för italienska. |
| ja.microsoft |
Microsoft-analysator för japanska. |
| ja.lucene |
Lucene-analysator för japanska. |
| kn.microsoft |
Microsoft analyzer för kannada. |
| ko.microsoft |
Microsoft-analysator för koreanska. |
| ko.lucene |
Lucene-analysator för koreanska. |
| lv.microsoft |
Microsoft-analysator för lettiska. |
| lv.lucene |
Lucene-analysator för lettiska. |
| lt.microsoft |
Microsoft analyzer för litauiska. |
| ml.microsoft |
Microsoft-analysator för malayalam. |
| ms.microsoft |
Microsoft-analysator för malajiska (latin). |
| mr.microsoft |
Microsoft-analysator för marathi. |
| nb.microsoft |
Microsoft analyzer for Norwegian (Bokmül). |
| no.lucene |
Lucene-analysator för norska. |
| fa.lucene |
Lucene-analysator för persiska. |
| pl.microsoft |
Microsoft-analysator för polska. |
| pl.lucene |
Lucene-analysator för polska. |
| pt-BR.microsoft |
Microsoft analyzer för portugisiska (Brasilien). |
| pt-BR.lucene |
Lucene-analysator för portugisiska (Brasilien). |
| pt-PT.microsoft |
Microsoft analyzer for Portuguese (Portugal). |
| pt-PT.lucene |
Lucene-analysator för portugisiska (Portugal). |
| pa.microsoft |
Microsoft-analysator för punjabi. |
| ro.microsoft |
Microsoft-analysator för rumänska. |
| ro.lucene |
Lucene-analysator för rumänska. |
| ru.microsoft |
Microsoft-analysator för ryska. |
| ru.lucene |
Lucene-analysator för ryska. |
| sr-cyrillic.microsoft |
Microsoft analyzer för serbiska (kyrilliska). |
| sr-latin.microsoft |
Microsoft analyzer för serbiska (latin). |
| sk.microsoft |
Microsoft-analysator för slovakiska. |
| sl.microsoft |
Microsoft analyzer for Slovenian. |
| es.microsoft |
Microsoft-analysator för spanska. |
| es.lucene |
Lucene-analysator för spanska. |
| sv.microsoft |
Microsoft-analysator för svenska. |
| sv.lucene |
Lucene analysator för svenska. |
| ta.microsoft |
Microsoft-analysator för tamil. |
| te.microsoft |
Microsoft analyzer för telugu. |
| th.microsoft |
Microsoft-analysator för thailändska. |
| th.lucene |
Lucene-analysator för thailändska. |
| tr.microsoft |
Microsoft-analysator för turkiskt. |
| tr.lucene |
Lucene-analysator för turkiska. |
| uk.microsoft |
Microsoft-analysator för ukrainska. |
| ur.microsoft |
Microsoft-analysator för urdu. |
| vi.microsoft |
Microsoft-analysator för vietnamesiska. |
| standard.lucene |
Lucene-analysator som standard. |
| standardasciifolding.lucene |
Standard ASCII vikning Lucene-analysator. Se https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers |
| keyword |
Behandlar hela innehållet i ett fält som en enda token. Detta är användbart för data som postnummer, ID och vissa produktnamn. Se http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html |
| pattern |
Flexibelt delar upp texten i termer med hjälp av ett reguljärt uttrycksmönster. Se http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html |
| simple |
Delar upp text med icke-bokstäver och konverterar dem till gemener. Se http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html |
| stop |
Delar upp text med icke-bokstäver; Tillämpar filter för gemener och stoppordstoken. Se http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html |
| whitespace |
En analysator som använder mellanslagstokeniseraren. Se http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html |
LexicalNormalizerName
Definierar namnen på alla textnormaliserare som stöds av sökmotorn.
LexicalTokenizerName
Definierar namnen på alla tokeniserare som stöds av sökmotorn.
TokenFilterName
Definierar namnen på alla tokenfilter som stöds av sökmotorn.