Prima di tutto, è necessario ottenere la chiave e l'endpoint della risorsa:
Passare alla pagina di panoramica della risorsa nel portale di Azure
Dal menu a sinistra selezionare Chiavi ed endpoint. L'endpoint e la chiave verranno usati per le richieste API
Creare un’attività di analisi testuale personalizzata per la salute
Usare questa richiesta POST per avviare un'attività di estrazione per l’analisi testuale personalizzata per la salute.
{ENDPOINT}/language/analyze-text/jobs?api-version={API-VERSION}
Segnaposto |
Valore |
Esempio |
{ENDPOINT} |
Endpoint per l'autenticazione della richiesta API. |
https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
La versione dell'API che si sta chiamando. Il valore a cui si fa riferimento qui è relativo alla versione più recente rilasciata. Per altre informazioni sulle altre versioni dell'API disponibili, vedere Ciclo di vita del modello. |
2022-05-01 |
Chiave |
valore |
Ocp-Apim-Subscription-Key |
La chiave che fornisce l'accesso all’API. |
Corpo
{
"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}"
}
}
]
}
Chiave |
Segnaposto |
Valore |
Esempio |
displayName |
{JOB-NAME} |
Il nome del processo. |
MyJobName |
documents |
[{},{}] |
Elenco di documenti per cui eseguire le attività. |
[{},{}] |
id |
{DOC-ID} |
Nome o ID del documento. |
doc1 |
language |
{LANGUAGE-CODE} |
Una stringa che specifica il codice lingua per il documento. Se questa chiave non è specificata, il servizio presuppone la lingua predefinita del progetto selezionata durante la creazione del progetto. Per un elenco dei codici lingua supportati, vedere Supporto lingua. |
en-us |
text |
{DOC-TEXT} |
Attività del documento per cui eseguire le attività. |
Lorem ipsum dolor sit amet |
tasks |
|
Elenco di attività da eseguire. |
[] |
taskName |
Custom Text Analytics for Health Test |
Il nome dell’attività |
Custom Text Analytics for Health Test |
kind |
CustomHealthcare |
Il tipo di progetto o attività che si sta tentando di eseguire |
CustomHealthcare |
parameters |
|
Elenco di parametri da passare all’attività. |
|
project-name |
{PROJECT-NAME} |
Nome del progetto. Per questo valore viene applicata la distinzione tra maiuscole e minuscole. |
myProject |
deployment-name |
{DEPLOYMENT-NAME} |
Il nome della distribuzione. Per questo valore viene applicata la distinzione tra maiuscole e minuscole. |
prod |
Response
Se l’attività è stata inviata correttamente, si riceverà una risposta 202. Nelle intestazioni della risposta, estrarre operation-location
.
operation-location
è formattato come indicato di seguito:
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
È possibile usare questo URL per eseguire una query sullo stato di completamento dell'attività e ottenere i risultati al termine dell'attività.
Ottenere i risultati dell’attività
Usare la richiesta GET seguente per eseguire una query sullo stato/sui risultati dell'attività di riconoscimento di entità personalizzate.
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
Segnaposto |
Valore |
Esempio |
{ENDPOINT} |
Endpoint per l'autenticazione della richiesta API. |
https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
La versione dell'API che viene richiamata. Il valore a cui si fa riferimento qui è relativo alla versione più recente rilasciata. Per altre informazioni sulle altre versioni dell'API disponibili, vedere Ciclo di vita del modello. |
2022-05-01 |
Chiave |
valore |
Ocp-Apim-Subscription-Key |
La chiave che fornisce l'accesso all’API. |
Testo della risposta
La risposta sarà un documento JSON con i parametri seguenti
{
"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"
}
}
]
}
}
Chiave |
Valore di esempio |
Descrizione |
entities |
[] |
Un array contenente tutte le entità estratte. |
entityComponentKind |
prebuiltComponent |
Una variabile che indica quale componente ha restituito l'entità specifica. Valori possibili: prebuiltComponent , learnedComponent , listComponent |
offset |
0 |
Un numero che indica il punto iniziale dell'entità estratta tramite l'indicizzazione dei caratteri |
length |
10 |
Un numero che indica la lunghezza dell'entità estratta in numero di caratteri. |
Testo |
first entity |
Il testo estratto per un'entità specifica. |
category |
MedicationName |
Il nome del tipo di entità o della categoria corrispondente al testo estratto. |
confidenceScore |
0.9 |
Un numero che indica il livello di certezza dell'entità estratta del modello, compreso tra 0 e 1, dove un numero più alto indica una maggiore certezza. |
assertion |
certainty |
Asserzioni associate all'entità estratta. Le asserzioni sono supportate solo per le entità dell’analisi testuale per la salute predefinite. |
name |
Ibuprofen |
Un nome normalizzato per il collegamento delle entità associato all'entità estratta. Il collegamento delle entità è supportato solo per le entità dell’analisi testuale per la salute predefinite. |
collegamenti |
[] |
Un array che contiene tutti i risultati del collegamento delle entità associati all'entità estratta. Il collegamento delle entità è supportato solo per le entità dell’analisi testuale per la salute predefinite. |
dataSource |
UMLS |
Lo standard di riferimento risultante dal collegamento delle entità associato all'entità estratta. Il collegamento delle entità è supportato solo per le entità dell’analisi testuale per la salute predefinite. |
ID |
C0020740 |
Il codice di riferimento risultante dal collegamento delle entità associato all'entità estratta appartenente all'origine dati estratta. Il collegamento delle entità è supportato solo per le entità dell’analisi testuale per la salute predefinite. |
relazioni |
[] |
Array contenente tutte le relazioni estratte. L’estrazione delle relazioni è supportata solo per le entità dell’analisi testuale per la salute predefinite. |
relationType |
DosageOfMedication |
La categoria della relazione estratta. L'estrazione delle relazioni è supportata solo per le entità dell’analisi testuale per la salute predefinite. |
entities |
"Dosage", "Medication" |
Le entità associate alla relazione estratta. L'estrazione delle relazioni è supportata solo per le entità dell’analisi testuale per la salute predefinite. |