如何创建 CLU 项目

Artículo
03/04/2024

通过本文了解如何设置这些要求并创建项目。

先决条件

开始使用 CLU 之前，需具备以下各项：

Azure 订阅 - 创建试用订阅。
一种 Azure AI 语言资源

创建“语言”资源

开始使用 CLU 之前，需要具备 Azure AI 语言资源。

注意

你需要分配有资源组的“所有者”角色才能创建语言资源。

从 Azure 门户创建新资源

若要创建新的 Azure AI 语言资源，请登录 Azure 门户。
选择“创建新资源”
在出现的窗口中，搜索“语言服务”
选择“创建”
创建包含以下详细信息的语言资源。

实例详细信息必需的值

区域语言资源支持的区域之一。

名称语言资源的所需名称

定价层语言资源支持的定价层之一。

实例详细信息	必需的值
区域	语言资源支持的区域之一。
名称	语言资源的所需名称
定价层	语言资源支持的定价层之一。

通过 Language Studio 创建新语言资源

如果是首次登录，你将在 Language Studio 中看到一个窗口，在该窗口中可以选择现有语言资源或创建新的语言资源。也可单击右上角的“设置”图标，选择“资源”，然后单击“创建新资源”，从而创建资源。

创建包含以下详细信息的语言资源。

实例详细信息	所需的值
Azure 订阅	你的 Azure 订阅
Azure 资源组	你的 Azure 资源组
Azure 资源名称	你的语言资源名称
位置	语言资源支持的区域。
定价层	语言资源支持的定价层。

重要

请确保在创建语言资源时启用“托管标识”。
阅读并确认“负责任的 AI”声明

转到 Language Studio，然后使用 Azure 帐户登录。

在出现的“选择语言资源”窗口中，找到你的 Azure 订阅，然后选择你的语言资源。如果没有资源，可新建一个。

实例详细信息	所需的值
Azure 订阅	Azure 订阅。
Azure 资源组	你的 Azure 资源组名称。
Azure 资源名称	你的 Azure 资源名称。
位置	语言资源支持的区域之一。例如“中国北部 2”。
定价层	语言资源的有效定价层之一。可以使用免费 (F0) 层来试用该服务。

创建对话项目

拥有创建的语言资源后，请创建对话语言理解项目。

Language Studio
REST API

在 Language Studio 中，找到名为“理解问题和对话语言”的部分，然后选择“对话语言理解”。
此时会转到“对话语言理解项目”页面。选择“创建新项目”。

为了创建新项目，你需要提供以下详细信息：

值	描述
名称	项目名称。项目在创建后无法更改
说明	可选项目说明。
语句主要语言	项目的主要语言。训练数据应主要使用此语言。
启用多种语言	是否希望使项目立刻支持多种语言。

完成后，选择“下一步”，并查看详细信息。选择“创建”以完成过程。现在应会看到项目中的“生成架构”屏幕。

使用以下 URL、标头和 JSON 正文提交 PATCH 请求，以创建新项目。

请求 URL

创建 API 请求时，请使用以下 URL。请将以下占位符值替换为你自己的值。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

占位符	值	示例
`{ENDPOINT}`	用于对 API 请求进行身份验证的终结点。	`https://<your-custom-subdomain>.cognitiveservices.azure.cn`
`{PROJECT-NAME}`	项目名称。此值区分大小写。	`myProject`
`{API-VERSION}`	要调用的 API 的版本。	`2023-04-01`

头文件

使用以下标头对请求进行身份验证。

键	值
`Ocp-Apim-Subscription-Key`	资源密钥。用于对 API 请求进行身份验证。
`Content-Type`	'application/merge-patch+json'

Body

使用以下示例 JSON 作为正文。

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "Conversation",
  "description": "Project description",
  "multilingual": true
}

密钥	占位符	值	示例
`projectName`	`{PROJECT-NAME}`	项目名称。此值区分大小写。	`EmailApp`
`language`	`{LANGUAGE-CODE}`	指定项目中所用语句的语言代码的字符串。如果项目是多语言项目，请选择大多数语句的语言代码。	`en-us`
`multilingual`	`true`	通过布尔值，你可以在数据集中有多种语言的文档，并且在部署模型时可以使用任何支持的语言（不一定包含在训练文档中）查询模型。请参阅语言支持，了解有关多语言支持的详细信息。	`true`

你随时可以将对话语言理解项目导出为 JSON 文件，方式如下：转到对话项目页，选择项目并在顶部菜单中单击“导出”。

该项目可以重新导入为新项目。如果导入完全同名的项目，将用新导入项目的数据替换项目的数据。

如果已有 LUIS 应用程序，可以将 LUIS 应用程序 JSON 直接导入对话语言理解，并且将创建一个对话项目，该项目包含当前可用的所有功能：意向、ML 实体和话语。有关详细信息，请参阅 LUIS 迁移文章。

若要导出项目，请选择“创建新项目”旁边的箭头按钮，选择“导入”，然后选择“LUIS”或“对话语言理解”JSON 文件。

可以将 CLU JSON 导入到服务中

使用以下 URL、标头和 JSON 正文提交 POST 请求，以导入项目。

请求 URL

创建 API 请求时，请使用以下 URL。将占位符值替换为你自己的值。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}

占位符	值	示例
`{ENDPOINT}`	用于对 API 请求进行身份验证的终结点。	`https://<your-custom-subdomain>.cognitiveservices.azure.cn`
`{PROJECT-NAME}`	项目名称。此值区分大小写，并且必须与要导入的 JSON 文件中的项目名称相匹配。	`EmailAppDemo`
`{API-VERSION}`	要调用的 API 的版本。	`2023-04-01`

头文件

使用以下标头对请求进行身份验证。

键	值
`Ocp-Apim-Subscription-Key`	资源密钥。用于对 API 请求进行身份验证。

正文

所发送的 JSON 正文类似于以下示例。有关 JSON 对象的更多详细信息，请参阅参考文档。

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "{PROJECT-NAME}",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "{LANGUAGE-CODE}"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "intent1"
      },
      {
        "category": "intent2"
      }
    ],
    "entities": [
      {
        "category": "entity1"
      }
    ],
    "utterances": [
      {
        "text": "text1",
        "dataset": "{DATASET}",
        "intent": "intent1",
        "entities": [
          {
            "category": "entity1",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "text2",
        "language": "{LANGUAGE-CODE}",
        "dataset": "{DATASET}",
        "intent": "intent2",
        "entities": []
      }
    ]
  }
}

密钥	占位符	值	示例
`{API-VERSION}`	要调用的 API 的版本。	`2023-04-01`
`projectName`	`{PROJECT-NAME}`	项目名称。此值区分大小写。	`EmailAppDemo`
`language`	`{LANGUAGE-CODE}`	指定项目中所用语句的语言代码的字符串。如果你的项目是多语言项目，请选择大多数语句的语言代码。	`en-us`
`multilingual`	`true`	一个布尔值，它让你可以在你的数据集内拥有多种语言的文档。部署模型后，可以使用任何支持的语言（包括训练文档中未包含的语言）查询该模型。	`true`
`dataset`	`{DATASET}`	有关在测试集和训练集之间拆分数据的信息，请参阅如何训练模型。此字段的可能值为 `Train` 和 `Test`。	`Train`

请求成功后，API 响应将包含一个 operation-location 标头，其中带有可用于检查导入作业状态的 URL。它的格式如下：

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}

导出项目

Language Studio
REST API

你随时可以将对话语言理解项目导出为 JSON 文件，方式如下：转到对话项目页，选择项目并按“导出”。

可以随时将对话语言理解项目导出为 JSON 文件。

使用以下 URL、标头和 JSON 正文创建 POST 请求，以导出项目。

请求 URL

创建 API 请求时，请使用以下 URL。请将以下占位符值替换为你自己的值。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:export?stringIndexType=Utf16CodeUnit&api-version={API-VERSION}

占位符	值	示例
`{ENDPOINT}`	用于对 API 请求进行身份验证的终结点。	`https://<your-custom-subdomain>.cognitiveservices.azure.cn`
`{PROJECT-NAME}`	项目名称。此值区分大小写。	`EmailApp`
`{API-VERSION}`	要调用的 API 的版本。	`2023-04-01`

头文件

使用以下标头对请求进行身份验证。

键	值
`Ocp-Apim-Subscription-Key`	资源密钥。用于对 API 请求进行身份验证。

当你发送 API 请求后，将收到指示成功的 202 响应。在响应头中，提取 operation-location 值。其格式如下：

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

JOB-ID 用于标识请求，因为此操作是异步操作。使用此 URL 可以通过相同的身份验证方法获取导出的项目 JSON。

获取 CLU 项目详细信息

Language Studio
REST API

转到 Language Studio 中的项目设置页面。
可以看到项目详细信息。
在此页中，可以在项目设置中更新项目说明以及启用/禁用多语言数据集。
还可以从此页面检索资源主键。

若要获取项目详细信息，请使用以下 URL 和标头提交 GET 请求。将占位符值替换为你自己的值。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

占位符	值	示例
`{ENDPOINT}`	用于对 API 请求进行身份验证的终结点。	`https://<your-custom-subdomain>.cognitiveservices.azure.cn`
`{PROJECT-NAME}`	项目名称。此值区分大小写。	`myProject`
`{API-VERSION}`	要调用的 API 的版本。	`2023-04-01`

头文件

使用以下标头对请求进行身份验证。

键	值
`Ocp-Apim-Subscription-Key`	资源密钥。用于对 API 请求进行身份验证。

响应正文

发送请求后，你将获得以下响应。

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "{PROJECT-NAME}",
  "multilingual": true,
  "description": "This is a sample conversation project.",
  "language": "{LANGUAGE-CODE}"
}

发送 API 请求后，将收到 200 响应（指示成功）和 JSON 响应正文（包含项目详细信息）。

删除项目

Language Studio
REST API

如果不再需要项目，可以使用 Language Studio 删除项目。在左侧导航菜单中选择“项目”，选择要删除的项目，然后选择顶部菜单中的“删除”。

如果你不再需要项目，可以使用 API 删除该项目。

使用以下 URL、标头和 JSON 正文创建 DELETE 请求，以删除对话语言理解项目。

请求 URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

占位符	值	示例
`{ENDPOINT}`	用于对 API 请求进行身份验证的终结点。	`https://<your-custom-subdomain>.cognitiveservices.azure.cn`
`{PROJECT-NAME}`	项目名称。此值区分大小写。	`myProject`
`{API-VERSION}`	要调用的 API 的版本。	`2023-04-01`

头文件

使用以下标头对请求进行身份验证。

键	值
`Ocp-Apim-Subscription-Key`	资源密钥。用于对 API 请求进行身份验证。

发送 API 请求后，将收到一个指示成功的 202 响应，这意味着项目已被删除。

后续步骤

生成架构

Compartir a través de

如何创建 CLU 项目

先决条件

创建“语言”资源

从 Azure 门户创建新资源

通过 Language Studio 创建新语言资源

创建对话项目

请求 URL

头文件

Body

导入项目

请求 URL

头文件

正文

导出项目

请求 URL

头文件

获取 CLU 项目详细信息

头文件

响应正文

删除项目

请求 URL

头文件

后续步骤

Recursos adicionales

Compartir a través de

如何创建 CLU 项目

先决条件

创建“语言”资源

从 Azure 门户创建新资源

通过 Language Studio 创建新语言资源

登录到 Language Studio

创建对话项目

导入项目

导出项目

获取 CLU 项目详细信息

删除项目

后续步骤

Recursos adicionales