Pobieranie mapy synonimów (interfejs API REST Azure Cognitive Search)

Operacja Pobierz mapę synonimów pobiera definicję mapy synonimów z Azure Cognitive Search.

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

Parametry identyfikatora URI

Parametr Opis
nazwa usługi Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania.
nazwa mapy synonimów Wymagane. Identyfikator URI żądania określa nazwę mapy synonimów do zwrócenia.
api-version Wymagane. Bieżąca stabilna wersja to api-version=2020-06-30. Zobacz Wersje interfejsu API , aby uzyskać więcej wersji.

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Pola Opis
Content-Type Wymagane. Ustaw tę wartość na application/json
api-key Wymagane. Klucz api-key służy do uwierzytelniania żądania w usługa wyszukiwania. Jest to wartość ciągu unikatowa dla usługi. Żądania dotyczące definicji obiektu w usłudze muszą zawierać pole api-key ustawione na klucz administratora (w przeciwieństwie do klucza zapytania). Klucz interfejsu API można znaleźć na pulpicie nawigacyjnym usługi wyszukiwania w Azure Portal.

Treść żądania

Brak.

Reakcja

Kod stanu: 200 OK jest zwracana dla pomyślnej odpowiedzi.

Odpowiedź jest podobna do przykładów w temacie Tworzenie mapy synonimów (interfejs API REST Azure Cognitive Search).

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

Uwaga

Jeśli mapa synonimów ma klucz szyfrowania, usługa wyszukiwania musi mieć dostęp do klucza szyfrowania, aby pobrać definicję mapy synonimów. Bez dostępu do klucza szyfrowania zwracany jest błąd 400 Nieprawidłowe żądanie. Przywrócenie dostępu do klucza umożliwia usłudze wyszukiwania ponowne pobranie definicji mapy synonimów.

Zobacz też