Compartir a través de

Obtención del mapa de sinónimos (API REST de Azure AI Search)

La operación Obtener mapa de sinónimos obtiene la definición del mapa de sinónimos de Azure AI Search.

GET https://[service name].search.windows.net/synonymmaps/[synonymmap name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

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 del mapa de sinónimos Necesario. El URI de solicitud especifica el nombre del mapa de sinónimos que se va a devolver.
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 de obtención de una definición de objeto deben incluir un campo de clave de API 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

Ninguno.

Response

Código de estado: al obtener una respuesta correcta, se visualiza 200 Correcto.

La respuesta es similar a los ejemplos de Creación de mapa de sinónimos (API REST de Azure AI Search).

{
    "name" : "synonymmap1",  
    "format" : "solr",  
    "synonyms" : "United States, United States of America, USA\n
    Washington, Wash. => WA",
    "encryptionKey": null
}

Nota

Si el mapa de sinónimos tiene una clave de cifrado, el servicio de búsqueda debe tener acceso a la clave de cifrado para recuperar la definición del mapa de sinónimos. Sin acceso a la clave de cifrado, se devuelve una solicitud incorrecta 400. Restaurar el acceso a la clave permite que el servicio de búsqueda recupere de nuevo la definición del mapa de sinónimos.

Consulte también