首先,您需要取得您的資源金鑰和端點:
移至您在 Azure 入口網站中的 [資源概觀] 頁面
從左側功能表中,選取 [金鑰和端點]。 您將使用此端點和金鑰來提出 API 要求
提交用於健康醫療領域的自訂文字分析工作
使用此 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 |
Key |
數值 |
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": "CustomHealthcare",
"taskName": "Custom TextAnalytics for Health Test",
"parameters": {
"projectName": "{PROJECT-NAME}",
"deploymentName": "{DEPLOYMENT-NAME}"
}
}
]
}
Key |
預留位置 |
值 |
範例 |
displayName |
{JOB-NAME} |
您的作業名稱。 |
MyJobName |
documents |
[{},{}] |
要執行工作的檔案清單。 |
[{},{}] |
id |
{DOC-ID} |
檔名稱或識別碼。 |
doc1 |
language |
{LANGUAGE-CODE} |
指定檔案語言代碼的字串。 如果未指定此金鑰,服務會假設專案建立期間選取的專案默認語言。 如需支援的語言代碼清單,請參閱 語言支援 。 |
en-us |
text |
{DOC-TEXT} |
要執行工作的檔工作。 |
Lorem ipsum dolor sit amet |
tasks |
|
我們想要執行的工作清單。 |
[] |
taskName |
Custom Text Analytics for Health Test |
工作名稱 |
Custom Text Analytics for Health Test |
kind |
CustomHealthcare |
我們正在嘗試執行的專案或工作種類 |
CustomHealthcare |
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 |
Key |
數值 |
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": "CustomHealthcareLROResults",
"taskName": "Custom Text Analytics for Health Test",
"lastUpdateDateTime": "2020-10-01T15:01:03Z",
"status": "succeeded",
"results": {
"documents": [
{
"entities": [
{
"entityComponentInformation": [
{
"entityComponentKind": "learnedComponent"
}
],
"offset": 0,
"length": 11,
"text": "first entity",
"category": "Entity1",
"confidenceScore": 0.98
},
{
"entityComponentInformation": [
{
"entityComponentKind": "listComponent"
}
],
"offset": 0,
"length": 11,
"text": "first entity",
"category": "Entity1.Dictionary",
"confidenceScore": 1.0
},
{
"entityComponentInformation": [
{
"entityComponentKind": "learnedComponent"
}
],
"offset": 16,
"length": 9,
"text": "entity two",
"category": "Entity2",
"confidenceScore": 1.0
},
{
"entityComponentInformation": [
{
"entityComponentKind": "prebuiltComponent"
}
],
"offset": 37,
"length": 9,
"text": "ibuprofen",
"category": "MedicationName",
"confidenceScore": 1,
"assertion": {
"certainty": "negative"
},
"name": "ibuprofen",
"links": [
{
"dataSource": "UMLS",
"id": "C0020740"
},
{
"dataSource": "AOD",
"id": "0000019879"
},
{
"dataSource": "ATC",
"id": "M01AE01"
},
{
"dataSource": "CCPSS",
"id": "0046165"
},
{
"dataSource": "CHV",
"id": "0000006519"
},
{
"dataSource": "CSP",
"id": "2270-2077"
},
{
"dataSource": "DRUGBANK",
"id": "DB01050"
},
{
"dataSource": "GS",
"id": "1611"
},
{
"dataSource": "LCH_NW",
"id": "sh97005926"
},
{
"dataSource": "LNC",
"id": "LP16165-0"
},
{
"dataSource": "MEDCIN",
"id": "40458"
},
{
"dataSource": "MMSL",
"id": "d00015"
},
{
"dataSource": "MSH",
"id": "D007052"
},
{
"dataSource": "MTHSPL",
"id": "WK2XYI10QM"
},
{
"dataSource": "NCI",
"id": "C561"
},
{
"dataSource": "NCI_CTRP",
"id": "C561"
},
{
"dataSource": "NCI_DCP",
"id": "00803"
},
{
"dataSource": "NCI_DTP",
"id": "NSC0256857"
},
{
"dataSource": "NCI_FDA",
"id": "WK2XYI10QM"
},
{
"dataSource": "NCI_NCI-GLOSS",
"id": "CDR0000613511"
},
{
"dataSource": "NDDF",
"id": "002377"
},
{
"dataSource": "PDQ",
"id": "CDR0000040475"
},
{
"dataSource": "RCD",
"id": "x02MO"
},
{
"dataSource": "RXNORM",
"id": "5640"
},
{
"dataSource": "SNM",
"id": "E-7772"
},
{
"dataSource": "SNMI",
"id": "C-603C0"
},
{
"dataSource": "SNOMEDCT_US",
"id": "387207008"
},
{
"dataSource": "USP",
"id": "m39860"
},
{
"dataSource": "USPMG",
"id": "MTHU000060"
},
{
"dataSource": "VANDF",
"id": "4017840"
}
]
},
{
"entityComponentInformation": [
{
"entityComponentKind": "prebuiltComponent"
}
],
"offset": 30,
"length": 6,
"text": "100 mg",
"category": "Dosage",
"confidenceScore": 0.98
}
],
"relations": [
{
"confidenceScore": 1,
"relationType": "DosageOfMedication",
"entities": [
{
"ref": "#/documents/0/entities/1",
"role": "Dosage"
},
{
"ref": "#/documents/0/entities/0",
"role": "Medication"
}
]
}
],
"id": "1",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-04-01"
}
}
]
}
}
Key |
範例值 |
描述 |
實體 |
[] |
包含所有已擷取之實體的陣列。 |
entityComponentKind |
prebuiltComponent |
一個用來指出哪個元件傳回特定實體的變數。 可能的值:prebuiltComponent 、、 learnedComponent listComponent |
offset |
0 |
一個藉由編制字元索引來表示已擷取實體之起點的數字 |
length |
10 |
一個以字元數表示已擷取實體之長度的數字。 |
text |
first entity |
針對特定實體擷取的文字。 |
category |
MedicationName |
對應於已擷取之文字的實體類型或類別名稱。 |
confidenceScore |
0.9 |
一個用來表示已擷取實體之模型確定程度的數字,範圍從 0 到 1,數字愈大表示確定程度愈高。 |
assertion |
certainty |
與已擷取實體相關聯的判斷提示。 只有預先建置的用於健康醫療領域的文字分析才支援判斷提示。 |
NAME |
Ibuprofen |
與已擷取實體相關聯的實體連結標準化名稱。 只有預先建置的用於健康醫療領域的文字分析才支援實體連結。 |
連結 |
[] |
一個包含所有與擷取實體相關聯之實體連結結果的陣列。 只有預先建置的用於健康醫療領域的文字分析才支援實體連結。 |
dataSource |
UMLS |
與已擷取實體相關聯之實體連結所產生的參考標準。 只有預先建置的用於健康醫療領域的文字分析才支援實體連結。 |
識別碼 |
C0020740 |
與屬於已擷取資料來源之已擷取實體相關聯的實體連結所產生的參考程式碼。 只有預先建置的用於健康醫療領域的文字分析才支援實體連結。 |
關係 |
[] |
包含所有已擷取之關聯性的陣列。 只有預先建置的用於健康醫療領域的文字分析實體才支援關聯性擷取。 |
relationType |
DosageOfMedication |
已擷取關聯性的類別。 只有預先建置的用於健康醫療領域的文字分析實體才支援關聯性擷取。 |
實體 |
"Dosage", "Medication" |
與已擷取之關聯性有所關聯的實體。 只有預先建置的用於健康醫療領域的文字分析實體才支援關聯性擷取。 |