Skip to content

TA v3.1-preview.4 - updated examples and definitions for TA for Health #12340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tjprescott merged 13 commits into from
Jan 20, 2021
Merged

TA v3.1-preview.4 - updated examples and definitions for TA for Health #12340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c4ede63
updated examples and health definitions for new preview version
Jan 8, 2021
ffc08e4
fixed linting issue in readme
Jan 11, 2021
d1b558f
removed old properties in ta.json
Jan 11, 2021
c96681e
undo changes to sentiment portion of response, update health response
Jan 11, 2021
dad4bd6
fixed spelling issues
Jan 11, 2021
eea5942
fixed more typose
Jan 11, 2021
9503770
remove linting issue in readme
Jan 12, 2021
89bf5a7
added enums to assertions
Jan 12, 2021
93b24be
add in ms-enum extension
Jan 13, 2021
eb0a5f6
Merge branch 'dev-cognitiveservices-TextAnalytics-v3.1-preview.4' int…
ctufts Jan 13, 2021
cbda14c
merged in latest changes from upstream
Jan 13, 2021
3f00546
ran prettier json linter over files
Jan 13, 2021
ef8c705
made assertion field singular
Jan 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 72 additions & 15 deletions ...tion/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1790,12 +1790,14 @@
"$ref": "#/definitions/Entity"
},
{
"required": [
"isNegated"
],
"properties": {
"isNegated": {
"type": "boolean"
"assertion": {
"type": "object",
"$ref": "#/definitions/HealthcareAssertion"
},
"name": {
"description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.",
"type": "string"
},
"links": {
"description": "Entity references in known data sources.",
Expand All @@ -1810,27 +1812,82 @@
},
"HealthcareRelation": {
"type": "object",
"description": "Every relation is an entity graph of a certain entityType, where all entities are connected and have specific roles within the relation context.",
"required": [
"relationType",
"bidirectional",
"source",
"target"
"entities"
],
"properties": {
"relationType": {
"description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.",
"type": "string"
},
"bidirectional": {
"description": "If true the relation between the entities is bidirectional, otherwise directionality is source to target.",
"type": "boolean"
"entities": {
"description": "The entities in the relation.",
"type": "array",
"items": {
"$ref": "#/definitions/HealthcareRelationEntity"
}
}
}
},
"HealthcareAssertion": {
"type": "object",
"properties": {
"conditionality": {
"description": "Describes any conditionality on the entity.",
"type": "string",
"enum": [
"Hypothetical",
"Conditional"
],
"x-ms-enum": {
"name": "Conditionality",
"modelAsString": false
}
},
"certainty": {
"description": "Describes the entities certainty and sentiment.",
"type": "string",
"enum": [
"Positive",
"Positive Possible",
"Neutral Possible",
"Negative Possible",
"Negative"
],
"x-ms-enum": {
"name": "Certainty",
"modelAsString": false
}
},
"source": {
"description": "Reference link to the source entity.",
"association": {
"description": "Describes if the entity is the subject of the text or if it describes someone else.",
"type": "string",
"enum": [
"subject",
"other"
],
"x-ms-enum": {
"name": "Association",
"modelAsString": false
}
}
}
},
"HealthcareRelationEntity": {
"type": "object",
"required": [
"ref",
"role"
],
"properties": {
"ref": {
"description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .",
"type": "string"
},
"target": {
"description": "Reference link to the target entity.",
"role": {
"description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).",
"type": "string"
}
}
Expand Down
36 changes: 25 additions & 11 deletions ...ta-plane/TextAnalytics/preview/v3.1-preview.4/examples/SuccessfulHealthStatusRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,17 @@
"length": 5,
"text": "100mg",
"category": "Dosage",
"confidenceScore": 0.99,
"isNegated": false
"confidenceScore": 0.99
},
{
"offset": 27,
"length": 9,
"text": "ibuprofen",
"category": "MedicationName",
"confidenceScore": 1.0,
"isNegated": false,
"assertion": {
"certainty": "Positive"
},
"links": [
{
"id": "C0020740",
Expand Down Expand Up @@ -161,22 +162,35 @@
"length": 11,
"text": "twice daily",
"category": "Frequency",
"confidenceScore": 1,
"isNegated": false
"confidenceScore": 1
}
],
"relations": [
{
"relationType": "DosageOfMedication",
"bidirectional": false,
"source": "#/documents/0/entities/0",
"target": "#/documents/0/entities/1"
"entities": [
{
"ref": "#/documents/0/entities/0",
"role": "Attribute"
},
{
"ref": "#/documents/0/entities/1",
"role": "Entity"
}
]
},
{
"relationType": "FrequencyOfMedication",
"bidirectional": false,
"source": "#/documents/0/entities/2",
"target": "#/documents/0/entities/1"
"entities": [
{
"ref": "#/documents/0/entities/2",
"role": "Attribute"
},
{
"ref": "#/documents/0/entities/1",
"role": "Entity"
}
]
}
],
"warnings": []
Expand Down