Индексы списка (REST API поиска ИИ Azure)
Операция Перечисление индексов возвращает список индексов, которые в настоящее время находятся в служба ИИ Azure.
GET https://[service name].search.windows.net/indexes?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Параметры URI
| Параметр | Описание |
|---|---|
| имя службы | Обязательный. Задайте уникальное, определяемое пользователем имя службы поиска. |
| api-version | Обязательный. Текущая стабильная версия — api-version=2020-06-30. Дополнительные версии см. в разделе Версии API . |
Заголовки запросов
Таблица ниже содержит обязательные и необязательные заголовки запроса.
| Поля | Описание |
|---|---|
| Content-Type | Обязательный. Для этого заголовка необходимо задать значение application/json |
| api-key | Необязательно, если вы используете роли Azure и в запросе предоставляется маркер носителя, в противном случае требуется ключ. Ключ API — это уникальная, сгенерированная системой строка, которая проверяет подлинность запроса к службе поиска. Запросы на получение определения объекта должны включать в себя поле ключа API, заданного в качестве ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Подключение к поиску ИИ Azure с помощью проверки подлинности по ключу . |
Текст запроса
Нет.
Ответ
Код состояния: "200 OK" возвращается для успешного ответа.
Примеры
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Вы можете отфильтровать ответ только по интересующим вас свойствам. Например, если необходим только список имен индексов, задайте параметр запроса OData $select :
GET /indexes?api-version=2020-06-30&$select=name
В этом случае ответ из приведенного выше примера будет выглядеть так:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Это удобный способ сократить нагрузку на пропускную способность, если в службе поиска много индексов.