Analizzare il testo (API REST ricerca intelligenza artificiale di Azure)

L' API di analisi illustra come un analizzatore suddivide il testo in token. È destinato ai test interattivi in modo che sia possibile vedere come un determinato analizzatore tokenzzerà un input stringa.

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

Per specificare un analizzatore usato durante l'indicizzazione e l'esecuzione di query, impostare la proprietà analizzatore sui campi stringa nell'indice.

Parametri dell'URI

Parametro Descrizione
nome servizio Obbligatorio. Impostare questo valore sul nome univoco definito dall'utente del servizio di ricerca.
nome indice Obbligatorio. L'URI della richiesta specifica il nome dell'indice che contiene il campo da analizzare.
api-version Obbligatorio. La versione stabile corrente è api-version=2020-06-30. Per altre versioni, vedere Versioni API .

Intestazioni richiesta

La tabella seguente descrive le intestazioni della richiesta obbligatorie e facoltative.

Campi Descrizione
Content-Type Obbligatorio. Impostare il valore su application/json
api-key Facoltativo se si usano ruoli di Azure e viene fornito un token di connessione nella richiesta, altrimenti è necessaria una chiave. Una chiave API è una stringa univoca generata dal sistema che autentica la richiesta al servizio di ricerca. Le richieste di analizzatore devono includere un'intestazione api-key impostata sulla chiave di amministrazione anziché su una chiave di query. Per informazioni dettagliate, vedere Connettersi a Ricerca intelligenza artificiale di Azure usando l'autenticazione delle chiavi .

Corpo della richiesta

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

oppure

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

, analyzer_nametokenizer_nametoken_filter_name e char_filter_name devono essere nomi validi di analizzatori predefiniti o personalizzati, tokenizzatori, filtri token e filtri char per l'indice. Per altre informazioni sul processo di analisi lessicale, vedere Analisi in Ricerca di intelligenza artificiale di Azure.

Risposta

Se la risposta ha esito positivo, viene restituito il codice di stato 200 OK.

Il corpo della risposta è nel formato seguente:

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

Esempio

Il corpo della richiesta include la stringa e l'analizzatore da usare.

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

La risposta mostra i token generati dall'analizzatore per la stringa specificata.

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

Vedi anche