Analisar texto (Azure Cognitive Search REST API)

A API de análise mostra como um analisador quebra o texto em fichas. Destina-se a testes interativos para que possa ver como um determinado analisador irá tokenizar uma entrada de corda.

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 execução de indexação e consulta, detete a propriedade do analisador nos campos de cordas no índice.

Parâmetros do URI

Parâmetro Descrição
nome de serviço Obrigatório. Desa cosçar isto para o nome único e definido pelo utilizador do seu serviço de pesquisa.
nome do índice Obrigatório. O pedido URI especifica o nome do índice que contém o campo que pretende analisar.
api-version Obrigatório. A versão atual estável é api-version=2020-06-30. Consulte as versões API para mais versões.

Pedido cabeçalhos

A tabela seguinte descreve os cabeçalhos de pedido necessários e opcionais.

Campos Descrição
Content-Type Obrigatório. Deseteia isto para application/json
api-chave Obrigatório. É api-key usado para autenticar o pedido para o seu Serviço de pesquisa. É um valor de corda, único ao seu serviço. Os pedidos do analisador devem incluir um api-key conjunto de cabeçalho na tecla de administração (em vez de uma chave de consulta). Pode encontrar a chave API no seu painel de pesquisa no portal do Azure.

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

Os analyzer_name, tokenizer_nametoken_filter_name e char_filter_name precisam de ser nomes válidos de analisadores predefinidos ou personalizados, tokenizers, filtros de fichas e filtros de carvão para o índice. Para saber mais sobre o processo de análise lexical, consulte a Análise em Azure Cognitive Search.

Resposta

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

O organismo de resposta encontra-se 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 de 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 corda 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