你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

安装并运行关键短语提取容器

项目
12/19/2023

利用容器能够在自己的基础结构上托管关键短语提取 API。如果你的安全或数据管理要求不能通过远程调用关键短语提取来完成，则容器可能是一个不错的选择。

注意

免费帐户限制为每月 5000 个文本记录，并且只有“免费”和“标准”定价层才对容器有效。有关事务请求费率的更多信息，请参阅数据和服务限制。

通过容器，你可以在自己的环境中运行关键短语提取 API，并且容器非常适合特定的安全和数据管控要求。关键短语分析容器提供对原始文本的高级自然语言处理，并且包含三项主要功能：情绪分析、关键短语提取和语言检测。

先决条件

如果还没有 Azure 订阅，可以创建一个免费帐户。
在主机上安装 Docker。必须将 Docker 配置为允许容器连接 Azure 并向其发送账单数据。
- 在 Windows 上，还必须将 Docker 配置为支持 Linux 容器。
- 应基本了解 Docker 概念。
使用免费 (F0) 或标准 (S) 定价层的语言资源。

收集必需的参数

所有 Azure AI 容器都需要三个主要参数。 Microsoft 软件许可条款的值必须为 “accept”。还需要终结点 URI 和 API 密钥。

终结点 URI

可在 Azure 门户中相应 Azure AI 服务资源的“概览”页上找到 {ENDPOINT_URI} 值。转到“概述”页，将鼠标悬停在终结点上就会显示一个“复制到剪贴板”图标。在需要的地方复制并使用终结点。

屏幕截图显示如何收集终结点 URI 以供将来使用。

键

{API_KEY} 值用于启动容器，可在 Azure 门户中相应 Azure AI 服务资源的“密钥”页上找到。转到“密钥”页，选择“复制到剪贴板” 图标。

屏幕截图显示如何获取两个密钥之一以供将来使用。

重要

这些订阅密钥用于访问 Azure AI 服务 API。请勿共享密钥。安全地存储它们。例如，使用 Azure Key Vault。此外，建议定期重新生成这些密钥。发出 API 调用只需一个密钥。重新生成第一个密钥时，可以使用第二个密钥继续访问服务。

主机要求和建议

主机是运行 Docker 容器且基于 x64 的计算机。它可以是本地计算机或 Azure 中的 Docker 托管服务，例如：

Azure Kubernetes 服务。
Azure 容器实例。
部署到 Azure Stack 的 Kubernetes 群集。有关详细信息，请参阅将 Kubernetes 部署到 Azure Stack。

下表显示了可用关键短语提取容器的最小资源规范和建议资源规范。每个 CPU 核心必须至少为 2.6 千兆赫 (GHz) 或更快。还列出了允许的每秒事务数 (TPS)。

	最小主机规格	推荐主机规格	最小 TPS	最大 TPS
关键短语提取	1 核，2GB 内存	1 核，4GB 内存	15	30

CPU 核心和内存对应于 --cpus 和 --memory 设置，用作 docker run 命令的一部分。

使用 `docker pull` 获取容器映像

在 mcr.microsoft.com 容器注册表联合项中可以找到关键短语提取容器映像。该映像驻留在 azure-cognitive-services/textanalytics/ 存储库中，名为 keyphrase。完全限定的容器映像名称为 mcr.microsoft.com/azure-cognitive-services/textanalytics/keyphrase。

若要使用最新版本的容器，可以使用 latest 标记。还可以在 MCR 上找到标记的完整列表。

使用 docker pull 命令从 Microsoft 容器注册表下载容器映像。

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

提示

可以使用 docker images 命令列出下载的容器映像。例如，以下命令以表格列出每个下载的容器映像的 ID、存储库和标记：

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 选项运行容器；否则，该容器不会启动。有关详细信息，请参阅计费。
情绪分析和语言检测容器使用该 API 的 v3 版本，并且已正式发布。关键短语提取容器使用该 API 的 v2 版本，并且处于预览阶段。

若要运行关键短语提取容器，请执行以下 docker run 命令。将下面的占位符替换为你自己的值：

占位符	Value	格式或示例
{API_KEY}	关键短语提取资源的键。可以在 Azure 门户中资源的“密钥和终结点”页上找到此项。	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
{ENDPOINT_URI}	用于访问关键短语提取 API 的终结点。可以在 Azure 门户中资源的“密钥和终结点”页上找到此项。	`https://<your-custom-subdomain>.cognitiveservices.azure.com`

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

此命令：

从容器映像运行关键短语提取容器
分配一个 CPU 核心和 4 GB 内存
公开 TCP 端口 5000，并为容器分配伪 TTY
退出后自动删除容器。容器映像在主计算机上仍然可用。

在同一主机上运行多个容器

若要使用公开端口运行多个容器，请确保在运行每个容器时使用不同的公开端口。例如，在端口 5000 上运行第一个容器，在端口 5001 上运行第二个容器。

可以让此容器和其他 Azure AI 服务容器一起在主机上运行。此外，还可以运行同一 Azure AI 服务容器的多个容器。

查询容器的预测终结点

容器提供了基于 REST 的查询预测终结点 API。

为容器 API 使用主机 http://localhost:5000。

验证容器是否正在运行

有几种方法可用于验证容器是否正在运行。找到相关容器的外部 IP 地址和公开端口，并打开你常用的 Web 浏览器。使用以下各种请求 URL 验证容器是否正在运行。此处列出的示例请求 URL 是 http://localhost:5000，但是你的特定容器可能会有所不同。请确保依赖容器的外部 IP 地址和公开端口。

请求 URL	用途
`http://localhost:5000/`	容器提供主页。
`http://localhost:5000/ready`	使用 GET 对此 URL 进行请求，可以验证容器是否已准备好接受针对模型的查询。此请求可用于 Kubernetes 运行情况和就绪情况探测。
`http://localhost:5000/status`	同样使用 GET 对此 URL 进行请求，可以验证用于启动容器的 api-key 是否有效，而不会导致终结点查询。此请求可用于 Kubernetes 运行情况和就绪情况探测。
`http://localhost:5000/swagger`	容器为终结点提供一组完整的文档以及“尝试”功能。使用此功能可以将设置输入到基于 Web 的 HTML 表单并进行查询，而无需编写任何代码。查询返回后，将提供示例 CURL 命令，用于演示所需的 HTTP 标头和正文格式。

容器的主页

运行已与 Internet 断开连接的容器

要使用此与 Internet 断开连接的容器，必须首先通过填写申请并购买承诺计划来请求访问权限。有关详细信息，请参阅在断开连接的环境中使用 Docker 容器。

如果已获准运行与 Internet 断开连接的容器，请使用以下示例，其中显示了将会使用的 docker run 命令的格式和占位符值。将这些占位符值替换为你自己的值。

docker run 命令中的 DownloadLicense=True 参数将会下载一个许可证文件，该文件将支持 Docker 容器能够在未连接到 Internet 时运行。它还包含到期日期，在此日期之后，许可证文件将失效，无法运行容器。只能将许可证文件用于已获批准的相应容器。例如，不能将语音转文本容器的许可证文件用于文档智能容器。

占位符	Value	格式或示例
`{IMAGE}`	要使用的容器映像。	`mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice`
`{LICENSE_MOUNT}`	将下载和装载许可证的路径。	`/host/license:/path/to/license/directory`
`{ENDPOINT_URI}`	用于对服务请求进行身份验证的终结点。可以在 Azure 门户中资源的“密钥和终结点”页上找到此项。	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{API_KEY}`	文本分析资源的密钥。可以在 Azure 门户中资源的“密钥和终结点”页上找到此项。	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
`{CONTAINER_LICENSE_DIRECTORY}`	容器本地文件系统上的许可证文件夹的位置。	`/path/to/license/directory`

docker run --rm -it -p 5000:5000 \ 
-v {LICENSE_MOUNT} \
{IMAGE} \
eula=accept \
billing={ENDPOINT_URI} \
apikey={API_KEY} \
DownloadLicense=True \
Mounts:License={CONTAINER_LICENSE_DIRECTORY}

下载许可证文件后，可以在断开连接的环境中运行容器。以下示例演示你将使用的 docker run 命令的格式设置以及占位符值。将这些占位符值替换为你自己的值。

无论容器在何处运行，都必须将许可证文件装载到容器，并且必须使用 Mounts:License= 指定容器本地文件系统上许可证文件夹的位置。还必须指定输出装载，以便可以写入计费使用情况记录。

占位符	Value	格式或示例
`{IMAGE}`	要使用的容器映像。	`mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice`
`{MEMORY_SIZE}`	要分配给容器的适当内存大小。	`4g`
`{NUMBER_CPUS}`	要分配给容器的适当 CPU 数。	`4`
`{LICENSE_MOUNT}`	将放置和装载许可证的路径。	`/host/license:/path/to/license/directory`
`{OUTPUT_PATH}`	记录使用情况记录的输出路径。	`/host/output:/path/to/output/directory`
`{CONTAINER_LICENSE_DIRECTORY}`	容器本地文件系统上的许可证文件夹的位置。	`/path/to/license/directory`
`{CONTAINER_OUTPUT_DIRECTORY}`	容器本地文件系统上的输出文件夹的位置。	`/path/to/output/directory`

docker run --rm -it -p 5000:5000 --memory {MEMORY_SIZE} --cpus {NUMBER_CPUS} \ 
-v {LICENSE_MOUNT} \ 
-v {OUTPUT_PATH} \
{IMAGE} \
eula=accept \
Mounts:License={CONTAINER_LICENSE_DIRECTORY}
Mounts:Output={CONTAINER_OUTPUT_DIRECTORY}

停止容器

若要关闭容器，请在运行容器的命令行环境中选择 Ctrl+C。

故障排除

如果运行启用了输出装入点和日志记录的容器，该容器会生成有助于排查启动或运行容器时发生的问题的日志文件。

提示

如需更多的故障排除信息和指南，请参阅 Azure AI 容器常见问题解答 (FAQ)。

计费

关键短语提取容器使用你的 Azure 帐户上的关键短语提取资源，将计费信息发送到 Azure。

对该容器的查询在用于 ApiKey 参数的 Azure 资源的定价层计费。

Azure AI 服务容器在未连接到计量或计费终结点的情况下无权运行。必须始终让容器可以向计费终结点传送计费信息。 Azure AI 服务容器不会将客户数据 (例如正在分析的图像或文本) 发送给 Microsoft。

连接到 Azure

容器需要计费参数值才能运行。这些值使容器可以连接到计费终结点。容器约每 10 到 15 分钟报告一次使用情况。如果容器未在允许的时间范围内连接到 Azure，容器将继续运行，但不会为查询提供服务，直到计费终结点恢复。尝试连接按 10 到 15 分钟的相同时间间隔进行 10 次。如果无法在 10 次尝试内连接到计费终结点，容器会停止处理请求。有关发送给 Microsoft 进行计费的信息的示例，请参阅 Azure AI 服务容器常见问题解答。

计费参数

当以下三个选项都提供了有效值时，docker run 命令会启动容器：

选项	说明
`ApiKey`	用于跟踪账单信息的 Azure AI 服务资源的 API 密钥。必须将此选项的值设置为 `Billing` 中指定的已预配资源的 API 密钥。
`Billing`	用于跟踪账单信息的 Azure AI 服务资源的终结点。必须将此选项的值设置为已预配的 Azure 资源的终结点 URI。
`Eula`	表示已接受容器的许可条款。此选项的值必须设置为 accept。

总结

在本文中，你已学习了下载、安装和运行关键短语提取容器的相关概念和工作流。综上所述：

关键短语提取提供适用于 Docker 的 Linux 容器。
从 Microsoft 容器注册表 (MCR) 下载容器映像。
容器映像在 Docker 中运行。
可以使用 REST API 或 SDK 通过指定容器的主机 URI 来调用关键短语提取容器中的操作。
必须在实例化容器时指定账单信息。

重要

如果未连接到 Azure 进行计量，则无法授权并运行 Azure AI 容器。客户需要始终让容器向计量服务传送账单信息。 Azure AI 容器不会向 Microsoft 发送客户数据（例如正在分析的文本）。

后续步骤

请参阅配置容器了解配置设置。