如何建立 CLU 專案

使用本文來瞭解如何設定這些需求並建立專案。

必要條件

開始使用 CLU 之前，您需要數件事：

• Azure 訂用帳戶 - 免費建立一個訂用帳戶。
• Azure AI 語言資源

建立語言資源

開始使用 CLU 之前，您將需要 Azure AI 語言資源。

注意

• 您必須在 資源群組上指派擁有者 角色，才能建立語言資源。

從 Azure 入口網站 建立新的資源

1. 登入 Azure 入口網站以建立新的 Azure AI 語言資源。

2. 選取 [建立新的資源]

3. 在出現的視窗中，搜尋 語言服務

4. 選取 [建立]

5. 使用下列詳細數據建立語言資源。

   實例詳細數據	必要值
   區域	您語言資源的其中一個支持區域。
   名稱	語言資源的必要名稱
   定價層	語言資源的其中 一個支援定價層 。

從 Language Studio 建立新的語言資源

如果您是第一次登入，您會在 Language Studio 中看到一個視窗，可讓您選擇現有的語言資源或建立新的資源。 您也可以按下右上角的設定圖示，選取 [資源]，然後按兩下 [ 建立新資源] 來建立資源。

使用下列詳細數據建立語言資源。

實例詳細數據	必要值
Azure 訂用帳戶	您的 Azure 訂用帳戶
Azure 資源群組	您的 Azure 資源群組
Azure 資源名稱	您的語言資源名稱
位置	語言資源支援的區域。
定價層	語言資源支持的定價層。

重要

• 建立語言資源時，請務必啟用 受控識別 。
• 閱讀並確認負責任 AI 通知

登入 Language Studio

1. 請前往 Language Studio，並以您的 Azure 帳戶登入。

2. 在出現的 [ 選擇語言資源 ] 視窗中，尋找您的 Azure 訂用帳戶，然後選擇您的語言資源。 如果您沒有資源，您可以建立新的資源。

   實例詳細數據	必要值
   Azure 訂用帳戶	您的 Azure 訂閱。
   Azure 資源群組	您的 Azure 資源組名。
   Azure 資源名稱	您的 Azure 資源名稱。
   位置	您語言資源的其中一個支持區域。 例如「美國西部 2」。
   定價層	語言資源的其中一個有效 定價層 。 您可以使用免費 （F0） 層來嘗試服務。

   

建立交談專案

建立語言資源之後，請建立 Conversational Language Understanding 專案。

Language Studio

1. 在 Language Studio 中，尋找名為 了解問題和交談語言 的區段，然後選取 [交談語言理解]。
   

2. 這會將您帶到 對話語言理解項目 頁面。 選取 [建立新專案]。

   

若要建立新專案，您需要提供下列詳細數據：

值	描述
Name	項目的名稱。 建立之後，就無法變更
描述	選擇性專案描述。
語句主要語言	專案的主要語言。 您的定型數據主要應在此語言中。
啟用多語言	是否要讓專案一次支援 多種語言 。

完成後，請選取 [下一步 ]，並檢閱詳細數據。 選取 [建立 ] 以完成程式。 您現在應該會在專案中看到 [ 建置架構 ] 畫面。

REST API

使用下列 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.com
{PROJECT-NAME}	專案名稱。 此值區分大小寫。	myProject
{API-VERSION}	您正在呼叫的 API 版本。	2023-04-01

標頭

使用下列標頭來驗證您的要求。

機碼	值
Ocp-Apim-Subscription-Key	資源的索引鍵。 用於驗證 API 要求。
Content-Type	'application/merge-patch+json'

本文

使用下列範例 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

匯入專案

Language Studio

您可以隨時移至對話項目頁面、選取專案，然後 從頂端功能表中按兩下 [匯出]，將 Conversational Language Understanding 項目匯出為 JSON 檔案。

該專案可以重新匯入為新專案。 如果您使用完全相同的名稱匯入專案，它會以新匯入的項目數據取代項目的數據。

如果您有現有的 LUIS 應用程式，您可以 直接將 LUIS 應用程式 JSON 匯 入至 Conversational Language Understanding，並且會建立對話專案，其中包含目前可用的所有部分：意圖、ML 實體和語句。 如需詳細資訊，請參閱 LUIS 移轉一文 。

若要匯入專案，請選取 [建立新專案] 旁的箭號按鈕並選取 [匯入]，然後選取 LUIS 或交談語言理解 JSON 檔案。

REST API

您可以將 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.com
{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

您可以隨時移至交談項目頁面、選取專案，然後按 [匯出]，將 Conversational Language Understanding 專案匯出為 JSON 檔案。

REST API

您可以隨時將 Conversational Language Understanding 項目導出為 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.com
{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

1. 在 Language Studio 中移至您的項目設定頁面。

2. 您可以看到項目詳細數據。

3. 在此頁面中，您可以更新專案描述，並在項目設定中啟用/停用多語言數據集。

4. 您也可以從此頁面擷取您的資源主鍵。

   

REST API

若要取得專案詳細數據，請使用下列URL和標頭提交 GET 要求。 將佔位元值取代為您自己的值。

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

預留位置	值	範例
{ENDPOINT}	用於驗證 API 要求的端點。	https://<your-custom-subdomain>.cognitiveservices.azure.com
{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

當您不再需要專案時，可以使用 Language Studio 刪除專案。 從左側導覽功能表選取 [專案]，選取要刪除的專案，然後從頂端功能表選取 [刪除]。

REST API

當您不再需要專案時，可以使用 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.com
{PROJECT-NAME}	專案名稱。 此值區分大小寫。	myProject
{API-VERSION}	您正在呼叫的 API 版本。	2023-04-01

標頭

使用下列標頭來驗證您的要求。

機碼	值
Ocp-Apim-Subscription-Key	資源的索引鍵。 用於驗證 API 要求。

傳送 API 要求之後，您會收到 202 指出成功的回應，這表示您的專案已刪除。

後續步驟

建置結構描述