Indeksy list (interfejs API REST usługi Azure AI Search)
Operacja Indeksy listy zwraca listę indeksów aktualnie w usłudze Azure AI usługa wyszukiwania.
GET https://[service name].search.windows.net/indexes?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. |
| 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.
Przykłady
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Odpowiedź można filtrować w dół do interesujących Cię właściwości. Jeśli na przykład potrzebujesz tylko listy nazw indeksów, użyj opcji zapytania OData $select :
GET /indexes?api-version=2020-06-30&$select=name
W takim przypadku odpowiedź z powyższego przykładu będzie wyglądać następująco:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Jest to przydatna technika oszczędzania przepustowości, jeśli masz wiele indeksów w usługa wyszukiwania.