您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

安装并运行 LUIS 的 Docker 容器

备注

容器图像位置最近发生了更改。 阅读本文以查看此容器的更新位置。

容器使你能够在自己的环境中使用 LUIS。 容器非常适合用于满足特定的安全性和数据管理要求。 本文介绍如何下载、安装以及运行 LUIS 容器。

语言理解 (LUIS) 容器加载已训练或已发布的语言理解模型。 作为 LUIS 应用,docker 容器提供从容器的 API 终结点执行预测查询的访问权限。 可以从容器中收集查询日志并将这些日志上传回语言理解应用以提高应用的预测准确性。

以下视频演示如何使用此容器。

认知服务的容器演示

如果没有 Azure 订阅,请在开始之前创建一个免费帐户

先决条件

若要运行 LUIS 容器,请注意以下先决条件:

  • 在主计算机上安装的 Docker。 必须将 Docker 配置为允许容器连接 Azure 并向其发送账单数据。
    • 在 Windows 上,还必须将 Docker 配置为支持 Linux 容器。
    • 你应该对 Docker 概念有基本的了解。
  • 使用免费 (F0) 或标准 (S) 定价层LUIS 资源
  • 已训练或已发布的应用,作为具有关联应用 ID 的容器的已装载输入打包。 可以通过 LUIS 门户或创作 API 获取打包文件。 若要通过 创作 API 获得 LUIS 打包应用,还将需要 创作密钥

收集必需的参数

所有认知服务容器都需要三个主要参数。 最终用户许可协议 (EULA) 的值必须为 accept。 此外,终结点 URL 和 API 密钥都是必需的。

终结点 URI {ENDPOINT_URI}

终结点 URI 值位于相应认知服务资源的 Azure 门户“概述”页上。 导航到“概述”页,将鼠标悬停在终结点上,将显示一个 Copy to clipboard 图标。 复制并在需要时使用。

收集终结点 URL 供以后使用

密钥 {API_KEY}

此密钥用于启动容器,在相应认知服务资源的 Azure 门户“密钥”页上提供。 导航到“密钥”页,然后单击 Copy to clipboard 图标。

获取两个密钥中的一个供以后使用

重要

这些订阅密钥用于访问认知服务 API。 不要共享你的密钥。 以安全方式存储密钥(例如,使用 Azure Key Vault 来存储)。 此外,我们建议定期重新生成这些密钥。 发出 API 调用只需一个密钥。 重新生成第一个密钥时,可以使用第二个密钥来持续访问服务。

应用 ID {APP_ID}

此 ID 用于选择应用。 可以在 LUIS 门户中找到应用 ID,方法是:单击应用屏幕顶部的“管理”,然后单击“设置”。

用于查找应用 ID 的屏幕。

创作密钥 {AUTHORING_KEY}

此密钥用于从云中的 LUIS 服务获取打包的应用并将查询日志上传回云。 如果使用 REST API 来导出应用,你需要创作密钥(在本文的后面部分介绍)。

可以通过单击应用屏幕顶部的“管理”,然后单击“Azure 资源”,从 LUIS 门户获取创作密钥。

用于查找创作资源密钥的屏幕。

用于包文件的创作 API

用于打包应用的创作 API:

主计算机

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

容器要求和建议

下表列出了容器主机的最小值和建议值。 你的要求可能会根据流量的多少而发生变化。

容器 最小值 建议 TPS
(最小值, 最大值)
LUIS 单核,2-GB 内存 单核,4-GB 内存 20, 40
  • 每个核心必须至少为 2.6 千兆赫 (GHz) 或更快。
  • TPS - 每秒事务数

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

使用 docker pull 获取容器映像

使用 docker pull 命令从 mcr.microsoft.com/azure-cognitive-services/language/luis 存储库下载容器映像:

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

有关可用标记的完整说明(如上述命令中使用的 latest),请参阅 Docker Hub 上的 LUIS

提示

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

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

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

如何使用容器

一旦容器位于主计算机上,请通过以下过程使用容器。

使用语言理解 (LUIS) 容器的过程

  1. 通过 LUIS 门户或 LUIS API 导出容器的包
  2. 将包文件移动到主计算机上的所需输入目录中。 请勿重命名、更改、覆盖或解压缩 LUIS 包文件。
  3. 使用所需的输入装入点和计费设置运行容器。 提供 docker run 命令的多个示例
  4. 查询容器的预测终结点
  5. 使用完此容器后,从 LUIS 门户的输出装入点导入终结点日志停止容器。
  6. 在“查看终结点话语”页上使用 LUIS 门户的主动学习改进应用。

无法更改正在容器中运行的应用。 若要更改容器中的应用,必须使用 LUIS 门户或使用 LUIS 创作 API 更改 LUIS 服务中的应用。 然后进行训练和/或发布,下载新包并再次运行该容器。

容器内的 LUIS 应用无法导出回 LUIS 服务。 只能上传查询日志。

从 LUIS 导出打包的应用

LUIS 容器需要已训练或已发布的 LUIS 应用才能回复用户话语的预测查询。 若要获取 LUIS 应用,请使用已训练或已发布的包 API。

默认位置是运行 docker run 命令的 input 子目录。

将包文件置于某个目录中,然后在运行 docker 容器时引用此目录作为输入装入点。

包类型

输入装入点目录可以同时包含应用的生产、过渡和版本控制模型。 所有包均已装载。

包类型 查询终结点 API 查询可用性 包文件名格式
带有版本 GET、POST 仅容器 {APP_ID}_v{APP_VERSION}.gz
过渡 GET、POST Azure 和容器 {APP_ID}_STAGING.gz
生产 GET、POST Azure 和容器 {APP_ID}_PRODUCTION.gz

重要

请勿重命名、更改、覆盖或解压缩 LUIS 包文件。

打包先决条件

在打包 LUIS 应用程序之前,必须满足以下条件:

打包要求 详细信息
Azure 认知服务资源实例 支持的区域包括

美国西部 (westus)
西欧 (westeurope)
澳大利亚东部 (australiaeast)
已训练或已发布的 LUIS 应用 没有不受支持的依赖项
访问主计算机的文件系统 主计算机必须允许输入装入点

通过 LUIS 门户导出应用包

LUIS 门户提供导出已训练或已发布的应用包的功能。

通过 LUIS 门户导出已发布的应用包

可从“我的应用”列表页中获取已发布的应用包。

  1. 登录到 LUIS 门户
  2. 选中列表中应用名称左侧的复选框。
  3. 从列表上方的上下文工具栏中选择“导出”项。
  4. 选择“导出容器 (GZIP)”。
  5. 选择“生产槽”或“过渡槽”的环境。
  6. 将从浏览器下载包。

从“应用”页面的“导出”菜单导出容器的已发布包

通过 LUIS 门户导出已进行版本控制的应用包

可从“版本”列表页中获取已进行版本控制的应用包。

  1. 登录到 LUIS 门户
  2. 在列表中选择该应用。
  3. 在应用的导航栏中选择“管理”。
  4. 在左侧导航栏中选择“版本”。
  5. 选中列表中版本名称左侧的复选框。
  6. 从列表上方的上下文工具栏中选择“导出”项。
  7. 选择“导出容器 (GZIP)”。
  8. 将从浏览器下载包。

从“版本”页面的“导出”菜单导出容器的已训练包

通过 API 导出已发布的应用包

使用以下 REST API 方法打包已发布的 LUIS 应用。 使用 HTTP 规范下方的表将 API 调用中的占位符替换为自己相应的值。

GET /luis/api/v2.0/package/{APP_ID}/slot/{SLOT_NAME}/gzip HTTP/1.1
Host: {AZURE_REGION}.api.cognitive.microsoft.com
Ocp-Apim-Subscription-Key: {AUTHORING_KEY}
占位符
{APP_ID} 已发布 LUIS 应用的应用程序 ID。
{SLOT_NAME} 已发布 LUIS 应用的环境。 使用以下值之一:
PRODUCTION
STAGING
{AUTHORING_KEY} 已发布 LUIS 应用的 LUIS 帐户的创作密钥。
可以从 LUIS 门户的“用户设置”页面中获取创作密钥。
{AZURE_REGION} 相应的 Azure 区域:

westus - 美国西部
westeurope - 西欧
australiaeast - 澳大利亚东部

若要下载已发布的包,请参考此处的 API 文档。 如果下载成功,响应是一个 LUIS 包文件。 将文件保存在为容器的输入装入点指定的存储位置中。

通过 API 导出已进行版本控制的应用包

使用以下 REST API 方法打包已训练的 LUIS 应用程序。 使用 HTTP 规范下方的表将 API 调用中的占位符替换为自己相应的值。

GET /luis/api/v2.0/package/{APP_ID}/versions/{APP_VERSION}/gzip HTTP/1.1
Host: {AZURE_REGION}.api.cognitive.microsoft.com
Ocp-Apim-Subscription-Key: {AUTHORING_KEY}
占位符
{APP_ID} 已训练 LUIS 应用的应用程序 ID。
{APP_VERSION} 已训练 LUIS 应用的应用程序版本。
{AUTHORING_KEY} 已发布 LUIS 应用的 LUIS 帐户的创作密钥。
可以从 LUIS 门户的“用户设置”页面中获取创作密钥。
{AZURE_REGION} 相应的 Azure 区域:

westus - 美国西部
westeurope - 西欧
australiaeast - 澳大利亚东部

若要下载已进行版本控制的包,请参考此处的 API 文档。 如果下载成功,响应是一个 LUIS 包文件。 将文件保存在为容器的输入装入点指定的存储位置中。

通过 docker run 运行容器

使用 docker run 命令运行容器。 有关如何获取 {ENDPOINT_URI}{API_KEY} 值的详细信息,请参阅收集所需的参数

docker run 命令的示例可用。

docker run --rm -it -p 5000:5000 ^
--memory 4g ^
--cpus 2 ^
--mount type=bind,src=c:\input,target=/input ^
--mount type=bind,src=c:\output\,target=/output ^
mcr.microsoft.com/azure-cognitive-services/language/luis ^
Eula=accept ^
Billing={ENDPOINT_URI} ^
ApiKey={API_KEY}
  • 此示例使用 C: 驱动器外的目录来避免 Windows 上的任何权限冲突。 如果需要使用特定目录作为输入目录,则需要授予 docker 服务权限。
  • 除非熟悉 docker 容器,否则不要更改参数顺序。
  • 如果使用的是不同的操作系统,请使用正确的控制台/终端、用于装载的文件夹语法和系统的行继续符。 这些示例假定 Windows 控制台使用行继续符 ^。 由于容器是 Linux 操作系统,因此目标装载使用 Linux 样式的文件夹语法。

此命令:

  • 从 LUIS 容器映像运行容器
  • 从位于容器主机上的 C:\input 中的输入装入点加载 LUIS 应用
  • 分配两个 CPU 内核和 4 千兆字节 (GB) 的内存
  • 公开 TCP 端口 5000,并为容器分配伪 TTY
  • 将容器和 LUIS 日志保存到位于容器主机上的 C:\output 中的输出装入点
  • 退出后自动删除容器。 容器映像在主计算机上仍然可用。

提供 docker run 命令的多个示例

重要

必须指定 EulaBillingApiKey 选项运行容器;否则,该容器不会启动。 有关详细信息,请参阅计费。 ApiKey 值是 LUIS 门户中“Azure 资源”页中的“密钥”,也可以在 Azure Cognitive Services 资源密钥页上找到。

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

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

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

容器支持的终结点 API

容器同时提供了 V2 和 V3 版 API。

查询容器的预测终结点

容器提供了基于 REST 的查询预测终结点 API。 已发布(过渡或生产)应用的终结点包含的路由与已进行版本控制的应用的终结点不同。

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

包类型 HTTP 谓词 路由 查询参数
已发布 GET、POST /luis/v3.0/apps/{appId}/slots/{slotName}/predict? query={query}
[&verbose]
[&log]
[&show-all-intents]
带有版本 GET、POST /luis/v3.0/apps/{appId}/versions/{versionId}/predict? query={query}
[&verbose]
[&log]
[&show-all-intents]

查询参数配置查询响应的返回方式以及返回内容:

查询参数 类型 用途
query string 用户的话语。
verbose boolean 一个布尔值,表示是否为预测的模型返回所有元数据。 默认值为 false。
log boolean 记录查询,以便以后用于主动学习。 默认值为 false。
show-all-intents boolean 一个布尔值,表示是返回所有意向,还是只返回打分最高的意向。 默认值为 false。

查询 LUIS 应用

用于查询已发布应用的容器的示例 CURL 命令是:

若要查询槽中的模型,请使用以下 API:

curl -G \
-d verbose=false \
-d log=true \
--data-urlencode "query=turn the lights on" \
"http://localhost:5000/luis/v3.0/apps/{APP_ID}/slots/production/predict"

若要对过渡环境执行查询,请将路由中的 production 替换为 staging

http://localhost:5000/luis/v3.0/apps/{APP_ID}/slots/staging/predict

若要查询进行了版本控制的模型,请使用以下 API:

curl -G \
-d verbose=false \
-d log=false \
--data-urlencode "query=turn the lights on" \
"http://localhost:5000/luis/v3.0/apps/{APP_ID}/versions/{APP_VERSION}/predict"

导入终结点日志以供主动学习

如果为 LUIS 容器指定了输出装入点,则应用查询日志文件将保存在输出目录中,其中 {INSTANCE_ID} 是容器 ID。 应用查询日志包含提交到 LUIS 容器的每个预测查询的查询、响应和时间戳。

以下位置显示了容器的日志文件的嵌套目录结构。

/output/luis/{INSTANCE_ID}/

从 LUIS 门户中选择应用,然后选择“导入终结点日志”以上传这些日志。

导入容器的日志文件以供主动学习

上传日志后,在 LUIS 门户中查看终结点话语。

验证容器是否正在运行

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

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

容器的主页

停止容器

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

故障排除

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

提示

如需更多的故障排除信息和指南,请参阅认知服务容器常见问题解答 (FAQ)

计费

LUIS 容器使用 Azure 帐户中的认知服务资源向 Azure 发送账单信息。

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

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

连接到 Azure

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

计费参数

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

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

有关这些选项的详细信息,请参阅配置容器

摘要

在本文中,我们已学习相关的概念,以及语言理解 (LUIS) 容器的下载、安装和运行工作流。 综上所述:

  • 语言理解 (LUIS) 为 Docker 提供一个 Linux 容器,用于提供话语的终结点查询预测。
  • 从 Microsoft 容器注册表 (MCR) 下载容器映像。
  • 容器映像在 Docker 中运行。
  • 可以使用 REST API 来通过指定容器的主机 URI 查询容器终结点。
  • 必须在实例化容器时指定账单信息。

重要

如果未连接到 Azure 进行计量,则无法授权并运行认知服务容器。 客户需要始终让容器向计量服务传送账单信息。 认知服务容器不会将客户数据(例如,正在分析的图像或文本)发送给 Microsoft。

后续步骤