成功部署模型後,你可以查詢部署內容,根據你指派給該部署的模型來分類文字。 您可以透過預測 API 或用戶端程式庫 (Azure SDK),以程式設計方式來查詢部署。
向你的模型發送文字分類請求(REST API)
您必須先取得資源金鑰和端點:
移至您在 Azure 入口網站中的 [資源概觀] 頁面
從左側功能表中,選取 [金鑰和端點]。 你用端點和金鑰來處理 API 請求
提交自訂文字分類工作
使用此 POST 要求來啟動文字分類工作。
{ENDPOINT}/language/analyze-text/jobs?api-version={API-VERSION}
| 預留位置 | 值 | 範例 |
|---|---|---|
{ENDPOINT} |
用於驗證 API 要求的端點。 | https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
您所呼叫 API 的版本。 所引用的值為最新版本。 欲了解更多資訊, 請參閱模型生命週期。 | 2022-05-01 |
headers
| 索引鍵 | 值 |
|---|---|
| Ocp-Apim-Subscription-Key | 可讓您存取此 API 的金鑰。 |
body
{
"displayName": "Classifying documents",
"analysisInput": {
"documents": [
{
"id": "1",
"language": "{LANGUAGE-CODE}",
"text": "Text1"
},
{
"id": "2",
"language": "{LANGUAGE-CODE}",
"text": "Text2"
}
]
},
"tasks": [
{
"kind": "CustomMultiLabelClassification",
"taskName": "Multi Label Classification",
"parameters": {
"projectName": "{PROJECT-NAME}",
"deploymentName": "{DEPLOYMENT-NAME}"
}
}
]
}
| 索引鍵 | 預留位置 | 值 | 範例 |
|---|---|---|---|
displayName |
{JOB-NAME} |
您的工作名稱。 | MyJobName |
documents |
[{},{}] | 要對其執行工作的文件清單。 | [{},{}] |
id |
{DOC-ID} |
文件名稱或識別碼。 | doc1 |
language |
{LANGUAGE-CODE} |
字串,指定文件的語言代碼。 如果未指定此金鑰,則服務將會採用專案建立期間所選取專案的預設語言。 如需支援的語言代碼清單,請參閱語言支援。 | en-us |
text |
{DOC-TEXT} |
對其執行工作的文件工作。 | Lorem ipsum dolor sit amet |
tasks |
我們需要執行的工作清單。 | [] |
|
taskName |
CustomMultiLabelClassification | 工作名稱 | CustomMultiLabelClassification |
parameters |
要傳遞至工作的參數清單。 | ||
project-name |
{PROJECT-NAME} |
您專案的名稱。 此值區分大小寫。 | myProject |
deployment-name |
{DEPLOYMENT-NAME} |
您部署的名稱。 此值區分大小寫。 | prod |
回應
您會收到表示成功的 202 回應。 在回應標頭中,擷取 operation-location。
operation-location 的格式如下所示:
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
您可以使用此 URL 來查詢工作完成狀態,並在工作完成時取得結果。
取得任務結果 (Azure SDK)
使用下列 GET 要求來查詢文字分類工作的狀態/結果。
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
| 預留位置 | 值 | 範例 |
|---|---|---|
{ENDPOINT} |
用於驗證 API 要求的端點。 | https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
您所呼叫 API 的版本。 所參考的數值為最新版本的模型。 | 2022-05-01 |
headers
| 索引鍵 | 值 |
|---|---|
| Ocp-Apim-Subscription-Key | 可讓您存取此 API 的金鑰。 |
回應主體
回應將會是具有下列參數的 JSON 文件。
{
"createdDateTime": "2021-05-19T14:32:25.578Z",
"displayName": "MyJobName",
"expirationDateTime": "2021-05-19T14:32:25.578Z",
"jobId": "xxxx-xxxxxx-xxxxx-xxxx",
"lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "customMultiClassificationTasks",
"taskName": "Classify documents",
"lastUpdateDateTime": "2020-10-01T15:01:03Z",
"status": "succeeded",
"results": {
"documents": [
{
"id": "{DOC-ID}",
"classes": [
{
"category": "Class_1",
"confidenceScore": 0.0551877357
}
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-04-01"
}
}
]
}
}
您必須先取得資源金鑰和端點:
移至您在 Azure 入口網站中的 [資源概觀] 頁面
從左側功能表中,選取 [金鑰和端點]。 端點和金鑰用於 API 請求。
下載並安裝您所選語言的用戶端程式庫套件:
語言 套件版本 .NET 5.2.0-beta.3 JAVA 5.2.0-beta.3 JavaScript 6.0.0-beta.1 Python 5.2.0b4 安裝用戶端程式庫之後,請使用 GitHub 上的下列範例來開始呼叫 API。
單一標籤分類:
多重標籤分類:
請參閱下列關於用戶端和傳回物件的參考文件: