Uzyskiwanie mapy synonimów (interfejs API REST usługi Azure AI Search)

  • Artykuł

Operacja Pobierz mapę synonimów pobiera definicję mapy synonimów z usługi Azure AI 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 Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest dostarczany w żądaniu, w przeciwnym razie wymagany jest klucz. Api-key to unikatowy ciąg generowany przez system, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania pobierania definicji obiektu muszą zawierać pole api-key ustawione na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza .

Treść żądania

Brak.

Reakcja

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

Odpowiedź jest podobna do przykładów w temacie Create Synonym Map (Azure AI Search REST API) (Tworzenie mapy synonimów (interfejs API REST usługi Azure AI 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ż