Indexes - Analyze
Montre comment un analyseur décompose le texte en jetons.
POST {endpoint}/indexes('{indexName}')/search.analyze?api-version=2023-11-01Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
URL du point de terminaison du service de recherche. |
|
index
|
path | True |
string |
Nom de l’index pour lequel tester un analyseur. |
|
api-version
|
query | True |
string |
Version de l’API cliente. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
ID de suivi envoyé avec la demande pour faciliter le débogage. |
Corps de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| text | True |
string |
Texte à décomposer en jetons. |
| analyzer |
Nom de l’analyseur à utiliser pour interrompre le texte donné. Si ce paramètre n’est pas spécifié, vous devez spécifier un tokenizer à la place. Les paramètres de tokenizer et d’analyseur s’excluent mutuellement. |
||
| charFilters |
Liste facultative de filtres de caractères à utiliser lors de la rupture du texte donné. Ce paramètre ne peut être défini que lors de l’utilisation du paramètre tokenizer. |
||
| tokenFilters |
Liste facultative de filtres de jetons à utiliser lors de la rupture du texte donné. Ce paramètre ne peut être défini que lors de l’utilisation du paramètre tokenizer. |
||
| tokenizer |
Nom du tokenizer à utiliser pour interrompre le texte donné. Si ce paramètre n’est pas spécifié, vous devez spécifier un analyseur à la place. Les paramètres de tokenizer et d’analyseur s’excluent mutuellement. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
Réponse d’erreur. |
Exemples
SearchServiceIndexAnalyze
Exemple de requête
POST https://myservice.search.windows.net/indexes('hotels')/search.analyze?api-version=2023-11-01
{
"text": "Text to analyze",
"analyzer": "standard.lucene"
}
Exemple de réponse
{
"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
}
]
}Définitions
| Nom | Description |
|---|---|
|
Analyzed |
Informations sur un jeton retourné par un analyseur. |
|
Analyze |
Spécifie certains composants de texte et d’analyse utilisés pour décomposer ce texte en jetons. |
|
Analyze |
Résultat du test d’un analyseur sur du texte. |
|
Char |
Définit les noms de tous les filtres de caractères pris en charge par le moteur de recherche. |
|
Lexical |
Définit les noms de tous les analyseurs de texte pris en charge par le moteur de recherche. |
|
Lexical |
Définit les noms de tous les tokenizers pris en charge par le moteur de recherche. |
|
Search |
Décrit une condition d’erreur pour l’API. |
|
Token |
Définit les noms de tous les filtres de jetons pris en charge par le moteur de recherche. |
AnalyzedTokenInfo
Informations sur un jeton retourné par un analyseur.
| Nom | Type | Description |
|---|---|---|
| endOffset |
integer (int32) |
Index du dernier caractère du jeton dans le texte d’entrée. |
| position |
integer (int32) |
Position du jeton dans le texte d’entrée par rapport à d’autres jetons. Le premier jeton du texte d’entrée a la position 0, la position suivante a la position 1, et ainsi de suite. Selon l’analyseur utilisé, certains jetons peuvent avoir la même position, par exemple s’ils sont synonymes les uns des autres. |
| startOffset |
integer (int32) |
Index du premier caractère du jeton dans le texte d’entrée. |
| token |
string |
Jeton retourné par l’analyseur. |
AnalyzeRequest
Spécifie certains composants de texte et d’analyse utilisés pour décomposer ce texte en jetons.
| Nom | Type | Description |
|---|---|---|
| analyzer |
Nom de l’analyseur à utiliser pour interrompre le texte donné. Si ce paramètre n’est pas spécifié, vous devez spécifier un tokenizer à la place. Les paramètres de tokenizer et d’analyseur s’excluent mutuellement. |
|
| charFilters |
Liste facultative de filtres de caractères à utiliser lors de la rupture du texte donné. Ce paramètre ne peut être défini que lors de l’utilisation du paramètre tokenizer. |
|
| text |
string |
Texte à décomposer en jetons. |
| tokenFilters |
Liste facultative de filtres de jetons à utiliser lors de la rupture du texte donné. Ce paramètre ne peut être défini que lors de l’utilisation du paramètre tokenizer. |
|
| tokenizer |
Nom du tokenizer à utiliser pour interrompre le texte donné. Si ce paramètre n’est pas spécifié, vous devez spécifier un analyseur à la place. Les paramètres de tokenizer et d’analyseur s’excluent mutuellement. |
AnalyzeResult
Résultat du test d’un analyseur sur du texte.
| Nom | Type | Description |
|---|---|---|
| tokens |
Liste des jetons retournés par l’analyseur spécifié dans la requête. |
CharFilterName
Définit les noms de tous les filtres de caractères pris en charge par le moteur de recherche.
| Valeur | Description |
|---|---|
| html_strip |
Filtre de caractères qui tente de supprimer les constructions HTML. Voir https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html |
LexicalAnalyzerName
Définit les noms de tous les analyseurs de texte pris en charge par le moteur de recherche.
| Valeur | Description |
|---|---|
| ar.microsoft |
Analyseur Microsoft pour l’arabe. |
| ar.lucene |
Analyseur Lucene pour l’arabe. |
| hy.lucene |
Analyseur Lucene pour arménien. |
| bn.microsoft |
Analyseur Microsoft pour Bangla. |
| eu.lucene |
Analyseur Lucene pour basque. |
| bg.microsoft |
Analyseur Microsoft pour bulgare. |
| bg.lucene |
Analyseur Lucene pour bulgare. |
| ca.microsoft |
Analyseur Microsoft pour catalan. |
| ca.lucene |
Analyseur Lucene pour catalan. |
| zh-Hans.microsoft |
Analyseur Microsoft pour chinois (simplifié). |
| zh-Hans.lucene |
Analyseur Lucene pour chinois (simplifié). |
| zh-Hant.microsoft |
Analyseur Microsoft pour chinois (traditionnel). |
| zh-Hant.lucene |
Analyseur Lucene pour chinois (traditionnel). |
| hr.microsoft |
Analyseur Microsoft pour croate. |
| cs.microsoft |
Analyseur Microsoft pour tchèque. |
| cs.lucene |
Analyseur Lucene pour tchèque. |
| da.microsoft |
Analyseur Microsoft pour danois. |
| da.lucene |
Analyseur Lucene pour danois. |
| nl.microsoft |
Analyseur Microsoft pour néerlandais. |
| nl.lucene |
Analyseur Lucene pour néerlandais. |
| en.microsoft |
Analyseur Microsoft pour l’anglais. |
| en.lucene |
Analyseur Lucene pour l’anglais. |
| et.microsoft |
Analyseur Microsoft pour estonien. |
| fi.microsoft |
Analyseur Microsoft pour finnois. |
| fi.lucene |
Analyseur Lucene pour le finnois. |
| fr.microsoft |
Analyseur Microsoft pour français. |
| fr.lucene |
Analyseur Lucene pour français. |
| gl.lucene |
Analyseur Lucene pour Galicien. |
| de.microsoft |
Analyseur Microsoft pour allemand. |
| de.lucene |
Analyseur Lucene pour allemand. |
| el.microsoft |
Analyseur Microsoft pour grec. |
| el.lucene |
Analyseur Lucene pour grec. |
| gu.microsoft |
Analyseur Microsoft pour Gujarati. |
| he.microsoft |
Analyseur Microsoft pour hébreu. |
| hi.microsoft |
Analyseur Microsoft pour hindi. |
| hi.lucene |
Analyseur Lucene pour hindi. |
| hu.microsoft |
Analyseur Microsoft pour hongrois. |
| hu.lucene |
Analyseur Lucene pour hongrois. |
| is.microsoft |
Analyseur Microsoft pour l’Islande. |
| id.microsoft |
Analyseur Microsoft pour indonésien (Bahasa). |
| id.lucene |
Analyseur Lucene pour l’Indonésien. |
| ga.lucene |
Analyseur Lucene pour irlandais. |
| it.microsoft |
Analyseur Microsoft pour italien. |
| it.lucene |
Analyseur Lucene pour italien. |
| ja.microsoft |
Analyseur Microsoft pour japonais. |
| ja.lucene |
Analyseur Lucene pour japonais. |
| kn.microsoft |
Analyseur Microsoft pour Kannada. |
| ko.microsoft |
Analyseur Microsoft pour coréen. |
| ko.lucene |
Analyseur Lucene pour coréen. |
| lv.microsoft |
Analyseur Microsoft pour letton. |
| lv.lucene |
Analyseur Lucene pour letton. |
| lt.microsoft |
Analyseur Microsoft pour lituanien. |
| ml.microsoft |
Analyseur Microsoft pour Malayalam. |
| ms.microsoft |
Analyseur Microsoft pour Malay (latin). |
| mr.microsoft |
Analyseur Microsoft pour Marathi. |
| nb.microsoft |
Analyseur Microsoft pour norvégien (Bokmål). |
| no.lucene |
Analyseur Lucene pour norvégien. |
| fa.lucene |
Analyseur Lucene pour Persane. |
| pl.microsoft |
Analyseur Microsoft pour polonais. |
| pl.lucene |
Analyseur Lucene pour polonais. |
| pt-BR.microsoft |
Analyseur Microsoft pour portugais (Brésil). |
| pt-BR.lucene |
Analyseur Lucene pour portugais (Brésil). |
| pt-PT.microsoft |
Analyseur Microsoft pour portugais (Portugal). |
| pt-PT.lucene |
Analyseur Lucene pour portugais (Portugal). |
| pa.microsoft |
Analyseur Microsoft pour Punjabi. |
| ro.microsoft |
Analyseur Microsoft pour roumain. |
| ro.lucene |
Analyseur Lucene pour roumain. |
| ru.microsoft |
Analyseur Microsoft pour russe. |
| ru.lucene |
Analyseur Lucene pour russe. |
| sr-cyrillic.microsoft |
Analyseur Microsoft pour serbe (cyrillique). |
| sr-latin.microsoft |
Analyseur Microsoft pour serbe (latin). |
| sk.microsoft |
Analyseur Microsoft pour slovaque. |
| sl.microsoft |
Analyseur Microsoft pour le Slovène. |
| es.microsoft |
Analyseur Microsoft pour l’espagnol. |
| es.lucene |
Analyseur Lucene pour l’espagnol. |
| sv.microsoft |
Analyseur Microsoft pour suédois. |
| sv.lucene |
Analyseur Lucene pour suédois. |
| ta.microsoft |
Analyseur Microsoft pour tamoul. |
| te.microsoft |
Analyseur Microsoft pour Telugu. |
| th.microsoft |
Analyseur Microsoft pour thaï. |
| th.lucene |
Analyseur Lucene pour thaï. |
| tr.microsoft |
Analyseur Microsoft pour turc. |
| tr.lucene |
Analyseur Lucene pour turc. |
| uk.microsoft |
Analyseur Microsoft pour ukrainien. |
| ur.microsoft |
Analyseur Microsoft pour Urdu. |
| vi.microsoft |
Analyseur Microsoft pour le Vietnamien. |
| standard.lucene |
Analyseur Lucene standard. |
| standardasciifolding.lucene |
Analyseur Lucene pliant ASCII standard. Voir https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers |
| keyword |
Traite l’intégralité du contenu d’un champ comme un seul jeton. Cela est utile pour les données telles que les codes postal, les ID et certains noms de produits. Voir http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html |
| pattern |
Sépare de manière flexible le texte en termes par le biais d’un modèle d’expression régulière. Voir http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html |
| simple |
Divise le texte en lettres non lettres et les convertit en minuscules. Voir http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html |
| stop |
Divise le texte en lettres non lettres ; Applique les filtres de jetons minuscules et de mots vides. Voir http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html |
| whitespace |
Analyseur qui utilise le générateur de jetons d’espace blanc. Voir http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html |
LexicalTokenizerName
Définit les noms de tous les tokenizers pris en charge par le moteur de recherche.
SearchError
Décrit une condition d’erreur pour l’API.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
| details |
Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée. |
|
| message |
string |
Représentation lisible par l’homme de l’erreur. |
TokenFilterName
Définit les noms de tous les filtres de jetons pris en charge par le moteur de recherche.