Установка и запуск контейнеров API анализа текстаInstall and run Text Analytics containers

Контейнеры позволяют запускать API анализа текста в собственной среде и прекрасно подходят для конкретных требований к безопасности и управлению данными.Containers enable you to run the Text Analytic APIs in your own environment and are great for your specific security and data governance requirements. Контейнеры Анализ текста обеспечивают расширенную обработку естественного языка по необработанному тексту и включают три основные функции: анализ тональностиности, извлечение ключевых фраз и определение языка.The Text Analytics containers provide advanced natural language processing over raw text, and include three main functions: sentiment analysis, key phrase extraction, and language detection. Связывание сущностей в настоящее время не поддерживается в контейнере.Entity linking is not currently supported in a container.

Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.If you don't have an Azure subscription, create a free account before you begin.

Предварительные требованияPrerequisites

Чтобы запустить любой из Анализ текста контейнеров, необходимо иметь главный компьютер и среды контейнеров.To run any of the Text Analytics containers, you must have the host computer and container environments.

ПодготовкаPreparation

Прежде чем использовать контейнеры Анализа текста, необходимо выполнить следующие условия:You must meet the following prerequisites before using Text Analytics containers:

Обязательное значениеRequired ЦельPurpose
Модуль DockerDocker Engine На главном компьютере должен быть установлен модуль Docker.You need the Docker Engine installed on a host computer. Docker предоставляет пакеты, которые настраивают среду Docker в ОС macOS, Windows и Linux.Docker provides packages that configure the Docker environment on macOS, Windows, and Linux. Ознакомьтесь с общими сведениями о Docker и контейнерах.For a primer on Docker and container basics, see the Docker overview.

Docker нужно настроить таким образом, чтобы контейнеры могли подключать и отправлять данные о выставлении счетов в Azure.Docker must be configured to allow the containers to connect with and send billing data to Azure.

В ОС Windows для Docker нужно также настроить поддержку контейнеров Linux.On Windows, Docker must also be configured to support Linux containers.

Опыт работы с DockerFamiliarity with Docker Требуется базовое представление о понятиях Docker, включая реестры, репозитории, контейнеры и образы контейнеров, а также знание основных команд docker.You should have a basic understanding of Docker concepts, like registries, repositories, containers, and container images, as well as knowledge of basic docker commands.
Ресурс API анализа текстаText Analytics resource Для использования контейнера необходимо следующее:In order to use the container, you must have:

Ресурс Azure анализ текста для получения соответствующего ключа API и URI конечной точки.An Azure Text Analytics resource to get the associated API key and endpoint URI. Оба значения доступны на страницах "Обзор" и "Ключи" API анализа текста на портале Azure и необходимы для запуска контейнера.Both values are available on the Azure portal's Text Analytics Overview and Keys pages and are required to start the container.

{API_KEY} : Один из двух доступных ключей ресурсов на странице " ключи "{API_KEY}: One of the two available resource keys on the Keys page

{ENDPOINT_URI} : Конечная точка, указанная на странице обзора{ENDPOINT_URI}: The endpoint as provided on the Overview page

Идет сбор обязательных параметровGathering required parameters

Есть три основных параметра для всех обязательных контейнеров Cognitive Services ".There are three primary parameters for all Cognitive Services' containers that are required. Лицензионное соглашение должно быть установлено созначением accept.The end-user license agreement (EULA) must be present with a value of accept. Кроме того, требуются URL-адрес конечной точки и ключ API.Additionally, both an Endpoint URL and API Key are needed.

URI конечной точки{Endpoint_URI}Endpoint URI {Endpoint_URI}

Значение URI конечной точки доступно на странице обзора портал Azure соответствующего ресурса службы.The Endpoint URI value is available on the Azure portal Overview page of the corresponding Cognitive Service resource. Перейдите на страницу обзора , наведите указатель мыши на конечную точку Copy to clipboard , и появится значок.Navigate to the Overview page, hover over the Endpoint, and a Copy to clipboard icon will appear. Копирование и использование при необходимости.Copy and use where needed.

Сбор URI конечной точки для последующего использования

Ключ{API_Key}Keys {API_Key}

Этот ключ используется для запуска контейнера и доступен на странице ключей портал Azure соответствующего ресурса службы.This key is used to start the container, and is available on the Azure portal's Keys page of the corresponding Cognitive Service resource. Перейдите на страницу ключи и щелкните Copy to clipboard значок.Navigate to the Keys page, and click on the Copy to clipboard icon.

Получите один из двух ключей для последующего использования

Важно!

Эти ключи подписки используются для доступа к API-интерфейсу для работы со службой.These subscription keys are used to access your Cognitive Service API. Не предоставляйте общий доступ к ключам.Do not share your keys. Храните их безопасно, например, с помощью Azure Key Vault.Store them securely, for example, using Azure Key Vault. Мы также советуем регулярно создавать эти ключи.We also recommend regenerating these keys regularly. Для вызова API требуется только один ключ.Only one key is necessary to make an API call. При повторном создании первого ключа можно использовать второй ключ для постоянного доступа к службе.When regenerating the first key, you can use the second key for continued access to the service.

Главный компьютерThe host computer

Узел — это 64-разрядный компьютер, на котором выполняется контейнер Docker.The host is a x64-based computer that runs the Docker container. Это может быть компьютер в локальной среде или служба размещения Docker в Azure, включая следующие решения:It can be a computer on your premises or a Docker hosting service in Azure, such as:

Требования к контейнеру и рекомендацииContainer requirements and recommendations

В следующей таблице описаны минимальные и рекомендуемые требования к ЦП (минимум 2,6 ГГц или быстрее) и памяти, в ГБ, для выделения для каждого контейнера Анализа текста.The following table describes the minimum and recommended CPU cores, at least 2.6 gigahertz (GHz) or faster, and memory, in gigabytes (GB), to allocate for each Text Analytics container.

КонтейнерContainer МинимумMinimum РекомендуетсяRecommended ПЛАТЫTPS
(Минимум, максимум)(Minimum, Maximum)
Извлечение ключевых фразKey Phrase Extraction 1 ядро, 2 ГБ памяти1 core, 2-GB memory 1 ядро, 4 ГБ памяти1 core, 4-GB memory 15, 3015, 30
Распознавание языкаLanguage Detection 1 ядро, 2 ГБ памяти1 core, 2-GB memory 1 ядро, 4 ГБ памяти1 core, 4-GB memory 15, 3015, 30
Анализ тональностиSentiment Analysis 1 ядро, 2 ГБ памяти1 core, 2-GB memory 1 ядро, 4 ГБ памяти1 core, 4-GB memory 15, 3015, 30
  • Частота каждого ядра должна быть минимум 2,6 ГГц.Each core must be at least 2.6 gigahertz (GHz) or faster.
  • TPS — транзакций в секунду.TPS - transactions per second

Ядро и память соответствуют параметрам --cpus и --memory, которые используются как часть команды docker run.Core and memory correspond to the --cpus and --memory settings, which are used as part of the docker run command.

Получение образа контейнера с помощью docker pullGet the container image with docker pull

Образы контейнеров для Анализа текста доступны в Реестре контейнеров Майкрософт.Container images for Text Analytics are available from Microsoft Container Registry.

КонтейнерContainer РепозиторийRepository
Извлечение ключевых фразKey Phrase Extraction mcr.microsoft.com/azure-cognitive-services/keyphrase
Распознавание языкаLanguage Detection mcr.microsoft.com/azure-cognitive-services/language
Анализ тональностиSentiment Analysis mcr.microsoft.com/azure-cognitive-services/sentiment

docker pull Используйте команду, чтобы скачать образ контейнера из реестра контейнеров Майкрософт.Use the docker pull command to download a container image from Microsoft Container Registry.

Полное описание доступных тегов для контейнеров Анализа текста см. в следующих контейнерах в центре Docker:For a full description of available tags for the Text Analytics containers, see the following containers on the Docker Hub:

Воспользуйтесь командой docker pull, чтобы скачать образ контейнера.Use the docker pull command to download a container image.

docker pull для контейнера извлечения ключевой фразыDocker pull for the Key phrase extraction container

docker pull mcr.microsoft.com/azure-cognitive-services/keyphrase:latest

docker pull для контейнера определения языкаDocker pull for the language detection container

docker pull mcr.microsoft.com/azure-cognitive-services/language:latest

docker pull для контейнера тональностиDocker pull for the sentiment container

docker pull mcr.microsoft.com/azure-cognitive-services/sentiment:latest

Совет

Используйте команду docker images, чтобы получить список скачанных образов контейнеров.You can use the docker images command to list your downloaded container images. Например, следующая команда возвращает таблицу со списком идентификаторов, репозиториев и тегов для каждого скачанного образа контейнера:For example, the following command lists the ID, repository, and tag of each downloaded container image, formatted as a table:

docker images --format "table {{.ID}}\t{{.Repository}}\t{{.Tag}}"

IMAGE ID         REPOSITORY                TAG
<image-id>       <repository-path/name>    <tag-name>

Использование контейнераHow to use the container

После размещения контейнера на главном компьютере воспользуйтесь следующей процедурой для работы с ним.Once the container is on the host computer, use the following process to work with the container.

  1. Запустите контейнер с необходимыми настройками выставления счетов.Run the container, with the required billing settings. Доступны дополнительные примеры команды docker run.More examples of the docker run command are available.
  2. Запрос конечной точки прогнозирования контейнера.Query the container's prediction endpoint.

Запуск контейнера с помощью команды docker runRun the container with docker run

Воспользуйтесь командой docker run для запуска любого из трех контейнеров.Use the docker run command to run any of the three containers. Дополнительные сведения о том, как получить значения и {API_Key} , {Endpoint_URI} см. в разделе сбор обязательных параметров .Refer to Gathering required parameters for details on how to get the {Endpoint_URI} and {API_Key} values.

Доступны примеры docker run команд.Examples of the docker run command are available.

Пример запуска контейнера команды запуска DOCKERRun container example of docker run command

docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 \
mcr.microsoft.com/azure-cognitive-services/keyphrase \
Eula=accept \
Billing={ENDPOINT_URI} \
ApiKey={API_KEY}

Эта команда:This command:

  • запускает контейнер ключевой фразы из образа контейнера;Runs a key phrase container from the container image
  • выделяет одно ядро ЦП и 4 ГБ памяти;Allocates one CPU core and 4 gigabytes (GB) of memory
  • предоставляет TCP-порт 5000 и выделяет псевдотелетайп для контейнера;Exposes TCP port 5000 and allocates a pseudo-TTY for the container
  • автоматически удаляет контейнер после завершения его работы.Automatically removes the container after it exits. Образ контейнера остается доступным на главном компьютере.The container image is still available on the host computer.

Важно!

Для запуска контейнера необходимо указать параметры Eula, Billing и ApiKey. В противном случае контейнер не запустится.The Eula, Billing, and ApiKey options must be specified to run the container; otherwise, the container won't start. Дополнительные сведения см. в разделе о выставлении счетов.For more information, see Billing.

Запуск нескольких контейнеров на одном узлеRun multiple containers on the same host

Если вы планируете запускать несколько контейнеров при открытых портах, обязательно назначьте каждому контейнеру отдельный открытый порт.If you intend to run multiple containers with exposed ports, make sure to run each container with a different exposed port. Например, запускайте первый контейнер на порте 5000, а второй — на порте 5001.For example, run the first container on port 5000 and the second container on port 5001.

Этот контейнер и другой контейнер Azure Cognitive Services могут одновременно работать на одном и том же узле.You can have this container and a different Azure Cognitive Services container running on the HOST together. Также одному запущенному контейнеру Cognitive Services могут соответствовать сразу несколько контейнеров.You also can have multiple containers of the same Cognitive Services container running.

Запрос конечной точки прогнозирования контейнераQuery the container's prediction endpoint

Контейнер предоставляет API запроса конечной точки прогнозирования на основе REST.The container provides REST-based query prediction endpoint APIs.

Используйте узел http://localhost:5000 для API контейнера.Use the host, http://localhost:5000, for container APIs.

Проверка состояния контейнераValidate that a container is running

Проверить это можно несколькими способами.There are several ways to validate that the container is running.

ЗапросRequest НазначениеPurpose
http://localhost:5000/ Контейнер предоставляет домашнюю страницу.The container provides a home page.
http://localhost:5000/status Запрашивается с помощью GET для проверки того, что контейнер работает, без отправки запроса к конечной точке.Requested with GET, to validate that the container is running without causing an endpoint query. Этот запрос может использоваться для проб активности и готовности Kubernetes.This request can be used for Kubernetes liveness and readiness probes.
http://localhost:5000/swagger Контейнер предоставляет полный набор документации для конечных точек, а также функцию Try it now.The container provides a full set of documentation for the endpoints and a Try it now feature. Эта функция позволяет ввести параметры в веб-форму HTML и создать запрос без необходимости писать код.With this feature, you can enter your settings into a web-based HTML form and make the query without having to write any code. После возвращения результатов запроса предоставляется пример команды CURL с примером требуемого формата HTTP-заголовков и текста.After the query returns, an example CURL command is provided to demonstrate the HTTP headers and body format that's required.

Домашняя страница контейнера

Остановка контейнераStop the container

Чтобы завершить работу контейнера, в среде командной строки, где выполняется контейнер, выберите Ctrl + C.To shut down the container, in the command-line environment where the container is running, select Ctrl+C.

Устранение неполадокTroubleshooting

Если контейнер запускается с выходным подключением и включенным ведением журнала, контейнер создает файлы журнала, которые удобно использовать для устранения неполадок, возникающих во время запуска или работы контейнера.If you run the container with an output mount and logging enabled, the container generates log files that are helpful to troubleshoot issues that happen while starting or running the container.

Выставление счетовBilling

Контейнеры API анализа текста отправляют данные для выставления счетов в Azure с помощью ресурса API анализа текста в учетной записи Azure.The Text Analytics containers send billing information to Azure, using a Text Analytics resource on your Azure account.

Запросы к контейнеру оплачиваются согласно ценовой категории ресурсов Azure, используемой для <ApiKey>.Queries to the container are billed at the pricing tier of the Azure resource that's used for the <ApiKey>.

Контейнеры Azure Cognitive Services не лицензируются для запуска без подключения к конечной точке выставления счетов для отслеживания использования.Azure Cognitive Services containers aren't licensed to run without being connected to the billing endpoint for metering. Вам необходимо разрешить контейнерам непрерывную передачу данных для выставления счетов в конечную точку выставления счетов.You must enable the containers to communicate billing information with the billing endpoint at all times. Контейнеры Cognitive Services не отправляют в корпорацию Майкрософт данные клиента, например анализируемые изображения или тексты.Cognitive Services containers don't send customer data, such as the image or text that's being analyzed, to Microsoft.

Подключение к AzureConnect to Azure

Для запуска контейнера необходимо указать значения аргументов, касающихся выставления счетов.The container needs the billing argument values to run. Эти значения обеспечивают подключение контейнера к конечной точке выставления счетов.These values allow the container to connect to the billing endpoint. Отчеты об использовании контейнера примерно каждые 10—15 минут.The container reports usage about every 10 to 15 minutes. Если контейнер не подключится к Azure в течение допустимого периода времени, контейнер будет продолжать работать, но не будет обслуживать запросы, пока не будет восстановлена конечная точка выставления счетов.If the container doesn't connect to Azure within the allowed time window, the container continues to run but doesn't serve queries until the billing endpoint is restored. Попытки подключения выполняются 10 раз на протяжении одинакового интервала времени (10–15 минут).The connection is attempted 10 times at the same time interval of 10 to 15 minutes. Если контейнеру не удается подключиться к конечной точке выставления счетов за 10 попыток, его выполнение останавливается.If it can't connect to the billing endpoint within the 10 tries, the container stops running.

Аргументы для выставления счетовBilling arguments

Чтобы запустить контейнер с помощью команды docker run, необходимо указать все три приведенных ниже параметра с допустимыми значениями:For the docker run command to start the container, all three of the following options must be specified with valid values:

ПараметрOption ОписаниеDescription
ApiKey Ключ API ресурса Cognitive Services, используемый для отслеживания информации о выставлении счетов.The API key of the Cognitive Services resource that's used to track billing information.
Этому параметру следует присвоить значение ключа API для подготовленного ресурса, который можно получить в Billing.The value of this option must be set to an API key for the provisioned resource that's specified in Billing.
Billing Конечная точка ресурса Cognitive Services, используемая для отслеживания информации о выставлении счетов.The endpoint of the Cognitive Services resource that's used to track billing information.
Этому параметру следует присвоить URI конечной точки подготовленного ресурса Azure.The value of this option must be set to the endpoint URI of a provisioned Azure resource.
Eula Указывает, что вы приняли условия лицензии для контейнера.Indicates that you accepted the license for the container.
Для этого параметра следует задать значение accept.The value of this option must be set to accept.

Дополнительные сведения об этих параметрах см. в статье Настройка контейнеров.For more information about these options, see Configure containers.

Записи блогаBlog posts

Примеры для разработчиковDeveloper samples

Примеры для разработчиков доступны в нашем репозитории GitHub.Developer samples are available at our GitHub repository.

Просмотреть вебинарView webinar

Присоединяйтесь к вебинару, чтобы узнать:Join the webinar to learn about:

  • как развернуть Cognitive Services на любом компьютере с помощью Docker;How to deploy Cognitive Services to any machine using Docker
  • как развернуть Cognitive Services в AKS.How to deploy Cognitive Services to AKS

СводкаSummary

В этой статье вы узнали основные понятия и рабочий процесс для скачивания, установки и выполнения контейнеров Анализа текста.In this article, you learned concepts and workflow for downloading, installing, and running Text Analytics containers. В разделе "Сводка" сделайте следующее.In summary:

  • Анализ текста предоставляет три контейнера Linux для Docker, инкапсулируя извлечение ключевых фраз, определение языка и анализ тональности.Text Analytics provides three Linux containers for Docker, encapsulating key phrase extraction, language detection, and sentiment analysis.
  • Образы контейнеров скачиваются из Реестра контейнеров (Майкрософт) в Azure.Container images are downloaded from the Microsoft Container Registry (MCR) in Azure.
  • Образы контейнеров выполняются в Docker.Container images run in Docker.
  • Указав узел URI контейнера, пакет SDK или REST API можно использовать для вызова операций в контейнерах Анализа текста.You can use either the REST API or SDK to call operations in Text Analytics containers by specifying the host URI of the container.
  • При создании экземпляра контейнера нужно указать данные для выставления счетов.You must specify billing information when instantiating a container.

Важно!

Контейнеры Cognitive Services не лицензируются для запуска без подключения к Azure для отслеживания использования.Cognitive Services containers are not licensed to run without being connected to Azure for metering. Клиенты должны разрешить контейнерам непрерывную передачу данных для выставления счетов в службу контроля потребления.Customers need to enable the containers to communicate billing information with the metering service at all times. Контейнеры Cognitive Services не отправляют в корпорацию Майкрософт данные клиента (например, анализируемые изображения или тексты).Cognitive Services containers do not send customer data (e.g., the image or text that is being analyzed) to Microsoft.

Следующие шагиNext steps