Synonymzuordnung abrufen (Azure AI Search-REST-API)

  • Artikel

Der Vorgang Synonymzuordnung abrufen ruft die Synonymzuordnungsdefinition aus Azure AI Search ab.

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

URI-Parameter

Parameter BESCHREIBUNG
Dienstname Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
Name der Synonymzuordnung Erforderlich. Der Anforderungs-URI gibt den Namen der zurückzugebenden Synonymzuordnung an.
api-version Erforderlich. Die aktuelle stabile Version ist api-version=2020-06-30. Weitere Versionen finden Sie unter API-Versionen .

Anforderungsheader

Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.

Felder BESCHREIBUNG
Content-Type Erforderlich. Auf application/json
api-key Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige, vom System generierte Zeichenfolge, die die Anforderung bei Ihrem Suchdienst authentifiziert. Abrufen von Anforderungen für eine Objektdefinition muss ein API-Schlüsselfeld enthalten, das auf Ihren Administratorschlüssel festgelegt ist (im Gegensatz zu einem Abfrageschlüssel). Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung .

Anforderungstext

Keine.

Antwort

Bei erfolgreicher Antwort wird der Statuscode "200 OK" zurückgegeben.

Die Antwort ähnelt den Beispielen in Create Synonym Map (Azure AI Search REST API).

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

Hinweis

Wenn die Synonymzuordnung über einen Verschlüsselungsschlüssel verfügt, muss der Suchdienst Zugriff auf den Verschlüsselungsschlüssel haben, um die Definition der Synonymzuordnung abzurufen. Ohne Zugriff auf den Verschlüsselungsschlüssel wird eine 400 ungültige Anforderung zurückgegeben. Durch die Wiederherstellung des Zugriffs auf den Schlüssel kann der Suchdienst die Synonymzuordnungsdefinition erneut abrufen.

Weitere Informationen