Tekst analyseren (Azure AI Search REST API)

  • Artikel

De Analyse-API laat zien hoe een analysetekst opsplitst in tokens. Het is bedoeld voor interactieve tests, zodat u kunt zien hoe een bepaalde analyse een tekenreeksinvoer tokeniseert.

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

Als u een analyse wilt opgeven die wordt gebruikt tijdens het indexeren en uitvoeren van query's, stelt u de eigenschap analyzer in op tekenreeksvelden in de index.

URI-parameters

Parameter Beschrijving
servicenaam Vereist. Stel deze in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice.
indexnaam Vereist. De aanvraag-URI geeft de naam op van de index die het veld bevat dat u wilt analyseren.
api-versie Vereist. De huidige stabiele versie is api-version=2020-06-30. Zie API-versies voor meer versies.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Velden Description
Content-Type Vereist. Stel dit in op application/json
api-key Optioneel als u Azure-rollen gebruikt en er een Bearer-token is opgegeven voor de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Analyseaanvragen moeten een api-key header bevatten die is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie.

Aanvraagbody

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

of

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

De analyzer_name, tokenizer_nametoken_filter_name en char_filter_name moeten geldige namen zijn van vooraf gedefinieerde of aangepaste analysefuncties, tokenizers, tokenfilters en char-filters voor de index. Zie Analyse in Azure AI Search voor meer informatie over het proces van lexicale analyse.

Antwoord

Statuscode: 200 OK wordt geretourneerd voor een geslaagd antwoord.

De hoofdtekst van het antwoord heeft de volgende indeling:

    {
      "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)
        },
        ...
      ]
    }

Voorbeelden

De aanvraagbody bevat de tekenreeks en analyse die u wilt gebruiken.

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

Het antwoord toont de tokens die door de analyse zijn verzonden voor de tekenreeks die u opgeeft.

{
    "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
        }
    ]
}

Zie ook