Поделиться через


Индексаторы списков (REST API поиска Azure ИИ)

Операция Перечисление индексаторов возвращает список индексаторов в служба ИИ Azure.

GET https://[service name].search.windows.net/indexers?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 — это уникальная, созданная системой строка, которая проверяет подлинность запроса к службе поиска. Запросы get для определения объекта должны включать в себя поле ключа API, заданное для ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Подключение к поиску ИИ Azure с помощью проверки подлинности по ключу .

Текст запроса

Нет.

Ответ

Для успешного запроса: «200 — ОК». Вот пример тела запроса:

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }  

Вы можете отфильтровать ответ только по интересующим вас свойствам. Например, если вам нужен только список имен индексатора, используйте параметр запроса OData $select :

GET /indexers?api-version=2020-06-30&$select=name  

В этом случае ответ из приведенного выше примера будет выглядеть так:

{  
      "value" : [ { "name": "myindexer" } ]  
    }  

Это удобный способ сократить нагрузку на пропускную способность, если в службе поиска много индексаторов.

Примечание

Если индексатор имеет ключ шифрования, служба поиска должна иметь доступ к ключу шифрования для получения зашифрованных свойств в определении этого индексатора. Без доступа к ключу "<encrypted>" шифрования вместо зашифрованных свойств возвращается заполнитель. Восстановление доступа к ключу позволяет службе поиска снова получить полное определение индексатора.

См. также раздел