Analyser le texte (API REST Recherche Azure AI)

Article
07/13/2024

L’ API Analyser montre comment l’analyseur découpe le texte en jetons. Il est destiné aux tests interactifs afin que vous puissiez voir comment un analyseur donné va jetoniser une entrée de chaîne.

POST https://[service name].search.windows.net/indexes/[index name]/analyze?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

Pour spécifier un analyseur utilisé pendant l’indexation et l’exécution de la requête, définissez la propriété de l’analyseur sur les champs de chaîne dans l’index.

Paramètres URI

Paramètre	Description
nom du service	Obligatoire. Définissez cette valeur sur le nom unique défini par l’utilisateur de votre service de recherche.
nom de l'index	Obligatoire. L’URI de requête spécifie le nom de l’index qui contient le champ à analyser.
api-version	Obligatoire. La version stable actuelle est `api-version=2020-06-30`. Pour plus d’informations, consultez Versions de l’API .

En-têtes de requête

Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.

Champs Description

Content-Type Obligatoire. À définir avec la valeur application/json

api-key Facultatif si vous utilisez des rôles Azure et qu’un jeton de porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la demande auprès de votre service de recherche. Les demandes d’analyseur doivent inclure un api-key en-tête défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé .

Champs	Description
Content-Type	Obligatoire. À définir avec la valeur `application/json`
api-key	Facultatif si vous utilisez des rôles Azure et qu’un jeton de porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la demande auprès de votre service de recherche. Les demandes d’analyseur doivent inclure un `api-key` en-tête défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé .

Corps de la demande

{
  "text": "Text to analyze",
  "analyzer": "analyzer_name"
}

{
  "text": "Text to analyze",
  "tokenizer": "tokenizer_name",
  "tokenFilters": (optional) [ "token_filter_name" ],
  "charFilters": (optional) [ "char_filter_name" ]
}

token_filter_name tokenizer_name, analyzer_nameet char_filter_name doivent être des noms valides d’analyseurs, de générateurs de jetons, de filtres de jetons et de filtres char prédéfinis ou personnalisés pour l’index. Pour en savoir plus sur le processus d’analyse lexicale, consultez Analyse dans Recherche Azure AI.

response

Code d'état : 200 OK est retourné pour une réponse correcte.

Le corps de la réponse a le format suivant :

    {
      "tokens": [
        {
          "token": string (token),
          "startOffset": number (index of the first character of the token),
          "endOffset": number (index of the last character of the token),
          "position": number (position of the token in the input text)
        },
        ...
      ]
    }

Exemples

Le corps de la demande inclut la chaîne et l’analyseur que vous souhaitez utiliser.

     {
       "text": "The quick brown fox",
       "analyzer": "standard"
     }

La réponse indique les jetons émis par l’analyseur pour la chaîne que vous fournissez.

{
    "tokens": [
        {
            "token": "the",
            "startOffset": 0,
            "endOffset": 3,
            "position": 0
        },
        {
            "token": "quick",
            "startOffset": 4,
            "endOffset": 9,
            "position": 1
        },
        {
            "token": "brown",
            "startOffset": 10,
            "endOffset": 15,
            "position": 2
        },
        {
            "token": "fox",
            "startOffset": 16,
            "endOffset": 19,
            "position": 3
        }
    ]
}

Partager via