Compartir a través de

List Synonym Maps (API REST de Azure AI Search)

La operación List Synonym Maps devuelve una lista de los mapas de sinónimos en la servicio Search de Azure AI.

GET https://[service name].search.windows.net/synonymmaps?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.
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

Para obtener una solicitud correcta: "200 Correcto". A continuación se proporciona un cuerpo de respuesta de ejemplo:

    {  
      "value" : [  
        {  
          "name": "synonymmap1",  
          "format": "solr",  
          ... other synonym map properties  
        }]  
    }

Puede filtrar la respuesta solo a las propiedades que le interesen. Por ejemplo, si solo quiere una lista de nombres de mapa de sinónimos, use la opción de consulta seleccionar OData:

GET https://[service name].search.windows.net/synonymmaps?api-version=[api-version]&$select=name
api-key: [admin key]

En este caso, la respuesta del ejemplo anterior podría aparecer como sigue:

    {  
      "value" : [ { "name": "synonymmap1" }, ... ]  
    }

Nota

Si un mapa de sinónimos tiene una clave de cifrado, el servicio de búsqueda debe tener acceso a la clave de cifrado para recuperar las propiedades cifradas en la definición de esa asignación de sinónimos. Sin acceso a la clave de cifrado, se devuelve un "<encrypted>" marcador de posición en lugar de las propiedades cifradas. Restaurar el acceso a la clave permite al servicio de búsqueda recuperar de nuevo la definición completa del mapa de sinónimos.

Consulte también