Создание или обновление псевдонима (предварительная версия REST API)
Применимо к: 2023-07-01-Preview, 2021-04-30-Preview
Важно!
2023-07-01-Preview (без изменений).
2021-04-30-Preview добавляет API.
В поиске ИИ Azure псевдоним — это дополнительное имя, которое можно использовать для ссылки на индекс для запросов, индексирования и других операций.
Для запроса на создание можно использовать POST или PUT. Для любого из них документ JSON в тексте запроса предоставляет определение объекта.
POST https://[service name].search.windows.net/aliases?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Для запросов на обновление используйте PUT и укажите имя псевдонима в URI.
PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Все запросы к службе отправляются по протоколу HTTPS. В случае с PUT, если псевдоним не существует, он создается. Если он уже существует, он обновляется до нового определения.
Создание псевдонима устанавливает сопоставление между именем псевдонима и именем индекса. Если запрос выполнен успешно, псевдоним можно использовать для индексирования, выполнения запросов и других операций.
Обновление псевдонима позволяет сопоставить этот псевдоним с другим индексом поиска. При обновлении существующего псевдонима все определение заменяется содержимым текста запроса. Как правило, лучше всего использовать для обновлений определение псевдонима с помощью GET, изменить его, а затем обновить с помощью PUT.
Примечание
Обновление псевдонима может занять до 10 секунд для распространения в системе, поэтому следует подождать не менее 10 секунд перед удалением индекса, с которым псевдоним был сопоставлен ранее.
Примечание
Максимальное количество псевдонимов, которые можно создать, зависит от ценовой категории. Дополнительные сведения см. в статье Ограничения службы.
Параметры URI
| Параметр | Описание |
|---|---|
| имя службы | Обязательный. Задайте для этого значения уникальное пользовательское имя службы поиска. |
| имя псевдонима | Требуется для URI, если используется PUT. Имя должно быть строчным, начинаться с буквы или цифры, не содержать косых черт или точек и содержать менее 128 символов. После того как имя начинается с буквы или цифры, остальная часть имени может включать любую букву, цифру и тире, если дефисы не являются последовательными. |
| api-version | Обязательный. Текущая предварительная версия — 2023-07-01-Preview. Дополнительные версии см. в разделе Версии API . |
Заголовки запросов
Таблица ниже содержит обязательные и необязательные заголовки запроса.
| Поля | Описание |
|---|---|
| Content-Type | Обязательный. Присвойте этому значению значение application/json |
| api-key | Необязательно, если вы используете роли Azure и в запросе предоставляется маркер носителя, в противном случае требуется ключ. Ключ API — это уникальная, сгенерированная системой строка, которая проверяет подлинность запроса к службе поиска. Запросы на создание должны включать заголовок, заданный api-key для ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Подключение к поиску ИИ Azure с помощью проверки подлинности по ключу . |
Текст запроса
Текст запроса содержит определение псевдонима, включающее имя псевдонима и массив с именем одного индекса.
Следующий код JSON представляет собой общее представление main частей определения.
{
"name" : (optional on PUT; required on POST) "The name of the alias",
"indexes" : (required) ["The name of the index the alias is mapped to"]
}
Запрос содержит следующие свойства.
| Свойство | Описание |
|---|---|
| name | Обязательный. Имя псевдонима. Имя псевдонима должно содержать только строчные буквы, цифры или тире, не может начинаться или заканчиваться дефисами и может содержать только 128 символов. |
| индексы | Обязательный. Имя индекса, с который сопоставлен псевдоним. В массив можно включить только одно имя индекса. |
Ответ
Для успешного создания запроса вы увидите код состояния "201 Создано".
Для успешного запроса на обновление должно появиться сообщение "204 Нет содержимого".
Примеры
Пример. Псевдоним индекса
{
"name" : "my-alias",
"indexes" : ["my-index"]
}