Análisis de texto (API REST de Azure AI Search)
La API de análisis muestra cómo un analizador descompone el texto en tokens. Está pensado para pruebas interactivas para que pueda ver cómo un analizador determinado tokenizará una entrada de cadena.
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 un analizador usado durante la indexación y la ejecución de consultas, establezca la propiedad analyzer en los campos de cadena del índice.
Parámetros de identificador URI
| Parámetro | Descripción |
|---|---|
| nombre del servicio | Necesario. Establézcalo en el nombre único definido por el usuario del servicio de búsqueda. |
| nombre de índice | Necesario. El URI de solicitud especifica el nombre del índice que contiene el campo que desea analizar. |
| api-version | Necesario. La versión estable actual es api-version=2020-06-30. Consulte Versiones de API para obtener más versiones. |
Encabezados de solicitud
En la siguiente tabla se describen los encabezados de solicitud obligatorios y opcionales.
| Campos | Descripción |
|---|---|
| Content-Type | Necesario. 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 api-key encabezado establecido en la clave de administración (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" ]
}
Los analyzer_name, tokenizer_nametoken_filter_name y char_filter_name deben ser nombres válidos de analizadores predefinidos o personalizados, tokenizadores, filtros de token y filtros char para el índice. Para más información sobre el proceso de análisis léxico, consulte Análisis en Azure AI Search.
Response
Código de estado: al obtener una respuesta correcta, se visualiza 200 Correcto.
El cuerpo de la respuesta está en 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 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
}
]
}