Analizowanie tekstu (interfejs API REST usługi Azure AI Search)

  • Artykuł

Interfejs API analizowania pokazuje, jak analizator dzieli tekst na tokeny. Jest on przeznaczony do testowania interakcyjnego, aby zobaczyć, jak dany analizator będzie tokenizować dane wejściowe ciągu.

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

Aby określić analizator używany podczas indeksowania i wykonywania zapytań, ustaw właściwość analizatora w polach ciągów w indeksie.

Parametry identyfikatora URI

Parametr Opis
nazwa usługi Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania.
nazwa indeksu Wymagane. Identyfikator URI żądania określa nazwę indeksu zawierającego pole, które chcesz przeanalizować.
api-version Wymagane. Bieżąca stabilna wersja to api-version=2020-06-30. Zobacz Wersje interfejsu API , aby uzyskać więcej wersji.

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Pola Opis
Content-Type Wymagane. Ustaw tę wartość na application/json
api-key Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest dostarczany w żądaniu, w przeciwnym razie wymagany jest klucz. Api-key to unikatowy ciąg generowany przez system, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania analizatora muszą zawierać api-key nagłówek ustawiony na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza .

Treść żądania

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

lub

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

Elementy analyzer_name, tokenizer_nametoken_filter_name i char_filter_name muszą być prawidłowymi nazwami wstępnie zdefiniowanych lub niestandardowych analizatorów, tokenizatorów, filtrów tokenów i filtrów znaków dla indeksu. Aby dowiedzieć się więcej na temat procesu analizy leksykalnej, zobacz Analiza w usłudze Azure AI Search.

Reakcja

Kod stanu: 200 OK jest zwracany dla pomyślnej odpowiedzi.

Treść odpowiedzi ma następujący 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)
        },
        ...
      ]
    }

Przykłady

Treść żądania zawiera ciąg i analizator, którego chcesz użyć.

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

Odpowiedź przedstawia tokeny emitowane przez analizator dla podanego ciągu.

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

Zobacz też