Analisar Texto (API REST da Pesquisa de IA do Azure)

  • Artigo

A API de Análise mostra como um analisador divide texto em tokens. Destina-se a testes interativos para que possa ver como um determinado analisador irá tokenizar uma entrada de cadeia.

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

Para especificar um analisador utilizado durante a indexação e a execução de consultas, defina a propriedade analisador em campos de cadeia no índice.

Parâmetros do URI

Parâmetro Description
nome do serviço Obrigatório. Defina-o como o nome exclusivo e definido pelo utilizador do seu serviço de pesquisa.
nome do índice Obrigatório. O URI do pedido especifica o nome do índice que contém o campo que pretende analisar.
api-version Obrigatório. A versão estável atual é api-version=2020-06-30. Veja Versões da API para obter mais versões.

Cabeçalhos do Pedido

A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.

Campos Description
Content-Type Obrigatório. Defina esta opção como application/json
api-key Opcional se estiver a utilizar funções do Azure e for fornecido um token de portador no pedido, caso contrário, é necessária uma chave. Uma chave de api é uma cadeia exclusiva gerada pelo sistema que autentica o pedido no seu serviço de pesquisa. Os pedidos do Analisador têm de incluir um api-key cabeçalho definido para a sua chave de administrador (em oposição a uma chave de consulta). Veja Ligar à Pesquisa de IA do Azure com a autenticação de chaves para obter detalhes.

Corpo do Pedido

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

ou

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

O analyzer_name, tokenizer_namee token_filter_namechar_filter_name tem de ser nomes válidos de analisadores predefinidos ou personalizados, tokenizers, filtros de tokens e filtros de caráter para o índice. Para saber mais sobre o processo de análise lexical, veja Analysis in Azure AI Search (Análise na Pesquisa de IA do Azure).

Resposta

Código de Estado: é devolvido 200 OK para uma resposta bem-sucedida.

O corpo da resposta está no seguinte formato:

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

Exemplos

O corpo do pedido inclui a cadeia e o analisador que pretende utilizar.

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

A resposta mostra os tokens emitidos pelo analisador para a cadeia que fornece.

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

Ver também