Freigeben über

Auflisten von Synonymzuordnungen (Azure AI Search-REST-API)

Der Vorgang Synonymzuordnungen auflisten gibt eine Liste der Synonymzuordnungen in Ihrer Azure KI-Suchdienst zurück.

GET https://[service name].search.windows.net/synonymmaps?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.
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 in der Anforderung ein Bearertoken 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 Anforderung: "200 OK". Hier ist ein Beispiel-Antworttext:

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

Sie können die Antwort nur nach den gewünschten Eigenschaften filtern. Wenn Sie z. B. nur eine Liste von Synonymzuordnungsnamen verwenden möchten, verwenden Sie die OData-Auswahlabfrageoption :

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

In diesem Fall würde die Antwort aus dem obigen Beispiel wie folgt aussehen:

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

Hinweis

Wenn eine Synonymzuordnung über einen Verschlüsselungsschlüssel verfügt, muss der Suchdienst Zugriff auf den Verschlüsselungsschlüssel haben, um verschlüsselte Eigenschaften in der Definition dieser Synonymzuordnung abzurufen. Ohne Zugriff auf den Verschlüsselungsschlüssel wird anstelle der verschlüsselten Eigenschaften ein "<encrypted>" Platzhalter zurückgegeben. Durch die Wiederherstellung des Zugriffs auf den Schlüssel kann der Suchdienst die vollständige Synonymzuordnungsdefinition erneut abrufen.

Weitere Informationen