Установка и запуск контейнеров распознавания пользовательских именованных сущностей
Контейнеры позволяют разместить API распознавания пользовательских именованных сущностей в собственной инфраструктуре с помощью собственной обученной модели. Если у вас есть требования к безопасности или управлению данными, которые не могут быть выполнены путем удаленного вызова распознавания именованных сущностей, контейнеры могут быть хорошим вариантом.
Примечание.
- Бесплатная учетная запись ограничена 5000 текстовыми записями в месяц, а для контейнеров действуют только ценовые категории Бесплатный и Стандартный. Дополнительные сведения о тарифах запросов транзакций см. в разделе Ограничения данных и услуг.
Необходимые компоненты
- Если у вас еще нет подписки Azure, создайте бесплатную учетную запись.
- Docker, установленный на главном компьютере. Docker нужно настроить таким образом, чтобы контейнеры могли подключать и отправлять данные о выставлении счетов в Azure.
- В Windows для поддержки контейнеров Linux также должен быть настроен Docker.
- Необходимо знать основные принципы и основные понятия Docker.
- Ресурс языка с бесплатной ценовой категорией (F0) или ценовой категории "Стандартный" (S).
- Обученная и развернутая модель распознавания именованных сущностей
Сбор обязательных параметров
Требуются три основных параметра для всех контейнеров ИИ Azure. Для условий лицензионного соглашения на использование программного обеспечения корпорации Майкрософт должно быть задано значение accept. Также требуются URI конечной точки и ключ API.
URI конечной точки
Это {ENDPOINT_URI} значение доступно на странице обзора портал Azure соответствующего ресурса служб ИИ Azure. Перейдите на страницу обзора, наведите указатель мыши на конечную точку и появится значок копирования в буфер обмена. Скопируйте и используйте конечную точку по мере необходимости.
Ключи
Значение {API_KEY} используется для запуска контейнера и доступно на странице ключей портал Azure соответствующего ресурса служб ИИ Azure. Перейдите на страницу "Ключи" и щелкните значок копирования в буфер обмена.
Внимание
Эти ключи подписки используются для доступа к API служб искусственного интеллекта Azure. Не предоставляйте доступ к ключам другим пользователям. Храните их в безопасном месте. Например, используйте Azure Key Vault. Также рекомендуется регулярно повторно создавать эти ключи. Для вызова API необходим только один ключ. При повторном создании первого ключа второй ключ можно использовать для бесперебойного доступа к службе.
Требования к главному компьютеру и рекомендации
Узел — это 64-разрядный компьютер, на котором выполняется контейнер Docker. Это может быть компьютер в локальной среде или служба размещения Docker в Azure, включая следующие решения:
- Служба Azure Kubernetes.
- Экземпляры контейнеров Azure.
- Кластер Kubernetes, развернутый в Azure Stack. Дополнительные сведения см. в статье Развертывание Kubernetes в Azure Stack.
В следующей таблице описаны минимальные и рекомендуемые спецификации для контейнеров распознавания именованных сущностей. Частота каждого ядра ЦП должна быть минимум 2,6 ГГц. Также указано допустимое количество транзакций в секунду (TPS).
| Минимальные спецификации узла | Рекомендуемые спецификации узла | Минимальное TPS | Максимальное TPS | |
|---|---|---|---|---|
| Настраиваемый компонент Распознавания именованных сущностей | 1 ядро, 2 ГБ памяти | 1 ядро, 4 ГБ памяти | 15 | 30 |
Ядро и память соответствуют параметрам --cpus и --memory, которые используются как часть команды docker run.
Экспорт модели распознавания пользовательских именованных сущностей
Прежде чем продолжить выполнение образа Docker, необходимо экспортировать собственную обученную модель, чтобы предоставить ее контейнеру. Используйте следующую команду, чтобы извлечь модель и заменить заполнители ниже собственными значениями:
| Заполнитель | Значение | Формат или пример |
|---|---|---|
| {API_KEY} | Ключ ресурса распознавания пользовательских именованных сущностей. Он представлен на странице ресурса Ключ и конечная точка на портале Azure. | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| {ENDPOINT_URI} | Конечная точка для доступа к API распознавания пользовательских именованных сущностей. Он представлен на странице ресурса Ключ и конечная точка на портале Azure. | https://<your-custom-subdomain>.cognitiveservices.azure.com |
| {PROJECT_NAME} | Имя проекта, содержащего модель, которую требуется экспортировать. Его можно найти на вкладке проектов на портале Language Studio. | myProject |
| {TRAINED_MODEL_NAME} | Имя обученной модели, которую вы хотите экспортировать. Вы можете найти обученные модели на вкладке оценки модели на портале Language Studio. | myTrainedModel |
curl --location --request PUT '{ENDPOINT_URI}/language/authoring/analyze-text/projects/{PROJECT_NAME}/exported-models/{TRAINED_MODEL_NAME}?api-version=2023-04-15-preview' \
--header 'Ocp-Apim-Subscription-Key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
"TrainedmodelLabel": "{TRAINED_MODEL_NAME}"
}'
Получение образа контейнера с помощью docker pull
Образ контейнера распознавания пользовательских mcr.microsoft.com именованных сущностей можно найти в синдикате реестра контейнеров. Он находится в репозитории azure-cognitive-services/textanalytics/ и называется customner. Полное имя образа контейнера — mcr.microsoft.com/azure-cognitive-services/textanalytics/customner.
Чтобы использовать последнюю версию контейнера, можно использовать latest тег. Полный список тегов также представлен в MCR.
Воспользуйтесь командой docker pull, чтобы скачать образ контейнера из реестра контейнеров Microsoft.
docker pull mcr.microsoft.com/azure-cognitive-services/textanalytics/customner:latest
Совет
Используйте команду docker images, чтобы получить список скачанных образов контейнеров. Например, следующая команда возвращает таблицу со списком идентификаторов, репозиториев и тегов для каждого скачанного образа контейнера:
docker images --format "table {{.ID}}\t{{.Repository}}\t{{.Tag}}"
IMAGE ID REPOSITORY TAG
<image-id> <repository-path/name> <tag-name>
Запуск контейнера с помощью команды docker run
После добавления контейнера на главный компьютер используйте команду docker run для запуска контейнеров. После запуска контейнер продолжи работу, пока вы его не остановите.
Внимание
- В командах Docker в следующих разделах используется обратная косая черта (
\) как символ продолжения строки. Замените или удалите ее в соответствии с требованиями вашей операционной системы. - Для запуска контейнера необходимо указать параметры
Eula,BillingиApiKey. В противном случае контейнер не запустится. Дополнительные сведения см. в разделе о выставлении счетов.
Чтобы запустить контейнер распознавания пользовательских именованных сущностей, выполните следующую docker run команду. Замените значения заполнителей ниже на собственные.
| Заполнитель | Значение | Формат или пример |
|---|---|---|
| {API_KEY} | Ключ ресурса распознавания пользовательских именованных сущностей. Он представлен на странице ресурса Ключ и конечная точка на портале Azure. | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| {ENDPOINT_URI} | Конечная точка для доступа к API распознавания пользовательских именованных сущностей. Он представлен на странице ресурса Ключ и конечная точка на портале Azure. | https://<your-custom-subdomain>.cognitiveservices.azure.com |
| {PROJECT_NAME} | Имя проекта, содержащего модель, которую требуется экспортировать. Его можно найти на вкладке проектов на портале Language Studio. | myProject |
| {LOCAL_PATH} | Путь, в котором будет загружена экспортируемая модель на предыдущем шаге. Вы можете выбрать любой путь вашего вкуса. | C:/custom-ner-model |
| {TRAINED_MODEL_NAME} | Имя обученной модели, которую вы хотите экспортировать. Вы можете найти обученные модели на вкладке оценки модели на портале Language Studio. | myTrainedModel |
docker run --rm -it -p5000:5000 --memory 4g --cpus 1 \
-v {LOCAL_PATH}:/modelPath \
mcr.microsoft.com/azure-cognitive-services/textanalytics/customner:latest \
EULA=accept \
BILLING={ENDPOINT_URI} \
APIKEY={API_KEY} \
projectName={PROJECT_NAME}
exportedModelName={TRAINED_MODEL_NAME}
Команда:
- Запускает контейнер распознавания пользовательских именованных сущностей и загружает экспортированную модель в указанный локальный путь.
- выделяет одно ядро ЦП и 4 ГБ памяти;
- предоставляет TCP-порт 5000 и выделяет псевдотелетайп для контейнера;
- автоматически удаляет контейнер после завершения его работы. Образ контейнера остается доступным на главном компьютере.
Запуск нескольких контейнеров на одном узле
Если вы планируете запускать несколько контейнеров при открытых портах, обязательно назначьте каждому контейнеру отдельный открытый порт. Например, запускайте первый контейнер на порте 5000, а второй — на порте 5001.
Этот контейнер можно использовать и другой контейнер служб ИИ Azure, работающий вместе на узле HOST. Кроме того, можно использовать несколько контейнеров одного и того же контейнера служб искусственного интеллекта Azure.
Запрос конечной точки прогнозирования контейнера
Контейнер предоставляет интерфейсы REST API конечной точки прогнозирования запросов.
Используйте узел http://localhost:5000 для API контейнера.
Проверка состояния контейнера
Проверить это можно несколькими способами. Получите адрес и открытый порт для рассматриваемого контейнера из его параметра Внешний IP-адрес и запустите веб-браузер. Используйте приведенные ниже URL-адреса запросов, чтобы убедиться, что контейнер работает. В примерах в качестве URL-адресов запросов используется значение http://localhost:5000, однако ваш конкретный контейнер может иметь отличия. Убедитесь в правильности внешнего IP-адреса и открытого порта контейнера.
| Запросить URL-адрес | Характер использования |
|---|---|
http://localhost:5000/ |
Контейнер предоставляет домашнюю страницу. |
http://localhost:5000/ready |
При запросе с помощью команды GET этот URL-адрес подтверждает, что контейнер готов принять запрос к модели. Этот запрос может использоваться для проб активности и готовности Kubernetes. |
http://localhost:5000/status |
Этот URL-адрес, который можно также запросить с помощью GET, проверяет, действителен ли ключ API, используемый для запуска контейнера, без запроса конечной точки. Этот запрос может использоваться для проб активности и готовности Kubernetes. |
http://localhost:5000/swagger |
Контейнер предоставляет полный набор документации по конечным точкам и функции Попробовать. Эта функция позволяет ввести параметры в веб-форму HTML и создать запрос без необходимости писать код. После возвращения результатов запроса предоставляется пример команды CURL с примером требуемого формата HTTP-заголовков и текста. |
Остановка контейнера
Чтобы завершить работу контейнера, в среде командной строки, где выполняется контейнер, нажмите комбинацию клавиш Ctrl+C.
Устранение неполадок
Если контейнер запускается с выходным подключением и включенным ведением журнала, контейнер создает файлы журнала, которые удобно использовать для устранения неполадок, возникающих во время запуска или работы контейнера.
Совет
Дополнительные сведения об устранении неполадок и рекомендации см. в статье часто задаваемые вопросы о контейнерах ИИ Azure.
Выставление счетов
Контейнеры распознавания пользовательских именованных сущностей отправляют сведения о выставлении счетов в Azure с помощью ресурса распознавания именованных сущностей в учетной записи Azure.
Запросы к контейнеру оплачиваются согласно ценовой категории ресурса Azure, используемого для параметра ApiKey.
Контейнеры служб искусственного интеллекта Azure не лицензируются для запуска без подключения к конечной точке измерения или выставления счетов. Вам необходимо разрешить контейнерам непрерывную передачу данных для выставления счетов в конечную точку выставления счетов. Контейнеры служб искусственного интеллекта Azure не отправляют данные клиентов, такие как изображение или текст, которые анализируются, в корпорацию Майкрософт.
Подключение к Azure
Для запуска контейнера необходимо указать значения аргументов, касающихся выставления счетов. Эти значения обеспечивают подключение контейнера к конечной точке выставления счетов. Отчеты об использовании контейнера примерно каждые 10—15 минут. Если контейнер не подключится к Azure в течение допустимого периода времени, контейнер будет продолжать работать, но не будет обслуживать запросы, пока не будет восстановлена конечная точка выставления счетов. Попытки подключения выполняются 10 раз на протяжении одинакового интервала времени (10–15 минут). Если контейнеру не удается подключиться к конечной точке выставления счетов за 10 попыток, он останавливает запросы на обслуживание. Дополнительные сведения о выставлении счетов см. в контейнере служб искусственного интеллекта Azure.
Аргументы для выставления счетов
Команда docker run запустит контейнер, когда все три из следующих параметров предоставляются допустимыми значениями:
| Вариант | Описание |
|---|---|
ApiKey |
Ключ API ресурса служб ИИ Azure, который используется для отслеживания сведений о выставлении счетов. Этому параметру следует присвоить значение ключа API для подготовленного ресурса, который можно получить в Billing. |
Billing |
Конечная точка ресурса служб искусственного интеллекта Azure, которая используется для отслеживания сведений о выставлении счетов. Этому параметру следует присвоить URI конечной точки подготовленного ресурса Azure. |
Eula |
Указывает, что вы приняли условия лицензии для контейнера. Для этого параметра следует задать значение accept. |
Итоги
В этой статье вы узнали основные понятия и рабочий процесс для скачивания, установки и запуска контейнеров распознавания именованных сущностей. Сводка:
- Распознавание именованных сущностей предоставляет контейнеры Linux для Docker.
- Образы контейнеров скачиваются из Реестра контейнеров Майкрософт (MCR).
- Образы контейнеров выполняются в Docker.
- Для вызова операций в контейнерах распознавания именованных сущностей можно использовать REST API или пакет SDK, указав URI узла контейнера.
- При создании экземпляра контейнера нужно указать данные для выставления счетов.
Внимание
Контейнеры ИИ Azure не лицензируются для запуска без подключения к Azure для измерения. Клиенты должны разрешить контейнерам непрерывную передачу данных для выставления счетов в службу контроля потребления. Контейнеры искусственного интеллекта Azure не отправляют данные клиента (например, текст, который анализируется) в корпорацию Майкрософт.
Следующие шаги
- Параметры конфигурации см. в разделе Конфигурация контейнеров.