你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Analyze Text Job Status - Analyze Text Job Status

参考

服务:: Azure AI Services

API 版本:: 2024-11-01

获取分析状态和结果
获取分析作业的状态。作业可以包含一个或多个任务。所有任务都成功后，作业将转换为成功的状态，并且结果可用于每个任务。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如 https://.api.cognitiveservices.azure.com).
jobId	path	True	string (uuid)	作业 ID
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
showStats	query		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
skip	query		integer (int32)	要返回的第一个资源的集合中的偏移量。
top	query		integer (int32)	要从集合返回的最大资源数。

响应

名称	类型	说明
200 OK	AnalyzeTextJobState	请求已成功。
Other Status Codes	ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

AnalyzeTextJobState

请求已成功。

Other Status Codes

ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

SuccessfulAbstractiveSummarizationSummaryLengthTaskResult

SuccessfulAbstractiveSummarizationTaskResult

SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest

SuccessfulHealthcareDocumentTypeTaskStatusRequest

SuccessfulHealthcareTaskStatusRequest

SuccessfulAbstractiveSummarizationSummaryLengthTaskResult

示例请求

HTTP

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

示例响应

状态代码:: 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

示例请求

HTTP

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

示例响应

状态代码:: 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

示例请求

HTTP

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

示例响应

状态代码:: 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

示例请求

HTTP

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

示例响应

状态代码:: 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

示例请求

HTTP

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

示例响应

状态代码:: 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"
        }
      }
    ]
  }
}

定义

名称	说明
AbstractiveSummarizationLROResult	一个对象，表示抽象摘要任务的结果。
AbstractiveSummarizationResult	一个对象，表示每个文档预先生成的抽象摘要结果。
AbstractiveSummary	一个对象，表示单个摘要，其中包含给定文档的上下文。
AbstractiveSummaryDocumentResult	一个对象，表示每个文档预先生成的抽象摘要结果。
AgeMetadata	表示 Age 实体元数据模型。
AgeUnit	度量的年龄单位
AnalyzeTextJobState	包含分析作业 LRO 作业状态的对象。
AnalyzeTextLROResultsKind	分析文本长时间运行的任务返回的响应对象的类型。
AreaMetadata	表示区域实体元数据模型。
AreaUnit	度量面积单位。
Association	描述实体是文本的主题，还是描述其他人。
Certainty	描述实体确定性和极性。
ClassificationDocumentResult	包含任务的分类文档结果。
ClassificationResult	包含分类结果。
Conditionality	描述实体的任何条件性。
CurrencyMetadata	表示 Currency ）实体元数据模型。
CustomEntitiesResult	包含文档检测到的自定义实体结果的列表。
CustomEntityRecognitionLROResult	包含自定义实体识别作业结果。
CustomLabelClassificationResult	包含自定义标签分类结果。
CustomMultiLabelClassificationLROResult	包含自定义多标签分类作业结果。
CustomSingleLabelClassificationLROResult	包含自定义单标签分类作业结果。
DateMetadata	日期实体实例的元数据。
DateTimeMetadata	日期/时间实体实例的元数据。
DateValue	表示日期值。
DocumentError	包含作业执行期间遇到的错误的详细信息。
DocumentSentimentValue	文档的预测情绪（负面、中性、积极或混合）。
DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
DocumentWarning	包含包含已处理文档遇到的警告的警告对象。
EntitiesDocumentResult	包含文档的实体识别任务结果。
EntitiesDocumentResultWithMetadata	包含元数据的实体文档结果。
EntitiesResult	包含实体识别任务结果。
Entity	定义检测到的实体对象，该对象包含检测到的实体类别和实体文本等。
EntityLinkingLROResult	包含分析文本实体链接任务 LRO 结果。
EntityLinkingResult	实体链接结果。
EntityRecognitionLROResult	包含实体识别作业任务结果。
EntityTag	包含标记名称的实体标记对象会中止任何关联的置信度分数。实体标记用于表达实体之间的一些相似性/相关性。
EntityWithMetadata	包含标记和元数据的实体对象。
Error	服务在处理请求期间遇到一些错误时返回的错误响应对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
ExtractedSummaryDocumentResult	表示提取摘要的句子的排名列表。
ExtractedSummarySentence	表示输入文档中的提取句子。
ExtractiveSummarizationLROResult	一个对象，表示提取摘要任务的结果。
ExtractiveSummarizationResult	一个对象，表示每个文档预生成的提取摘要结果。
HealthcareAssertion	实体的断言。
HealthcareEntitiesDocumentResult	已处理的 Healthcare 文档的结果对象。
HealthcareEntity	从文档中提取的医疗保健实体
healthcareEntityCategory	医疗保健实体类别。
HealthcareEntityLink	对已知数据源中的实体的引用。
HealthcareLROResult	Healthcare Analyze Text long tunning operation result object.
HealthcareRelation	每个关系都是特定 relationType 的实体图，其中所有实体都已连接，并在关系上下文中具有特定角色。
HealthcareRelationEntity	关系中的实体。
HealthcareResult	已处理的 Healthcare 任务的结果对象。
InformationMetadata	表示信息（数据）实体元数据模型。
InformationUnit	信息（数据）度量单位。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
KeyPhraseExtractionLROResult	包含分析文本 KeyPhraseExtraction LRO 任务。
KeyPhraseResult	包含 KeyPhraseResult。
KeyPhrasesDocumentResult	包含文档的关键短语提取结果。
LengthMetadata	表示 Length 实体元数据模型。
LengthUnit	测量的长度单位。
LinkedEntitiesDocumentResult	实体链接文档结果。
LinkedEntity	包含检测到的实体与关联的源/链接的 LinkedEntity 对象。
Match	包含检测到的实体文本的 Match 对象，其偏移量和长度。
MetadataKind	实体元数据对象类型。
NumberKind	提取的数字实体的类型。
NumberMetadata	数值实体实例的元数据。
NumericRangeMetadata	表示数值间隔的元数据。
OrdinalMetadata	数值实体实例的元数据。
PiiEntitiesDocumentResult	包含 PII 结果。
PiiEntityRecognitionLROResult	包含 PII LRO 结果。
PiiResult	包含 PiiResult。
RangeInclusivity	此属性属性的范围非独占性。
RangeKind	数字范围实体的类型。
relationType	关系类型。示例包括：`DosageOfMedication` 或“FrequencyOfMedication”等。
RelativeTo	序号表示的引用点。
RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
SentenceAssessment	表示句子评估及其相关的评估或目标对象。
SentenceSentiment	文档的句子情绪。
SentenceSentimentValue	句子的预测情绪。
SentenceTarget	表示句子目标以及与其相关的评估或目标对象。
SentimentConfidenceScores	表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。
SentimentDocumentResult	一个对象，表示每个文档预先生成的情绪分析结果。
SentimentLROResult	包含情绪分析 LRO 结果。
SentimentResponse	输入文档的情绪分析结果。
SpeedMetadata	表示 Speed 实体元数据模型。
SpeedUnit	测量速度单位
State	上次更新时任务的状态。
SummaryContext	摘要的上下文。
TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正数和负数。
TargetRelation	表示评估与/或目标之间的关系。
TargetRelationType	与目标相关的类型。
Tasks	LRO 作业的任务状态的容器。
TemperatureMetadata	表示信息实体元数据模型。
TemperatureUnit	温度度量单位。
Temporality	描述有关实体的时态信息。
TemporalModifier	日期/时间实例的可选修饰符。
TemporalSetMetadata	临时集实体实例的元数据。
TemporalSpanMetadata	表示日期和/或时间范围的元数据。
TemporalSpanValues	时态跨度对象。
TimeMetadata	时间实体实例的元数据。
TokenSentimentValue	句子的预测情绪。
VolumeMetadata	表示卷实体元数据模型。
VolumeUnit	测量量单位
WarningCodeValue	定义警告代码的列表。
WeightMetadata	表示 Weight ）实体元数据模型。
WeightUnit	度量单位的权重单位。

AbstractiveSummarizationLROResult

Object

一个对象，表示抽象摘要任务的结果。

名称	类型	说明
kind	string: AbstractiveSummarizationLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	AbstractiveSummarizationResult	任务的结果。
status	State	上次更新时任务的状态。
taskName	string	任务名称

AbstractiveSummarizationResult

Object

一个对象，表示每个文档预先生成的抽象摘要结果。

名称	类型	说明
documents	AbstractiveSummaryDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

AbstractiveSummary

Object

一个对象，表示单个摘要，其中包含给定文档的上下文。

名称	类型	说明
contexts	SummaryContext[]	摘要的上下文列表。
text	string	摘要的文本。

AbstractiveSummaryDocumentResult

Object

一个对象，表示每个文档预先生成的抽象摘要结果。

名称	类型	说明
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
summaries	AbstractiveSummary[]	抽象摘要的列表。
warnings	DocumentWarning[]	处理文档时遇到的警告。

AgeMetadata

Object

表示 Age 实体元数据模型。

名称	类型	说明
metadataKind	string: AgeMetadata	实体元数据对象类型。
unit	AgeUnit	年龄度量单位。
value	number (double)	提取的文本表示的数值。

AgeUnit

枚举

度量的年龄单位

值	说明
Day	一天中的时间段
Month	一个月的时间段
Unspecified	未指定的时间段
Week	一周的时间段
Year	一年的时间段

AnalyzeTextJobState

Object

包含分析作业 LRO 作业状态的对象。

名称	类型	说明
createdDateTime	string (date-time)	创建的日期和时间作业
displayName	string	显示名称
errors	Error[]	错误
expirationDateTime	string (date-time)	日期和时间作业过期
jobId	string (uuid)	作业 ID
lastUpdatedDateTime	string (date-time)	上次更新时间和时间
nextLink	string	下一个链接
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
status	State	地位
tasks	Tasks	任务列表。

AnalyzeTextLROResultsKind

枚举

分析文本长时间运行的任务返回的响应对象的类型。

值	说明
AbstractiveSummarizationLROResults	抽象摘要 LRO 结果
CustomEntityRecognitionLROResults	自定义实体识别 LRO 结果
CustomMultiLabelClassificationLROResults	自定义多标签分类 LRO 结果
CustomSingleLabelClassificationLROResults	自定义单标签分类 LRO 结果
EntityLinkingLROResults	实体链接 LRO 结果
EntityRecognitionLROResults	实体识别 LRO 结果
ExtractiveSummarizationLROResults	提取摘要 LRO 结果
HealthcareLROResults	医疗保健 LRO 结果
KeyPhraseExtractionLROResults	关键短语提取 LRO 结果
PiiEntityRecognitionLROResults	PII 实体识别 LRO 结果
SentimentAnalysisLROResults	情绪分析 LRO 结果

AreaMetadata

Object

表示区域实体元数据模型。

名称	类型	说明
metadataKind	string: AreaMetadata	实体元数据对象类型。
unit	AreaUnit	面积的度量单位。
value	number (double)	提取的文本表示的数值。

AreaUnit

枚举

度量面积单位。

值	说明
Acre	面积单位（以英亩为单位）
SquareCentimeter	面积单位（平方厘米）
SquareDecameter	正方形十分仪中的面积单位
SquareDecimeter	面积单位（以平方分数为单位）
SquareFoot	面积单位（平方英尺）
SquareHectometer	方堆计中的面积单位
SquareInch	面积单位（以平方英寸为单位）
SquareKilometer	面积单位（平方公里）
SquareMeter	面积单位（平方米）
SquareMile	面积单位（平方英里）
SquareMillimeter	面积单位（以平方毫米为单位）
SquareYard	面积单位（以平方码为单位）
Unspecified	未指定的区域单位

Association

枚举

描述实体是文本的主题，还是描述其他人。

值	说明
other	其他关联
subject	主题关联

Certainty

枚举

描述实体确定性和极性。

值	说明
negative	负确定性
negativePossible	可能为负确定性
neutralPossible	可能中立的确定性
positive	正确定性
positivePossible	可能是积极的确定性

ClassificationDocumentResult

Object

包含任务的分类文档结果。

名称	类型	说明
class	ClassificationResult[]	包含所有文档的分类文档结果。
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

ClassificationResult

Object

包含分类结果。

名称	类型	说明
category	string	分类类型。
confidenceScore	number (double)	已识别类的 0 到 1 之间的置信度分数。

Conditionality

枚举

描述实体的任何条件性。

值	说明
conditional	条件性
hypothetical	假设条件性

CurrencyMetadata

Object

表示 Currency ）实体元数据模型。

名称	类型	说明
iso4217	string	基于另一个 ISO 标准 ISO 3166 的字母代码，其中列出了国家/地区名称的代码。 ISO 4217 三字母代码的前两个字母与国家/地区名称的代码相同，并且，如果可能，第三个字母对应于货币名称的第一个字母。
metadataKind	string: CurrencyMetadata	实体元数据对象类型。
unit	string	货币单位。
value	number (double)	提取的文本表示的数值。

CustomEntitiesResult

Object

包含文档检测到的自定义实体结果的列表。

名称	类型	说明
deploymentName	string	此字段指示模型的部署名称。
documents	EntitiesDocumentResult[]	文档结果的枚举。
errors	DocumentError[]	按文档 ID 显示的错误。
projectName	string	此字段指示模型的项目名称。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

CustomEntityRecognitionLROResult

Object

包含自定义实体识别作业结果。

名称	类型	说明
kind	string: CustomEntityRecognitionLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	CustomEntitiesResult	结果列表。
status	State	上次更新时任务的状态。
taskName	string	任务名称

CustomLabelClassificationResult

Object

包含自定义标签分类结果。

名称	类型	说明
deploymentName	string	此字段指示模型的部署名称。
documents	ClassificationDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
projectName	string	此字段指示模型的项目名称。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

CustomMultiLabelClassificationLROResult

Object

包含自定义多标签分类作业结果。

名称	类型	说明
kind	string: CustomMultiLabelClassificationLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	CustomLabelClassificationResult	结果列表。
status	State	上次更新时任务的状态。
taskName	string	任务名称

CustomSingleLabelClassificationLROResult

Object

包含自定义单标签分类作业结果。

名称	类型	说明
kind	string: CustomSingleLabelClassificationLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	CustomLabelClassificationResult	结果列表。
status	State	上次更新时任务的状态。
taskName	string	任务名称

DateMetadata

Object

日期实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: DateMetadata	实体元数据对象类型。

DateTimeMetadata

Object

日期/时间实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: DateTimeMetadata	实体元数据对象类型。

DateValue

Object

表示日期值。

名称	类型	说明
modifier	TemporalModifier	日期时间的修饰符，用于指示引用点，如之前、之后等。
timex	string	如（https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml）中所述的延长 ISO 8601 日期/时间表示形式
value	string	提取的文本表示的实际时间。

DocumentError

Object

包含作业执行期间遇到的错误的详细信息。

名称	类型	说明
error	Error	遇到错误。
id	string	输入文档的 ID。

DocumentSentimentValue

枚举

文档的预测情绪（负面、中性、积极或混合）。

值	说明
mixed	Mixed 语句
negative	负语句
neutral	Neutral 语句
positive	Positive 语句

DocumentStatistics

Object

如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。

名称	类型	说明
charactersCount	integer (int32)	文档中识别的文本元素数。
transactionsCount	integer (int32)	文档的事务数。

DocumentWarning

Object

包含包含已处理文档遇到的警告的警告对象。

名称	类型	说明
code	WarningCodeValue	警告代码。
message	string	警告消息。
targetRef	string	指示目标对象的 JSON 指针引用。

EntitiesDocumentResult

Object

包含文档的实体识别任务结果。

名称	类型	说明
entities	Entity[]	文档中的已识别实体。
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

EntitiesDocumentResultWithMetadata

Object

包含元数据的实体文档结果。

名称	类型	说明
entities	EntityWithMetadata[]	文档中的已识别实体。
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

EntitiesResult

Object

包含实体识别任务结果。

名称	类型	说明
documents	EntitiesDocumentResultWithMetadata[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

Entity

Object

定义检测到的实体对象，该对象包含检测到的实体类别和实体文本等。

名称	类型	说明
category	string	实体类型。
confidenceScore	number (double)	提取实体的 0 到 1 之间的置信度分数。
length	integer (int32)	实体文本的长度。使用不同的“stringIndexType”值可能会影响返回的长度。
offset	integer (int32)	实体文本的起始位置。使用不同的“stringIndexType”值可能会影响返回的偏移量。
subcategory	string	（可选）实体子类型。
text	string	请求中显示的实体文本。

EntityLinkingLROResult

Object

包含分析文本实体链接任务 LRO 结果。

名称	类型	说明
kind	string: EntityLinkingLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	EntityLinkingResult	实体链接结果。
status	State	上次更新时任务的状态。
taskName	string	任务名称

EntityLinkingResult

Object

实体链接结果。

名称	类型	说明
documents	LinkedEntitiesDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

EntityRecognitionLROResult

Object

包含实体识别作业任务结果。

名称	类型	说明
kind	string: EntityRecognitionLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	EntitiesResult	任务的结果。
status	State	上次更新时任务的状态。
taskName	string	任务名称

EntityTag

Object

包含标记名称的实体标记对象会中止任何关联的置信度分数。实体标记用于表达实体之间的一些相似性/相关性。

名称	类型	说明
confidenceScore	number (double)	提取实体的 0 到 1 之间的检测分数。
name	string	标记的名称。实体标记名称将全局唯一。

EntityWithMetadata

Object

包含标记和元数据的实体对象。

名称	类型	说明
category	string	实体类型。
confidenceScore	number (double)	提取实体的 0 到 1 之间的置信度分数。
length	integer (int32)	实体文本的长度。使用不同的“stringIndexType”值可能会影响返回的长度。
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	实体元数据对象。
offset	integer (int32)	实体文本的起始位置。使用不同的“stringIndexType”值可能会影响返回的偏移量。
subcategory	string	（可选）实体子类型。
tags	EntityTag[]	实体标记列表。标记表示实体之间的一些相似性/相关性。
text	string	请求中显示的实体文本。
type	string	实体类型是检测到实体的最低（或最佳）粒度。该类型映射到与检测到的实体关联的特定元数据属性。

Error

Object

服务在处理请求期间遇到一些错误时返回的错误响应对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorCode

枚举

人工可读错误代码。

值	说明
AzureCognitiveSearchIndexLimitReached	Azure 认知搜索索引限制达到错误
AzureCognitiveSearchIndexNotFound	Azure 认知搜索索引找不到错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
Conflict	冲突错误
Forbidden	禁止访问错误
InternalServerError	内部服务器错误
InvalidArgument	参数错误无效
InvalidRequest	请求错误无效
NotFound	找不到错误
OperationNotFound	找不到操作错误
ProjectNotFound	项目找不到错误
QuotaExceeded	超出配额错误
ServiceUnavailable	服务不可用错误
Timeout	超时错误
TooManyRequests	请求过多错误
Unauthorized	未经授权的访问错误
Warning	警告错误

ErrorResponse

Object

错误响应。

名称	类型	说明
error	Error	错误对象。

ExtractedSummaryDocumentResult

Object

表示提取摘要的句子的排名列表。

名称	类型	说明
id	string	唯一的非空文档标识符。
sentences	ExtractedSummarySentence[]	指定输入文档中提取的句子。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

ExtractedSummarySentence

Object

表示输入文档中的提取句子。

名称	类型	说明
length	integer (int32)	句子的长度。
offset	integer (int32)	基于参数 StringIndexType 的值，从文档开头的句子偏移量。
rankScore	number (double)	一个双精度值，表示摘要中句子的相关性。较高的值表示重要性越高。
text	string	提取的句子文本。

ExtractiveSummarizationLROResult

Object

一个对象，表示提取摘要任务的结果。

名称	类型	说明
kind	string: ExtractiveSummarizationLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	ExtractiveSummarizationResult	任务的结果。
status	State	上次更新时任务的状态。
taskName	string	任务名称

ExtractiveSummarizationResult

Object

一个对象，表示每个文档预生成的提取摘要结果。

名称	类型	说明
documents	ExtractedSummaryDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

HealthcareAssertion

Object

实体的断言。

名称	类型	说明
association	Association	描述实体是文本的主题，还是描述其他人。
certainty	Certainty	描述实体确定性和极性。
conditionality	Conditionality	描述实体的任何条件性。
temporality	Temporality	描述有关实体的时态信息。

HealthcareEntitiesDocumentResult

Object

已处理的 Healthcare 文档的结果对象。

名称	类型	说明
entities	HealthcareEntity[]	医疗保健实体。
fhirBundle	FhirBundle	包含 FHIR 兼容对象的 JSON 捆绑包，用于在其他医疗保健工具中使用。有关详细信息，请参阅 https://www.hl7.org/fhir/overview.html。
id	string	唯一的非空文档标识符。
relations	HealthcareRelation[]	医疗保健实体关系。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

HealthcareEntity

Object

从文档中提取的医疗保健实体

名称	类型	说明
assertion	HealthcareAssertion	实体的断言。
category	healthcareEntityCategory	医疗保健实体类别。
confidenceScore	number (double)	提取实体的 0 到 1 之间的置信度分数。
length	integer (int32)	实体文本的长度。使用不同的“stringIndexType”值可能会影响返回的长度。
links	HealthcareEntityLink[]	已知数据源中的实体引用。
name	string	实体的首选名称。示例：“histologically”的“name”为“histologic”。
offset	integer (int32)	实体文本的起始位置。使用不同的“stringIndexType”值可能会影响返回的偏移量。
subcategory	string	（可选）实体子类型。
text	string	请求中显示的实体文本。

healthcareEntityCategory

枚举

医疗保健实体类别。

值	说明
AdministrativeEvent	管理事件
Age	年龄
Allergen	过敏原
BodyStructure	正文结构
CareEnvironment	护理环境
ConditionQualifier	条件限定符
ConditionScale	条件缩放
Course	课程
Date	日期
Diagnosis	诊断
Direction	方向
Dosage	剂量
Employment	就业
Ethnicity	种族
ExaminationName	考试名称
Expression	表达
FamilyRelation	家庭关系
Frequency	频率
Gender	性
GeneOrProtein	基因或蛋白质
HealthcareProfession	医疗保健行业
LivingStatus	生活状态
MeasurementUnit	度量单位
MeasurementValue	度量值
MedicationClass	药物类
MedicationForm	药物形式
MedicationName	药物名称
MedicationRoute	药物路线
MutationType	突变类型
RelationalOperator	关系运算符
SubstanceUse	物质使用
SubstanceUseAmount	物质使用量
SymptomOrSign	症状或符号
Time	时间
TreatmentName	处理名称
Variant	变体

HealthcareEntityLink

Object

对已知数据源中的实体的引用。

名称	类型	说明
dataSource	string	实体目录。示例包括：UMLS、CHV、MSH 等。
id	string	给定源目录中的实体 ID。

HealthcareLROResult

Object

Healthcare Analyze Text long tunning operation result object.

名称	类型	说明
kind	string: HealthcareLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	HealthcareResult	任务的结果。
status	State	上次更新时任务的状态。
taskName	string	任务名称

HealthcareRelation

Object

每个关系都是特定 relationType 的实体图，其中所有实体都已连接，并在关系上下文中具有特定角色。

名称	类型	说明
confidenceScore	number (double)	提取关系 0 和 1 之间的置信度分数。
entities	HealthcareRelationEntity[]	关系中的实体。
relationType	relationType	关系类型。示例包括：`DosageOfMedication` 或“FrequencyOfMedication”等。

HealthcareRelationEntity

Object

关系中的实体。

名称	类型	说明
ref	string	引用链接对象，使用 JSON 指针 RFC 6901（URI 片段标识符表示形式），指向实体。
role	string	关系中实体的角色。例如：“CD20阳性漫射大型B细胞淋巴瘤”具有以下实体，其作用在括号：CD20（GeneOrProtein）、阳性（表达式）、扩散大型B细胞淋巴瘤（诊断）。

HealthcareResult

Object

已处理的 Healthcare 任务的结果对象。

名称	类型	说明
documents	HealthcareEntitiesDocumentResult[]	已处理的 Healthcare 文档的结果对象列表。
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

InformationMetadata

Object

表示信息（数据）实体元数据模型。

名称	类型	说明
metadataKind	string: InformationMetadata	实体元数据对象类型。
unit	InformationUnit	信息的度量单位。
value	number (double)	提取的文本表示的数值。

InformationUnit

枚举

信息（数据）度量单位。

值	说明
Bit	数据大小单位（以位为单位）
Byte	数据大小单位（以字节为单位）
Gigabit	数据大小单位（以千兆位为单位）
Gigabyte	数据大小单位（以 GB 为单位）
Kilobit	千位中的数据大小单位
Kilobyte	数据大小单位（以 KB 为单位）
Megabit	以兆位为单位的数据大小单位
Megabyte	数据大小单位（以兆字节为单位）
Petabit	petabits 中的数据大小单位
Petabyte	数据大小单位（以 PB 为单位）
Terabit	terabits 中的数据大小单位
Terabyte	数据大小单位（以 TB 为单位）
Unspecified	未指定的数据大小单位

InnerErrorCode

枚举

人工可读错误代码。

值	说明
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
EmptyRequest	空请求错误
ExtractionFailure	提取失败错误
InvalidCountryHint	国家/地区提示错误无效
InvalidDocument	文档错误无效
InvalidDocumentBatch	文档批处理错误无效
InvalidParameterValue	参数值错误无效
InvalidRequest	请求错误无效
InvalidRequestBodyFormat	请求正文格式错误无效
KnowledgeBaseNotFound	知识库找不到错误
MissingInputDocuments	缺少输入文档错误
ModelVersionIncorrect	模型版本错误错误
UnsupportedLanguageCode	不支持的语言代码错误

InnerErrorModel

Object

包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误信息。
target	string	错误目标。

KeyPhraseExtractionLROResult

Object

包含分析文本 KeyPhraseExtraction LRO 任务。

名称	类型	说明
kind	string: KeyPhraseExtractionLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	KeyPhraseResult	关键短语提取结果的列表
status	State	上次更新时任务的状态。
taskName	string	任务名称

KeyPhraseResult

Object

包含 KeyPhraseResult。

名称	类型	说明
documents	KeyPhrasesDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

KeyPhrasesDocumentResult

Object

包含文档的关键短语提取结果。

名称	类型	说明
id	string	唯一的非空文档标识符。
keyPhrases	string[]	具有代表性的字词或短语的列表。返回的关键短语数与输入文档中的字数成正比。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

LengthMetadata

Object

表示 Length 实体元数据模型。

名称	类型	说明
metadataKind	string: LengthMetadata	实体元数据对象类型。
unit	LengthUnit	长度度量单位。
value	number (double)	提取的文本表示的数值。

LengthUnit

枚举

测量的长度单位。

值	说明
Centimeter	长度单位（以厘米为单位）。
Decameter	长度单位（以十分计为单位）。
Decimeter	长度单位（以分数为单位）。
Foot	长度单位（以英尺为单位）。
Hectometer	hectometers 中的长度单位。
Inch	长度单位（以英寸为单位）。
Kilometer	长度单位（以公里为单位）。
LightYear	长度单位（以光年为单位）。
Meter	长度单位（以米为单位）。
Micrometer	长度单位（以微计为单位）。
Mile	长度单位（以英里为单位）。
Millimeter	长度单位（以毫米为单位）。
Nanometer	长度单位（以纳米为单位）。
Picometer	picometers 中的长度单位。
Point	长度单位（以磅为单位）。
Unspecified	未指定的长度单位。
Yard	长度单位（以码为单位）。

LinkedEntitiesDocumentResult

Object

实体链接文档结果。

名称	类型	说明
entities	LinkedEntity[]	文档中已识别的已知实体。
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

LinkedEntity

Object

包含检测到的实体与关联的源/链接的 LinkedEntity 对象。

名称	类型	说明
bingId	string	已识别实体的必应实体搜索 API 唯一标识符。
dataSource	string	用于提取实体链接的数据源，如 Wiki/必应等。
id	string	数据源中已识别实体的唯一标识符。
language	string	数据源中使用的语言。
matches	Match[]	此实体的实例列表显示在文本中。
name	string	实体链接形式名称。
url	string	数据源中实体页面的 URL。

Match

Object

包含检测到的实体文本的 Match 对象，其偏移量和长度。

名称	类型	说明
confidenceScore	number (double)	如果识别出已知项，则会返回一个十进制数字，表示 0 和 1 之间的置信度级别。
length	integer (int32)	实体匹配文本的长度。
offset	integer (int32)	实体匹配文本的起始位置。
text	string	请求中显示的实体文本。

MetadataKind

枚举

实体元数据对象类型。

值	说明
AgeMetadata	与年龄相关的值的元数据。
AreaMetadata	区域相关值的元数据。
CurrencyMetadata	与货币相关的值的元数据。
DateMetadata	与日期相关的值的元数据。
DateTimeMetadata	日期和时间相关值的元数据。
InformationMetadata	与信息相关的值的元数据。
LengthMetadata	与长度相关的值的元数据。
NumberMetadata	数值的元数据。
NumericRangeMetadata	数值范围的元数据。
OrdinalMetadata	序号的元数据。
SpeedMetadata	与速度相关的值的元数据。
TemperatureMetadata	与温度相关的值的元数据。
TemporalSetMetadata	与时间相关的值集的元数据。
TemporalSpanMetadata	时态跨度值的元数据。
TimeMetadata	与时间相关的值的元数据。
VolumeMetadata	卷相关值的元数据。
WeightMetadata	与权重相关的值的元数据。

NumberKind

枚举

提取的数字实体的类型。

值	说明
Decimal	十进制数
Fraction	分数号
Integer	整数
Percent	百分比
Power	电源编号
Unspecified	未指定的数字类型

NumberMetadata

Object

数值实体实例的元数据。

名称	类型	说明
metadataKind	string: NumberMetadata	实体元数据对象类型。
numberKind	NumberKind	数字类型的类型。
value	number (double)	提取的文本所表示内容的数值表示形式。

NumericRangeMetadata

Object

表示数值间隔的元数据。

名称	类型	说明
maximum	number (double)	间隔的结束值。
metadataKind	string: NumericRangeMetadata	实体元数据对象类型。
minimum	number (double)	间隔的起始值。
rangeInclusivity	RangeInclusivity	此范围的包容性。
rangeKind	RangeKind	支持的数值范围类型 - 例如数字、速度等。

OrdinalMetadata

Object

数值实体实例的元数据。

名称	类型	说明
metadataKind	string: OrdinalMetadata	实体元数据对象类型。
offset	string	引用的偏移量（例如偏移量 = -1 指示第二个到最后一个）
relativeTo	RelativeTo	序号表示的引用点。
value	string	序号表示的简单算术表达式。

PiiEntitiesDocumentResult

Object

包含 PII 结果。

名称	类型	说明
entities	Entity[]	文档中的已识别实体。
id	string	唯一的非空文档标识符。
redactedText	string	返回经过编辑的文本。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

PiiEntityRecognitionLROResult

Object

包含 PII LRO 结果。

名称	类型	说明
kind	string: PiiEntityRecognitionLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	PiiResult	pii 结果列表
status	State	上次更新时任务的状态。
taskName	string	任务名称

PiiResult

Object

包含 PiiResult。

名称	类型	说明
documents	PiiEntitiesDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

RangeInclusivity

枚举

此属性属性的范围非独占性。

值	说明
LeftInclusive	左侧非独占
LeftRightInclusive	双方均包含
NoneInclusive	无包容性
RightInclusive	右侧（含）

RangeKind

枚举

数字范围实体的类型。

值	说明
Age	年龄范围
Area	区域范围
Currency	货币范围
Information	信息范围
Length	长度范围
Number	数字范围
Speed	速度范围
Temperature	温度范围
Volume	音量范围
Weight	权重范围

relationType

枚举

关系类型。示例包括：DosageOfMedication 或“FrequencyOfMedication”等。

值	说明
Abbreviation	缩写
BodySiteOfCondition	条件正文站点
BodySiteOfTreatment	身体治疗部位
CourseOfCondition	条件过程
CourseOfExamination	考试过程
CourseOfMedication	药物课程
CourseOfTreatment	治疗过程
DirectionOfBodyStructure	正文结构的方向
DirectionOfCondition	条件方向
DirectionOfExamination	检查方向
DirectionOfTreatment	治疗方向
DosageOfMedication	药物剂量
ExaminationFindsCondition	检查查找条件
ExpressionOfGene	基因的表达
ExpressionOfVariant	变体的表达式
FormOfMedication	药物形式
FrequencyOfCondition	条件频率
FrequencyOfMedication	药物频率
FrequencyOfTreatment	治疗频率
MutationTypeOfGene	基因突变类型
MutationTypeOfVariant	变体的突变类型
QualifierOfCondition	条件限定符
RelationOfExamination	考试关系
RouteOfMedication	药物路线
ScaleOfCondition	条件缩放
TimeOfCondition	条件时间
TimeOfEvent	事件时间
TimeOfExamination	考试时间
TimeOfMedication	药物时间
TimeOfTreatment	治疗时间
UnitOfCondition	条件单位
UnitOfExamination	考试单位
ValueOfCondition	条件值
ValueOfExamination	检查值
VariantOfGene	基因变体

RelativeTo

枚举

序号表示的引用点。

值	说明
Current	当前状态或位置
End	结束状态或位置
Start	开始状态或位置

RequestStatistics

Object

如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

名称	类型	说明
documentsCount	integer (int32)	请求中提交的文档数。
erroneousDocumentsCount	integer (int32)	无效文档数。这包括空、大小过高或不支持的语言文档。
transactionsCount	integer (int64)	请求的事务数。
validDocumentsCount	integer (int32)	有效文档数。这不包括空的、大小过大的限制或不支持的语言文档。

SentenceAssessment

Object

表示句子评估及其相关的评估或目标对象。

名称	类型	说明
confidenceScores	TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正数和负数。
isNegated	boolean	表示评估是否被否定的指示器。
length	integer (int32)	目标的长度。
offset	integer (int32)	与句子开头的目标偏移量。
sentiment	TokenSentimentValue	句子的情绪。
text	string	检测到的目标文本。

SentenceSentiment

Object

文档的句子情绪。

名称	类型	说明
assessments	SentenceAssessment[]	句子的评估数组。
confidenceScores	SentimentConfidenceScores	所有类的句子的情绪置信度分数介于 0 和 1 之间。
length	integer (int32)	目标的长度。
offset	integer (int32)	与句子开头的目标偏移量。
sentiment	SentenceSentimentValue	句子的预测情绪。
targets	SentenceTarget[]	句子目标的数组。
text	string	句子文本。

SentenceSentimentValue

枚举

句子的预测情绪。

值	说明
negative	负面情绪
neutral	中性情绪
positive	积极情绪

SentenceTarget

Object

表示句子目标以及与其相关的评估或目标对象。

名称	类型	说明
confidenceScores	TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正数和负数。
length	integer (int32)	目标的长度。
offset	integer (int32)	与句子开头的目标偏移量。
relations	TargetRelation[]	与目标相关的评估或目标对象的数组。
sentiment	TokenSentimentValue	句子的情绪。
text	string	检测到的目标文本。

SentimentConfidenceScores

Object

表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。

名称	类型	说明
negative	number (double)	负面情绪的置信度分数
neutral	number (double)	中性情绪的置信度分数
positive	number (double)	正面情绪的置信度分数

SentimentDocumentResult

Object

一个对象，表示每个文档预先生成的情绪分析结果。

名称	类型	说明
confidenceScores	SentimentConfidenceScores	所有类的句子的情绪置信度分数介于 0 和 1 之间。
id	string	唯一的非空文档标识符。
sentences	SentenceSentiment[]	文档的句子情绪。
sentiment	DocumentSentimentValue	文档的预测情绪（负面、中性、积极或混合）。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

SentimentLROResult

Object

包含情绪分析 LRO 结果。

名称	类型	说明
kind	string: SentimentAnalysisLROResults	任务的种类。
lastUpdateDateTime	string (date-time)	任务的上次更新时间（UTC）。
results	SentimentResponse	情绪分析结果
status	State	上次更新时任务的状态。
taskName	string	任务名称

SentimentResponse

Object

输入文档的情绪分析结果。

名称	类型	说明
documents	SentimentDocumentResult[]	输入中每个文档的情绪分析结果。
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

SpeedMetadata

Object

表示 Speed 实体元数据模型。

名称	类型	说明
metadataKind	string: SpeedMetadata	实体元数据对象类型。
unit	SpeedUnit	速度度量单位。
value	number (double)	提取的文本表示的数值。

SpeedUnit

枚举

测量速度单位

值	说明
CentimetersPerMillisecond	速度单位（以厘米/毫秒为单位）。
FeetPerMinute	每分钟的速度单位（以英尺为单位）。
FeetPerSecond	速度单位（以英尺/秒为单位）。
KilometersPerHour	每小时速度单位（以公里为单位）。
KilometersPerMillisecond	速度单位（以千米/毫秒为单位）。
KilometersPerMinute	速度单位（以公里/分钟为单位）。
KilometersPerSecond	速度单位（以公里/秒为单位）。
Knots	结中的速度单位。
MetersPerMillisecond	速度单位（以米/毫秒为单位）。
MetersPerSecond	速度单位（以米/秒为单位）。
MilesPerHour	速度单位，以英里/小时为单位。
Unspecified	未指定的速度单位。
YardsPerMinute	每分钟的速度单位（以码为单位）。
YardsPerSecond	每秒速度单位（以码为单位）。

State

枚举

上次更新时任务的状态。

值	说明
cancelled	已取消状态
cancelling	正在取消状态
failed	失败状态
notStarted	未启动状态
partiallyCompleted	部分完成状态
running	运行状态
succeeded	成功状态

SummaryContext

Object

摘要的上下文。

名称	类型	说明
length	integer (int32)	上下文的长度。使用不同的“stringIndexType”值可能会影响返回的长度。
offset	integer (int32)	上下文的开始位置。使用不同的“stringIndexType”值可能会影响返回的偏移量。

TargetConfidenceScoreLabel

Object

表示所有情绪类的置信度分数：正数和负数。

名称	类型	说明
negative	number (double)	负面情绪的置信度分数
positive	number (double)	正面情绪的置信度分数

TargetRelation

Object

表示评估与/或目标之间的关系。

名称	类型	说明
ref	string	指示链接对象的 JSON 指针。
relationType	TargetRelationType	与目标相关的类型。

TargetRelationType

枚举

与目标相关的类型。

值	说明
assessment	评估关系。
target	目标关系。

Tasks

Object

LRO 作业的任务状态的容器。

名称	类型	说明
completed	integer (int32)	已完成的任务计数。
failed	integer (int32)	失败的任务计数。
inProgress	integer (int32)	入口任务计数。
items	AnalyzeTextLROResult[]: AbstractiveSummarizationLROResult[] CustomEntityRecognitionLROResult[] CustomMultiLabelClassificationLROResult[] CustomSingleLabelClassificationLROResult[] EntityLinkingLROResult[] EntityRecognitionLROResult[] ExtractiveSummarizationLROResult[] HealthcareLROResult[] KeyPhraseExtractionLROResult[] PiiEntityRecognitionLROResult[] SentimentLROResult[]	分析文本作业结果的枚举。
total	integer (int32)	总任务的计数。

TemperatureMetadata

Object

表示信息实体元数据模型。

名称	类型	说明
metadataKind	string: TemperatureMetadata	实体元数据对象类型。
unit	TemperatureUnit	温度的度量单位。
value	number (double)	提取的文本表示的数值。

TemperatureUnit

枚举

温度度量单位。

值	说明
Celsius	温度单位（摄氏度）
Fahrenheit	华氏温度单位
Kelvin	凯尔文的温度单位
Rankine	Rankine 中的温度单位
Unspecified	未指定的温度单位

Temporality

枚举

描述有关实体的时态信息。

值	说明
current	当前时态
future	未来的时态性
past	过去的时态性

TemporalModifier

枚举

日期/时间实例的可选修饰符。

值	说明
After	在特定时间之后
AfterApprox	大约一段时间后
AfterMid	时间段中间之后
AfterStart	时间段开始后
Approx	大约在特定时间
Before	在特定时间之前
BeforeApprox	大致时间之前
BeforeEnd	时间段结束前
BeforeStart	在时间段开始之前
End	时间段结束时
Less	小于特定时间
Mid	在一段时间内
More	比特定时间多
ReferenceUndefined	对未定义时间的引用
Since	自特定时间起
SinceEnd	自时间段结束以来
Start	在时间段开始时
Until	直到特定时间

TemporalSetMetadata

Object

临时集实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: TemporalSetMetadata	实体元数据对象类型。

TemporalSpanMetadata

Object

表示日期和/或时间范围的元数据。

名称	类型	说明
metadataKind	string: TemporalSpanMetadata	实体元数据对象类型。
spanValues	TemporalSpanValues[]	检测到的时态跨度列表。

TemporalSpanValues

Object

时态跨度对象。

名称	类型	说明
begin	string	范围起始值。
duration	string	基于 ISO 8601（https://en.wikipedia.org/wiki/ISO_8601#Durations）格式的可选持续时间值
end	string	范围结束值。
modifier	TemporalModifier	日期时间的修饰符，用于指示引用点，如之前、之后等。
timex	string	一个可选的三元列，其中包含开头、结尾和持续时间，所有表示为 ISO 8601 格式的字符串。

TimeMetadata

Object

时间实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: TimeMetadata	实体元数据对象类型。

TokenSentimentValue

枚举

句子的预测情绪。

值	说明
mixed	混合情绪
negative	负面情绪
positive	积极情绪

VolumeMetadata

Object

表示卷实体元数据模型。

名称	类型	说明
metadataKind	string: VolumeMetadata	实体元数据对象类型。
unit	VolumeUnit	卷的度量单位。
value	number (double)	提取的文本表示的数值。

VolumeUnit

枚举

测量量单位

值	说明
Barrel	卷单位（以桶为单位）。
Bushel	bushels 中的卷单元。
Centiliter	卷单位（以百分比为单位）。
Cord	带中的音量单位。
CubicCentimeter	以立方厘米为单位的体积单位。
CubicFoot	体积单位（以立方英尺为单位）。
CubicInch	卷单位（以立方英寸为单位）。
CubicMeter	体积单位（以立方米为单位）。
CubicMile	体积单位（以立方英里为单位）。
CubicMillimeter	体积单位（以立方毫米为单位）。
CubicYard	卷单位（以立方码为单位）。
Cup	杯子中的音量单位。
Decaliter	卷单位（以解码器为单位）。
FluidDram	液体 drams 中的音量单位。
FluidOunce	液体盎司的体积单位。
Gill	金牌中的卷单位。
Hectoliter	百叶数中的卷单位。
Hogshead	猪头中的卷单位。
Liter	音量单位（升）。
Milliliter	以毫升为单位的卷单位。
Minim	小型卷单元。
Peck	卷单位（以 pecks 为单位）。
Pinch	卷单位（以英寸为单位）。
Pint	品脱中的卷单位。
Quart	卷单位（以四分为单位）。
Tablespoon	表匙中的卷单位。
Teaspoon	卷单位（以茶匙为单位）。
Unspecified	未指定的卷单位。

WarningCodeValue

枚举

定义警告代码的列表。

值	说明
DocumentTruncated	文档截断警告
LongWordsInDocument	文档警告中的长字

WeightMetadata

Object

表示 Weight ）实体元数据模型。

名称	类型	说明
metadataKind	string: WeightMetadata	实体元数据对象类型。
unit	WeightUnit	权重度量单位。
value	number (double)	提取的文本表示的数值。

WeightUnit

枚举

度量单位的权重单位。

值	说明
Dram	drams 中的重量单位
Gallon	容量单位（以加仑为单位）
Grain	粒度中的重量单位
Gram	以克为单位的重量单位
Kilogram	重量单位（以公斤为单位）
LongTonBritish	长吨重量单位（英国）
MetricTon	以指标吨为单位的重量单位
Milligram	以毫米为单位的重量单位
Ounce	重量单位（盎司）
PennyWeight	重量单位（以便士为单位）
Pound	重量单位（磅）
ShortHundredWeightUS	短百重量级重量单位（美国）
ShortTonUS	短吨（美国）重量单位
Stone	石头中的重量单位
Ton	重量单位（以吨为单位）
Unspecified	未指定的权重单位

通过

Analyze Text Job Status - Analyze Text Job Status

URI 参数

响应

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

作用域

示例

SuccessfulAbstractiveSummarizationSummaryLengthTaskResult

示例请求

示例响应

SuccessfulAbstractiveSummarizationTaskResult

示例请求

示例响应

SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest

示例请求

示例响应

SuccessfulHealthcareDocumentTypeTaskStatusRequest

示例请求

示例响应

SuccessfulHealthcareTaskStatusRequest

示例请求

示例响应

定义

AbstractiveSummarizationLROResult

AbstractiveSummarizationResult

AbstractiveSummary

AbstractiveSummaryDocumentResult

AgeMetadata

AgeUnit

AnalyzeTextJobState

AnalyzeTextLROResultsKind

AreaMetadata

AreaUnit

Association

Certainty

ClassificationDocumentResult

ClassificationResult

Conditionality

CurrencyMetadata

CustomEntitiesResult

CustomEntityRecognitionLROResult

CustomLabelClassificationResult

CustomMultiLabelClassificationLROResult

CustomSingleLabelClassificationLROResult

DateMetadata

DateTimeMetadata

DateValue

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResult

EntitiesDocumentResultWithMetadata

EntitiesResult

Entity

EntityLinkingLROResult

EntityLinkingResult

EntityRecognitionLROResult

EntityTag

EntityWithMetadata

Error

ErrorCode

ErrorResponse

ExtractedSummaryDocumentResult

ExtractedSummarySentence

ExtractiveSummarizationLROResult

ExtractiveSummarizationResult

HealthcareAssertion

HealthcareEntitiesDocumentResult

HealthcareEntity

healthcareEntityCategory

HealthcareEntityLink

HealthcareLROResult

HealthcareRelation

HealthcareRelationEntity

HealthcareResult

InformationMetadata

InformationUnit