Sdílet prostřednictvím

Výpis map synonym (rozhraní REST API služby Azure AI Search)

Operace Vypsat mapy synonym vrátí seznam map synonym v Search Azure AI.

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

Parametry identifikátoru URI

Parametr Popis
název služby Povinná hodnota. Nastavte ho na jedinečný, uživatelem definovaný název vaší vyhledávací služby.
verze-api Povinná hodnota. Aktuální stabilní verze je api-version=2020-06-30. Další verze najdete v tématu Verze rozhraní API .

Hlavičky požadavku

Následující tabulka popisuje požadovanou a volitelnou hlavičku požadavku.

Pole Description
Typ obsahu Povinná hodnota. Nastavte tuto možnost na application/json
klíč rozhraní API Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Klíč api-key je jedinečný, systémem vygenerovaný řetězec, který ověřuje požadavek na vaši vyhledávací službu. Požadavky na získání pro definici objektu musí obsahovat pole api-key nastavené na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče .

Text požadavku

Žádné

Odpověď

Pro úspěšný požadavek: 200 OK. Tady je příklad textu odpovědi:

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

V odpovědi můžete vyfiltrovat jenom vlastnosti, které vás zajímají. Pokud například chcete jenom seznam názvů mapování synonym, použijte možnost výběrového dotazu OData:

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

V tomto případě by odpověď z výše uvedeného příkladu vypadala takto:

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

Poznámka

Pokud má mapa synonym šifrovací klíč, musí mít vyhledávací služba přístup k šifrovacímu klíči, aby načetla šifrované vlastnosti v definici této mapy synonym. Bez přístupu k šifrovacímu klíči "<encrypted>" se místo šifrovaných vlastností vrátí zástupný symbol. Obnovení přístupu ke klíči umožní vyhledávací službě znovu načíst úplnou definici mapy synonym.

Viz také