Analýza textu (rozhraní REST API služby Azure AI Search)

  • Článek

Rozhraní API pro analýzu ukazuje, jak analyzátor rozděluje text na tokeny. Je určená pro interaktivní testování, abyste viděli, jak daný analyzátor tokenizuje řetězcový vstup.

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

Pokud chcete určit analyzátor použitý při indexování a provádění dotazů, nastavte vlastnost analyzátoru pro pole řetězců v indexu.

Parametry identifikátoru URI

Parametr Popis
název služby Povinná hodnota. Nastavte ho na jedinečný, uživatelem definovaný název vaší vyhledávací služby.
název indexu Povinná hodnota. Identifikátor URI požadavku určuje název indexu obsahujícího pole, které chcete analyzovat.
verze-api Povinná hodnota. Aktuální stabilní verze je api-version=2020-06-30. Další verze najdete v tématu Verze rozhraní API .

Hlavičky požadavku

Následující tabulka popisuje požadovanou a volitelnou hlavičku požadavku.

Pole Description
Typ obsahu Povinná hodnota. Nastavte tuto možnost na application/json
klíč rozhraní API Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Klíč api-key je jedinečný, systémem vygenerovaný řetězec, který ověřuje požadavek na vaši vyhledávací službu. Požadavky analyzátoru musí obsahovat hlavičku nastavenou api-key na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče .

Text požadavku

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

nebo

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

, analyzer_nametokenizer_nametoken_filter_name a char_filter_name musí být platné názvy předdefinovaných nebo vlastních analyzátorů, tokenizátorů, filtrů tokenů a filtrů znaků pro index. Další informace o procesu lexikální analýzy najdete v tématu Analýza ve službě Azure AI Search.

Odpověď

Stavový kód: Pro úspěšnou odpověď se vrátí 200 OK.

Text odpovědi je v následujícím formátu:

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

Příklady

Text požadavku obsahuje řetězec a analyzátor, který chcete použít.

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

V odpovědi se zobrazí tokeny generované analyzátorem pro zadaný řetězec.

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

Viz také