Zuerst müssen Sie Ihren Ressourcenschlüssel und Endpunkt abrufen:
Navigieren Sie im Azure-Portal zur Übersichtsseite Ihrer Ressource.
Wählen Sie im Menü auf der linken Seite Schlüssel und Endpunkt aus. Sie verwenden den Endpunkt und Schlüssel für die API-Anforderungen.
Übermitteln einer Aufgabe für die benutzerdefinierte Textanalyse für Gesundheit
Verwenden Sie die folgende POST-Anforderung, um eine Extraktionsaufgabe für die benutzerdefinierte Textanalyse für Gesundheit zu starten:
{ENDPOINT}/language/analyze-text/jobs?api-version={API-VERSION}
| Platzhalter |
Wert |
Beispiel |
{ENDPOINT} |
Der Endpunkt für die Authentifizierung Ihrer API-Anforderung. |
https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
Die Version der von Ihnen aufgerufenen API. Der hier referenzierte Wert gilt für die neueste veröffentlichte Version. Weitere Informationen zu anderen verfügbaren API-Versionen finden Sie unter Modelllebenszyklus. |
2022-05-01 |
| Schlüssel |
Wert |
| Ocp-Apim-Subscription-Key |
Ihr Schlüssel, der den Zugriff auf diese API ermöglicht. |
Body
{
"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}"
}
}
]
}
| Schlüssel |
Platzhalter |
Wert |
Beispiel |
displayName |
{JOB-NAME} |
Dies ist der Name Ihres Auftrags. |
MyJobName |
documents |
[{},{}] |
Dies ist die Liste der Dokumente, für die Aufgaben ausgeführt werden sollen. |
[{},{}] |
id |
{DOC-ID} |
Hierbei handelt es sich um den Namen oder die ID des Dokuments. |
doc1 |
language |
{LANGUAGE-CODE} |
Dies ist eine Zeichenfolge, die den Sprachcode des Dokuments angibt. Wenn dieser Schlüssel nicht angegeben ist, nimmt der Dienst die Standardsprache des Projekts an, die bei der Projekterstellung ausgewählt wurde. Unter Sprachunterstützung finden sie eine Liste der unterstützten Sprachcodes. |
en-us |
text |
{DOC-TEXT} |
Dies ist die Dokumentaufgabe, für die die Aufgaben ausgeführt werden sollen. |
Lorem ipsum dolor sit amet |
tasks |
|
Liste der Aufgaben, die ausgeführt werden sollen. |
[] |
taskName |
Custom Text Analytics for Health Test |
Aufgabenname |
Custom Text Analytics for Health Test |
kind |
CustomHealthcare |
Angabe der gewünschten Art von Projekt oder Aufgabe |
CustomHealthcare |
parameters |
|
Dies ist die Liste der Parameter, die an die Aufgabe übergeben werden. |
|
project-name |
{PROJECT-NAME} |
Der Name für Ihr Projekt. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet. |
myProject |
deployment-name |
{DEPLOYMENT-NAME} |
Der Name Ihrer Bereitstellung. Bei diesem Wert wird die Groß-/Kleinschreibung beachtet. |
prod |
Antwort
Sie erhalten eine Antwort vom Typ „202“, die angibt, dass Ihre Aufgabe erfolgreich übermittelt wurde. Extrahieren Sie operation-location in den Antwortheadern.
operation-location weist dieses Format auf:
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
Sie können diese URL verwenden, um den Abschlussstatus der Aufgabe abzufragen und die Ergebnisse abzurufen, wenn die Aufgabe abgeschlossen ist.
Abrufen der Aufgabenergebnisse
Verwenden Sie die folgende GET-Anforderung, um den Status/die Ergebnisse der Aufgabe für die Erkennung von benutzerdefinierten Entitäten abzufragen.
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
| Platzhalter |
Wert |
Beispiel |
{ENDPOINT} |
Der Endpunkt für die Authentifizierung Ihrer API-Anforderung. |
https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
Die Version der von Ihnen aufgerufenen API. Der hier referenzierte Wert gilt für die neueste veröffentlichte Version. Weitere Informationen zu anderen verfügbaren API-Versionen finden Sie unter Modelllebenszyklus. |
2022-05-01 |
| Schlüssel |
Wert |
| Ocp-Apim-Subscription-Key |
Ihr Schlüssel, der den Zugriff auf diese API ermöglicht. |
Antworttext
Die Antwort ist ein JSON-Dokument mit den folgenden Parametern:
{
"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"
}
}
]
}
}
| Schlüssel |
Beispielwert |
BESCHREIBUNG |
| entities |
[] |
Ein Array, das alle extrahierten Entitäten enthält. |
| entityComponentKind |
prebuiltComponent |
Eine Variable, die angibt, welche Komponente die spezifische Entität zurückgegeben hat. Mögliche Werte: prebuiltComponent, learnedComponent, listComponent |
| offset |
0 |
Eine Zahl, die den Ausgangspunkt der extrahierten Entität angibt (mittels Indizierung über die Zeichen). |
| length |
10 |
Eine Zahl, die die Länge der extrahierten Entität angibt (als Anzahl von Zeichen). |
| text |
first entity |
Der Text, der für eine spezifische Entität extrahiert wurde. |
| category |
MedicationName |
Der Name des Entitätstyps oder der Kategorie, der bzw. die dem extrahierten Text entspricht. |
| confidenceScore |
0.9 |
Eine Zahl zwischen 0 und 1, die den Grad der Gewissheit des Modells in Bezug auf die extrahierte Entität angibt. Je höher der Wert, desto höher die Gewissheit. |
| assertion |
certainty |
Assertionen, die der extrahierten Entität zugeordnet sind. Assertionen werden nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
| name |
Ibuprofen |
Der normalisierte Name für die Entitätsverknüpfung, die der extrahierten Entität zugeordnet ist. Entitätsverknüpfung wird nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
| Verknüpfungen |
[] |
Ein Array, das alle Ergebnisse der Entitätsverknüpfung enthält, die der extrahierten Entität zugeordnet ist. Entitätsverknüpfung wird nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
| dataSource |
UMLS |
Der Referenzstandard, der sich aus der Entitätsverknüpfung ergibt, die der extrahierten Entität zugeordnet ist. Entitätsverknüpfung wird nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
| ID |
C0020740 |
Der Referenzcode, der sich aus der Entitätsverknüpfung ergibt, die der extrahierten Entität zugeordnet ist, die zur extrahierten Datenquelle gehört. Entitätsverknüpfung wird nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
| Relationen |
[] |
Array, das alle extrahierten Beziehungen enthält. Beziehungsextraktion wird nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
| relationType |
DosageOfMedication |
Die Kategorie der extrahierten Beziehung. Beziehungsextraktion wird nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
| entities |
"Dosage", "Medication" |
Die Entitäten, die der extrahierten Beziehung zugeordnet sind. Beziehungsextraktion wird nur für vordefinierte Entitäten der Textanalyse für Gesundheit unterstützt. |
