Compartir a través de

Analizar texto (API REST de versión preliminar)

se aplica a: 2023-07-01-Preview. Esta versión ya no se admite. Actualizar inmediatamente a una versión más reciente.

Importante

2023-07-01-Preview (sin cambios).

2021-04-30-Preview agrega "normalizador", que se usa para probar la insensibilidad de mayúsculas y minúsculas y el procesamiento de texto en filtros y ordenación.

El Analyze Text API muestra cómo un analizador divide el texto en tokens y cómo un normalizador preprocesa texto. Está pensado para pruebas interactivas para que pueda evaluar un analizador o normalizador determinado con fines de depuración.

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

Probar un analizador o normalizador es una tarea independiente. Si usa un analizador o un normalizador durante la ejecución de la indexación o consulta, lo especificará en Crear o actualizar índice en campos individuales.

Parámetros de URI

Parámetro Descripción
nombre del servicio Obligatorio. Nombre del servicio de búsqueda.
nombre de índice Obligatorio. Nombre del índice que contiene el campo que desea analizar.
api-version Obligatorio. Consulte versiones de API para obtener la lista completa.

Encabezados de solicitud

En la tabla siguiente se describen los encabezados de solicitud obligatorios y opcionales.

Campos Descripción
Tipo de contenido Obligatorio. Establézcalo en application/json
api-key Opcional si usa roles de Azure y se proporciona un token de portador en la solicitud; de lo contrario, se requiere una clave. Una clave de API es una cadena única generada por el sistema que autentica la solicitud en el servicio de búsqueda. Las solicitudes del analizador deben incluir un encabezado api-key establecido en la clave de administrador (en lugar de una clave de consulta). Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información.

Cuerpo de la solicitud

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

o

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

o

{
  "text": "Text to normalize",
  "normalizer": "normalizer_name"
}

La solicitud contiene las siguientes propiedades:

Propiedad Descripción
Mensaje de texto Obligatorio. Texto que se va a analizar o normalizar.
Analizador Analizador que se usa para dividir el texto en tokens. Esta propiedad es el nombre de un analizador integrado , el nombre de un analizador de lenguaje o el nombre de analizador personalizado en la definición de índice. Para más información sobre el proceso de análisis léxico, consulte Analysis in Azure AI Search.
tokenizer Tokenizador que se usa para dividir el texto en tokens. Esta propiedad es el nombre de un tokenizador predefinido o el nombre de un tokenizador personalizado en la definición de índice.
tokenFilters Colección de filtros de token usados para procesar el texto. Los valores de la colección deben ser los nombres de filtros de token predefinidos o los nombres de filtros de token personalizados en la definición de índice. En el caso de los analizadores de pruebas, esta propiedad debe usarse junto con la propiedad tokenizer. Para probar los normalizadores, esta propiedad se puede usar de forma independiente.
charFilters Colección de filtros de caracteres usados para procesar el texto. Los valores de la colección deben ser los nombres de filtros de caracteres predefinidos o los nombres de filtros de caracteres personalizados en la definición de índice. En el caso de los analizadores de pruebas, esta propiedad debe usarse junto con la propiedad tokenizer. Para probar los normalizadores, esta propiedad se puede usar de forma independiente.
normalizador Normalizador usado para procesar el texto. Esta propiedad es el nombre de un normalizador predefinido o el nombre de normalizador personalizado en la definición de índice. Para obtener más información sobre los normalizadores, consulte Normalización de texto para filtrar, facetas y ordenar.

Respuesta

Código de estado: 200 Ok se devuelve para obtener una respuesta correcta.

El cuerpo de la respuesta tiene el formato siguiente:

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

Ejemplos

El cuerpo de la solicitud incluye la cadena y el analizador o el normalizador que desea usar.

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

La respuesta muestra los tokens emitidos por el analizador para la cadena que proporcione.

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

Consulte también