Text analysieren (Azure AI Search-REST-API)

  • Artikel

Die Analyse-API zeigt, wie ein Analysemodul Text in einzelne Token unterteilt. Es ist für interaktive Tests vorgesehen, damit Sie sehen können, wie ein bestimmtes Analysetool eine Zeichenfolgeneingabe tokenisiert.

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

Um ein Analysetool anzugeben, das während der Indizierung und Abfrageausführung verwendet wird, legen Sie die Analyzer-Eigenschaft für Zeichenfolgenfelder im Index fest.

URI-Parameter

Parameter BESCHREIBUNG
Dienstname Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
Indexname Erforderlich. Der Anforderungs-URI gibt den Namen des Indexes an, der das zu analysierende Feld enthält.
api-version Erforderlich. Die aktuelle stabile Version ist api-version=2020-06-30. Weitere Versionen finden Sie unter API-Versionen .

Anforderungsheader

Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.

Felder BESCHREIBUNG
Content-Type Erforderlich. Auf application/json
api-key Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige, vom System generierte Zeichenfolge, die die Anforderung bei Ihrem Suchdienst authentifiziert. Analyseanforderungen müssen einen api-key Header enthalten, der auf Ihren Administratorschlüssel (im Gegensatz zu einem Abfrageschlüssel) festgelegt ist. Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung .

Anforderungstext

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

oder

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

Die analyzer_name, tokenizer_nameund token_filter_namechar_filter_name müssen gültige Namen von vordefinierten oder benutzerdefinierten Analysetools, Tokenisierern, Tokenfiltern und Zeichenfiltern für den Index sein. Weitere Informationen zum Prozess der lexikalischen Analyse finden Sie unter Analyse in Azure AI Search.

Antwort

Bei erfolgreicher Antwort wird der Statuscode "200 OK" zurückgegeben.

Der Antworttext hat folgendes Format:

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

Beispiele

Anforderungstext enthält die Zeichenfolge und das Analysetool, das Sie verwenden möchten.

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

Die Antwort zeigt die Token an, die vom Analysetool für die von Ihnen bereitgestellte Zeichenfolge ausgegeben werden.

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

Weitere Informationen