Сначала необходимо получить ключ ресурса и конечную точку.
Перейдите на страницу обзора ресурса на портале 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 |
Ключ |
Стоимость |
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}"
}
}
]
}
Ключ |
Заполнитель |
Значение |
Пример |
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 |
Response
Вы получите ответ 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": "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"
}
}
]
}
}
Ключ |
Образец значения |
Description |
Объекты |
[] |
Массив, содержащий все извлеченные сущности. |
entityComponentKind |
prebuiltComponent |
Переменная, указывающая, какой компонент вернул определенную сущность. Возможные значения: prebuiltComponent , learnedComponent , listComponent |
offset |
0 |
Число, обозначающее начальную точку извлеченной сущности путем индексирования по символам |
length |
10 |
Число, обозначающее длину извлеченной сущности в количестве символов. |
text |
first entity |
Текст, извлеченный для определенной сущности. |
Категория |
MedicationName |
Имя типа сущности или категории, соответствующей извлеченного текста. |
confidenceScore |
0.9 |
Число, обозначающее уровень определенности модели извлеченной сущности в диапазоне от 0 до 1 с более высоким числом, обозначающим более высокую уверенность. |
assertion |
certainty |
Утверждения, связанные с извлеченной сущностью. Утверждения поддерживаются только для предварительно созданных Анализ текста для сущностей работоспособности. |
name |
Ibuprofen |
Нормализованное имя для связи сущностей, связанной с извлеченной сущностью. Связывание сущностей поддерживается только для предварительно созданных Анализ текста для сущностей работоспособности. |
ссылки |
[] |
Массив, содержащий все результаты связи сущностей , связанной с извлеченной сущностью. Связывание сущностей поддерживается только для предварительно созданных Анализ текста для сущностей работоспособности. |
dataSource |
UMLS |
Эталонный стандарт, полученный от связывания сущностей, связанной с извлеченной сущностью. Связывание сущностей поддерживается только для предварительно созданных Анализ текста для сущностей работоспособности. |
ID |
C0020740 |
Ссылочный код, связанный с извлеченной сущностью, связанной с извлеченным источником данных. Связывание сущностей поддерживается только для предварительно созданных Анализ текста для сущностей работоспособности. |
Отношения |
[] |
Массив, содержащий все извлеченные связи. Извлечение связей поддерживается только для предварительно созданных Анализ текста для сущностей работоспособности. |
relationType |
DosageOfMedication |
Категория извлеченной связи. Извлечение связей поддерживается только для предварительно созданных Анализ текста для сущностей работоспособности. |
entities |
"Dosage", "Medication" |
Сущности, связанные с извлеченной связью. Извлечение связей поддерживается только для предварительно созданных Анализ текста для сущностей работоспособности. |