如何在協調工作流程中建立專案
協調流程工作流程可讓您建立專案，以將應用程式連線至：
- 自訂 Language Understanding
- 問題解答
- LUIS
必要條件
開始使用協調流程工作流程之前，您需要幾個項目：
- Azure 訂用帳戶 - 建立免費帳戶。
- Azure AI 語言資源
建立語言資源
開始使用協調流程工作流程之前，您需要 Azure AI 語言資源。
注意
- 您必須在資源群組上指派擁有者角色，才能建立語言資源。
- 如果您打算使用問題解答，則必須在建立資源時啟用問題解答
從 Azure 入口網站建立新的資源
移至 Azure 入口網站以建立新的 Azure AI 語言資源。
選取 [繼續建立您的資源]
使用下列詳細資料建立語言資源。
從 Language Studio 建立新的語言資源
如果這是您第一次登入，您將會在 Language Studio 中看到一個視窗，讓您選擇現有的語言資源或建立新的語言資源。 您也可以按一下右上角的設定圖示，選取 [資源]，然後按一下 [建立新的資源] 來建立資源。
使用下列詳細資料建立語言資源。
| 執行個體詳細資料 |
必要值 |
| Azure 訂用帳戶 |
Azure 訂用帳戶 |
| Azure 資源群組 |
您的 Azure 資源群組 |
| Azure 資源名稱 |
您的 Azure 資源名稱 |
| Location |
深入了解支援的區域。 |
| 定價層 |
深入了解支援的定價層。 |
重要
- 當建立語言資源時，請務必啟用 [受控識別]。
- 閱讀並確認負責任 AI 通知
登入 Language Studio
若要建立新的意圖，請選取 [+新增] 按鈕，然後為意圖提供名稱來開始。 您會看到兩個選項，分別是連線到專案或不連線。 您可以連線到 (LUIS、問題解答或交談語言理解) 專案，也可以選擇 [無] 選項。
建立協調流程工作流程專案
建立語言資源後，請建立協調工作流程專案。
在 Language Studio 中，尋找標記為理解問題和交談語言的區段，並選取 [協調工作流程]。
這會將您引導至協調工作流程專案頁面。 選取 [建立新專案]。 若要建立專案，您必須提供下列詳細資料：
| 值 |
描述 |
| Name |
您專案的名稱。 |
| 描述 |
選擇性的專案描述。 |
| 語句主要語言 |
您專案的主要語言。 您的定型資料主要應該是採用這種語言。 |
完成後請選取 [下一步]，並檢閱詳細資料。 選取 [建立專案]，完成此流程。 您現在應該會在專案中看到 [建置結構描述] 畫面。
使用下列 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 要求。 |
本文
使用下列範例 JSON 作為本文。
{
"projectName": "{PROJECT-NAME}",
"language": "{LANGUAGE-CODE}",
"projectKind": "Orchestration",
"description": "Project description"
}
| 機碼 |
預留位置 |
值 |
範例 |
projectName |
{PROJECT-NAME} |
您專案的名稱。 此值區分大小寫。 |
EmailApp |
language |
{LANGUAGE-CODE} |
字串，指定專案中所用語句的語言代碼。 若您的專案是多語系專案，請選擇大部分語句的語言代碼。 |
en-us |
匯入協調流程工作流程專案
藉由移至協調流程工作流程專案頁面、選取專案，然後從頂端功能表中按一下 [匯出]，您可以隨時將協調流程工作流程專案匯出為 JSON 檔案。
可將該專案重新匯入為新的專案。 如果您匯入的專案具有完全相同的名稱，則會將專案的資料取代為新匯入的專案資料。
若要匯入專案，請選取 [建立新專案] 旁邊的箭號按鈕，並選取 [匯入]，然後選取 JSON 檔案。
![顯示 [交談語言理解匯入] 按鈕的螢幕擷取畫面。](../media/import-export.png)
您可以將協調流程工作流程 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} |
專案名稱。 此值區分大小寫。 |
myProject |
{API-VERSION} |
您正在呼叫的 API 版本。 |
2023-04-01 |
使用下列標頭來驗證您的要求。
| 機碼 |
值 |
Ocp-Apim-Subscription-Key |
資源的金鑰。 用於驗證 API 要求。 |
本文
注意
每個意圖只能是 (CLU、LUIS 和 qna) 中的一種類型
使用下列範例 JSON 作為本文。
{
"projectFileVersion": "{API-VERSION}",
"stringIndexType": "Utf16CodeUnit",
"metadata": {
"projectKind": "Orchestration",
"settings": {
"confidenceThreshold": 0
},
"projectName": "{PROJECT-NAME}",
"description": "Project description",
"language": "{LANGUAGE-CODE}"
},
"assets": {
"projectKind": "Orchestration",
"intents": [
{
"category": "string",
"orchestration": {
"kind": "luis",
"luisOrchestration": {
"appId": "00000000-0000-0000-0000-000000000000",
"appVersion": "string",
"slotName": "string"
},
"cluOrchestration": {
"projectName": "string",
"deploymentName": "string"
},
"qnaOrchestration": {
"projectName": "string"
}
}
}
],
"utterances": [
{
"text": "Trying orchestration",
"language": "{LANGUAGE-CODE}",
"intent": "string"
}
]
}
}
| 機碼 |
預留位置 |
值 |
範例 |
api-version |
{API-VERSION} |
您正在呼叫的 API 版本。 此處所使用的版本必須是 URL 中的相同 API 版本。 |
2022-03-01-preview |
projectName |
{PROJECT-NAME} |
您專案的名稱。 此值區分大小寫。 |
EmailApp |
language |
{LANGUAGE-CODE} |
字串，指定專案中所用語句的語言代碼。 若您的專案是多語系專案，請選擇大部分語句的語言代碼。 |
en-us |
匯出專案
藉由移至協調流程工作流程專案頁面、選取專案，然後按 [匯出]，您可以隨時將協調流程工作流程專案匯出為 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.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。
取得協調流程專案的詳細資料
移至您在 Language Studio 中的專案設定頁面。
您可以看到專案詳細資料。
在此頁面中，您可以更新專案描述。
您也可以從此頁面擷取資源主要索引鍵。
![[專案設定] 頁面的螢幕擷取畫面。](../media/project-settings.png)
若要取得協調流程工作流程專案的詳細資料，請使用下列 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": "Orchestration",
"projectName": "{PROJECT-NAME}",
"description": "This is a sample orchestration project.",
"language": "{LANGUAGE-CODE}"
}
傳送 API 要求之後，您會收到 200 回應，指出成功和 JSON 回應本文與您的專案詳細資料。
刪除專案
當您不再需要專案時，可以使用 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.com |
{PROJECT-NAME} |
專案名稱。 此值區分大小寫。 |
myProject |
{API-VERSION} |
您正在呼叫的 API 版本。 |
2023-04-01 |
使用下列標頭來驗證您的要求。
| 機碼 |
值 |
Ocp-Apim-Subscription-Key |
資源的金鑰。 用於驗證 API 要求。 |
傳送 API 要求之後，您將會收到指出成功的 202 回應，這表示您的專案已刪除。
後續步驟
建置結構描述
![顯示 [交談語言理解匯入] 按鈕的螢幕擷取畫面。](../media/import-export.png#lightbox)
![[專案設定] 頁面的螢幕擷取畫面。](../media/project-settings.png#lightbox)
