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

Analyze Text Job Status - Analyze Text Job Status

参考

Service:: Cognitive Services - Language

API Version:: 2023-04-01

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

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

With optional parameters:

GET {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-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	要用于此操作的 API 版本。
showStats	query		boolean	(可选) 如果设置为 true，则响应将包含请求和文档级别的统计信息。
skip	query		integer int32	要返回的第一个资源的集合中的偏移量。
top	query		integer int32	要从集合返回的最大资源数。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

响应

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

名称

类型

说明

200 OK

AnalyzeTextJobState

请求已成功。

Other Status Codes

ErrorResponse

意外的错误响应。

Headers

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

SuccessfulAbstractiveSummarizationTaskResult

SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest

SuccessfulAbstractiveSummarizationTaskResult

Sample Request

HTTP

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

Sample Response

Status code:: 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",
                  "confidenceScore": 0.61,
                  "length": 4,
                  "offset": 18,
                  "text": "trip"
                },
                {
                  "category": "Location",
                  "confidenceScore": 0.82,
                  "length": 7,
                  "offset": 26,
                  "subcategory": "GPE",
                  "text": "Seattle"
                },
                {
                  "category": "DateTime",
                  "confidenceScore": 0.8,
                  "length": 9,
                  "offset": 34,
                  "subcategory": "DateRange",
                  "text": "last week"
                }
              ],
              "id": "1",
              "warnings": []
            },
            {
              "entities": [
                {
                  "category": "Location",
                  "confidenceScore": 0.52,
                  "length": 3,
                  "offset": 14,
                  "subcategory": "GPE",
                  "text": "NYC"
                },
                {
                  "category": "DateTime",
                  "confidenceScore": 0.8,
                  "length": 8,
                  "offset": 18,
                  "subcategory": "Date",
                  "text": "tomorrow"
                }
              ],
              "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"
        }
      }
    ]
  }
}

定义

名称	说明
AbstractiveSummarizationLROResult	一个对象，表示抽象摘要任务的结果。
AbstractiveSummarizationResult	一个对象，表示每个文档的预生成抽象摘要结果。
AbstractiveSummary	一个对象，表示具有给定文档上下文的单个摘要。
AbstractiveSummaryDocumentResult	一个对象，表示每个文档的预生成抽象摘要结果。
AnalyzeTextJobState	包含分析作业 LRO 作业状态的对象。
AnalyzeTextLROResultsKind	分析文本长时间运行任务返回的响应对象的类型。
Association	描述实体是文本的主题，还是描述其他人。
Certainty	描述实体确定性和极性。
ClassificationDocumentResult	包含任务的分类文档结果。
ClassificationResult	包含分类结果。
Conditionality	描述实体的任何条件。
CustomEntitiesResult	包含文档的检测到的自定义实体结果的列表。
CustomEntityRecognitionLROResult	包含自定义实体识别作业结果。
CustomLabelClassificationResult	包含自定义标签分类结果。
CustomMultiLabelClassificationLROResult	包含自定义多标签分类作业结果。
CustomSingleLabelClassificationLROResult	包含自定义单标签分类作业结果。
DocumentError	包含作业执行期间遇到的错误的详细信息。
DocumentSentimentValue	预测的文档情绪 (负面、中性、正面或混合) 。
DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
DocumentWarning	包含已处理文档遇到的警告的 warnings 对象。
EntitiesDocumentResult	包含文档的实体识别任务结果。
EntitiesResult	包含实体识别任务结果。
Entity	定义包含实体类别和检测到的实体文本等的检测到的实体对象。
EntityLinkingLROResult	包含分析文本实体链接任务 LRO 结果。
EntityLinkingResult	实体链接结果。
EntityRecognitionLROResult	包含实体识别作业任务结果。
Error	当服务在处理请求期间遇到一些错误时返回的错误响应对象。
ErrorCode	用户可读的错误代码。
ErrorResponse	错误响应。
ExtractedSummaryDocumentResult	表示提取摘要的句子的排名列表。
ExtractedSummarySentence	表示从输入文档中提取的句子。
ExtractiveSummarizationLROResult	一个对象，表示提取式摘要任务的结果。
ExtractiveSummarizationResult	一个对象，该对象表示每个文档的预生成提取式摘要结果。
HealthcareAssertion	实体的断言。
HealthcareEntitiesDocumentResult	已处理的 Healthcare 文档的 Result 对象。
HealthcareEntity	从文档中提取的医疗保健实体
healthcareEntityCategory	医疗保健实体类别。
HealthcareEntityLink	对已知数据源中的实体的引用。
HealthcareLROResult	Healthcare Analyze Text long tunning 操作结果对象。
HealthcareRelation	每个关系都是特定 relationType 的实体图，其中所有实体都相互连接，并在关系上下文中具有特定角色。
HealthcareRelationEntity	关系中的实体。
HealthcareResult	已处理医疗保健任务的结果对象。
InnerErrorCode	用户可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
KeyPhraseExtractionLROResult	包含分析文本 KeyPhraseExtraction LRO 任务。
KeyPhraseResult	包含 KeyPhraseResult。
KeyPhrasesDocumentResult	包含文档的关键短语提取结果。
LinkedEntitiesDocumentResult	实体链接文档结果。
LinkedEntity	包含检测到的实体以及关联的源/链接的 LinkedEntity 对象。
Match	包含具有偏移量和长度的检测到的实体文本的 Match 对象。
PiiEntitiesDocumentResult	包含 PII 结果。
PiiEntityRecognitionLROResult	包含 PII LRO 结果。
PiiResult	包含 PiiResult。
relationType	关系类型。示例包括： `DosageOfMedication` 或“FrequencyOfMedication”等。
RequestStatistics	如果在请求中指定了 showStats=true，则此字段将包含有关请求有效负载的信息。
SentenceAssessment	表示句子评估及其相关的评估或目标对象。
SentenceSentiment	文档的句子情绪。
SentenceSentimentValue	句子的预测情绪。
SentenceTarget	表示句子目标及其相关的评估或目标对象。
SentimentConfidenceScores	表示所有情绪类的置信度分数介于 0 和 1 之间：积极、中性、消极。
SentimentDocumentResult	一个对象，表示每个文档的预生成情绪分析结果。
SentimentLROResult	包含情绪分析 LRO 结果。
SentimentResponse	输入文档的情绪分析结果。
State	上次更新时任务的状态。
SummaryContext	摘要的上下文。
TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正和负。
TargetRelation	表示评估和/或目标之间的关系。
TargetRelationType	与目标相关的类型。
Tasks	LRO 作业的任务状态的容器。
TokenSentimentValue	句子的预测情绪。
WarningCodeValue	定义警告代码的列表。

AbstractiveSummarizationLROResult

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

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

AbstractiveSummarizationResult

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

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

AbstractiveSummary

一个对象，表示具有给定文档上下文的单个摘要。

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

AbstractiveSummaryDocumentResult

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

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

AnalyzeTextJobState

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

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

AnalyzeTextLROResultsKind

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

名称	类型	说明
AbstractiveSummarizationLROResults	string	抽象摘要 LRO 结果
CustomEntityRecognitionLROResults	string	自定义实体识别 LRO 结果
CustomMultiLabelClassificationLROResults	string	自定义多标签分类 LRO 结果
CustomSingleLabelClassificationLROResults	string	自定义单标签分类 LRO 结果
EntityLinkingLROResults	string	实体链接 LRO 结果
EntityRecognitionLROResults	string	实体识别 LRO 结果
ExtractiveSummarizationLROResults	string	提取式汇总 LRO 结果
HealthcareLROResults	string	Healthcare LRO 结果
KeyPhraseExtractionLROResults	string	关键短语提取 LRO 结果
PiiEntityRecognitionLROResults	string	PII 实体识别 LRO 结果
SentimentAnalysisLROResults	string	情绪分析 LRO 结果

Association

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

名称	类型	说明
other	string	其他关联
subject	string	主题关联

Certainty

描述实体确定性和极性。

名称	类型	说明
negative	string	负确定性
negativePossible	string	可能为负确定性
neutralPossible	string	可能中性确定性
positive	string	正确定性
positivePossible	string	可能为正确定性

ClassificationDocumentResult

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

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

ClassificationResult

包含分类结果。

名称	类型	说明
category	string	分类类型。
confidenceScore	number	已识别类的置信度分数介于 0 和 1 之间。

Conditionality

描述实体的任何条件。

名称	类型	说明
conditional	string	条件条件性
hypothetical	string	假设条件性

CustomEntitiesResult

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

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

CustomEntityRecognitionLROResult

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

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

CustomLabelClassificationResult

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

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

CustomMultiLabelClassificationLROResult

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

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

CustomSingleLabelClassificationLROResult

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

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

DocumentError

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

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

DocumentSentimentValue

预测的文档情绪 (负面、中性、正面或混合) 。

名称	类型	说明
mixed	string	混合语句
negative	string	Negative 语句
neutral	string	中性语句
positive	string	正语句

DocumentStatistics

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

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

DocumentWarning

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

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

EntitiesDocumentResult

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

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

EntitiesResult

包含实体识别任务结果。

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

Entity

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

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

EntityLinkingLROResult

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

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

EntityLinkingResult

实体链接结果。

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

EntityRecognitionLROResult

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

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

Error

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

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

ErrorCode

用户可读的错误代码。

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

ErrorResponse

错误响应。

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

ExtractedSummaryDocumentResult

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

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

ExtractedSummarySentence

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

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

ExtractiveSummarizationLROResult

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

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

ExtractiveSummarizationResult

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

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

HealthcareAssertion

实体的断言。

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

HealthcareEntitiesDocumentResult

已处理的 Healthcare 文档的 Result 对象。

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

HealthcareEntity

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

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

healthcareEntityCategory

医疗保健实体类别。

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

HealthcareEntityLink

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

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

HealthcareLROResult

Healthcare Analyze Text long tunning 操作结果对象。

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

HealthcareRelation

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

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

HealthcareRelationEntity

关系中的实体。

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

HealthcareResult

已处理医疗保健任务的结果对象。

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

InnerErrorCode

用户可读的错误代码。

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

InnerErrorModel

包含有关错误的更具体信息的对象。根据 Microsoft One 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

包含分析文本 KeyPhraseExtraction LRO 任务。

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

KeyPhraseResult

包含 KeyPhraseResult。

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

KeyPhrasesDocumentResult

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

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

LinkedEntitiesDocumentResult

实体链接文档结果。

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

LinkedEntity

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

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

Match

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

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

PiiEntitiesDocumentResult

包含 PII 结果。

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

PiiEntityRecognitionLROResult

包含 PII LRO 结果。

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

PiiResult

包含 PiiResult。

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

relationType

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

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

RequestStatistics

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

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

SentenceAssessment

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

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

SentenceSentiment

文档的句子情绪。

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

SentenceSentimentValue

句子的预测情绪。

名称	类型	说明
negative	string	负面情绪
neutral	string	中性情绪
positive	string	积极情绪

SentenceTarget

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

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

SentimentConfidenceScores

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

名称	类型	说明
negative	number	负面情绪的置信度分数
neutral	number	中性情绪的置信度分数
positive	number	积极情绪的置信度分数

SentimentDocumentResult

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

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

SentimentLROResult

包含情绪分析 LRO 结果。

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

SentimentResponse

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

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

State

上次更新时任务的状态。

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

SummaryContext

摘要的上下文。

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

TargetConfidenceScoreLabel

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

名称	类型	说明
negative	number	负面情绪的置信度分数
positive	number	积极情绪的置信度分数

TargetRelation

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

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

TargetRelationType

与目标相关的类型。

名称	类型	说明
assessment	string	评估关系。
target	string	目标关系。

Tasks

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

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

TokenSentimentValue

句子的预测情绪。

名称	类型	说明
mixed	string	混合情绪
negative	string	负面情绪
positive	string	积极情绪

WarningCodeValue

定义警告代码的列表。

名称	类型	说明
DocumentTruncated	string	文档截断警告
LongWordsInDocument	string	文档中的长字警告

通过

Analyze Text Job Status - Analyze Text Job Status

URI 参数

请求头

响应

安全性

Ocp-Apim-Subscription-Key

示例

SuccessfulAbstractiveSummarizationTaskResult

Sample Request

Sample Response

SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest

Sample Request

Sample Response

定义

AbstractiveSummarizationLROResult

AbstractiveSummarizationResult

AbstractiveSummary

AbstractiveSummaryDocumentResult

AnalyzeTextJobState

AnalyzeTextLROResultsKind

Association

Certainty

ClassificationDocumentResult

ClassificationResult

Conditionality

CustomEntitiesResult

CustomEntityRecognitionLROResult

CustomLabelClassificationResult

CustomMultiLabelClassificationLROResult

CustomSingleLabelClassificationLROResult

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResult

EntitiesResult

Entity

EntityLinkingLROResult

EntityLinkingResult

EntityRecognitionLROResult

Error

ErrorCode

ErrorResponse

ExtractedSummaryDocumentResult

ExtractedSummarySentence

ExtractiveSummarizationLROResult

ExtractiveSummarizationResult

HealthcareAssertion

HealthcareEntitiesDocumentResult

HealthcareEntity

healthcareEntityCategory

HealthcareEntityLink

HealthcareLROResult

HealthcareRelation

HealthcareRelationEntity

HealthcareResult

InnerErrorCode

InnerErrorModel

KeyPhraseExtractionLROResult

KeyPhraseResult

KeyPhrasesDocumentResult

LinkedEntitiesDocumentResult

LinkedEntity

Match

PiiEntitiesDocumentResult

PiiEntityRecognitionLROResult

PiiResult

relationType

RequestStatistics

SentenceAssessment

SentenceSentiment

SentenceSentimentValue

SentenceTarget

SentimentConfidenceScores

SentimentDocumentResult

SentimentLROResult

SentimentResponse

State

SummaryContext