Indexes - Analyze
Mostra como um analisador divide o texto em tokens.
POST {endpoint}/indexes('{indexName}')/search.analyze?api-version=2026-04-01Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A URL do ponto de extremidade do serviço de pesquisa. |
|
index
|
path | True |
string |
O nome do índice. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Accept |
O cabeçalho Aceitar. |
||
| x-ms-client-request-id |
string (uuid) |
Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido. |
Corpo do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| text | True |
string |
O texto para dividir em tokens. |
| analyzer |
O nome do analisador a ser usado para quebrar o texto fornecido. Se esse parâmetro não for especificado, você deverá especificar um tokenizador. Os parâmetros do tokenizador e do analisador são mutuamente exclusivos. |
||
| charFilters |
Uma lista opcional de filtros de caracteres para usar ao quebrar o texto determinado. Este parâmetro só pode ser definido ao usar o parâmetro tokenizer. |
||
| normalizer |
O nome do normalizador a ser usado para normalizar o texto fornecido. |
||
| tokenFilters |
Uma lista opcional de filtros de token para usar ao quebrar o texto fornecido. Este parâmetro só pode ser definido ao usar o parâmetro tokenizer. |
||
| tokenizer |
O nome do tokenizador a ser usado para quebrar o texto fornecido. Se esse parâmetro não for especificado, você deverá especificar um analisador. Os parâmetros do tokenizador e do analisador são mutuamente exclusivos. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
O pedido foi bem-sucedido. |
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
api-key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbitos
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Exemplos
SearchServiceIndexAnalyze
Pedido de amostra
POST https://exampleservice.search.windows.net/indexes('example-index')/search.analyze?api-version=2026-04-01
{
"text": "Text to analyze",
"analyzer": "ar.lucene"
}
Resposta da amostra
{
"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
}
]
}Definições
| Name | Description |
|---|---|
| Accept |
O cabeçalho Aceitar. |
|
Analyzed |
Informações sobre um token retornado por um analisador. |
|
Analyze |
Especifica alguns componentes de texto e análise usados para dividir esse texto em tokens. |
|
Analyze |
O resultado do teste de um analisador em texto. |
|
Char |
Define os nomes de todos os filtros de caracteres suportados pelo mecanismo de pesquisa. |
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.) |
|
Lexical |
Define os nomes de todos os analisadores de texto suportados pelo mecanismo de pesquisa. |
|
Lexical |
Define os nomes de todos os normalizadores de texto suportados pelo mecanismo de pesquisa. |
|
Lexical |
Define os nomes de todos os tokenizadores suportados pelo mecanismo de pesquisa. |
|
Token |
Define os nomes de todos os filtros de token suportados pelo mecanismo de pesquisa. |
Accept
O cabeçalho Aceitar.
| Valor | Description |
|---|---|
| application/json;odata.metadata=minimal |
AnalyzedTokenInfo
Informações sobre um token retornado por um analisador.
| Name | Tipo | Description |
|---|---|---|
| endOffset |
integer (int32) |
O índice do último caractere do token no texto de entrada. |
| position |
integer (int32) |
A posição do token no texto de entrada em relação a outros tokens. O primeiro token no texto de entrada tem a posição 0, o próximo tem a posição 1 e assim por diante. Dependendo do analisador usado, alguns tokens podem ter a mesma posição, por exemplo, se forem sinônimos uns dos outros. |
| startOffset |
integer (int32) |
O índice do primeiro caractere do token no texto de entrada. |
| token |
string |
O token retornado pelo analisador. |
AnalyzeRequest
Especifica alguns componentes de texto e análise usados para dividir esse texto em tokens.
| Name | Tipo | Description |
|---|---|---|
| analyzer |
O nome do analisador a ser usado para quebrar o texto fornecido. Se esse parâmetro não for especificado, você deverá especificar um tokenizador. Os parâmetros do tokenizador e do analisador são mutuamente exclusivos. |
|
| charFilters |
Uma lista opcional de filtros de caracteres para usar ao quebrar o texto determinado. Este parâmetro só pode ser definido ao usar o parâmetro tokenizer. |
|
| normalizer |
O nome do normalizador a ser usado para normalizar o texto fornecido. |
|
| text |
string |
O texto para dividir em tokens. |
| tokenFilters |
Uma lista opcional de filtros de token para usar ao quebrar o texto fornecido. Este parâmetro só pode ser definido ao usar o parâmetro tokenizer. |
|
| tokenizer |
O nome do tokenizador a ser usado para quebrar o texto fornecido. Se esse parâmetro não for especificado, você deverá especificar um analisador. Os parâmetros do tokenizador e do analisador são mutuamente exclusivos. |
AnalyzeResult
O resultado do teste de um analisador em texto.
| Name | Tipo | Description |
|---|---|---|
| tokens |
A lista de tokens retornados pelo analisador especificado na solicitação. |
CharFilterName
Define os nomes de todos os filtros de caracteres suportados pelo mecanismo de pesquisa.
| Valor | Description |
|---|---|
| html_strip |
Um filtro de caracteres que tenta remover construções HTML. Veja https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
| Name | Tipo | Description |
|---|---|---|
| info |
As informações adicionais. |
|
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| additionalInfo |
O erro informações adicionais. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O alvo do erro. |
ErrorResponse
Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
| Name | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
LexicalAnalyzerName
Define os nomes de todos os analisadores de texto suportados pelo mecanismo de pesquisa.
| Valor | Description |
|---|---|
| ar.microsoft |
Analisador Microsoft para árabe. |
| ar.lucene |
Analisador de Lucene para árabe. |
| hy.lucene |
Analisador de Lucene para arménio. |
| bn.microsoft |
Analisador Microsoft para Bangla. |
| eu.lucene |
Analisador Lucene para basco. |
| bg.microsoft |
Analisador Microsoft para búlgaro. |
| bg.lucene |
Lucene analisador para búlgaro. |
| ca.microsoft |
Analisador Microsoft para catalão. |
| ca.lucene |
Lucene analisador para catalão. |
| zh-Hans.microsoft |
Analisador Microsoft para chinês (Simplificado). |
| zh-Hans.lucene |
Analisador Lucene para chinês (simplificado). |
| zh-Hant.microsoft |
Analisador Microsoft para chinês (tradicional). |
| zh-Hant.lucene |
Analisador de Lucene para chinês (tradicional). |
| hr.microsoft |
Analisador Microsoft para croata. |
| cs.microsoft |
Analisador Microsoft para checo. |
| cs.lucene |
Lucene analisador para checo. |
| da.microsoft |
Analisador Microsoft para dinamarquês. |
| da.lucene |
Lucene analisador para dinamarquês. |
| nl.microsoft |
Analisador Microsoft para holandês. |
| nl.lucene |
Analisador Lucene para holandês. |
| en.microsoft |
Analisador Microsoft para inglês. |
| en.lucene |
Analisador Lucene para Inglês. |
| et.microsoft |
Analisador Microsoft para estónio. |
| fi.microsoft |
Analisador Microsoft para finlandês. |
| fi.lucene |
Analisador de Lucene para finlandês. |
| fr.microsoft |
Analisador Microsoft para francês. |
| fr.lucene |
Analisador Lucene para francês. |
| gl.lucene |
Lucene analisador para galego. |
| de.microsoft |
Analisador Microsoft para alemão. |
| de.lucene |
Lucene analisador para alemão. |
| el.microsoft |
Analisador Microsoft para grego. |
| el.lucene |
Analisador de Lucene para grego. |
| gu.microsoft |
Analisador Microsoft para Gujarati. |
| he.microsoft |
Analisador Microsoft para hebraico. |
| hi.microsoft |
Analisador Microsoft para Hindi. |
| hi.lucene |
Analisador de Lucene para Hindi. |
| hu.microsoft |
Analisador Microsoft para húngaro. |
| hu.lucene |
Lucene analisador para húngaro. |
| is.microsoft |
Analisador Microsoft para islandês. |
| id.microsoft |
Analisador Microsoft para Indonésio (Bahasa). |
| id.lucene |
Analisador de Lucene para indonésio. |
| ga.lucene |
Lucene analisador para irlandês. |
| it.microsoft |
Analisador Microsoft para italiano. |
| it.lucene |
Analisador Lucene para italiano. |
| ja.microsoft |
Analisador Microsoft para japonês. |
| ja.lucene |
Analisador Lucene para japonês. |
| kn.microsoft |
Analisador Microsoft para Kannada. |
| ko.microsoft |
Analisador Microsoft para coreano. |
| ko.lucene |
Analisador Lucene para coreano. |
| lv.microsoft |
Analisador Microsoft para letão. |
| lv.lucene |
Analisador Lucene para letão. |
| lt.microsoft |
Analisador Microsoft para lituano. |
| ml.microsoft |
Analisador Microsoft para malaiala. |
| ms.microsoft |
Analisador Microsoft para malaio (latim). |
| mr.microsoft |
Analisador Microsoft para Marathi. |
| nb.microsoft |
Microsoft analyzer for Norwegian (Bokmål). |
| no.lucene |
Analisador Lucene para norueguês. |
| fa.lucene |
Analisador de Lucene para persa. |
| pl.microsoft |
Analisador Microsoft para polaco. |
| pl.lucene |
Analisador de Lucene para polaco. |
| pt-BR.microsoft |
Analisador Microsoft para português (Brasil). |
| pt-BR.lucene |
Analisador Lucene para Português (Brasil). |
| pt-PT.microsoft |
Analisador Microsoft para português (Portugal). |
| pt-PT.lucene |
Analisador de Lucene para Português (Portugal). |
| pa.microsoft |
Analisador Microsoft para Punjabi. |
| ro.microsoft |
Analisador Microsoft para romeno. |
| ro.lucene |
Lucene analisador para romeno. |
| ru.microsoft |
Analisador Microsoft para russo. |
| ru.lucene |
Lucene analisador para russo. |
| sr-cyrillic.microsoft |
Analisador Microsoft para sérvio (cirílico). |
| sr-latin.microsoft |
Analisador Microsoft para sérvio (latim). |
| sk.microsoft |
Analisador Microsoft para eslovaco. |
| sl.microsoft |
Analisador Microsoft para esloveno. |
| es.microsoft |
Analisador Microsoft para espanhol. |
| es.lucene |
Analisador Lucene para espanhol. |
| sv.microsoft |
Analisador Microsoft para sueco. |
| sv.lucene |
Lucene analisador para sueco. |
| ta.microsoft |
Analisador Microsoft para tâmil. |
| te.microsoft |
Analisador Microsoft para Telugu. |
| th.microsoft |
Analisador Microsoft para tailandês. |
| th.lucene |
Lucene analisador para tailandês. |
| tr.microsoft |
Analisador Microsoft para turco. |
| tr.lucene |
Lucene analisador para turco. |
| uk.microsoft |
Analisador Microsoft para ucraniano. |
| ur.microsoft |
Analisador Microsoft para urdu. |
| vi.microsoft |
Analisador Microsoft para vietnamita. |
| standard.lucene |
Analisador Lucene padrão. |
| standardasciifolding.lucene |
Analisador padrão ASCII Folding Lucene. Veja https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers |
| keyword |
Trata todo o conteúdo de um campo como um único token. Isso é útil para dados como códigos postais, ids e alguns nomes de produtos. Veja http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html |
| pattern |
Separa o texto de forma flexível em termos através de um padrão de expressão regular. Veja http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html |
| simple |
Divide o texto em letras não escritas e converte-as em minúsculas. Veja http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html |
| stop |
Divide o texto em não-letras; Aplica os filtros de token minúsculo e stopword. Veja http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html |
| whitespace |
Um analisador que utiliza o tokenizador de espaços em branco. Veja http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html |
LexicalNormalizerName
Define os nomes de todos os normalizadores de texto suportados pelo mecanismo de pesquisa.
LexicalTokenizerName
Define os nomes de todos os tokenizadores suportados pelo mecanismo de pesquisa.
TokenFilterName
Define os nomes de todos os filtros de token suportados pelo mecanismo de pesquisa.