您需要先取得資源金鑰和端點:
移至您在 Azure 入口網站中的 [資源概觀] 頁面
從左側功能表中,選取 [金鑰和端點]。 您將使用此端點和金鑰來提出 API 要求
提交自訂 NER 工作
使用此 POST 要求來啟動文字分類工作。
{ENDPOINT}/language/analyze-text/jobs?api-version={API-VERSION}
預留位置 |
值 |
範例 |
{ENDPOINT} |
用於驗證 API 要求的端點。 |
https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
您正在呼叫的 API 版本。 此處參考的值適用於發行的最新版本。 若要深入了解其他可用的 API 版本,請參閱模型生命週期。 |
2022-05-01 |
機碼 |
數值 |
Ocp-Apim-Subscription-Key |
可讓您存取此 API 的金鑰。 |
本文
{
"displayName": "Extracting entities",
"analysisInput": {
"documents": [
{
"id": "1",
"language": "{LANGUAGE-CODE}",
"text": "Text1"
},
{
"id": "2",
"language": "{LANGUAGE-CODE}",
"text": "Text2"
}
]
},
"tasks": [
{
"kind": "CustomEntityRecognition",
"taskName": "Entity Recognition",
"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 |
CustomEntityRecognition |
工作名稱 |
CustomEntityRecognition |
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 來查詢工作完成狀態,並在工作完成時取得結果。
取得工作結果
使用下列 GET 要求來查詢自訂實體辨識工作的狀態/結果。
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
預留位置 |
值 |
範例 |
{ENDPOINT} |
用於驗證 API 要求的端點。 |
https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
您正在呼叫的 API 版本。 此處參考的值適用於發行的最新版本。 若要深入了解其他可用的 API 版本,請參閱模型生命週期。 |
2022-05-01 |
機碼 |
數值 |
Ocp-Apim-Subscription-Key |
可讓您存取此 API 的金鑰。 |
回應本文
回應將會是具有下列參數的 JSON 文件
{
"createdDateTime": "2021-05-19T14:32:25.578Z",
"displayName": "MyJobName",
"expirationDateTime": "2021-05-19T14:32:25.578Z",
"jobId": "xxxx-xxxx-xxxxx-xxxxx",
"lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "EntityRecognitionLROResults",
"taskName": "Recognize Entities",
"lastUpdateDateTime": "2020-10-01T15:01:03Z",
"status": "succeeded",
"results": {
"documents": [
{
"entities": [
{
"category": "Event",
"confidenceScore": 0.61,
"length": 4,
"offset": 18,
"text": "trip"
},
{
"category": "Location",
"confidenceScore": 0.82,
"length": 7,
"offset": 26,
"subcategory": "GPE",
"text": "Seattle"
},
{
"category": "DateTime",
"confidenceScore": 0.8,
"length": 9,
"offset": 34,
"subcategory": "DateRange",
"text": "last week"
}
],
"id": "1",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-04-01"
}
}
]
}
}