Документ подстановки (REST API поиска ИИ Azure)

Статья
11/13/2023

Операция поиска документа извлекает документ из поиска ИИ Azure. Она применяется в ситуации, когда пользователь щелкает по тому или иному результату поиска и необходимо получить определенные сведения о соответствующем документе. За один раз можно получить только один документ. Используйте поиск документов , чтобы получить несколько документов в одном запросе.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

Кроме того, для поиска по ключу можно использовать традиционный синтаксис OData:

GET /indexes/[index name]/docs('[key]')?[query parameters]

Параметры URI

Параметр	Описание
имя службы	Обязательный. Задайте уникальное, определяемое пользователем имя службы поиска.
имя индекса	Обязательный. В URI запроса указывается имя индекса. Параметры запроса указываются в строке запроса для запросов GET и в тексте запроса для запросов POST.
ключ	Обязательный. Значение `Edm.String` , однозначно определяющее каждый документ в индексе. Ключ иногда называют идентификатором документа. Значение ключа учитывает регистр. Например, документ с ключом "abc" отличается от документа с ключом "ABC".
параметры запроса	Многокомпонентная конструкция, включающая `$select` (необязательно) и `api-version=2020-06-30` (обязательно). Для этой операции в качестве параметра запроса указана версия API. `$select=[string]` — это список полей с разделиниями-запятыми для извлечения. В это предложение можно включить только поля, помеченные как извлекаемые. Если этот параметр не указан или содержит значение `*`, возвращаются все поля, помеченные в схеме как подлежащие извлечению и входящие в проекцию.

Заголовки запросов

Таблица ниже содержит обязательные и необязательные заголовки запроса.

Поля Описание

Content-Type Обязательный. Для этого заголовка необходимо задать значение application/json

api-key Необязательно, если вы используете роли Azure и в запросе предоставляется маркер носителя, в противном случае требуется ключ. Ключ API — это уникальная, сгенерированная системой строка, которая проверяет подлинность запроса к службе поиска. Запросы на получение определения объекта должны включать в себя поле ключа API, заданного в качестве ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Подключение к поиску ИИ Azure с помощью проверки подлинности по ключу .

Поля	Описание
Content-Type	Обязательный. Для этого заголовка необходимо задать значение `application/json`
api-key	Необязательно, если вы используете роли Azure и в запросе предоставляется маркер носителя, в противном случае требуется ключ. Ключ API — это уникальная, сгенерированная системой строка, которая проверяет подлинность запроса к службе поиска. Запросы на получение определения объекта должны включать в себя поле ключа API, заданного в качестве ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Подключение к поиску ИИ Azure с помощью проверки подлинности по ключу .

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

Нет.

Ответ

Код состояния: "200 OK" возвращается для успешного ответа.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Примеры

Поиск документа с ключом "2":

GET /indexes/hotels/docs/2?api-version=2020-06-30

Запрос документа со значением ключа 3 с помощью синтаксиса OData:

GET /indexes/hotels/docs('3')?api-version=2020-06-30