Analyze Text Submit Job - Analyze Text Submit Job

服务:

Azure AI Services

API 版本:

2024-11-01

提交文本文档集合以供分析。 指定要作为长时间运行的操作执行的一个或多个唯一任务。

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如 https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
analysisInput	True	MultiLanguageAnalysisInput	包含要分析的输入。
tasks	True	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	要作为 LRO 的一部分执行的任务的列表。
displayName		string	任务的名称。

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。 标头 Operation-Location: string
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

示例

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

SuccessfulAbstractiveSummarizationTaskSubmit

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

SuccessfulHealthcareDocumentTypePostRequest

SuccessfulHealthcarePostRequest

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

示例请求

HTTP

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

{
  "displayName": "Document Abstractive Summarization Task Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
      }
    ]
  },
  "tasks": [
    {
      "kind": "AbstractiveSummarization",
      "taskName": "Document Abstractive Summarization Task 1",
      "parameters": {
        "summaryLength": "medium"
      }
    }
  ]
}

示例响应

状态代码:

202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulAbstractiveSummarizationTaskSubmit

示例请求

HTTP

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

{
  "displayName": "Document Abstractive Summarization Task Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
      }
    ]
  },
  "tasks": [
    {
      "kind": "AbstractiveSummarization",
      "taskName": "Document Abstractive Summarization Task 1",
      "parameters": {
        "sentenceCount": 1
      }
    }
  ]
}

示例响应

状态代码:

202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

示例请求

HTTP

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

{
  "displayName": "Extracting Location & US Region",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "I had a wonderful trip to Seattle last week."
      },
      {
        "id": "2",
        "language": "en",
        "text": "I'm flying to NYC tomorrow. See you there."
      }
    ]
  },
  "tasks": [
    {
      "kind": "EntityRecognition",
      "taskName": "Recognize Entities",
      "parameters": {
        "modelVersion": "latest"
      }
    },
    {
      "kind": "CustomEntityRecognition",
      "taskName": "Recognize US Regions",
      "parameters": {
        "projectName": "MyProject",
        "deploymentName": "MyDeployment"
      }
    }
  ]
}

示例响应

状态代码:

202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulHealthcareDocumentTypePostRequest

示例请求

HTTP

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

{
  "analysisInput": {
    "documents": [
      {
        "text": "Prescribed 100mg ibuprofen, taken twice daily.",
        "id": "1",
        "language": "en"
      }
    ]
  },
  "tasks": [
    {
      "kind": "Healthcare",
      "parameters": {
        "modelVersion": "latest",
        "fhirVersion": "4.0.1",
        "documentType": "DischargeSummary"
      }
    }
  ]
}

示例响应

状态代码:

202

Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01

SuccessfulHealthcarePostRequest

示例请求

HTTP

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

{
  "analysisInput": {
    "documents": [
      {
        "text": "Prescribed 100mg ibuprofen, taken twice daily.",
        "id": "1",
        "language": "en"
      }
    ]
  },
  "tasks": [
    {
      "kind": "Healthcare",
      "parameters": {
        "modelVersion": "latest"
      }
    }
  ]
}

示例响应

状态代码:

202

Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01

定义

名称	说明
AbstractiveSummarizationLROTask	一个对象，表示抽象摘要任务的任务定义。
AbstractiveSummarizationTaskParameters	预生成的抽象摘要任务支持的参数。
AllowOverlapEntityPolicyType	表示允许重叠策略。 不会对实体应用后期处理逻辑。 模型预测的任何内容都将返回给用户。 这样，用户就可以获取每个模型可能值的完整视图，并在实体选择时应用自己的自定义逻辑
AnalyzeTextJobsInput	分析文本 LRO 的输入对象。
AnalyzeTextLROTaskKind	支持的长时间运行的分析文本任务的类型。
CustomEntitiesLROTask	包含自定义文本 LRO 任务。
CustomEntitiesTaskParameters	自定义实体任务支持的参数。
CustomMultiLabelClassificationLROTask	使用自定义模型将文本分类为多标签分类
CustomMultiLabelClassificationTaskParameters	自定义多分类任务支持的参数。
CustomSingleLabelClassificationLROTask	使用自定义模型将文本分类为单个标签分类
CustomSingleLabelClassificationTaskParameters	自定义单一分类任务支持的参数。
EntitiesLROTask	一个对象，表示实体识别任务的任务定义。
EntitiesTaskParameters	实体识别任务支持的参数。
EntityCategory	包含实体识别检测到的所有实体类别。
EntityInferenceOptions	包含允许命名实体识别的推理选项的类。
EntityLinkingLROTask	包含分析文本实体链接 LRO 任务。
EntityLinkingTaskParameters	实体链接任务支持的参数。
Error	服务在处理请求期间遇到一些错误时返回的错误响应对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
ExtractiveSummarizationLROTask	一个对象，表示提取摘要任务的任务定义。
ExtractiveSummarizationSortingCriteria	指定如何对提取的摘要进行排序。
ExtractiveSummarizationTaskParameters	提取摘要任务支持的参数。
fhirVersion	FHIR 规范版本。
healthcareDocumentType	文档类型。
HealthcareLROTask	服务要对医疗保健输入文档执行的长时间运行任务。
HealthcareTaskParameters	医疗保健任务支持的参数。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
KeyPhraseLROTask	一个对象，表示关键短语提取任务的任务定义。
KeyPhraseTaskParameters	关键短语提取任务支持的参数。
MatchLongestEntityPolicyType	表示匹配最长重叠策略。 尽可能没有重叠实体。 1. 如果有重叠的实体，将返回最长的实体。 2. 如果为 2 个或多个实体预测的字符集完全相同，请选择置信度分数较高的实体。 如果实体分数相同，则返回应用上述规则后仍然存在的所有实体。 3. 如果部分重叠（如 Hello 文本分析中所示），请遵循从 1 开始的上述步骤。
MultiLanguageAnalysisInput	要由服务分析的输入文档的集合。
MultiLanguageInput	包含要由服务分析的输入文档。
PiiCategory	（可选）描述要返回的 PII 类别
PiiDomain	PII 任务的域
PiiLROTask	包含分析文本 PIIEntityRecognition LRO 任务。
PiiTaskParameters	PII 实体识别任务支持的参数。
SentimentAnalysisLROTask	一个对象，表示情绪分析任务的任务定义。
SentimentAnalysisTaskParameters	情绪分析任务支持的参数。
StringIndexType	字符串索引类型
SummaryLengthBucket	定义输出摘要长度的枚举。

AbstractiveSummarizationLROTask

Object

一个对象，表示抽象摘要任务的任务定义。

名称	类型	说明
kind	string: AbstractiveSummarization	要执行的任务类型。
parameters	AbstractiveSummarizationTaskParameters	抽象摘要任务的参数。
taskName	string	任务名称

AbstractiveSummarizationTaskParameters

Object

预生成的抽象摘要任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
sentenceCount	integer (int32)		控制输出摘要中的大致句子数。
stringIndexType	StringIndexType	TextElements_v8	字符串索引类型
summaryLength	SummaryLengthBucket		（注意：建议使用 summaryLength over sentenceCount）控制输出摘要的大致长度。

AllowOverlapEntityPolicyType

Object

表示允许重叠策略。 不会对实体应用后期处理逻辑。 模型预测的任何内容都将返回给用户。 这样，用户就可以获取每个模型可能值的完整视图，并在实体选择时应用自己的自定义逻辑

名称	类型	默认值	说明
policyKind	string: allowOverlap	matchLongest	实体 OverlapPolicy 对象类型。

AnalyzeTextJobsInput

Object

分析文本 LRO 的输入对象。

名称	类型	说明
analysisInput	MultiLanguageAnalysisInput	包含要分析的输入。
displayName	string	任务的名称。
tasks	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	要作为 LRO 的一部分执行的任务的列表。

AnalyzeTextLROTaskKind

枚举

支持的长时间运行的分析文本任务的类型。

值	说明
AbstractiveSummarization	抽象摘要任务
CustomEntityRecognition	自定义实体识别任务
CustomMultiLabelClassification	自定义多标签分类任务
CustomSingleLabelClassification	自定义单标签分类任务
EntityLinking	实体链接任务
EntityRecognition	实体识别任务
ExtractiveSummarization	提取摘要任务
Healthcare	医疗保健任务
KeyPhraseExtraction	关键短语提取任务
PiiEntityRecognition	PII 实体识别任务
SentimentAnalysis	情绪分析任务

CustomEntitiesLROTask

Object

包含自定义文本 LRO 任务。

名称	类型	说明
kind	string: CustomEntityRecognition	要执行的任务类型。
parameters	CustomEntitiesTaskParameters	任务参数。
taskName	string	任务名称

CustomEntitiesTaskParameters

Object

自定义实体任务支持的参数。

名称	类型	默认值	说明
deploymentName	string		此字段指示模型的部署名称。
loggingOptOut	boolean	False	日志记录选择退出
projectName	string		此字段指示模型的项目名称。
stringIndexType	StringIndexType	TextElements_v8	用于提供用于解释字符串偏移的字符串索引类型的可选参数。 默认为 TextElements （Graphemes）。

CustomMultiLabelClassificationLROTask

Object

使用自定义模型将文本分类为多标签分类

名称	类型	说明
kind	string: CustomMultiLabelClassification	要执行的任务类型。
parameters	CustomMultiLabelClassificationTaskParameters	任务参数。
taskName	string	任务名称

CustomMultiLabelClassificationTaskParameters

Object

自定义多分类任务支持的参数。

名称	类型	默认值	说明
deploymentName	string		此字段指示模型的部署名称。
loggingOptOut	boolean	False	日志记录选择退出
projectName	string		此字段指示模型的项目名称。

CustomSingleLabelClassificationLROTask

Object

使用自定义模型将文本分类为单个标签分类

名称	类型	说明
kind	string: CustomSingleLabelClassification	要执行的任务类型。
parameters	CustomSingleLabelClassificationTaskParameters	任务参数
taskName	string	任务名称

CustomSingleLabelClassificationTaskParameters

Object

自定义单一分类任务支持的参数。

名称	类型	默认值	说明
deploymentName	string		此字段指示模型的部署名称。
loggingOptOut	boolean	False	日志记录选择退出
projectName	string		此字段指示模型的项目名称。

EntitiesLROTask

Object

一个对象，表示实体识别任务的任务定义。

名称	类型	说明
kind	string: EntityRecognition	要执行的任务类型。
parameters	EntitiesTaskParameters	任务参数。
taskName	string	任务名称

EntitiesTaskParameters

Object

实体识别任务支持的参数。

名称	类型	默认值	说明
exclusionList	EntityCategory[]		（可选）请求参数，用于筛选出包含 excludeList 的任何实体。 当用户指定 excludeList 时，他们无法获取使用该列表中的实体返回的预测。 我们将在 exclusionList 之前应用 inclusionList
inclusionList	EntityCategory[]		（可选） 请求参数，用于将输出限制为此列表中包含的请求实体类型。 我们将在 exclusionList 之前应用 inclusionList
inferenceOptions	EntityInferenceOptions		（可选）请求参数，允许用户提供运行推理的设置。
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		（可选）描述应用于 ner 输出的重叠策略的类型。
stringIndexType	StringIndexType	TextElements_v8	（可选）参数，用于提供用于解释字符串偏移量的字符串索引类型。 默认为 TextElements （Graphemes）。

EntityCategory

枚举

包含实体识别检测到的所有实体类别。

值	说明
Address	具体街道级别提到位置：房屋/建筑编号、街道、大道、高速公路、按名称引用的交叉口。
Age	与年龄相关的值。
Airport	机场。
Area	对象的区域。
City	与城市相关的值。
ComputingProduct	计算产品。
Continent	与大陆相关的值。
CountryRegion	与国家或地区相关的值。
CulturalEvent	与文化事件相关的值。
Currency	与货币相关的值。
Date	日历日期。
DateRange	日期范围。
DateTime	带时间的日历日期。
DateTimeRange	日期和时间范围。
Dimension	度量维度
Duration	持续时间。
Email	电子邮件地址。
Event	社会、体育、商业、政治、教育、自然、历史、犯罪、暴力、法律、军事活动等一段时间。
GPE	城市、国家/地区、州。
Geological	地理和自然特征，如河流、海洋和沙漠。
Height	对象的高度。
IP	网络 IP 地址。
Information	数字信息的度量单位。
Length	对象的长度。
Location	物理空间中的特定点或位置。
NaturalEvent	与事件相关的自然值。
Number	没有单位的数字
NumberRange	数字范围
Numeric	数值，包括数字和数字字。
Ordinal	序号。
Organization	由一些既定组织结构定义的公司、机构和其他人员群体。 这些标签可以包括公司、政党/运动、音乐乐队、体育俱乐部、政府机构和公共组织。 民族或宗教不是组织。
OrganizationMedical	医疗公司和集团。
OrganizationSports	与体育相关的组织。
OrganizationStockExchange	证券交易所集团。
Percentage	与百分比相关的值。
Person	第一个、最后一个和中间名、虚构字符的名称和别名。 标题，如“先生”。 或“总统”，不被视为命名实体的一部分。
PersonType	按组成员身份分类的人类角色。
PhoneNumber	电话号码（仅限美国和欧盟电话号码）。
Product	单一或一组商业、易耗品、电子、车辆、食品组。
SetTemporal	与时间相关的值集。
Skill	功能、技能或专业知识。
Speed	对象的速度。
SportsEvent	与体育赛事相关的值。
State	与状态相关的值。
Structural	人造结构。
Temperature	与温度相关的值。
Temporal	与时间相关的项。
Time	一天中的时间。
TimeRange	时间范围。
URL	网站的 URL。
Volume	对象的卷。
Weight	对象的权重。

EntityInferenceOptions

Object

包含允许命名实体识别的推理选项的类。

名称	类型	默认值	说明
excludeNormalizedValues	boolean	False	用于包括/排除要规范化的检测到的实体值并将其包含在元数据中的选项。 数值和临时实体类型支持值规范化。

EntityLinkingLROTask

Object

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

名称	类型	说明
kind	string: EntityLinking	要执行的任务类型。
parameters	EntityLinkingTaskParameters	任务参数。
taskName	string	任务名称

EntityLinkingTaskParameters

Object

实体链接任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
stringIndexType	StringIndexType	TextElements_v8	用于提供用于解释字符串偏移的字符串索引类型的可选参数。 默认为 TextElements （Graphemes）。

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	错误对象。

ExtractiveSummarizationLROTask

Object

一个对象，表示提取摘要任务的任务定义。

名称	类型	说明
kind	string: ExtractiveSummarization	要执行的任务类型。
parameters	ExtractiveSummarizationTaskParameters	提取摘要任务的参数。
taskName	string	任务名称

ExtractiveSummarizationSortingCriteria

枚举

指定如何对提取的摘要进行排序。

值	说明
Offset	指示结果应按文本外观顺序排序。
Rank	指示应按重要性顺序（即排名分数）根据模型对结果进行排序。

ExtractiveSummarizationTaskParameters

Object

提取摘要任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
sentenceCount	integer (int64)	3	指定提取摘要中的句子数。
sortBy	ExtractiveSummarizationSortingCriteria	Offset	指定如何对提取的摘要进行排序。
stringIndexType	StringIndexType	TextElements_v8	指定用于解释字符串偏移的方法。

fhirVersion

枚举

FHIR 规范版本。

值	说明
4.0.1	版本 4.0.1

healthcareDocumentType

枚举

文档类型。

值	说明
ClinicalTrial	临床试验文档类型
Consult	查阅文档类型
DischargeSummary	释放摘要文档类型
HistoryAndPhysical	历史记录和物理文档类型
Imaging	图像处理文档类型
None	无文档类型
Pathology	病理学文档类型
ProcedureNote	过程说明文档类型
ProgressNote	进度说明文档类型

HealthcareLROTask

Object

服务要对医疗保健输入文档执行的长时间运行任务。

名称	类型	说明
kind	string: Healthcare	要执行的任务类型。
parameters	HealthcareTaskParameters	医疗保健任务的参数。
taskName	string	任务名称

HealthcareTaskParameters

Object

医疗保健任务支持的参数。

名称	类型	默认值	说明
documentType	healthcareDocumentType		可作为 Fhir Documents 的输入提供的文档类型。 预期在使用时会提供 fhirVersion。 使用 None 枚举的行为与不使用 documentType 参数的行为相同。
fhirVersion	fhirVersion		结果用于格式化 fhirBundle 的 FHIR 规范版本。 有关详细信息，请参阅 https://www.hl7.org/fhir/overview.html。
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
stringIndexType	StringIndexType	TextElements_v8	指定用于解释字符串偏移的方法。

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	错误目标。

KeyPhraseLROTask

Object

一个对象，表示关键短语提取任务的任务定义。

名称	类型	说明
kind	string: KeyPhraseExtraction	要执行的任务类型。
parameters	KeyPhraseTaskParameters	关键短语提取任务参数。
taskName	string	任务名称

KeyPhraseTaskParameters

Object

关键短语提取任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本

MatchLongestEntityPolicyType

Object

表示匹配最长重叠策略。 尽可能没有重叠实体。 1. 如果有重叠的实体，将返回最长的实体。 2. 如果为 2 个或多个实体预测的字符集完全相同，请选择置信度分数较高的实体。 如果实体分数相同，则返回应用上述规则后仍然存在的所有实体。 3. 如果部分重叠（如 Hello 文本分析中所示），请遵循从 1 开始的上述步骤。

名称	类型	默认值	说明
policyKind	string: matchLongest	matchLongest	实体 OverlapPolicy 对象类型。

MultiLanguageAnalysisInput

Object

要由服务分析的输入文档的集合。

名称	类型	说明
documents	MultiLanguageInput[]	要分析的输入文档。

MultiLanguageInput

Object

包含要由服务分析的输入文档。

名称	类型	说明
id	string	唯一的非空文档标识符。
language	string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。 例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。 （以下仅适用于 2023-04-15-preview 及更高版本）对于自动语言检测，请使用“auto”。 如果未设置，请将“en”用于英语作为默认值。
text	string	要处理的输入文本。

PiiCategory

枚举

（可选）描述要返回的 PII 类别

值	说明
ABARoutingNumber	ABA 路由编号
ARNationalIdentityNumber	AR 国家标识号
ATIdentityCard	AT 标识卡
ATTaxIdentificationNumber	AT 税务标识号
ATValueAddedTaxNumber	AT 增值税号码
AUBankAccountNumber	AT Bank 帐户号
AUBusinessNumber	AU 业务编号
AUCompanyNumber	AU 公司编号
AUDriversLicenseNumber	AU 驾照编号
AUMedicalAccountNumber	AU 医疗帐户号
AUPassportNumber	AU Passport 号码
AUTaxFileNumber	AU 税务文件编号
Address	地址
Age	年龄
All	所有 PII 类别。
AzureDocumentDBAuthKey	Azure Document DB 身份验证密钥
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS 数据库连接和 SQL 字符串
AzureIoTConnectionString	Azure IoT 连接字符串
AzurePublishSettingPassword	Azure 发布设置密码
AzureRedisCacheString	Azure Redis 缓存字符串
AzureSAS	Azure SAS
AzureServiceBusString	Azure 服务总线字符串
AzureStorageAccountGeneric	Azure 存储帐户通用
AzureStorageAccountKey	Azure 存储帐户密钥
BENationalNumber	BE National Number
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	BE 增值税号码
BGUniformCivilNumber	BG 统一民用号码
BRCPFNumber	BR CPF 编号
BRLegalEntityNumber	BR 法律实体编号
BRNationalIDRG	BR 国家 ID RG
CABankAccountNumber	CA 银行帐户号
CADriversLicenseNumber	CA 驱动程序许可证号
CAHealthServiceNumber	CA 运行状况服务编号
CAPassportNumber	CA Passport 号码
CAPersonalHealthIdentification	CA 个人运行状况标识
CASocialInsuranceNumber	CA 社会保险号码
CHSocialSecurityNumber	CH 社会保险号码
CLIdentityCardNumber	CL 标识卡号
CNResidentIdentityCardNumber	CN 居民身份证号
CYIdentityCard	CY 标识卡
CYTaxIdentificationNumber	CY 税务标识号
CZPersonalIdentityNumber	CZ 个人标识号
CZPersonalIdentityV2	CZ 个人标识 V2
CreditCardNumber	信用卡号
DEDriversLicenseNumber	DE Driver's License Number
DEIdentityCardNumber	DE Identity Card Number
DEPassportNumber	DE Passport 号码
DETaxIdentificationNumber	DE 税务标识号
DEValueAddedNumber	DE Value Added Number
DKPersonalIdentificationNumber	DK 个人标识号
DKPersonalIdentificationV2	DK 个人标识 V2
Date	日期
Default	语言的默认 PII 类别。
DrugEnforcementAgencyNumber	毒品执法局号码
EEPersonalIdentificationCode	EE 个人标识代码
ESDNI	ES DNI
ESSocialSecurityNumber	ES 社会保险号码
ESTaxIdentificationNumber	ES 税务标识号
EUDebitCardNumber	欧盟借记卡号码
EUDriversLicenseNumber	欧盟驾照编号
EUGPSCoordinates	欧盟 GPS 坐标
EUNationalIdentificationNumber	欧盟国家标识号
EUPassportNumber	欧盟护照号码
EUSocialSecurityNumber	欧盟社会保障号码
EUTaxIdentificationNumber	欧盟税务标识号
Email	电子邮件
FIEuropeanHealthNumber	FI 欧洲健康号码
FINationalID	FI 国家/地区 ID
FINationalIDV2	FI 国家/地区 ID V2
FIPassportNumber	FI Passport 号码
FRDriversLicenseNumber	FR 驱动程序许可证号
FRHealthInsuranceNumber	FR 健康保险号码
FRNationalID	FR 国家/地区 ID
FRPassportNumber	FR Passport 号码
FRSocialSecurityNumber	FR 社会保险号码
FRTaxIdentificationNumber	FR 税务标识号
FRValueAddedTaxNumber	FR 增值税号
GRNationalIDCard	GR 国家 ID 卡
GRNationalIDV2	GR 国家/地区 ID V2
GRTaxIdentificationNumber	GR 税务标识号
HKIdentityCardNumber	HK 身份证号码
HRIdentityCardNumber	HR 标识卡号
HRNationalIDNumber	HR 国家/地区 ID 编号
HRPersonalIdentificationNumber	HR 个人标识号
HRPersonalIdentificationOIBNumberV2	HR 个人标识 OIB 号码 V2
HUPersonalIdentificationNumber	胡个人标识号
HUTaxIdentificationNumber	胡税务标识号
HUValueAddedNumber	胡增值数字
IDIdentityCardNumber	ID 标识卡号
IEPersonalPublicServiceNumber	IE 个人公共服务号码
IEPersonalPublicServiceNumberV2	IE 个人公共服务号码 V2
ILBankAccountNumber	IL 银行帐户号
ILNationalID	IL 国家/地区 ID
INPermanentAccount	IN 永久帐户
INUniqueIdentificationNumber	IN 唯一标识号
IPAddress	IP地址
ITDriversLicenseNumber	IT 驱动程序的许可证号
ITFiscalCode	IT 会计代码
ITValueAddedTaxNumber	IT 增值税号
InternationalBankingAccountNumber	国际银行帐户编号
JPBankAccountNumber	JP 银行帐户编号
JPDriversLicenseNumber	JP 驱动程序许可证号
JPMyNumberCorporate	JP 我的号码公司
JPMyNumberPersonal	JP 我的号码个人
JPPassportNumber	JP Passport 号码
JPResidenceCardNumber	JP 住宅卡号码
JPResidentRegistrationNumber	JP 居民注册号
JPSocialInsuranceNumber	JP 社会保险号码
KRResidentRegistrationNumber	KR 居民注册号码
LTPersonalCode	LT 个人代码
LUNationalIdentificationNumberNatural	LU 国家标识号自然
LUNationalIdentificationNumberNonNatural	LU 国家标识号非自然
LVPersonalCode	LV 个人代码
MTIdentityCardNumber	MT 标识卡号
MTTaxIDNumber	MT 税号
MYIdentityCardNumber	MY Identity Card Number
NLCitizensServiceNumber	NL 公民服务号码
NLCitizensServiceNumberV2	NL 公民服务号码 V2
NLTaxIdentificationNumber	NL 税务标识号
NLValueAddedTaxNumber	NL 增值税号
NOIdentityNumber	NO 标识号
NZBankAccountNumber	NZ Bank 帐户编号
NZDriversLicenseNumber	NZ Driver's License Number
NZInlandRevenueNumber	NZ 内陆收入号码
NZMinistryOfHealthNumber	新西兰卫生部号码
NZSocialWelfareNumber	NZ 社会福利号码
Organization	组织
PHUnifiedMultiPurposeIDNumber	PH 统一多用途 ID 号
PLIdentityCard	PL 标识卡
PLNationalID	PL 国家 ID
PLNationalIDV2	PL 国家 ID V2
PLPassportNumber	PL Passport 号码
PLREGONNumber	PL REGON 编号
PLTaxIdentificationNumber	PL 税务标识号
PTCitizenCardNumber	PT 公民卡号码
PTCitizenCardNumberV2	PT 公民卡号码 V2
PTTaxIdentificationNumber	PT 税务标识号
Person	人
PhoneNumber	电话号码
ROPersonalNumericalCode	RO 个人数字代码
RUPassportNumberDomestic	RU Passport 号码国内
RUPassportNumberInternational	RU Passport 号码国际
SANationalID	SA 国家/地区 ID
SENationalID	SE 国家/地区 ID
SENationalIDV2	SE 国家 ID V2
SEPassportNumber	SE Passport 号码
SETaxIdentificationNumber	SE 税务标识号
SGNationalRegistrationIdentityCardNumber	SG 国家注册身份证号
SITaxIdentificationNumber	SI 税务标识号
SIUniqueMasterCitizenNumber	SI 唯一主公民号码
SKPersonalNumber	SK 个人号码
SQLServerConnectionString	SQL Server 连接字符串
SWIFTCode	SWIFT 代码
THPopulationIdentificationCode	TH 总体标识代码
TRNationalIdentificationNumber	TR 国家标识号
TWNationalID	TW 国家/地区 ID
TWPassportNumber	TW Passport 号码
TWResidentCertificate	TW 居民证书
UAPassportNumberDomestic	UA 护照号码国内
UAPassportNumberInternational	UA Passport Number International
UKDriversLicenseNumber	英国驾照编号
UKElectoralRollNumber	英国选举卷编号
UKNationalHealthNumber	英国国民健康号码
UKNationalInsuranceNumber	英国国民保险号码
UKUniqueTaxpayerNumber	英国唯一纳税人号码
URL	网址
USBankAccountNumber	美国银行帐户号
USDriversLicenseNumber	美国驾照编号
USIndividualTaxpayerIdentification	美国个人纳税人身份
USSocialSecurityNumber	美国社会保险号码
USUKPassportNumber	美国英国护照号码
ZAIdentificationNumber	ZA 标识号

PiiDomain

枚举

PII 任务的域

值	说明
none	指示未指定域。
phi	指示应对个人运行状况信息域中的实体进行修订。

PiiLROTask

Object

包含分析文本 PIIEntityRecognition LRO 任务。

名称	类型	说明
kind	string: PiiEntityRecognition	要执行的任务类型。
parameters	PiiTaskParameters	Pii 任务参数。
taskName	string	任务名称

PiiTaskParameters

Object

PII 实体识别任务支持的参数。

名称	类型	默认值	说明
domain	PiiDomain	none	PII 任务的域
loggingOptOut	boolean	True	日志记录选择退出
modelVersion	string	latest	模型版本
piiCategories	PiiCategory[]		将在响应中返回的 PII 类别的枚举。
stringIndexType	StringIndexType	TextElements_v8	要用于分析的 StringIndexType。

SentimentAnalysisLROTask

Object

一个对象，表示情绪分析任务的任务定义。

名称	类型	说明
kind	string: SentimentAnalysis	要执行的任务类型。
parameters	SentimentAnalysisTaskParameters	情绪分析任务的参数。
taskName	string	任务名称

SentimentAnalysisTaskParameters

Object

情绪分析任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
opinionMining	boolean	False	是否在请求中使用意见挖掘。
stringIndexType	StringIndexType	TextElements_v8	指定用于解释字符串偏移的方法。

StringIndexType

枚举

字符串索引类型

值	说明
TextElements_v8	返回的偏移量和长度值将与 TextElements（Graphemes 和 Grapheme 群集）相对应，确认为 Unicode 8.0.0 标准。 如果应用程序是用 .Net Framework 或 .Net Core 编写的，并且将使用 StringInfo，请使用此选项。
UnicodeCodePoint	返回的偏移量和长度值将对应于 Unicode 码位。 如果使用支持 Unicode 的语言（例如 Python）编写应用程序，请使用此选项。
Utf16CodeUnit	返回的偏移量和长度值将对应于 UTF-16 代码单元。 如果应用程序是用支持 Unicode 的语言（例如 Java、JavaScript）编写的，请使用此选项。

SummaryLengthBucket

枚举

定义输出摘要长度的枚举。

值	说明
long	指示模型生成更长的长度摘要。
medium	指示模型生成中等长度摘要。
short	指示模型生成较短的长度摘要。