Analyze Text Job Status - Analyze Text Job Status

Service:

Azure AI Services

API-versie:

2024-11-01

Analysestatus en -resultaten ophalen
De status van een analysetaak ophalen. Een taak kan bestaan uit een of meer taken. Nadat alle taken zijn geslaagd, wordt de taak overgezet naar de status Geslaagd en zijn de resultaten beschikbaar voor elke taak.

GET {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

Met optionele parameters:

GET {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01&showStats={showStats}&top={top}&skip={skip}

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
jobId	path	True	string (uuid)	taak-id
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
showStats	query		boolean	(Optioneel) als deze is ingesteld op waar, bevat het antwoord statistieken op aanvraag- en documentniveau.
skip	query		integer (int32)	Een verschuiving in de verzameling van de eerste resource die moet worden geretourneerd.
top	query		integer (int32)	Het maximum aantal resources dat moet worden geretourneerd uit de verzameling.

Antwoorden

Name	Type	Description
200 OK	AnalyzeTextJobState	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

SuccessfulAbstractiveSummarizationSummaryLengthTaskResult

SuccessfulAbstractiveSummarizationTaskResult

SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest

SuccessfulHealthcareDocumentTypeTaskStatusRequest

SuccessfulHealthcareTaskStatusRequest

SuccessfulAbstractiveSummarizationSummaryLengthTaskResult

Voorbeeldaanvraag

HTTP

GET {Endpoint}/language/analyze-text/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18?api-version=2024-11-01

Voorbeeldrespons

Statuscode:

200

{
  "createdDateTime": "2020-10-01T15:00:45Z",
  "displayName": "Document Abstractive Summarization Task Example",
  "expirationDateTime": "2020-10-03T15:01:03Z",
  "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
  "lastUpdatedDateTime": "2020-10-01T15:01:03Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "AbstractiveSummarizationLROResults",
        "taskName": "Document Abstractive Summarization Task 1",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "summaries": [
                {
                  "text": "Microsoft is working towards advancing AI through a holistic, human-centric approach. The Chief Technology Officer of Azure AI services, who has a unique perspective on human cognition, is working with a team to develop a joint representation called XYZ-code. This code, which combines monologuistic text, audio or visual sensory signals, and multilinguality, is being used to create more powerful AI that can better understand humans. The goal is to have pre-trained models that can jointly learn representations to support a broad range of AI tasks, similar to how humans do today. Over the past five years, Microsoft has achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning.",
                  "contexts": [
                    {
                      "offset": 0,
                      "length": 1629
                    }
                  ]
                }
              ],
              "id": "1",
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "latest"
        }
      }
    ]
  }
}

SuccessfulAbstractiveSummarizationTaskResult

Voorbeeldaanvraag

HTTP

GET {Endpoint}/language/analyze-text/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18?api-version=2024-11-01

Voorbeeldrespons

Statuscode:

200

{
  "createdDateTime": "2020-10-01T15:00:45Z",
  "displayName": "Document Abstractive Summarization Task Example",
  "expirationDateTime": "2020-10-03T15:01:03Z",
  "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
  "lastUpdatedDateTime": "2020-10-01T15:01:03Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "AbstractiveSummarizationLROResults",
        "taskName": "Document Abstractive Summarization Task 1",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "summaries": [
                {
                  "text": "Microsoft have been on a quest to advance AI beyond existing techniques.",
                  "contexts": [
                    {
                      "offset": 0,
                      "length": 1629
                    }
                  ]
                }
              ],
              "id": "1",
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "latest"
        }
      }
    ]
  }
}

SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest

Voorbeeldaanvraag

HTTP

GET {Endpoint}/language/analyze-text/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18?api-version=2024-11-01

Voorbeeldrespons

Statuscode:

200

{
  "createdDateTime": "2020-10-01T15:00:45Z",
  "displayName": "Extracting Location & US Region",
  "expirationDateTime": "2020-10-03T15:01:03Z",
  "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
  "lastUpdatedDateTime": "2020-10-01T15:01:03Z",
  "status": "succeeded",
  "tasks": {
    "completed": 2,
    "failed": 0,
    "inProgress": 0,
    "total": 2,
    "items": [
      {
        "kind": "EntityRecognitionLROResults",
        "taskName": "Recognize Entities",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "entities": [
                {
                  "category": "Event",
                  "type": "Event",
                  "confidenceScore": 0.61,
                  "length": 4,
                  "offset": 18,
                  "text": "trip",
                  "tags": [
                    {
                      "name": "Event",
                      "confidenceScore": 0.61
                    }
                  ]
                },
                {
                  "category": "Location",
                  "type": "GPE",
                  "confidenceScore": 0.82,
                  "length": 7,
                  "offset": 26,
                  "tags": [
                    {
                      "name": "Location",
                      "confidenceScore": 0.82
                    },
                    {
                      "name": "GPE",
                      "confidenceScore": 0.82
                    }
                  ],
                  "text": "Seattle"
                },
                {
                  "category": "Temporal",
                  "type": "DateRange",
                  "confidenceScore": 0.8,
                  "length": 9,
                  "offset": 34,
                  "text": "last week",
                  "tags": [
                    {
                      "name": "DateRange",
                      "confidenceScore": 0.8
                    },
                    {
                      "name": "Temporal",
                      "confidenceScore": 0.8
                    }
                  ]
                }
              ],
              "id": "1",
              "warnings": []
            },
            {
              "entities": [
                {
                  "category": "Location",
                  "type": "GPE",
                  "confidenceScore": 0.52,
                  "length": 3,
                  "offset": 14,
                  "text": "NYC",
                  "tags": [
                    {
                      "name": "Location",
                      "confidenceScore": 0.82
                    },
                    {
                      "name": "GPE",
                      "confidenceScore": 0.82
                    }
                  ]
                },
                {
                  "category": "Temporal",
                  "type": "Date",
                  "confidenceScore": 0.8,
                  "length": 8,
                  "offset": 18,
                  "text": "tomorrow",
                  "tags": [
                    {
                      "name": "Date",
                      "confidenceScore": 0.8
                    },
                    {
                      "name": "Temporal",
                      "confidenceScore": 0.8
                    }
                  ]
                }
              ],
              "id": "2",
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2020-04-01"
        }
      },
      {
        "kind": "CustomEntityRecognitionLROResults",
        "taskName": "Recognize US Regions",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "entities": [
                {
                  "category": "USRegion",
                  "confidenceScore": 0.85,
                  "length": 17,
                  "offset": 45,
                  "text": "Pacific Northwest"
                }
              ],
              "id": "1",
              "warnings": []
            },
            {
              "entities": [
                {
                  "category": "USRegion",
                  "confidenceScore": 0.88,
                  "length": 10,
                  "offset": 63,
                  "text": "East Coast"
                }
              ],
              "id": "2",
              "warnings": []
            }
          ],
          "errors": [],
          "projectName": "MyProject",
          "deploymentName": "MyDeployment"
        }
      }
    ]
  }
}

SuccessfulHealthcareDocumentTypeTaskStatusRequest

Voorbeeldaanvraag

HTTP

GET {Endpoint}/language/analyze-text/jobs/15e4a46b-62e2-4386-8d36-9c2a92bb45dd?api-version=2024-11-01

Voorbeeldrespons

Statuscode:

200

{
  "createdDateTime": "2022-09-06T23:47:43Z",
  "displayName": "Providing Document Type",
  "expirationDateTime": "2022-09-07T23:47:43Z",
  "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd",
  "lastUpdatedDateTime": "2022-09-06T23:48:10Z",
  "status": "succeeded",
  "errors": [],
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "HealthcareLROResults",
        "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "id": "a",
              "entities": [
                {
                  "offset": 11,
                  "length": 5,
                  "text": "100mg",
                  "category": "Dosage",
                  "confidenceScore": 0.98
                },
                {
                  "offset": 17,
                  "length": 9,
                  "text": "ibuprofen",
                  "category": "MedicationName",
                  "confidenceScore": 1,
                  "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"
                    }
                  ]
                },
                {
                  "offset": 34,
                  "length": 11,
                  "text": "twice daily",
                  "category": "Frequency",
                  "confidenceScore": 1
                }
              ],
              "relations": [
                {
                  "confidenceScore": 1,
                  "relationType": "DosageOfMedication",
                  "entities": [
                    {
                      "ref": "#/results/documents/0/entities/0",
                      "role": "Dosage"
                    },
                    {
                      "ref": "#/results/documents/0/entities/1",
                      "role": "Medication"
                    }
                  ]
                },
                {
                  "confidenceScore": 1,
                  "relationType": "FrequencyOfMedication",
                  "entities": [
                    {
                      "ref": "#/results/documents/0/entities/1",
                      "role": "Medication"
                    },
                    {
                      "ref": "#/results/documents/0/entities/2",
                      "role": "Frequency"
                    }
                  ]
                }
              ],
              "warnings": [],
              "fhirBundle": {
                "resourceType": "Bundle",
                "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f",
                "meta": {
                  "profile": [
                    "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle"
                  ]
                },
                "identifier": {
                  "system": "urn:ietf:rfc:3986",
                  "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f"
                },
                "type": "document",
                "entry": [
                  {
                    "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946",
                    "resource": {
                      "resourceType": "Composition",
                      "id": "5bd33290-b92e-4aa5-becf-535578207946",
                      "status": "final",
                      "type": {
                        "coding": [
                          {
                            "system": "http://loinc.org",
                            "code": "18842-5",
                            "display": "Discharge summary"
                          }
                        ],
                        "text": "Discharge summary"
                      },
                      "subject": {
                        "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594",
                        "type": "Patient"
                      },
                      "encounter": {
                        "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63",
                        "type": "Encounter",
                        "display": "unknown"
                      },
                      "date": "2022-09-06",
                      "author": [
                        {
                          "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046",
                          "type": "Practitioner",
                          "display": "Unknown"
                        }
                      ],
                      "title": "Discharge summary",
                      "section": [
                        {
                          "title": "General",
                          "code": {
                            "coding": [
                              {
                                "system": "",
                                "display": "Unrecognized Section"
                              }
                            ],
                            "text": "General"
                          },
                          "text": {
                            "status": "additional",
                            "div": "<div>\r\n\t\t\t\t\t\t\t<h1>General</h1>\r\n\t\t\t\t\t\t\t<p>Prescribed 100mg ibuprofen, taken twice daily.</p>\r\n\t\t\t\t\t</div>"
                          },
                          "entry": [
                            {
                              "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad",
                              "type": "List",
                              "display": "General"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  {
                    "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046",
                    "resource": {
                      "resourceType": "Practitioner",
                      "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046",
                      "name": [
                        {
                          "text": "Unknown",
                          "family": "Unknown"
                        }
                      ]
                    }
                  },
                  {
                    "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594",
                    "resource": {
                      "resourceType": "Patient",
                      "id": "efcccdf7-87f0-4061-b553-09fc11734594",
                      "gender": "unknown"
                    }
                  },
                  {
                    "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63",
                    "resource": {
                      "resourceType": "Encounter",
                      "id": "76214457-f94c-4ccf-95ef-ab31e7232d63",
                      "meta": {
                        "profile": [
                          "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
                        ]
                      },
                      "status": "finished",
                      "class": {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                        "display": "unknown"
                      },
                      "subject": {
                        "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594",
                        "type": "Patient"
                      },
                      "period": {
                        "start": "2022-09-06",
                        "end": "2022-09-06"
                      }
                    }
                  },
                  {
                    "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7",
                    "resource": {
                      "resourceType": "MedicationStatement",
                      "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7",
                      "extension": [
                        {
                          "extension": [
                            {
                              "url": "offset",
                              "valueInteger": 17
                            },
                            {
                              "url": "length",
                              "valueInteger": 9
                            }
                          ],
                          "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference"
                        }
                      ],
                      "status": "active",
                      "medicationCodeableConcept": {
                        "coding": [
                          {
                            "system": "http://www.nlm.nih.gov/research/umls",
                            "code": "C0020740",
                            "display": "ibuprofen"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/aod",
                            "code": "0000019879"
                          },
                          {
                            "system": "http://www.whocc.no/atc",
                            "code": "M01AE01"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/ccpss",
                            "code": "0046165"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/chv",
                            "code": "0000006519"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/csp",
                            "code": "2270-2077"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/drugbank",
                            "code": "DB01050"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/gs",
                            "code": "1611"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/lch_nw",
                            "code": "sh97005926"
                          },
                          {
                            "system": "http://loinc.org",
                            "code": "LP16165-0"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/medcin",
                            "code": "40458"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/mmsl",
                            "code": "d00015"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/msh",
                            "code": "D007052"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/mthspl",
                            "code": "WK2XYI10QM"
                          },
                          {
                            "system": "http://ncimeta.nci.nih.gov",
                            "code": "C561"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp",
                            "code": "C561"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/nci_dcp",
                            "code": "00803"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/nci_dtp",
                            "code": "NSC0256857"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/nci_fda",
                            "code": "WK2XYI10QM"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss",
                            "code": "CDR0000613511"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/nddf",
                            "code": "002377"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/pdq",
                            "code": "CDR0000040475"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/rcd",
                            "code": "x02MO"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                            "code": "5640"
                          },
                          {
                            "system": "http://snomed.info/sct",
                            "code": "E-7772"
                          },
                          {
                            "system": "http://snomed.info/sct",
                            "code": "C-603C0"
                          },
                          {
                            "system": "http://snomed.info/sct",
                            "code": "387207008"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/usp",
                            "code": "m39860"
                          },
                          {
                            "system": "http://www.nlm.nih.gov/research/umls/uspmg",
                            "code": "MTHU000060"
                          },
                          {
                            "system": "http://hl7.org/fhir/ndfrt",
                            "code": "4017840"
                          }
                        ],
                        "text": "ibuprofen"
                      },
                      "subject": {
                        "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594",
                        "type": "Patient"
                      },
                      "context": {
                        "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63",
                        "type": "Encounter",
                        "display": "unknown"
                      },
                      "dosage": [
                        {
                          "text": "100mg",
                          "timing": {
                            "repeat": {
                              "frequency": 2,
                              "period": 1,
                              "periodUnit": "d"
                            },
                            "code": {
                              "text": "twice daily"
                            }
                          },
                          "doseAndRate": [
                            {
                              "doseQuantity": {
                                "value": 100
                              }
                            }
                          ]
                        }
                      ]
                    }
                  },
                  {
                    "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad",
                    "resource": {
                      "resourceType": "List",
                      "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad",
                      "status": "current",
                      "mode": "snapshot",
                      "title": "General",
                      "subject": {
                        "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594",
                        "type": "Patient"
                      },
                      "encounter": {
                        "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63",
                        "type": "Encounter",
                        "display": "unknown"
                      },
                      "entry": [
                        {
                          "item": {
                            "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7",
                            "type": "MedicationStatement",
                            "display": "ibuprofen"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ],
          "errors": [],
          "modelVersion": "2022-03-01"
        }
      }
    ]
  }
}

SuccessfulHealthcareTaskStatusRequest

Voorbeeldaanvraag

HTTP

GET {Endpoint}/language/analyze-text/jobs/1780194a-e9c1-4298-b0d4-fdc59ba818a0?api-version=2024-11-01

Voorbeeldrespons

Statuscode:

200

{
  "createdDateTime": "2022-07-20T18:43:35Z",
  "displayName": "Extracting Location & US Region",
  "expirationDateTime": "2022-07-21T18:43:35Z",
  "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0",
  "lastUpdatedDateTime": "2022-07-20T18:43:36Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "HealthcareLROResults",
        "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "id": "1",
              "entities": [
                {
                  "offset": 11,
                  "length": 5,
                  "text": "100mg",
                  "category": "Dosage",
                  "confidenceScore": 0.98
                },
                {
                  "offset": 17,
                  "length": 9,
                  "text": "ibuprofen",
                  "category": "MedicationName",
                  "confidenceScore": 1,
                  "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"
                    }
                  ]
                },
                {
                  "offset": 34,
                  "length": 11,
                  "text": "twice daily",
                  "category": "Frequency",
                  "confidenceScore": 1
                }
              ],
              "relations": [
                {
                  "confidenceScore": 1,
                  "relationType": "DosageOfMedication",
                  "entities": [
                    {
                      "ref": "#/results/documents/0/entities/0",
                      "role": "Dosage"
                    },
                    {
                      "ref": "#/results/documents/0/entities/1",
                      "role": "Medication"
                    }
                  ]
                },
                {
                  "confidenceScore": 1,
                  "relationType": "FrequencyOfMedication",
                  "entities": [
                    {
                      "ref": "#/results/documents/0/entities/1",
                      "role": "Medication"
                    },
                    {
                      "ref": "#/results/documents/0/entities/2",
                      "role": "Frequency"
                    }
                  ]
                }
              ],
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2022-03-01"
        }
      }
    ]
  }
}

Definities

Name	Description
AbstractiveSummarizationLROResult	Een object dat de resultaten weergeeft voor een abstractieve samenvattingstaak.
AbstractiveSummarizationResult	Een object dat de vooraf samengestelde samenvattingsresultaten van elk document weergeeft.
AbstractiveSummary	Een object dat één samenvatting vertegenwoordigt met context voor een bepaald document.
AbstractiveSummaryDocumentResult	Een object dat de vooraf samengestelde samenvattingsresultaten van elk document weergeeft.
AgeMetadata	Vertegenwoordigt het metagegevensmodel leeftijdsentiteit.
AgeUnit	De maateenheid Leeftijd
AnalyzeTextJobState	Het object met de LRO-taakstatus analyseren.
AnalyzeTextLROResultsKind	Het type antwoordobject dat wordt geretourneerd door de langlopende taak analyze-text.
AreaMetadata	Vertegenwoordigt het metagegevensmodel van de gebiedsentiteit.
AreaUnit	De maateenheid.
Association	Hierin wordt beschreven of de entiteit het onderwerp van de tekst is of als deze iemand anders beschrijft.
Certainty	Beschrijft de entiteitszekerheid en polariteit.
ClassificationDocumentResult	Bevat het resultaat van het classificatiedocumenten voor de taak.
ClassificationResult	Bevat het classificatieresultaat.
Conditionality	Beschrijft eventuele conditionaliteit voor de entiteit.
CurrencyMetadata	Vertegenwoordigt het valuta)-entiteitsmetagegevensmodel.
CustomEntitiesResult	Bevat de lijst met gedetecteerde aangepaste entiteiten voor de documenten.
CustomEntityRecognitionLROResult	Bevat het resultaat van de aangepaste entiteitsherkenningstaak.
CustomLabelClassificationResult	Bevat de resultaten van de classificatie van aangepaste labels.
CustomMultiLabelClassificationLROResult	Bevat het resultaat van de aangepaste classificatietaak voor meerdere labels.
CustomSingleLabelClassificationLROResult	Bevat het resultaat van de aangepaste classificatietaak voor één label.
DateMetadata	Een metagegevens voor datumentiteitexemplaren.
DateTimeMetadata	Een metagegevens voor exemplaren van datum/tijd-entiteiten.
DateValue	Vertegenwoordigt de datumwaarde.
DocumentError	Bevat details van fouten die zijn opgetreden tijdens het uitvoeren van een taak.
DocumentSentimentValue	Voorspeld sentiment voor document (negatief, neutraal, positief of gemengd).
DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
DocumentWarning	Bevat het waarschuwingsobject met waarschuwingen die zijn aangetroffen voor het verwerkte document.
EntitiesDocumentResult	Bevat het resultaat van de entiteitsherkenningstaak voor het document.
EntitiesDocumentResultWithMetadata	Resultaat entiteitsdocumenten met metagegevens.
EntitiesResult	Bevat het resultaat van de entiteitsherkenningstaak.
Entity	Hiermee definieert u het gedetecteerde entiteitsobject met de entiteitscategorie en de gedetecteerde entiteitstekst, enzovoort.
EntityLinkingLROResult	Bevat het LRO-resultaat van de entiteitskoppelingstaak analyseren.
EntityLinkingResult	Resultaat entiteitskoppeling.
EntityRecognitionLROResult	Bevat het taakresultaat voor entiteitsherkenningstaak.
EntityTag	Entiteitstagobject dat de naam van de tags bevat, bevat een bijbehorende betrouwbaarheidsscore. Entiteitstags worden gebruikt om overeenkomsten/affiniteit tussen entiteiten uit te drukken.
EntityWithMetadata	Entiteitsobject met tags en metagegevens.
Error	Het antwoordobject voor fouten dat wordt geretourneerd wanneer de service enkele fouten tegenkomt tijdens het verwerken van de aanvraag.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
ExtractedSummaryDocumentResult	Een gerangschikte lijst met zinnen die de geëxtraheerde samenvatting vertegenwoordigen.
ExtractedSummarySentence	Vertegenwoordigt een geëxtraheerde zinnen uit het invoerdocument.
ExtractiveSummarizationLROResult	Een object dat de resultaten vertegenwoordigt voor een extraherende samenvattingstaak.
ExtractiveSummarizationResult	Een object dat de vooraf samengestelde samenvattingsresultaten van elk document vertegenwoordigt.
HealthcareAssertion	Verklaring van de entiteit.
HealthcareEntitiesDocumentResult	Resultaatobject voor het verwerkte healthcare-document.
HealthcareEntity	Gezondheidszorgentiteit geëxtraheerd uit het document
healthcareEntityCategory	Categorie Gezondheidszorgentiteit.
HealthcareEntityLink	Verwijzing naar een entiteit in bekende gegevensbronnen.
HealthcareLROResult	Healthcare Analyze Text long tunning operation result object.
HealthcareRelation	Elke relatie is een entiteitsgrafiek van een bepaald relationType, waarbij alle entiteiten zijn verbonden en specifieke rollen hebben binnen de relationele context.
HealthcareRelationEntity	Entiteit in de relatie.
HealthcareResult	Resultaatobject voor de verwerkte gezondheidszorgtaak.
InformationMetadata	Vertegenwoordigt het metagegevensmodel van de informatie(gegevens) entiteit.
InformationUnit	De meeteenheid (gegevens).
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseExtractionLROResult	Bevat de analysetekst KeyPhraseExtraction LRO-taak.
KeyPhraseResult	Bevat de KeyPhraseResult.
KeyPhrasesDocumentResult	Bevat de resultaten van sleuteltermextractie voor een document.
LengthMetadata	Vertegenwoordigt het model voor de lengte-entiteitmetagegevens.
LengthUnit	De lengte-eenheid van de meting.
LinkedEntitiesDocumentResult	Resultaat van entiteitskoppelingsdocument.
LinkedEntity	Het LinkedEntity-object met de gedetecteerde entiteit met de bijbehorende bronnen/koppelingen.
Match	Het object Match met de gedetecteerde entiteitstekst met de offset en de lengte.
MetadataKind	Het objecttype Metagegevens van de entiteit.
NumberKind	Het type geëxtraheerde getalentiteit.
NumberMetadata	Een metagegevens voor exemplaren van numerieke entiteiten.
NumericRangeMetadata	vertegenwoordigt de metagegevens van numerieke intervallen.
OrdinalMetadata	Een metagegevens voor exemplaren van numerieke entiteiten.
PiiEntitiesDocumentResult	Bevat de PII-resultaten.
PiiEntityRecognitionLROResult	Bevat de PII LRO-resultaten.
PiiResult	Bevat de PiiResult.
RangeInclusivity	De bereikinclusiviteit van deze eigenschap.
RangeKind	Het type getalbereikentiteit.
relationType	Type relatie. Voorbeelden zijn: DosageOfMedication of 'FrequencyOfMedication', enzovoort.
RelativeTo	Het verwijzingspunt dat het rangnummer aangeeft.
RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.
SentenceAssessment	Vertegenwoordigt een zinsevaluatie en de evaluaties of doelobjecten die eraan zijn gerelateerd.
SentenceSentiment	Het zinsgevoel van een document.
SentenceSentimentValue	Het voorspelde gevoel voor de zin.
SentenceTarget	Vertegenwoordigt een zinsdoel en de evaluaties of doelobjecten die eraan zijn gerelateerd.
SentimentConfidenceScores	Vertegenwoordigt de betrouwbaarheidsscores tussen 0 en 1 voor alle sentimentklassen: positief, neutraal, negatief.
SentimentDocumentResult	Een object dat de vooraf gemaakte sentimentanalyseresultaten van elk document weergeeft.
SentimentLROResult	Bevat de LRO-resultaten van sentimentanalyse.
SentimentResponse	Resultaten van sentimentanalyse voor de invoerdocumenten.
SpeedMetadata	Vertegenwoordigt het metagegevensmodel van de snelheidsentiteit.
SpeedUnit	De snelheidseenheid van de meting
State	De status van de taak op de genoemde laatste updatetijd.
SummaryContext	De context van de samenvatting.
TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
TargetRelation	Vertegenwoordigt de relatie tussen evaluaties en/of doelen.
TargetRelationType	Het type dat is gerelateerd aan het doel.
Tasks	Container voor de taakstatus voor de LRO-taak.
TemperatureMetadata	Vertegenwoordigt het metagegevensmodel van de informatie-entiteit.
TemperatureUnit	De temperatuureenheid van de meting.
Temporality	Beschrijft tijdelijke informatie met betrekking tot de entiteit.
TemporalModifier	Een optionele wijziging van een datum/tijd-exemplaar.
TemporalSetMetadata	Een metagegevens voor exemplaren van tijdelijke set-entiteiten.
TemporalSpanMetadata	vertegenwoordigt de metagegevens van een datum en/of tijdsperiode.
TemporalSpanValues	Tijdelijk spanobject.
TimeMetadata	Een metagegevens voor tijdentiteitexemplaren.
TokenSentimentValue	Het voorspelde gevoel voor de zin.
VolumeMetadata	Vertegenwoordigt het metagegevensmodel van de volumeentiteit.
VolumeUnit	De volume-eenheid van de meting
WarningCodeValue	Hiermee definieert u de lijst met waarschuwingscodes.
WeightMetadata	Vertegenwoordigt het model voor de gewichtsentiteitsmetagegevens.
WeightUnit	De gewichtseenheid van de meting.

AbstractiveSummarizationLROResult

Object

Een object dat de resultaten weergeeft voor een abstractieve samenvattingstaak.

Name	Type	Description
kind	string: AbstractiveSummarizationLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	AbstractiveSummarizationResult	Resultaten van de taak.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

AbstractiveSummarizationResult

Object

Een object dat de vooraf samengestelde samenvattingsresultaten van elk document weergeeft.

Name	Type	Description
documents	AbstractiveSummaryDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

AbstractiveSummary

Object

Een object dat één samenvatting vertegenwoordigt met context voor een bepaald document.

Name	Type	Description
contexts	SummaryContext[]	De contextlijst van de samenvatting.
text	string	De tekst van de samenvatting.

AbstractiveSummaryDocumentResult

Object

Een object dat de vooraf samengestelde samenvattingsresultaten van elk document weergeeft.

Name	Type	Description
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
summaries	AbstractiveSummary[]	Een lijst met abstractieve samenvattingen.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

AgeMetadata

Object

Vertegenwoordigt het metagegevensmodel leeftijdsentiteit.

Name	Type	Description
metadataKind	string: AgeMetadata	Het objecttype Metagegevens van de entiteit.
unit	AgeUnit	Maateenheid voor leeftijd.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

AgeUnit

Inventarisatie

De maateenheid Leeftijd

Waarde	Description
Day	Tijdsperiode van een dag
Month	Periode van een maand
Unspecified	Niet-opgegeven tijdsperiode
Week	Periode van een week
Year	Periode van een jaar

AnalyzeTextJobState

Object

Het object met de LRO-taakstatus analyseren.

Name	Type	Description
createdDateTime	string (date-time)	Datum- en tijdtaak gemaakt
displayName	string	weergavenaam
errors	Error[]	Fouten
expirationDateTime	string (date-time)	Datum- en tijdtaak verloopt
jobId	string (uuid)	taak-id
lastUpdatedDateTime	string (date-time)	laatst bijgewerkte datum en tijd
nextLink	string	volgende koppeling
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.
status	State	status
tasks	Tasks	Lijst met taken.

AnalyzeTextLROResultsKind

Inventarisatie

Het type antwoordobject dat wordt geretourneerd door de langlopende taak analyze-text.

Waarde	Description
AbstractiveSummarizationLROResults	Abstractieve samenvatting LRO-resultaten
CustomEntityRecognitionLROResults	LRO-resultaten voor aangepaste entiteitsherkenning
CustomMultiLabelClassificationLROResults	LRO-resultaten voor aangepaste classificatie met meerdere labels
CustomSingleLabelClassificationLROResults	LRO-resultaten voor aangepaste classificatie met één label
EntityLinkingLROResults	LRO-resultaten voor entiteitskoppeling
EntityRecognitionLROResults	LRO-resultaten voor entiteitsherkenning
ExtractiveSummarizationLROResults	Extractieve samenvatting LRO-resultaten
HealthcareLROResults	LRO-resultaten gezondheidszorg
KeyPhraseExtractionLROResults	LRO-resultaten voor sleuteltermextractie
PiiEntityRecognitionLROResults	LRO-resultaten voor PII-entiteitsherkenning
SentimentAnalysisLROResults	LRO-resultaten voor sentimentanalyse

AreaMetadata

Object

Vertegenwoordigt het metagegevensmodel van de gebiedsentiteit.

Name	Type	Description
metadataKind	string: AreaMetadata	Het objecttype Metagegevens van de entiteit.
unit	AreaUnit	Maateenheid voor oppervlakte.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

AreaUnit

Inventarisatie

De maateenheid.

Waarde	Description
Acre	Oppervlakte-eenheid in hectare
SquareCentimeter	Oppervlakte-eenheid in vierkante centimeters
SquareDecameter	Oppervlakte-eenheid in vierkante decameters
SquareDecimeter	Vlakeenheid in vierkante decimeters
SquareFoot	Oppervlakte-eenheid in vierkante voet
SquareHectometer	Oppervlakte-eenheid in vierkante hectometers
SquareInch	Gebiedseenheid in vierkante inch
SquareKilometer	Oppervlakte-eenheid in vierkante kilometers
SquareMeter	Oppervlakte-eenheid in vierkante meters
SquareMile	Oppervlakte-eenheid in vierkante mijl
SquareMillimeter	Oppervlakte-eenheid in vierkante millimeters
SquareYard	Oppervlakte-eenheid op vierkante meter
Unspecified	Niet-opgegeven vlakeenheid

Association

Inventarisatie

Hierin wordt beschreven of de entiteit het onderwerp van de tekst is of als deze iemand anders beschrijft.

Waarde	Description
other	Andere koppeling
subject	Onderwerpkoppeling

Certainty

Inventarisatie

Beschrijft de entiteitszekerheid en polariteit.

Waarde	Description
negative	Negatieve zekerheid
negativePossible	Mogelijk negatieve zekerheid
neutralPossible	Mogelijk neutrale zekerheid
positive	Positieve zekerheid
positivePossible	Mogelijk positieve zekerheid

ClassificationDocumentResult

Object

Bevat het resultaat van het classificatiedocumenten voor de taak.

Name	Type	Description
class	ClassificationResult[]	Bevat de resultaten van het classificatiedocumenten voor alle documenten.
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

ClassificationResult

Object

Bevat het classificatieresultaat.

Name	Type	Description
category	string	Classificatietype.
confidenceScore	number (double)	Betrouwbaarheidsscore tussen 0 en 1 van de herkende klasse.

Conditionality

Inventarisatie

Beschrijft eventuele conditionaliteit voor de entiteit.

Waarde	Description
conditional	Voorwaardelijke conditionaliteit
hypothetical	Hypothetische conditionaliteit

CurrencyMetadata

Object

Vertegenwoordigt het valuta)-entiteitsmetagegevensmodel.

Name	Type	Description
iso4217	string	De alfabetische code op basis van een andere ISO-standaard, ISO 3166, waarin de codes voor landnamen worden vermeld. De eerste twee letters van de ISO 4217 drieletterige code zijn hetzelfde als de code voor de landnaam, en, indien mogelijk, komt de derde letter overeen met de eerste letter van de valutanaam.
metadataKind	string: CurrencyMetadata	Het objecttype Metagegevens van de entiteit.
unit	string	Valuta-eenheid.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

CustomEntitiesResult

Object

Bevat de lijst met gedetecteerde aangepaste entiteiten voor de documenten.

Name	Type	Description
deploymentName	string	Dit veld geeft de implementatienaam voor het model aan.
documents	EntitiesDocumentResult[]	Opsomming van de documentresultaten.
errors	DocumentError[]	Fouten per document-id.
projectName	string	Dit veld geeft de projectnaam voor het model aan.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

CustomEntityRecognitionLROResult

Object

Bevat het resultaat van de aangepaste entiteitsherkenningstaak.

Name	Type	Description
kind	string: CustomEntityRecognitionLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	CustomEntitiesResult	Lijst met resultaten.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

CustomLabelClassificationResult

Object

Bevat de resultaten van de classificatie van aangepaste labels.

Name	Type	Description
deploymentName	string	Dit veld geeft de implementatienaam voor het model aan.
documents	ClassificationDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
projectName	string	Dit veld geeft de projectnaam voor het model aan.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

CustomMultiLabelClassificationLROResult

Object

Bevat het resultaat van de aangepaste classificatietaak voor meerdere labels.

Name	Type	Description
kind	string: CustomMultiLabelClassificationLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	CustomLabelClassificationResult	Lijst met resultaten.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

CustomSingleLabelClassificationLROResult

Object

Bevat het resultaat van de aangepaste classificatietaak voor één label.

Name	Type	Description
kind	string: CustomSingleLabelClassificationLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	CustomLabelClassificationResult	Lijst met resultaten.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

DateMetadata

Object

Een metagegevens voor datumentiteitexemplaren.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: DateMetadata	Het objecttype Metagegevens van de entiteit.

DateTimeMetadata

Object

Een metagegevens voor exemplaren van datum/tijd-entiteiten.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: DateTimeMetadata	Het objecttype Metagegevens van de entiteit.

DateValue

Object

Vertegenwoordigt de datumwaarde.

Name	Type	Description
modifier	TemporalModifier	Wijzigingsfunctie voor datum/tijd om een verwijzingspunt aan te geven, zoals voorheen, na, enzovoort.
timex	string	Een uitgebreide ISO 8601-datum-/tijdweergave zoals beschreven in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	De werkelijke tijd die de geëxtraheerde tekst aangeeft.

DocumentError

Object

Bevat details van fouten die zijn opgetreden tijdens het uitvoeren van een taak.

Name	Type	Description
error	Error	Er is een fout opgetreden.
id	string	De id van het invoerdocument.

DocumentSentimentValue

Inventarisatie

Voorspeld sentiment voor document (negatief, neutraal, positief of gemengd).

Waarde	Description
mixed	Gemengde instructie
negative	Negatieve instructie
neutral	Neutrale instructie
positive	Positieve verklaring

DocumentStatistics

Object

als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.

Name	Type	Description
charactersCount	integer (int32)	Het aantal tekstelementen dat in het document wordt herkend.
transactionsCount	integer (int32)	Aantal transacties voor het document.

DocumentWarning

Object

Bevat het waarschuwingsobject met waarschuwingen die zijn aangetroffen voor het verwerkte document.

Name	Type	Description
code	WarningCodeValue	Waarschuwingscode.
message	string	Waarschuwingsbericht.
targetRef	string	Een JSON-aanwijzerverwijzing die het doelobject aangeeft.

EntitiesDocumentResult

Object

Bevat het resultaat van de entiteitsherkenningstaak voor het document.

Name	Type	Description
entities	Entity[]	Herkende entiteiten in het document.
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

EntitiesDocumentResultWithMetadata

Object

Resultaat entiteitsdocumenten met metagegevens.

Name	Type	Description
entities	EntityWithMetadata[]	Herkende entiteiten in het document.
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

EntitiesResult

Object

Bevat het resultaat van de entiteitsherkenningstaak.

Name	Type	Description
documents	EntitiesDocumentResultWithMetadata[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

Entity

Object

Hiermee definieert u het gedetecteerde entiteitsobject met de entiteitscategorie en de gedetecteerde entiteitstekst, enzovoort.

Name	Type	Description
category	string	Entiteitstype.
confidenceScore	number (double)	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer (int32)	Lengte voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de geretourneerde lengte.
offset	integer (int32)	Beginpositie voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de offset die wordt geretourneerd.
subcategory	string	(Optioneel) Subtype entiteit.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.

EntityLinkingLROResult

Object

Bevat het LRO-resultaat van de entiteitskoppelingstaak analyseren.

Name	Type	Description
kind	string: EntityLinkingLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	EntityLinkingResult	Resultaat entiteitskoppeling.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

EntityLinkingResult

Object

Resultaat entiteitskoppeling.

Name	Type	Description
documents	LinkedEntitiesDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

EntityRecognitionLROResult

Object

Bevat het taakresultaat voor entiteitsherkenningstaak.

Name	Type	Description
kind	string: EntityRecognitionLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	EntitiesResult	Resultaten voor de taak.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

EntityTag

Object

Entiteitstagobject dat de naam van de tags bevat, bevat een bijbehorende betrouwbaarheidsscore. Entiteitstags worden gebruikt om overeenkomsten/affiniteit tussen entiteiten uit te drukken.

Name	Type	Description
confidenceScore	number (double)	Detectiescore tussen 0 en 1 van de geëxtraheerde entiteit.
name	string	Naam van de tag. Namen van entiteitstags zijn wereldwijd uniek.

EntityWithMetadata

Object

Entiteitsobject met tags en metagegevens.

Name	Type	Description
category	string	Entiteitstype.
confidenceScore	number (double)	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer (int32)	Lengte voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de geretourneerde lengte.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Het object voor entiteitmetagegevens.
offset	integer (int32)	Beginpositie voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de offset die wordt geretourneerd.
subcategory	string	(Optioneel) Subtype entiteit.
tags	EntityTag[]	Lijst met entiteitstags. Tags zijn bedoeld om overeenkomsten/affiniteit tussen entiteiten uit te drukken.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.
type	string	Een entiteitstype is de laagste (of beste) granulariteit waarmee de entiteit is gedetecteerd. Het type wordt toegewezen aan de specifieke metagegevenskenmerken die zijn gekoppeld aan de gedetecteerde entiteit.

Error

Object

Het antwoordobject voor fouten dat wordt geretourneerd wanneer de service enkele fouten tegenkomt tijdens het verwerken van de aanvraag.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexlimiet bereikt fout
AzureCognitiveSearchIndexNotFound	Fout bij azure Cognitive Search-index is niet gevonden
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
Conflict	Conflictfout
Forbidden	Fout bij verboden toegang
InternalServerError	Interne serverfout
InvalidArgument	Ongeldig argumentfout
InvalidRequest	Ongeldige aanvraagfout
NotFound	Fout niet gevonden
OperationNotFound	Fout bij bewerking niet gevonden
ProjectNotFound	De fout Project is niet gevonden
QuotaExceeded	Fout over overschreden quotum
ServiceUnavailable	Fout over niet-beschikbaar service
Timeout	Time-outfout
TooManyRequests	Fout bij te veel aanvragen
Unauthorized	Fout bij onbevoegde toegang
Warning	Waarschuwingsfout

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

ExtractedSummaryDocumentResult

Object

Een gerangschikte lijst met zinnen die de geëxtraheerde samenvatting vertegenwoordigen.

Name	Type	Description
id	string	Unieke, niet-lege document-id.
sentences	ExtractedSummarySentence[]	Hiermee geeft u de geëxtraheerde zinnen uit het invoerdocument op.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

ExtractedSummarySentence

Object

Vertegenwoordigt een geëxtraheerde zinnen uit het invoerdocument.

Name	Type	Description
length	integer (int32)	De lengte van de zin.
offset	integer (int32)	De zin wordt verschoven van het begin van het document, op basis van de waarde van de parameter StringIndexType.
rankScore	number (double)	Een dubbele waarde die de relevantie van de zin in de samenvatting aangeeft. Hogere waarden geven een hogere urgentie aan.
text	string	De geëxtraheerde zintekst.

ExtractiveSummarizationLROResult

Object

Een object dat de resultaten vertegenwoordigt voor een extraherende samenvattingstaak.

Name	Type	Description
kind	string: ExtractiveSummarizationLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	ExtractiveSummarizationResult	Resultaten van de taak.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

ExtractiveSummarizationResult

Object

Een object dat de vooraf samengestelde samenvattingsresultaten van elk document vertegenwoordigt.

Name	Type	Description
documents	ExtractedSummaryDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

HealthcareAssertion

Object

Verklaring van de entiteit.

Name	Type	Description
association	Association	Hierin wordt beschreven of de entiteit het onderwerp van de tekst is of als deze iemand anders beschrijft.
certainty	Certainty	Beschrijft de entiteitszekerheid en polariteit.
conditionality	Conditionality	Beschrijft eventuele conditionaliteit voor de entiteit.
temporality	Temporality	Beschrijft tijdelijke informatie met betrekking tot de entiteit.

HealthcareEntitiesDocumentResult

Object

Resultaatobject voor het verwerkte healthcare-document.

Name	Type	Description
entities	HealthcareEntity[]	Gezondheidszorgentiteiten.
fhirBundle	FhirBundle	JSON-bundel met een FHIR-compatibel object voor verbruik in andere hulpprogramma's voor gezondheidszorg. Zie https://www.hl7.org/fhir/overview.htmlvoor meer informatie.
id	string	Unieke, niet-lege document-id.
relations	HealthcareRelation[]	Relaties tussen gezondheidszorgentiteiten.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

HealthcareEntity

Object

Gezondheidszorgentiteit geëxtraheerd uit het document

Name	Type	Description
assertion	HealthcareAssertion	Verklaring van de entiteit.
category	healthcareEntityCategory	Categorie Gezondheidszorgentiteit.
confidenceScore	number (double)	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer (int32)	Lengte voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de geretourneerde lengte.
links	HealthcareEntityLink[]	Entiteitsverwijzingen in bekende gegevensbronnen.
name	string	Voorkeursnaam voor de entiteit. Voorbeeld: 'histologisch' zou een 'naam' van 'histologic' hebben.
offset	integer (int32)	Beginpositie voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de offset die wordt geretourneerd.
subcategory	string	(Optioneel) Subtype entiteit.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.

healthcareEntityCategory

Inventarisatie

Categorie Gezondheidszorgentiteit.

Waarde	Description
AdministrativeEvent	Beheer gebeurtenis
Age	Leeftijd
Allergen	Allergeen
BodyStructure	Hoofdtekststructuur
CareEnvironment	Zorgomgeving
ConditionQualifier	Kwalificatie van voorwaarde
ConditionScale	Voorwaardeschaal
Course	Cursus
Date	Datum
Diagnosis	Diagnose
Direction	Richting
Dosage	Dosering
Employment	Werkgelegenheid
Ethnicity	Etniciteit
ExaminationName	Naam van onderzoek
Expression	Uitdrukking
FamilyRelation	Familierelatie
Frequency	Frequentie
Gender	Geslacht
GeneOrProtein	Gen of eiwit
HealthcareProfession	Beroep gezondheidszorg
LivingStatus	Levende status
MeasurementUnit	Maateenheid
MeasurementValue	Meetwaarde
MedicationClass	Medicatieklasse
MedicationForm	Medicatieformulier
MedicationName	Naam van medicatie
MedicationRoute	Medicatieroute
MutationType	Mutatietype
RelationalOperator	Relationele operator
SubstanceUse	Stofgebruik
SubstanceUseAmount	Hoeveelheid stofgebruik
SymptomOrSign	Symptoom of teken
Time	Tijd
TreatmentName	Behandelingsnaam
Variant	Variant

HealthcareEntityLink

Object

Verwijzing naar een entiteit in bekende gegevensbronnen.

Name	Type	Description
dataSource	string	Entiteitscatalogus. Voorbeelden zijn: UMLS, CHV, MSH, enzovoort.
id	string	Entiteits-id in de opgegeven broncatalogus.

HealthcareLROResult

Object

Healthcare Analyze Text long tunning operation result object.

Name	Type	Description
kind	string: HealthcareLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	HealthcareResult	Resultaten van de taak.
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

HealthcareRelation

Object

Elke relatie is een entiteitsgrafiek van een bepaald relationType, waarbij alle entiteiten zijn verbonden en specifieke rollen hebben binnen de relationele context.

Name	Type	Description
confidenceScore	number (double)	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde relatie.
entities	HealthcareRelationEntity[]	De entiteiten in de relatie.
relationType	relationType	Type relatie. Voorbeelden zijn: DosageOfMedication of 'FrequencyOfMedication', enzovoort.

HealthcareRelationEntity

Object

Entiteit in de relatie.

Name	Type	Description
ref	string	Referentiekoppelingsobject met behulp van een JSON-aanwijzer RFC 6901 (URI Fragment Identifier Representation), die verwijst naar de entiteit.
role	string	Rol van entiteit in de relatie. Bijvoorbeeld: 'CD20-positieve grote B-cellymfoom' heeft de volgende entiteiten met hun rollen tussen haakjes: CD20 (GeneOrProtein), Positief (Expressie), diffuse grote B-cellymfoom (Diagnose).

HealthcareResult

Object

Resultaatobject voor de verwerkte gezondheidszorgtaak.

Name	Type	Description
documents	HealthcareEntitiesDocumentResult[]	Lijst met resultaatobjecten voor de verwerkte healthcare-documenten.
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

InformationMetadata

Object

Vertegenwoordigt het metagegevensmodel van de informatie(gegevens) entiteit.

Name	Type	Description
metadataKind	string: InformationMetadata	Het objecttype Metagegevens van de entiteit.
unit	InformationUnit	Maateenheid voor informatie.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

InformationUnit

Inventarisatie

De meeteenheid (gegevens).

Waarde	Description
Bit	Gegevensgrootte-eenheid in bits
Byte	Gegevensgrootte-eenheid in bytes
Gigabit	Gegevensgrootte-eenheid in gigabits
Gigabyte	Gegevensgrootte-eenheid in gigabytes
Kilobit	Gegevensgrootte-eenheid in kilobits
Kilobyte	Gegevensgrootte-eenheid in kilobytes
Megabit	Gegevensgrootte-eenheid in megabits
Megabyte	Gegevensgrootte-eenheid in megabytes
Petabit	Gegevensgrootte-eenheid in petabits
Petabyte	Gegevensgrootte-eenheid in petabytes
Terabit	Gegevensgrootte-eenheid in terabits
Terabyte	Gegevensgrootte-eenheid in terabytes
Unspecified	Niet-opgegeven gegevensgrootte-eenheid

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
EmptyRequest	Fout bij lege aanvraag
ExtractionFailure	Fout bij extractiefout
InvalidCountryHint	Fout met ongeldige landhint
InvalidDocument	Ongeldige documentfout
InvalidDocumentBatch	Ongeldige documentbatchfout
InvalidParameterValue	Fout met ongeldige parameterwaarde
InvalidRequest	Ongeldige aanvraagfout
InvalidRequestBodyFormat	Fout bij ongeldige indeling van aanvraagtekst
KnowledgeBaseNotFound	Fout in Knowledge Base is niet gevonden
MissingInputDocuments	Fout bij ontbrekende invoerdocumenten
ModelVersionIncorrect	Fout bij onjuiste modelversie
UnsupportedLanguageCode	Fout met niet-ondersteunde taalcode

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

KeyPhraseExtractionLROResult

Object

Bevat de analysetekst KeyPhraseExtraction LRO-taak.

Name	Type	Description
kind	string: KeyPhraseExtractionLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	KeyPhraseResult	De lijst met resultaten van sleuteltermextractie
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

KeyPhraseResult

Object

Bevat de KeyPhraseResult.

Name	Type	Description
documents	KeyPhrasesDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

KeyPhrasesDocumentResult

Object

Bevat de resultaten van sleuteltermextractie voor een document.

Name	Type	Description
id	string	Unieke, niet-lege document-id.
keyPhrases	string[]	Een lijst met representatieve woorden of woordgroepen. Het aantal geretourneerde sleuteltermen is evenredig met het aantal woorden in het invoerdocument.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

LengthMetadata

Object

Vertegenwoordigt het model voor de lengte-entiteitmetagegevens.

Name	Type	Description
metadataKind	string: LengthMetadata	Het objecttype Metagegevens van de entiteit.
unit	LengthUnit	Maateenheid voor lengte.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

LengthUnit

Inventarisatie

De lengte-eenheid van de meting.

Waarde	Description
Centimeter	Lengteeenheid in centimeters.
Decameter	Lengteeenheid in decameters.
Decimeter	Lengteeenheid in decimeters.
Foot	Lengteeenheid in voeten.
Hectometer	Lengteeenheid in hectometers.
Inch	Lengteeenheid in inches.
Kilometer	Lengteeenheid in kilometers.
LightYear	Lengteeenheid in lichtjaren.
Meter	Lengteeenheid in meters.
Micrometer	Lengteeenheid in micrometers.
Mile	Lengte eenheid in mijlen.
Millimeter	Lengteeenheid in millimeters.
Nanometer	Lengteeenheid in nanometers.
Picometer	Lengteeenheid in picometers.
Point	Lengteeenheid in punten.
Unspecified	Niet-opgegeven lengteeenheid.
Yard	Lengte-eenheid in meter.

LinkedEntitiesDocumentResult

Object

Resultaat van entiteitskoppelingsdocument.

Name	Type	Description
entities	LinkedEntity[]	Bekende entiteiten in het document worden herkend.
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

LinkedEntity

Object

Het LinkedEntity-object met de gedetecteerde entiteit met de bijbehorende bronnen/koppelingen.

Name	Type	Description
bingId	string	Unieke id van de herkende entiteit in de Bing Entiteiten zoeken-API.
dataSource	string	Gegevensbron die wordt gebruikt voor het extraheren van entiteitskoppelingen, zoals Wiki/Bing, enzovoort.
id	string	Unieke id van de herkende entiteit uit de gegevensbron.
language	string	Taal die wordt gebruikt in de gegevensbron.
matches	Match[]	Lijst met exemplaren van deze entiteit wordt weergegeven in de tekst.
name	string	Formele naam van Entity Linking.
url	string	URL voor de pagina van de entiteit uit de gegevensbron.

Match

Object

Het object Match met de gedetecteerde entiteitstekst met de offset en de lengte.

Name	Type	Description
confidenceScore	number (double)	Als een bekend item wordt herkend, wordt een decimaal getal dat het betrouwbaarheidsniveau tussen 0 en 1 aangeeft, geretourneerd.
length	integer (int32)	Lengte voor de entiteitovereenkomsttekst.
offset	integer (int32)	Beginpositie voor de entiteitovereenkomsttekst.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.

MetadataKind

Inventarisatie

Het objecttype Metagegevens van de entiteit.

Waarde	Description
AgeMetadata	Metagegevens voor leeftijdsgerelateerde waarden.
AreaMetadata	Metagegevens voor gebiedsgerelateerde waarden.
CurrencyMetadata	Metagegevens voor valutagerelateerde waarden.
DateMetadata	Metagegevens voor datumgerelateerde waarden.
DateTimeMetadata	Metagegevens voor datum- en tijdgerelateerde waarden.
InformationMetadata	Metagegevens voor informatiegerelateerde waarden.
LengthMetadata	Metagegevens voor lengtegerelateerde waarden.
NumberMetadata	Metagegevens voor numerieke waarden.
NumericRangeMetadata	Metagegevens voor numerieke bereikwaarden.
OrdinalMetadata	Metagegevens voor rangtelnummers.
SpeedMetadata	Metagegevens voor snelheidsgerelateerde waarden.
TemperatureMetadata	Metagegevens voor temperatuurgerelateerde waarden.
TemporalSetMetadata	Metagegevens voor set tijdgerelateerde waarden.
TemporalSpanMetadata	Metagegevens voor tijdelijke spanwaarden.
TimeMetadata	Metagegevens voor tijdgerelateerde waarden.
VolumeMetadata	Metagegevens voor volumegerelateerde waarden.
WeightMetadata	Metagegevens voor gewichtsgerelateerde waarden.

NumberKind

Inventarisatie

Het type geëxtraheerde getalentiteit.

Waarde	Description
Decimal	Decimaal getal
Fraction	Breuknummer
Integer	Geheel getal
Percent	Percentagenummer
Power	Machtsnummer
Unspecified	Niet-opgegeven soort getallen

NumberMetadata

Object

Een metagegevens voor exemplaren van numerieke entiteiten.

Name	Type	Description
metadataKind	string: NumberMetadata	Het objecttype Metagegevens van de entiteit.
numberKind	NumberKind	Soort van het getaltype.
value	number (double)	Een numerieke weergave van wat de geëxtraheerde tekst aangeeft.

NumericRangeMetadata

Object

vertegenwoordigt de metagegevens van numerieke intervallen.

Name	Type	Description
maximum	number (double)	De eindwaarde van het interval.
metadataKind	string: NumericRangeMetadata	Het objecttype Metagegevens van de entiteit.
minimum	number (double)	De beginwaarde van het interval.
rangeInclusivity	RangeInclusivity	De inclusiefheid van dit bereik.
rangeKind	RangeKind	Soort numerieke bereiken die worden ondersteund, zoals Getal, Snelheid, enzovoort.

OrdinalMetadata

Object

Een metagegevens voor exemplaren van numerieke entiteiten.

Name	Type	Description
metadataKind	string: OrdinalMetadata	Het objecttype Metagegevens van de entiteit.
offset	string	De offset met betrekking tot de verwijzing (bijvoorbeeld offset = -1 geeft de tweede tot laatste aan)
relativeTo	RelativeTo	Het verwijzingspunt dat het rangnummer aangeeft.
value	string	Een eenvoudige rekenkundige expressie die de rangtelwoorden aangeeft.

PiiEntitiesDocumentResult

Object

Bevat de PII-resultaten.

Name	Type	Description
entities	Entity[]	Herkende entiteiten in het document.
id	string	Unieke, niet-lege document-id.
redactedText	string	Retourneert redacted text.
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

PiiEntityRecognitionLROResult

Object

Bevat de PII LRO-resultaten.

Name	Type	Description
kind	string: PiiEntityRecognitionLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	PiiResult	De lijst met pii-resultaten
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

PiiResult

Object

Bevat de PiiResult.

Name	Type	Description
documents	PiiEntitiesDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

RangeInclusivity

Inventarisatie

De bereikinclusiviteit van deze eigenschap.

Waarde	Description
LeftInclusive	Inclusief links
LeftRightInclusive	Beide zijden inclusief
NoneInclusive	Geen inclusiviteit
RightInclusive	Inclusief rechts

RangeKind

Inventarisatie

Het type getalbereikentiteit.

Waarde	Description
Age	Leeftijdsbereik
Area	Gebiedsbereik
Currency	Valutabereik
Information	Informatiebereik
Length	Lengtebereik
Number	Getalbereik
Speed	Snelheidsbereik
Temperature	Temperatuurbereik
Volume	Volumebereik
Weight	Gewichtsbereik

relationType

Inventarisatie

Type relatie. Voorbeelden zijn: DosageOfMedication of 'FrequencyOfMedication', enzovoort.

Waarde	Description
Abbreviation	Afkorting
BodySiteOfCondition	Hoofdtekstsite van voorwaarde
BodySiteOfTreatment	Lichaamsplaats van behandeling
CourseOfCondition	Verloop van voorwaarde
CourseOfExamination	Cursus examen
CourseOfMedication	Cursus medicatie
CourseOfTreatment	Behandeling
DirectionOfBodyStructure	Richting van lichaamsstructuur
DirectionOfCondition	Richting van voorwaarde
DirectionOfExamination	Richting van onderzoek
DirectionOfTreatment	Richting van behandeling
DosageOfMedication	Dosering van medicatie
ExaminationFindsCondition	Onderzoek vindt voorwaarde
ExpressionOfGene	Expressie van gen
ExpressionOfVariant	Expressie van variant
FormOfMedication	Vorm van medicatie
FrequencyOfCondition	Frequentie van voorwaarde
FrequencyOfMedication	Frequentie van medicatie
FrequencyOfTreatment	Frequentie van behandeling
MutationTypeOfGene	Mutatietype gen
MutationTypeOfVariant	Mutatietype variant
QualifierOfCondition	Kwalificatie van voorwaarde
RelationOfExamination	Relatie van onderzoek
RouteOfMedication	Route van medicatie
ScaleOfCondition	Schaal van voorwaarde
TimeOfCondition	Tijd van voorwaarde
TimeOfEvent	Tijdstip van gebeurtenis
TimeOfExamination	Tijdstip van onderzoek
TimeOfMedication	Tijd van medicatie
TimeOfTreatment	Tijdstip van behandeling
UnitOfCondition	Eenheid van voorwaarde
UnitOfExamination	Exameneenheid
ValueOfCondition	Waarde van voorwaarde
ValueOfExamination	Waarde van onderzoek
VariantOfGene	Variant van gen

RelativeTo

Inventarisatie

Het verwijzingspunt dat het rangnummer aangeeft.

Waarde	Description
Current	Huidige status of positie
End	Eindstatus of -positie
Start	Beginstatus of -positie

RequestStatistics

Object

als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

Name	Type	Description
documentsCount	integer (int32)	Het aantal documenten dat in de aanvraag is ingediend.
erroneousDocumentsCount	integer (int32)	Aantal ongeldige documenten. Dit omvat lege, te grote limieten of niet-ondersteunde talendocumenten.
transactionsCount	integer (int64)	Aantal transacties voor de aanvraag.
validDocumentsCount	integer (int32)	Aantal geldige documenten. Dit sluit lege, te grote limieten of niet-ondersteunde talendocumenten uit.

SentenceAssessment

Object

Vertegenwoordigt een zinsevaluatie en de evaluaties of doelobjecten die eraan zijn gerelateerd.

Name	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
isNegated	boolean	De indicator die aangeeft of de evaluatie wordt ontkend.
length	integer (int32)	De lengte van het doel.
offset	integer (int32)	Het doel wordt verschoven vanaf het begin van de zin.
sentiment	TokenSentimentValue	Het gevoel van de zin.
text	string	De doeltekst gedetecteerd.

SentenceSentiment

Object

Het zinsgevoel van een document.

Name	Type	Description
assessments	SentenceAssessment[]	De matrix van evaluaties voor de zin.
confidenceScores	SentimentConfidenceScores	De betrouwbaarheidsscore van het gevoel tussen 0 en 1 voor de zin voor alle klassen.
length	integer (int32)	De lengte van het doel.
offset	integer (int32)	Het doel wordt verschoven vanaf het begin van de zin.
sentiment	SentenceSentimentValue	Het voorspelde gevoel voor de zin.
targets	SentenceTarget[]	De matrix met zinsdoelen voor de zin.
text	string	De zintekst.

SentenceSentimentValue

Inventarisatie

Het voorspelde gevoel voor de zin.

Waarde	Description
negative	Negatief gevoel
neutral	Neutraal gevoel
positive	Positief gevoel

SentenceTarget

Object

Vertegenwoordigt een zinsdoel en de evaluaties of doelobjecten die eraan zijn gerelateerd.

Name	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
length	integer (int32)	De lengte van het doel.
offset	integer (int32)	Het doel wordt verschoven vanaf het begin van de zin.
relations	TargetRelation[]	De matrix van evaluatie- of doelobjecten die zijn gerelateerd aan het doel.
sentiment	TokenSentimentValue	Het gevoel van de zin.
text	string	De doeltekst gedetecteerd.

SentimentConfidenceScores

Object

Vertegenwoordigt de betrouwbaarheidsscores tussen 0 en 1 voor alle sentimentklassen: positief, neutraal, negatief.

Name	Type	Description
negative	number (double)	Betrouwbaarheidsscore voor negatief gevoel
neutral	number (double)	Betrouwbaarheidsscore voor neutraal sentiment
positive	number (double)	Betrouwbaarheidsscore voor positief gevoel

SentimentDocumentResult

Object

Een object dat de vooraf gemaakte sentimentanalyseresultaten van elk document weergeeft.

Name	Type	Description
confidenceScores	SentimentConfidenceScores	De betrouwbaarheidsscore van het gevoel tussen 0 en 1 voor de zin voor alle klassen.
id	string	Unieke, niet-lege document-id.
sentences	SentenceSentiment[]	Het gevoel van zinnen van het document.
sentiment	DocumentSentimentValue	Voorspeld sentiment voor document (negatief, neutraal, positief of gemengd).
statistics	DocumentStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

SentimentLROResult

Object

Bevat de LRO-resultaten van sentimentanalyse.

Name	Type	Description
kind	string: SentimentAnalysisLROResults	Soort taak.
lastUpdateDateTime	string (date-time)	De laatst bijgewerkte tijd in UTC voor de taak.
results	SentimentResponse	De resultaten van sentimentanalyse
status	State	De status van de taak op de genoemde laatste updatetijd.
taskName	string	taaknaam

SentimentResponse

Object

Resultaten van sentimentanalyse voor de invoerdocumenten.

Name	Type	Description
documents	SentimentDocumentResult[]	De resultaten van sentimentanalyse voor elk document in de invoer.
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

SpeedMetadata

Object

Vertegenwoordigt het metagegevensmodel van de snelheidsentiteit.

Name	Type	Description
metadataKind	string: SpeedMetadata	Het objecttype Metagegevens van de entiteit.
unit	SpeedUnit	Maateenheid voor snelheid.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

SpeedUnit

Inventarisatie

De snelheidseenheid van de meting

Waarde	Description
CentimetersPerMillisecond	Snelheidseenheid in centimeters per milliseconde.
FeetPerMinute	Snelheidseenheid in voet per minuut.
FeetPerSecond	Snelheidseenheid in voet per seconde.
KilometersPerHour	Snelheidseenheid in kilometers per uur.
KilometersPerMillisecond	Snelheidseenheid in kilometers per milliseconde.
KilometersPerMinute	Snelheidseenheid in kilometers per minuut.
KilometersPerSecond	Snelheidseenheid in kilometers per seconde.
Knots	Snelheidseenheid in knopen.
MetersPerMillisecond	Snelheidseenheid in meters per milliseconde.
MetersPerSecond	Snelheidseenheid in meters per seconde.
MilesPerHour	Snelheidseenheid in mijlen per uur.
Unspecified	Niet-opgegeven snelheidseenheid.
YardsPerMinute	Snelheidseenheid in meter per minuut.
YardsPerSecond	Snelheidseenheid in meter per seconde.

State

Inventarisatie

De status van de taak op de genoemde laatste updatetijd.

Waarde	Description
cancelled	Geannuleerde status
cancelling	Status annuleren
failed	Mislukte status
notStarted	Status niet gestart
partiallyCompleted	Gedeeltelijk voltooide status
running	Status wordt uitgevoerd
succeeded	Geslaagde status

SummaryContext

Object

De context van de samenvatting.

Name	Type	Description
length	integer (int32)	De lengte van de context. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de geretourneerde lengte.
offset	integer (int32)	Beginpositie voor de context. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de offset die wordt geretourneerd.

TargetConfidenceScoreLabel

Object

Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.

Name	Type	Description
negative	number (double)	Betrouwbaarheidsscore voor negatief gevoel
positive	number (double)	Betrouwbaarheidsscore voor positief gevoel

TargetRelation

Object

Vertegenwoordigt de relatie tussen evaluaties en/of doelen.

Name	Type	Description
ref	string	De JSON-aanwijzer die het gekoppelde object aangeeft.
relationType	TargetRelationType	Het type dat is gerelateerd aan het doel.

TargetRelationType

Inventarisatie

Het type dat is gerelateerd aan het doel.

Waarde	Description
assessment	Beoordelingsrelatie.
target	Doelrelatie.

Tasks

Object

Container voor de taakstatus voor de LRO-taak.

Name	Type	Description
completed	integer (int32)	Aantal voltooide taken.
failed	integer (int32)	Aantal mislukte taken.
inProgress	integer (int32)	Het aantal inkomende taken.
items	AnalyzeTextLROResult[]: AbstractiveSummarizationLROResult[] CustomEntityRecognitionLROResult[] CustomMultiLabelClassificationLROResult[] CustomSingleLabelClassificationLROResult[] EntityLinkingLROResult[] EntityRecognitionLROResult[] ExtractiveSummarizationLROResult[] HealthcareLROResult[] KeyPhraseExtractionLROResult[] PiiEntityRecognitionLROResult[] SentimentLROResult[]	Enumerable of Analyze text job results.
total	integer (int32)	Het aantal totale taken.

TemperatureMetadata

Object

Vertegenwoordigt het metagegevensmodel van de informatie-entiteit.

Name	Type	Description
metadataKind	string: TemperatureMetadata	Het objecttype Metagegevens van de entiteit.
unit	TemperatureUnit	Maateenheid voor temperatuur.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

TemperatureUnit

Inventarisatie

De temperatuureenheid van de meting.

Waarde	Description
Celsius	Temperatuureenheid in Celsius
Fahrenheit	Temperatuureenheid in Fahrenheit
Kelvin	Temperatuureenheid in Kelvin
Rankine	Temperatuureenheid in Rankine
Unspecified	Niet-opgegeven temperatuureenheid

Temporality

Inventarisatie

Beschrijft tijdelijke informatie met betrekking tot de entiteit.

Waarde	Description
current	Huidige tijdelijkheid
future	Toekomstige tijdelijkheid
past	Eerdere tijdelijkheid

TemporalModifier

Inventarisatie

Een optionele wijziging van een datum/tijd-exemplaar.

Waarde	Description
After	Na een specifieke tijd
AfterApprox	Na een geschatte tijd
AfterMid	Na het midden van een periode
AfterStart	Na het begin van een periode
Approx	Ongeveer op een bepaald tijdstip
Before	Voor een specifieke tijd
BeforeApprox	Voor een geschatte tijd
BeforeEnd	Vóór het einde van een periode
BeforeStart	Vóór het begin van een periode
End	Aan het einde van een periode
Less	Minder dan een specifieke tijd
Mid	Midden in een periode
More	Meer dan een specifieke tijd
ReferenceUndefined	Verwijzing naar een niet-gedefinieerde tijd
Since	Sinds een specifieke tijd
SinceEnd	Sinds het einde van een periode
Start	Aan het begin van een periode
Until	Tot een specifieke tijd

TemporalSetMetadata

Object

Een metagegevens voor exemplaren van tijdelijke set-entiteiten.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: TemporalSetMetadata	Het objecttype Metagegevens van de entiteit.

TemporalSpanMetadata

Object

vertegenwoordigt de metagegevens van een datum en/of tijdsperiode.

Name	Type	Description
metadataKind	string: TemporalSpanMetadata	Het objecttype Metagegevens van de entiteit.
spanValues	TemporalSpanValues[]	Lijst met gedetecteerde tijdelijke periodes.

TemporalSpanValues

Object

Tijdelijk spanobject.

Name	Type	Description
begin	string	Beginwaarde voor de periode.
duration	string	Een optionele duurwaarde die is opgemaakt op basis van de ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Eindwaarde voor de periode.
modifier	TemporalModifier	Wijzigingsfunctie voor datum/tijd om een verwijzingspunt aan te geven, zoals voorheen, na, enzovoort.
timex	string	Een optionele triplet met het begin, het einde en de duur die allemaal als ISO 8601 opgemaakte tekenreeksen zijn opgegeven.

TimeMetadata

Object

Een metagegevens voor tijdentiteitexemplaren.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: TimeMetadata	Het objecttype Metagegevens van de entiteit.

TokenSentimentValue

Inventarisatie

Het voorspelde gevoel voor de zin.

Waarde	Description
mixed	Gemengde sentimenten
negative	Negatief gevoel
positive	Positief gevoel

VolumeMetadata

Object

Vertegenwoordigt het metagegevensmodel van de volumeentiteit.

Name	Type	Description
metadataKind	string: VolumeMetadata	Het objecttype Metagegevens van de entiteit.
unit	VolumeUnit	Maateenheid voor volume.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

VolumeUnit

Inventarisatie

De volume-eenheid van de meting

Waarde	Description
Barrel	Volumeeenheid in vaten.
Bushel	Volumeeenheid in bushels.
Centiliter	Volumeeenheid in centiliters.
Cord	Volumeeenheid in koorden.
CubicCentimeter	Volumeeenheid in kubieke centimeters.
CubicFoot	Volumeeenheid in kubieke voeten.
CubicInch	Volumeeenheid in kubieke inch.
CubicMeter	Volumeeenheid in kubieke meters.
CubicMile	Volumeeenheid in kubieke mijlen.
CubicMillimeter	Volumeeenheid in kubieke millimeters.
CubicYard	Volumeeenheid in kubieke meter.
Cup	Volumeeenheid in kopjes.
Decaliter	Volumeeenheid in decaliters.
FluidDram	Volumeeenheid in vloeistofdrams.
FluidOunce	Volumeeenheid in vloeistof ounces.
Gill	Volumeeenheid in kieuwen.
Hectoliter	Volumeeenheid in hectoliters.
Hogshead	Volumeeenheid in hogsheads.
Liter	Volumeeenheid in liter.
Milliliter	Volumeeenheid in milliliters.
Minim	Volumeeenheid in minims.
Peck	Volumeeenheid in pecks.
Pinch	Volumeeenheid in knijpen.
Pint	Volumeeenheid in pints.
Quart	Volumeeenheid in kwartielen.
Tablespoon	Volumeeenheid in eetlepels.
Teaspoon	Volumeeenheid in theelepels.
Unspecified	Niet-opgegeven volumeeenheid.

WarningCodeValue

Inventarisatie

Hiermee definieert u de lijst met waarschuwingscodes.

Waarde	Description
DocumentTruncated	Waarschuwing over afgekapt document
LongWordsInDocument	Lange woorden in documentwaarschuwing

WeightMetadata

Object

Vertegenwoordigt het model voor de gewichtsentiteitsmetagegevens.

Name	Type	Description
metadataKind	string: WeightMetadata	Het objecttype Metagegevens van de entiteit.
unit	WeightUnit	Maateenheid voor gewicht.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

WeightUnit

Inventarisatie

De gewichtseenheid van de meting.

Waarde	Description
Dram	Gewichtseenheid in drams
Gallon	Volumeeenheid in gallon
Grain	Gewichtseenheid in korrels
Gram	Gewichtseenheid in gram
Kilogram	Gewichtseenheid in kilogram
LongTonBritish	Gewichtseenheid in lange ton (Brits)
MetricTon	Gewichtseenheid in metrische ton
Milligram	Gewichtseenheid in mg
Ounce	Gewichtseenheid in ounces
PennyWeight	Gewichtseenheid in pennygewichten
Pound	Gewichtseenheid in ponden
ShortHundredWeightUS	Gewichtseenheid in korte honderdgewichten (VS)
ShortTonUS	Gewichtseenheid in korte ton (VS)
Stone	Gewichtseenheid in stenen
Ton	Gewichtseenheid in ton
Unspecified	Niet-opgegeven gewichtseenheid