Synonymzuordnung abrufen (Azure Cognitive Search REST-API)

Der Vorgang "Synonymzuordnung abrufen" ruft die Synonymzuordnungsdefinition von Azure Cognitive 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.
Synonymzuordnungsname 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 Erforderlich. Der API-Schlüssel wird verwendet, um die Anforderung für Ihre Suchdienst zu authentifizieren. Es handelt sich um einen für Ihren Dienst eindeutigen Zeichenfolgewert. Abrufen von Anforderungen für eine Objektdefinition in Ihrem Dienst muss ein API-Schlüsselfeld enthalten, das auf Ihren Administratorschlüssel festgelegt ist (im Gegensatz zu einem Abfrageschlüssel). Sie finden den API-Schlüssel im Suchdienstdashboard im Azure-Portal.

Anforderungstext

Keine.

Antwort

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

Die Antwort ähnelt Beispielen in Create Synonym Map (Azure Cognitive 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 Synonymzuordnungsdefinition abzurufen. Ohne Zugriff auf den Verschlüsselungsschlüssel wird eine 400 ungültige Anforderung zurückgegeben. Durch das Wiederherstellen des Zugriffs auf den Schlüssel kann der Suchdienst die Synonymzuordnungsdefinition erneut abrufen.

Weitere Informationen