部署模型，並使用執行階段 API 從文字中擷取實體
本文內容
當您對模型執行效能感到滿意之後，即可開始進行部署，並用於辨識文字中的實體。 模型部署後則可透過預測 API 使用。
必要條件
如需詳細資訊，請參閱專案開發生命週期 。
部署模型
檢閱模型的效能並決定可在您的環境中使用之後，您必須將其指派給部署。 將模型指派給部署後即可透過預測 API 來使用。 建議您建立名為生產
若要從 Language Studio 內部署您的模型：
從左側功能表中，選取 [部署模型]
選取 [新增部署] 以啟動新的部署作業。
選取 [建立新的部署]覆寫現有的部署 ，然後從下方的下拉式清單中，選取您想要為其指派的定型模型。
注意
覆寫現有的部署不需要變更預測 API 呼叫，但您取得的結果將會以新指派的模型為基礎。
選取 [部署] 以啟動部署作業。
部署成功之後，在其旁邊會出現到期日。 部署到期 表示部署的模型無法再用於預測，通常發生於訓練組態到期的十二 個月後。
提交部署作業
使用下列 URL、標頭和 JSON 本文來提交 PUT 要求，以提交部署作業。 請以您自己的值取代下列預留位置值。
{Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}您專案的名稱。 此值區分大小寫。
myProject
{DEPLOYMENT-NAME}您部署的名稱。 此值區分大小寫。
staging
{API-VERSION}您正在呼叫的 API 版本。 此處參考的值適用於發行的最新版本。 若要深入了解其他可用的 API 版本，請參閱模型生命週期 。
2022-05-01
使用下列標頭來驗證您的要求。
機碼
值
Ocp-Apim-Subscription-Key資源的金鑰。 用於驗證 API 要求。
要求本文
在要求的主體中使用下列 JSON。 使用您要指派給部署的模型名稱。
{
"trainedModelLabel": "{MODEL-NAME}"
}
機碼
預留位置
值
範例
trainedModelLabel
{MODEL-NAME}模型名稱會指派給您的部署。 您只能指派成功定型的模型。 此值區分大小寫。
myModel
傳送 API 要求之後，您將會收到 202 回應，指出作業已正確提交。 在回應標頭中，擷取 operation-location 值。 其格式如下：
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
{JOB-ID} 用來識別您的要求，因為此為非同步作業。 您可以使用此 URL 來取得部署狀態。
取得部署作業狀態
使用下列 GET 要求來查詢部署作業的狀態。 您可以使用您在上一個步驟中收到的 URL，或以您自己的值取代下列預留位置值。
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}您專案的名稱。 此值區分大小寫。
myProject
{DEPLOYMENT-NAME}您部署的名稱。 此值區分大小寫。
staging
{JOB-ID}用來尋找模型定型狀態的識別碼。 這是在上一個步驟中收到的 location 標頭值。
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION}您正在呼叫的 API 版本。 此處參考的值適用於發行的最新版本。 若要深入了解其他可用的 API 版本，請參閱模型生命週期 。
2022-05-01
使用下列標頭來驗證您的要求。
機碼
值
Ocp-Apim-Subscription-Key資源的金鑰。 用於驗證 API 要求。
回應本文
傳送要求之後，您會收到下列回應。 持續輪詢此端點，直到狀態 參數變更為「成功」為止。 您應該會收到 200 代碼，指出要求是否成功。
{
"jobId":"{JOB-ID}",
"createdDateTime":"{CREATED-TIME}",
"lastUpdatedDateTime":"{UPDATED-TIME}",
"expirationDateTime":"{EXPIRATION-TIME}",
"status":"running"
}
交換部署
完成測試指派給一個部署的模型，且您想要將此模型指派給另一個部署之後，您可以交換這兩個部署。 交換部署牽涉到取得指派給第一個部署的模型，以及將模型指派給第二個部署。 然後取得指派給第二個部署的模型，並將其指派給第一個部署。 當您想要將指派給預備
若要從 Language Studio 內交換部署：
在 [部署模型] 頁面中，選取您想要交換的兩個部署，然後選取頂端功能表中的 [交換部署]。
從出現的視窗中，選取要交換的部署名稱。
使用下列 URL、標頭和 JSON 本文來建立 POST 要求，以啟動交換部署工作。
要求 URL
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/:swap?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}專案名稱。 此值區分大小寫。
myProject
{API-VERSION}您正在呼叫的 API 版本。 此處的參考值適用於發行的最新模型版本 。
2022-05-01
使用下列標頭來驗證您的要求。
機碼
值
Ocp-Apim-Subscription-Key資源的金鑰。 用於驗證 API 要求。
要求本文
{
"firstDeploymentName": "{FIRST-DEPLOYMENT-NAME}",
"secondDeploymentName": "{SECOND-DEPLOYMENT-NAME}"
}
機碼
預留位置
值
範例
firstDeploymentName
{FIRST-DEPLOYMENT-NAME}第一個部署的名稱。 此值區分大小寫。
production
secondDeploymentName
{SECOND-DEPLOYMENT-NAME}第二個部署的名稱。 此值區分大小寫。
staging
傳送 API 要求之後，您會收到表示成功的 202 回應。
刪除部署
使用下列 URL、標頭和 JSON 本文來建立 DELETE 要求，以刪除部署。
要求 URL
{Endpoint}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{deploymentName}?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}專案名稱。 此值區分大小寫。
myProject
{DEPLOYMENT-NAME}部署的名稱。 此值區分大小寫。
prod
{API-VERSION}您正在呼叫的 API 版本。 此處參考的值適用於發行的最新版本。 若要深入了解其他可用的 API 版本，請參閱模型生命週期 。
2022-05-01
使用下列標頭來驗證您的要求。
機碼
值
Ocp-Apim-Subscription-Key資源的金鑰。 用於驗證 API 要求。
傳送 API 要求後，您將會收到 202 回應指示已成功，這表示您的部署已刪除。 成功呼叫的結果是用於檢查作業狀態的 Operation-Location 標頭。
指派部署資源
您可以指派在不同區域的不同語言資源，將專案部署至多個區域 。
若要在 Language Studio 中指派其他區域中的部署資源，方法如下：
請確定您已為自己指派用來建立專案資源的認知服務語言擁有者 。
前往 Language Studio 的 [部署模型]
選取 [區域] 索引標籤。
選取 [新增部署資源]。
選取另一個區域的語言資源。
您現在已準備好將專案部署至已指派資源的區域。
以程式設計的方式指派部署資源需要 Microsoft Entra 驗證。 您想將資源指派至多區域部署的專案時，可使用 Microsoft Entra ID 確認您具有該資源的存取權。 若要在進行 REST API 呼叫時，以程式設計方式使用 Microsoft Entra 驗證，請透過 Azure AI 服務文件 來深入瞭解。
指派資源
使用下列 URL、標頭和 JSON 本文來提交 POST 要求，以指派部署資源。
要求 URL
建立 API 要求時，請使用下列 URL。 請以您自己的值取代下列預留位置值。
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:assign?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}專案名稱。 此值區分大小寫。
myProject
{API-VERSION}您所呼叫 API 的版本。
2022-10-01-preview
使用 Microsoft Entra 驗證 以驗證此 API。
本文
使用下列範例 JSON 作為本文。
{
"resourcesMetadata": [
{
"azureResourceId": "{AZURE-RESOURCE-ID}",
"customDomain": "{CUSTOM-DOMAIN}",
"region": "{REGION-CODE}"
}
]
}
機碼
預留位置
值
範例
azureResourceId{AZURE-RESOURCE-ID}您要指派的完整資源識別碼路徑。 請前往 Azure 入口網站，在該資源的 [屬性]
/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource
customDomain{CUSTOM-DOMAIN}您想指派之資源的自訂子網域。 請前往 Azure 入口網站，在該資源的 [金鑰和端點]https://<your-custom-subdomain>.cognitiveservices.azure.com/ 的 [端點]
contosoresource
region{REGION-CODE}區域代碼，指定您想指派之資源的區域。 請前往 Azure 入口網站，在該資源的 [金鑰和端點]
eastus
取得指派資源狀態
使用下列 GET 要求，取得指派部署資源工作的狀態。 請以您自己的值取代下列預留位置值。
要求 URL
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/assign/jobs/{JOB-ID}?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}專案名稱。 此值區分大小寫。
myProject
{JOB-ID}取得指派部署狀態所需的工作識別碼。 在回應您指派部署資源要求的 API operation-location 標頭值中，會顯示此識別碼。
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION}您所呼叫 API 的版本。
2022-10-01-preview
使用下列標頭來驗證您的要求。
機碼
值
Ocp-Apim-Subscription-Key資源的金鑰。 用於驗證 API 要求。
回應本文
傳送要求之後，您會收到下列回應。 持續輪詢此端點，直到 status 參數變更為 succeeded 為止。
{
"jobId":"{JOB-ID}",
"createdDateTime":"{CREATED-TIME}",
"lastUpdatedDateTime":"{UPDATED-TIME}",
"expirationDateTime":"{EXPIRATION-TIME}",
"status":"running"
}
取消指派部署資源
從專案取消指派或移除部署資源時，您也會刪除已部署至該資源區域的所有部署。
若要使用 Language Studio 來取消指派或移除其他區域的部署資源，方法如下：
前往 [部署模型]
選取您要取消指派的資源。
選取 [移除指派] 按鈕。
在顯示的視窗中，鍵入您想移除的資源名稱。
取消指派資源
使用下列 URL、標頭和 JSON 本文來提交 POST 要求，以從您的專案取消指派或移除部署資源。
要求 URL
建立 API 要求時，請使用下列 URL。 請以您自己的值取代下列預留位置值。
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:unassign?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}專案名稱。 此值區分大小寫。
myProject
{API-VERSION}您所呼叫 API 的版本。
2022-10-01-preview
使用下列標頭來驗證您的要求。
機碼
值
Ocp-Apim-Subscription-Key資源的金鑰。 用於驗證 API 要求。
本文
使用下列範例 JSON 作為本文。
{
"assignedResourceIds": [
"{AZURE-RESOURCE-ID}"
]
}
機碼
預留位置
值
範例
assignedResourceIds{AZURE-RESOURCE-ID}您要取消指派的完整資源識別碼路徑。 請前往 Azure 入口網站，在該資源的 [屬性]
/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource
取得取消指派資源狀態
使用下列 GET 要求，取得取消指派部署資源工作的狀態。 請以您自己的值取代下列預留位置值。
要求 URL
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/unassign/jobs/{JOB-ID}?api-version={API-VERSION}
預留位置
值
範例
{ENDPOINT}用於驗證 API 要求的端點。
https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}專案名稱。 此值區分大小寫。
myProject
{JOB-ID}取得指派部署狀態所需的工作識別碼。 在回應您取消指派部署資源要求的 API operation-location 標頭值中，會顯示此識別碼。
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION}您所呼叫 API 的版本。
2022-10-01-preview
使用下列標頭來驗證您的要求。
機碼
值
Ocp-Apim-Subscription-Key資源的金鑰。 用於驗證 API 要求。
回應本文
傳送要求之後，您會收到下列回應。 持續輪詢此端點，直到狀態 參數變更為「成功」為止。
{
"jobId":"{JOB-ID}",
"createdDateTime":"{CREATED-TIME}",
"lastUpdatedDateTime":"{UPDATED-TIME}",
"expirationDateTime":"{EXPIRATION-TIME}",
"status":"running"
}
下一步
部署之後，您可以將其用來從文字中擷取實體 。
