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

适用于语言的 Azure 认知服务

Azure 认知语言服务（以前称为“文本分析”连接器）可检测提供的语言、情绪和其他文本。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	标准	所有 Power Automate 区域
逻辑应用程序	标准	所有逻辑应用区域
Power Apps	标准	所有 Power Apps 区域
Power Automate	标准	所有 Power Automate 区域

联系人
Name	Microsoft
URL	https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2
Email	mlapi@microsoft.com

连接器元数据
发布者	Microsoft
网站	https://azure.microsoft.com/services/cognitive-services/text-analytics/

注释

此连接器以前称为“文本分析”或“Microsoft认知服务文本分析”。

若要使用此集成，需要在 Azure 门户中使用认知服务资源。你将获得用于对应用程序进行身份验证的终结点和密钥。若要建立连接，请提供帐户密钥、站点 URL 并选择“ 创建连接”。有关连接的作成本，请在此处了解详细信息。

现在，你已准备好开始使用此集成。

使用 Microsoft Entra ID 进行连接

若要使用 Microsoft Entra ID 创建连接，必须将认知服务用户角色添加到帐户才能访问。若要使用此连接，必须将认知服务资源关联的唯一子域输入到支持作中。

Microsoft Entra ID 身份验证不支持的作

使用 Microsoft Entra ID 身份验证 时，仅支持 V4作。弃用的作将继续使用 Access Key 身份验证，但如果 与 Microsoft Entra ID 连接一起使用，将失败。

正在创建连接

连接器支持以下身份验证类型：


Api 密钥	ApiKey（应用程序密钥）	所有区域	可共享
默认值 [已弃用]	此选项仅适用于没有显式身份验证类型的较旧连接，并且仅用于向后兼容性。	所有区域	不可共享

Api 密钥

身份验证 ID：keyBasedAuth

适用：所有区域

ApiKey（应用程序密钥）

这是可共享的连接。如果 Power App 与其他用户共享，则连接也会共享。有关详细信息，请参阅画布应用的连接器概述 - Power Apps |Microsoft Docs

Name	类型	Description	必选
帐户密钥	securestring	认知服务帐户密钥	True
网站 URL	字符串	根网站 URL （示例： https://westus.api.cognitive.microsoft.com）

默认值 [已弃用]

适用：所有区域

此选项仅适用于没有显式身份验证类型的较旧连接，并且仅用于向后兼容性。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
帐户密钥	securestring	认知服务帐户密钥	True
网站 URL	字符串	根网站 URL （示例： https://westus.api.cognitive.microsoft.com）。如果未指定，网站 URL 将默认为 https://westus.api.cognitive.microsoft.com。

限制

名称	调用	续订期
每个连接的 API 调用数	1200	60 秒

操作

Async CustomEntityRecognition （2022-05-01）	提交文本文档集合以进行自定义实体识别分析。
Async CustomSingleLabelClassification （2022-05-01）	提交文本文档集合以进行自定义单一分类分析。
Async EntityRecognition （2022-05-01）	提交文本文档集合以进行实体识别分析。
Async PiiEntityRecognition （2022-05-01）	提交文本文档集合以进行个人实体识别分析。
从 Project 生成答案	此作有助于在项目中使用知识库回答指定的问题。
关键短语 [已弃用]	此作已弃用。请改用关键短语（V4）。 ~~返回表示输入文本中关键说话点的字符串列表。目前支持以下语言：英语、德语、西班牙语和日语。~~
关键短语 [已弃用]	此作已弃用。请改用关键短语（V4）。 ~~返回表示输入文本中关键说话点的字符串列表。~~
关键短语（V2） [已弃用]	此作已弃用。请改用关键短语（V4）。 ~~返回一个字符串列表，该字符串表示每个文档的输入文本中的关键说话点。~~
关键短语（V3.0）	API 返回表示输入文本中关键短语的字符串列表。有关支持的语言列表，请参阅关键短语提取的语言支持。
关键短语（V3.1）（预览版）	API 返回表示输入文本中关键短语的字符串列表。有关支持的语言列表，请参阅关键短语提取的语言支持。
关键短语（V4）（预览版）	API 返回表示输入文本中关键短语的字符串列表。有关支持的语言列表，请参阅关键短语提取的语言支持。
命名实体识别（V3.0）	API 返回给定文档中常规命名实体的列表。有关支持的实体类型列表，请查看支持的命名实体识别（NER）实体类别。
命名实体识别（V3.1）（预览版）	API 返回给定文档中常规命名实体的列表。有关支持的实体类型列表，请查看支持的命名实体识别（NER）实体类别。
命名实体识别（V4）（预览版）	API 返回给定文档中常规命名实体的列表。有关支持的实体类型列表，请查看支持的命名实体识别（NER）实体类别。
实体 [已弃用]	此作已弃用。请改用命名实体识别（V4）。 ~~返回给定文档中已知实体和常规命名实体的列表（“Person”、“Location”、“Organization”等）。~~
实体链接（V3.0）	API 返回一个可识别实体列表，其中包含指向已知知识库的链接。有关支持的语言列表，请参阅语言支持。
实体链接（V3.1）（预览版）	API 返回一个已识别实体列表，其中包含指向已知知识库的链接。有关支持的语言列表，请参阅语言支持。
实体链接（V4）（预览版）	API 返回一个已识别实体列表，其中包含指向已知知识库的链接。有关支持的语言列表，请参阅语言支持。
对话（CLU）（2022-05-01）	分析输入对话话语。
对话（业务流程）（2022-05-01）	分析输入对话话语。
异步 AbstractiveSummarization （2022-10-01-preview）	提交文本文档集合以进行抽象摘要
异步 CustomMultiLabelClassification （2022-05-01）	提交文本文档集合以进行自定义单一分类分析。
异步 EntityLinking （2022-05-01）	提交文本文档集合以进行实体链接分析。
异步 KeyPhrases （2022-05-01）	提交文本文档集合以进行关键短语提取分析。
异步 SentimentAnalysis （2022-05-01）	提交文本文档集合以进行情绪分析。
异步医疗保健（2022-05-01）	提交文本文档集合以进行医疗保健分析。
异步对话 PII （文本）（2022-05-15-preview）	提交对话集合进行分析。指定要执行的一个或多个唯一任务。
异步对话 PII （脚本）（2022-05-15-preview）	提交对话集合进行分析。指定要执行的一个或多个唯一任务。
异步对话摘要（2022-05-15-preview）	提交对话集合进行分析。指定要执行的一个或多个唯一任务。
异步提取摘要（2022-10-01-preview）	提交文本文档集合以进行提取摘要
情绪（V3.1）（预览版）	API 返回输入文本的详细情绪分析。分析以多个粒度级别完成，从文档级别开始，到句子和关键术语（目标和评估）。
情绪（V4）（预览版）	API 返回输入文本的详细情绪分析。分析以多个粒度级别完成，从文档级别开始，到句子和关键术语（目标和评估）。
情绪（V3.0）	API 为文档及其中的每个句子返回情绪预测，以及每个情绪类（积极、负面和中性）的情绪评分。有关支持的语言列表，请参阅情绪分析和意见挖掘语言支持。
检测个人信息（V3.1）	API 返回文档中包含个人信息（“SSN”、“银行帐户”等）的实体列表。有关支持的实体类型列表，请查看支持的个人身份信息（PII）实体类别。有关支持的语言列表，请参阅 Azure 认知服务中支持的语言。
检测个人信息（V4）（预览版）	API 返回文档中包含个人信息（“SSN”、“银行帐户”等）的实体列表。有关支持的实体类型列表，请查看支持的个人身份信息（PII）实体类别。有关支持的语言列表，请参阅 Azure 认知服务中支持的语言。
检测实体（V2） [已弃用]	此作已弃用。请改用命名实体识别（V4）。 ~~返回给定文档中已知实体和常规命名实体的列表（“Person”、“Location”、“Organization”等）。~~
检测情绪 [已弃用]	此作已弃用。请改用情绪（V4 ）。返回介于 0 和 1 之间的数值分数。接近 1 的评分表示积极情绪，而接近 0 的评分表示消极情绪。目前支持以下语言：英语、西班牙语、法语、葡萄牙语。
检测情绪 [已弃用]	此作已弃用。请改用情绪（V4 ）。 ~~返回介于 0 和 1 之间的数值分数。接近 1 的评分表示积极情绪，而接近 0 的评分表示消极情绪。~~
检测情绪（V2） [已弃用]	此作已弃用。请改用情绪（V4 ）。 ~~为每个文档返回介于 0 和 1 之间的数值分数。接近 1 的评分表示积极情绪，而接近 0 的评分表示消极情绪。~~
检测语言 [已弃用]	此作已弃用。请改用检测语言（V4）。 ~~返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。总共支持 120 种语言。~~
检测语言 [已弃用]	此作已弃用。请改用检测语言（V4）。 ~~返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。总共支持 120 种语言。~~
检测语言（V2） [已弃用]	此作已弃用。请改用检测语言（V4）。 ~~为每个文档返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。总共支持 120 种语言。~~
检测语言（V3.0）	API 返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。有关支持的语言列表，请参阅语言检测的语言支持。
检测语言（V3.1）（预览版）	API 返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。有关支持的语言列表，请参阅语言检测的语言支持。
检测语言（V4）（预览版）	API 返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。有关支持的语言列表，请参阅语言检测的语言支持。

Async CustomEntityRecognition （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_CustomEntityRecognition

提交文本文档集合以进行自定义实体识别分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
projectName	projectName	True	string	此字段指示模型的项目名称。
deploymentName （部署名称）	deploymentName	True	string	此字段指示模型的部署名称。

Body: LanguageAnalyzeTextJobState_CNER

Async CustomSingleLabelClassification （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_CustomSingleClassification

提交文本文档集合以进行自定义单一分类分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
projectName	projectName	True	string	此字段指示模型的项目名称。
deploymentName （部署名称）	deploymentName	True	string	此字段指示模型的部署名称。

Body: LanguageAnalyzeTextJobState_CSLC

Async EntityRecognition （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_EntityRecognition

提交文本文档集合以进行实体识别分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: LanguageAnalyzeTextJobState_Entites

Async PiiEntityRecognition （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_PersonalEntityRecognition

提交文本文档集合以进行个人实体识别分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
域	domain		string	用于 PII 实体识别的 PII 域。
piiCategories	piiCategories		array of string	（可选）描述要返回的 PII 类别

Body: LanguageAnalyzeTextJobState_Pii

从 Project 生成答案

操作 ID:: GenerateAnswer

此作有助于在项目中使用知识库回答指定的问题。

参数

名称	密钥	必需	类型	说明
项目名称	projectName	True	string	这是要使用的项目名称。
问题	question		string	针对项目进行查询的用户问题。
用户 ID	userId		string	用户的唯一标识符。
返回页首#	top		integer	要为问题返回的最大答案数。
置信度阈值	confidenceScoreThreshold		float	答案的最低阈值分数。值范围为 0 到 1。
排名器类型	rankerType		string	要使用的排名器的类型。
QnA ID	qnaId		string	这是从项目中提取的确切 QnA ID。
以前的 QnA ID	previousQnaId		integer	上一轮热门答案结果 QnA ID。
以前的用户查询	previousUserQuery		string	以前的用户查询。
关键值	key		string	QnA 中使用的元数据字典中的元数据密钥。
value	value		string	QnA 中使用的元数据字典中的元数据值。
使用联接元数据	logicalOperation		string	为元数据筛选器的相应逻辑作设置“OR”或“AND”。
源筛选器	sourceFilter		string	查找与项目中任何给定源列表关联的 QnA。
使用联接筛选器	logicalOperation		string	用于将元数据筛选器与源筛选器联接的逻辑操作。
启用精确答案	enable		boolean	启用或禁用答案范围预测。
置信度阈值	confidenceScoreThreshold		float	包含精确答案所需的最小阈值分数，值范围为 0 到 1。
返回页首#	topAnswersWithSpan		integer	要考虑的顶级答案数，用于精确答案预测，从 1 到 10。
包括非结构化源	includeUnstructuredSources		boolean	用于对非结构化源启用查询的标志。
部署名称	deploymentName	True	string	这是要使用的项目的特定部署。
API 版本	api-version	True	string	这是客户端 API 版本。

表示问题解答列表。

Body: AnswersResult

关键短语 [已弃用]

操作 ID:: KeyPhrases

此作已弃用。请改用关键短语（V4）。

~~返回表示输入文本中关键说话点的字符串列表。目前支持以下语言：英语、德语、西班牙语和日语。~~

参数

名称	密钥	必需	类型	说明
文本	text		string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: KeyPhraseResult

关键短语 [已弃用]

操作 ID:: KeyPhrasesV2

此作已弃用。请改用关键短语（V4）。

~~返回表示输入文本中关键说话点的字符串列表。~~

参数

名称	密钥	必需	类型	说明
文本	text		string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: KeyPhraseResult

关键短语（V2） [已弃用]

操作 ID:: KeyPhrasesV3

此作已弃用。请改用关键短语（V4）。

~~返回一个字符串列表，该字符串表示每个文档的输入文本中的关键说话点。~~

参数

名称	密钥	必需	类型	说明
Id	id	True	string	唯一的非空文档标识符。
文本	text	True	string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: KeyPhraseResults

关键短语（V3.0）

操作 ID:: KeyPhraseV3

API 返回表示输入文本中关键短语的字符串列表。有关支持的语言列表，请参阅关键短语提取的语言支持。

参数

名称	密钥	必需	类型	说明
模型版本	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
显示统计信息	showStats		boolean	（可选）如果设置为 true，响应将包含输入和文档级别统计信息。
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: KeyPhraseResultV3

关键短语（V3.1）（预览版）

操作 ID:: KeyPhraseV3_1

API 返回表示输入文本中关键短语的字符串列表。有关支持的语言列表，请参阅关键短语提取的语言支持。

参数

名称	密钥	必需	类型	说明
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: KeyPhraseResult

关键短语（V4）（预览版）

操作 ID:: KeyPhraseV4

API 返回表示输入文本中关键短语的字符串列表。有关支持的语言列表，请参阅关键短语提取的语言支持。

参数

名称	密钥	必需	类型	说明
资源子域或区域	subdomain	True	string	Azure 子域或地理区域（例如 westus）
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: KeyPhraseResult

命名实体识别（V3.0）

操作 ID:: EntitiesRecognitionGeneralV3

API 返回给定文档中常规命名实体的列表。有关支持的实体类型列表，请查看支持的命名实体识别（NER）实体类别。

参数

名称	密钥	必需	类型	说明
模型版本	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
显示统计信息	showStats		boolean	（可选）如果设置为 true，响应将包含输入和文档级别统计信息。
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: EntitiesResultV3

命名实体识别（V3.1）（预览版）

操作 ID:: EntitiesRecognitionGeneralV3_1

API 返回给定文档中常规命名实体的列表。有关支持的实体类型列表，请查看支持的命名实体识别（NER）实体类别。

参数

名称	密钥	必需	类型	说明
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: EntitiesResult

命名实体识别（V4）（预览版）

操作 ID:: EntitiesRecognitionGeneralV4

API 返回给定文档中常规命名实体的列表。有关支持的实体类型列表，请查看支持的命名实体识别（NER）实体类别。

参数

名称	密钥	必需	类型	说明
资源子域或区域	subdomain	True	string	Azure 子域或地理区域（例如 westus）
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: EntitiesResult

实体 [已弃用]

操作 ID:: DetectEntities

此作已弃用。请改用命名实体识别（V4）。

~~返回给定文档中已知实体和常规命名实体的列表（“Person”、“Location”、“Organization”等）。~~

参数

名称	密钥	必需	类型	说明
文本	text		string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: EntitiesResult

实体链接（V3.0）

操作 ID:: EntitiesLinkingV3

API 返回一个可识别实体列表，其中包含指向已知知识库的链接。有关支持的语言列表，请参阅语言支持。

参数

名称	密钥	必需	类型	说明
模型版本	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
显示统计信息	showStats		boolean	（可选）如果设置为 true，响应将包含输入和文档级别统计信息。
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: EntityLinkingResult

实体链接（V3.1）（预览版）

操作 ID:: EntitiesLinkingV3_1

API 返回一个已识别实体列表，其中包含指向已知知识库的链接。有关支持的语言列表，请参阅语言支持。

参数

名称	密钥	必需	类型	说明
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: EntityLinkingResult

实体链接（V4）（预览版）

操作 ID:: EntitiesLinkingV4

API 返回一个已识别实体列表，其中包含指向已知知识库的链接。有关支持的语言列表，请参阅语言支持。

参数

名称	密钥	必需	类型	说明
资源子域或区域	subdomain	True	string	Azure 子域或地理区域（例如 westus）
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: EntityLinkingResult

对话（CLU）（2022-05-01）

操作 ID:: ConversationAnalysis_AnalyzeConversation_Conversation

分析输入对话话语。

参数

名称	密钥	必需	类型	说明
语言	language		string	BCP 47 语言表示形式的对话项的替代语言。
文本消息	text	True	string	文本输入
projectName	projectName	True	string	要使用的项目的名称。
deploymentName （部署名称）	deploymentName	True	string	要使用的部署的名称。
详细的	verbose		boolean	如果为 true，服务将在响应中返回更详细的信息。

对话任务的结果。

Body: ConversationalTaskResult

对话（业务流程）（2022-05-01）

操作 ID:: ConversationAnalysis_AnalyzeConversation_Orchestration

分析输入对话话语。

参数

名称	密钥	必需	类型	说明
语言	language		string	BCP 47 语言表示形式的对话项的替代语言。
文本消息	text	True	string	文本输入
projectName	projectName	True	string	要使用的项目的名称。
deploymentName （部署名称）	deploymentName	True	string	要使用的部署的名称。
详细的	verbose		boolean	如果为 true，服务将在响应中返回更详细的信息。
directTarget	directTarget		string	要转发请求的目标项目的名称。
targetProjectParameters	targetProjectParameters		object	一个字典，表示每个目标项目的参数。

对话任务的结果。

Body: ConversationalTaskResult_Orchestration

异步 AbstractiveSummarization （2022-10-01-preview）

操作 ID:: AnalyzeText_SubmitJob_AbstractiveSummarization

提交文本文档集合以进行抽象摘要

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
sentenceCount	sentenceCount		integer	它控制输出摘要中的大致句子数。

Body: LanguageAnalyzeTextJobState_AbstractiveSummarization

异步 CustomMultiLabelClassification （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_CustomMultiClassification

提交文本文档集合以进行自定义单一分类分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
projectName	projectName	True	string	此字段指示模型的项目名称。
deploymentName （部署名称）	deploymentName	True	string	此字段指示模型的部署名称。

Body: LanguageAnalyzeTextJobState_CMLC

异步 EntityLinking （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_EntityLinking

提交文本文档集合以进行实体链接分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: LanguageAnalyzeTextJobState_EntityLinking

异步 KeyPhrases （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_keyPhraseExtraction

提交文本文档集合以进行关键短语提取分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
loggingOptOut	loggingOptOut		boolean

Body: LanguageAnalyzeTextJobState_KPE

异步 SentimentAnalysis （2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_SentimentAnalysis

提交文本文档集合以进行情绪分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
opinionMining	opinionMining		boolean

Body: LanguageAnalyzeTextJobState_Sentiment

异步医疗保健（2022-05-01）

操作 ID:: AnalyzeText_SubmitJob_HealthCare

提交文本文档集合以进行医疗保健分析。

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: LanguageAnalyzeTextJobState_HealthCare

异步对话 PII （文本）（2022-05-15-preview）

操作 ID:: AnalyzeConversationText_SubmitJob

提交对话集合进行分析。指定要执行的一个或多个唯一任务。

参数

名称	密钥	必需	类型	说明
id	id	True	string	会话项的 ID。
participantId	participantId	True	string	会话项的参与者 ID。
语言	language		string	BCP 47 语言表示形式的对话项的替代语言。
角色	role		string	参与者的角色。
文本消息	text	True	string	文本输入
语言	language	True	string	BCP-47 格式的对话项的语言。
域	domain		string	枚举受支持的对话域。
loggingOptOut	loggingOptOut		boolean
piiCategories	piiCategories		array of string	描述要返回用于检测的 PII 类别。如果未提供，将返回“默认”类别，这与语言不同。

包含与相关统计信息一起提交的分析对话作业的状态。

Body: ConversationalPIITextJobState

异步对话 PII （脚本）（2022-05-15-preview）

操作 ID:: AnalyzeConversationTranscript_SubmitJob

提交对话集合进行分析。指定要执行的一个或多个唯一任务。

参数

名称	密钥	必需	类型	说明
id	id	True	string	会话项的 ID。
participantId	participantId	True	string	会话项的参与者 ID。
语言	language		string	BCP 47 语言表示形式的对话项的替代语言。
角色	role		string	参与者的角色。
itn	itn		string	输入的反文本规范化表示形式。反文本规范化形式是Microsoft语音转文本 API 中识别的文本，并应用了电话号码、号码、缩写和其他转换。
maskedItn	maskedItn		string	应用了不雅屏蔽的反文本规范化格式。
文本消息	text		string	从语音到文本 API 的已识别文本的显示形式，并添加了标点和大写。
词汇的	lexical		string	从语音到文本 API 的已识别文本的词法形式，可识别实际字词。
字	word		string	识别的单词。
偏移	offset		integer	从语音音频的开始偏移量（以刻度为单位）。 1 刻度 = 100 ns。
duration	duration		integer	单词表达的持续时间（以刻度为单位）。 1 刻度 = 100 ns。
语言	language	True	string	BCP-47 格式的对话项的语言。
域	domain		string	枚举受支持的对话域。
loggingOptOut	loggingOptOut		boolean
piiCategories	piiCategories		array of string	描述要返回用于检测的 PII 类别。如果未提供，将返回“默认”类别，这与语言不同。
includeAudioRedaction	includeAudioRedaction		boolean	指示是否请求音频修订的标志。默认情况下，不会执行音频修订。
redactionSource	redactionSource		string	支持的脚本内容类型的枚举。

包含与相关统计信息一起提交的分析对话作业的状态。

Body: ConversationalPIITranscriptJobState

异步对话摘要（2022-05-15-preview）

操作 ID:: AnalyzeConversationSummarization_SubmitJob

提交对话集合进行分析。指定要执行的一个或多个唯一任务。

参数

名称	密钥	必需	类型	说明
id	id	True	string	会话项的 ID。
participantId	participantId	True	string	会话项的参与者 ID。
语言	language		string	BCP 47 语言表示形式的对话项的替代语言。
角色	role		string	参与者的角色。
文本消息	text	True	string	文本输入
语言	language	True	string	BCP-47 格式的对话项的语言。
域	domain		string	枚举受支持的对话域。
loggingOptOut	loggingOptOut		boolean
summaryAspects	summaryAspects	True	array of string

包含与相关统计信息一起提交的分析对话作业的状态。

Body: AnalyzeConversationSummarizationJobState

异步提取摘要（2022-10-01-preview）

操作 ID:: AnalyzeText_SubmitJob_ExtractiveSummarization

提交文本文档集合以进行提取摘要

参数

名称	密钥	必需	类型	说明
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
sentenceCount	sentenceCount		integer
sortBy	sortBy		string	用于提取摘要结果的排序条件。

Body: LanguageAnalyzeTextJobState_ExtractiveSummarization

情绪（V3.1）（预览版）

操作 ID:: SentimentV3_1

API 返回输入文本的详细情绪分析。分析以多个粒度级别完成，从文档级别开始，到句子和关键术语（目标和评估）。

参数

名称	密钥	必需	类型	说明
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
opinionMining	opinionMining		boolean	（可选）如果设置为 true，则响应不仅包含情绪预测，还包含观点挖掘（基于方面的情绪分析）结果。
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: SentimentResponse

情绪（V4）（预览版）

操作 ID:: SentimentV4

API 返回输入文本的详细情绪分析。分析以多个粒度级别完成，从文档级别开始，到句子和关键术语（目标和评估）。

参数

名称	密钥	必需	类型	说明
资源子域或区域	subdomain	True	string	Azure 子域或地理区域（例如 westus）
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
opinionMining	opinionMining		boolean	（可选）如果设置为 true，则响应不仅包含情绪预测，还包含观点挖掘（基于方面的情绪分析）结果。
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: SentimentResponse

情绪（V3.0）

操作 ID:: SentimentV3

API 为文档及其中的每个句子返回情绪预测，以及每个情绪类（积极、负面和中性）的情绪评分。有关支持的语言列表，请参阅情绪分析和意见挖掘语言支持。

参数

名称	密钥	必需	类型	说明
模型版本	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
显示统计信息	showStats		boolean	（可选）如果设置为 true，响应将包含输入和文档级别统计信息。
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: SentimentResponse

检测个人信息（V3.1）

操作 ID:: EntitiesRecognitionPIIV3_1

API 返回文档中包含个人信息（“SSN”、“银行帐户”等）的实体列表。有关支持的实体类型列表，请查看支持的个人身份信息（PII）实体类别。有关支持的语言列表，请参阅 Azure 认知服务中支持的语言。

参数

名称	密钥	必需	类型	说明
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
域	domain		string	（可选）如果指定，将 PII 域设置为仅包含实体类别的子集。可能的值包括：“PHI”、“none”。
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
piiCategories	piiCategories		array	（可选）描述要返回的 PII 类别
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: PiiResult

检测个人信息（V4）（预览版）

操作 ID:: EntitiesRecognitionPIIV4

参数

名称	密钥	必需	类型	说明
资源子域或区域	subdomain	True	string	Azure 子域或地理区域（例如 westus）
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
域	domain		string	（可选）如果指定，将 PII 域设置为仅包含实体类别的子集。可能的值包括：“PHI”、“none”。
stringIndexType	stringIndexType		string	（可选）指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
piiCategories	piiCategories		array	（可选）描述要返回的 PII 类别
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string	要处理的输入文本。
语言	language		string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。

Body: PiiResult

检测实体（V2） [已弃用]

操作 ID:: DetectEntitiesV2

此作已弃用。请改用命名实体识别（V4）。

~~返回给定文档中已知实体和常规命名实体的列表（“Person”、“Location”、“Organization”等）。~~

参数

名称	密钥	必需	类型	说明
Id	id	True	string	唯一的非空文档标识符。
文本	text	True	string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: EntitiesResults

检测情绪 [已弃用]

操作 ID:: DetectSentiment

此作已弃用。请改用情绪（V4 ）。

返回介于 0 和 1 之间的数值分数。接近 1 的评分表示积极情绪，而接近 0 的评分表示消极情绪。目前支持以下语言：英语、西班牙语、法语、葡萄牙语。

参数

名称	密钥	必需	类型	说明
文本	text		string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: SentimentResult

检测情绪 [已弃用]

操作 ID:: DetectSentimentV2

此作已弃用。请改用情绪（V4 ）。

~~返回介于 0 和 1 之间的数值分数。接近 1 的评分表示积极情绪，而接近 0 的评分表示消极情绪。~~

参数

名称	密钥	必需	类型	说明
文本	text		string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: SentimentResult

检测情绪（V2） [已弃用]

操作 ID:: DetectSentimentV3

此作已弃用。请改用情绪（V4 ）。

~~为每个文档返回介于 0 和 1 之间的数值分数。接近 1 的评分表示积极情绪，而接近 0 的评分表示消极情绪。~~

参数

名称	密钥	必需	类型	说明
Id	id	True	string	唯一的非空文档标识符。
文本	text	True	string	要分析的文本。
语言	language		string	这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”

Body: SentimentResults

检测语言 [已弃用]

操作 ID:: DetectLanguage

此作已弃用。请改用检测语言（V4）。

~~返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。总共支持 120 种语言。~~

参数

名称	密钥	必需	类型	说明
文本	text		string	要分析的文本。
语言数	numberOfLanguagesToDetect		integer	要检测的语言数。默认情况下设置为 1。

Body: LanguageResult

检测语言 [已弃用]

操作 ID:: DetectLanguageV2

此作已弃用。请改用检测语言（V4）。

~~返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。总共支持 120 种语言。~~

参数

名称	密钥	必需	类型	说明
文本	text		string	要分析的文本。

Body: LanguageResult

检测语言（V2） [已弃用]

操作 ID:: DetectLanguageV3

此作已弃用。请改用检测语言（V4）。

~~为每个文档返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。总共支持 120 种语言。~~

参数

名称	密钥	必需	类型	说明
Id	id	True	string	唯一的非空文档标识符。
文本	text	True	string	要分析的文本。

Body: LanguageResults

检测语言（V3.0）

操作 ID:: LanguagesV3

API 返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。有关支持的语言列表，请参阅语言检测的语言支持。

参数

名称	密钥	必需	类型	说明
模型版本	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
显示统计信息	showStats		boolean	（可选）如果设置为 true，响应将包含输入和文档级别统计信息。
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string
countryHint	countryHint		string

Body: LanguageResultV3

检测语言（V3.1）（预览版）

操作 ID:: LanguagesV3_1

API 返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。有关支持的语言列表，请参阅语言检测的语言支持。

参数

名称	密钥	必需	类型	说明
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string
countryHint	countryHint		string

Body: LanguageResult

检测语言（V4）（预览版）

操作 ID:: LanguagesV4

API 返回检测到的语言和介于 0 和 1 之间的数值分数。分数接近 1 表示 100% 确定所识别语言为 true。有关支持的语言列表，请参阅语言检测的语言支持。

参数

名称	密钥	必需	类型	说明
资源子域或区域	subdomain	True	string	Azure 子域或地理区域（例如 westus）
model-version	model-version		string	（可选）此值指示将用于评分的模型。如果未指定模型版本，API 应默认为最新的非预览版本。
showStats	showStats		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。
loggingOptOut	loggingOptOut		boolean	（可选）如果设置为 true，则选择退出记录文本输入进行故障排除。默认情况下，用于语言的 Azure 认知服务将输入文本记录 48 小时，仅用于排查提供 Azure 认知服务语言自然语言处理函数时出现的问题。将此参数设置为 true，将禁用输入日志记录，并可能限制我们修正所发生的问题的能力。有关更多详细信息，请参阅认知服务合规性和隐私说明https://aka.ms/cs-compliance，Microsoft负责任的 AI 原则。https://www.microsoft.com/en-us/ai/responsible-ai
id	id	True	string	唯一的非空文档标识符。
文本消息	text	True	string
countryHint	countryHint		string

Body: LanguageResult

定义

ConversationalPIITranscriptJobState

包含与相关统计信息一起提交的分析对话作业的状态。

名称	路径	类型	说明
displayName	displayName	string
createdDateTime	createdDateTime	date-time
expirationDateTime	expirationDateTime	date-time
jobId	jobId	string
lastUpdatedDateTime	lastUpdatedDateTime	date-time
状态	status	string
错误	errors	array of Error
nextLink	nextLink	string
statistics	statistics	ConversationRequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
完成	tasks.completed	integer	成功完成的任务计数。
“失败”	tasks.failed	integer	失败的任务计数。
inProgress	tasks.inProgress	integer	当前正在进行的任务计数。
总	tasks.total	integer	作为作业一部分提交的任务总数。
taskResult	tasks.taskResult	ConversationalPIITranscriptResult	个人身份信息检测和修订作对对话列表执行的结果。

ConversationRequestStatistics

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

名称	路径	类型	说明
documentsCount	documentsCount	integer	请求中提交的文档数。
validDocumentsCount	validDocumentsCount	integer	有效文档数。这不包括空的、大小过大的限制或不支持的语言文档。
错误DocumentsCount	erroneousDocumentsCount	integer	无效文档数。这包括空、大小过高或不支持的语言文档。
transactionsCount	transactionsCount	integer	请求的事务数。
conversationsCount	conversationsCount	integer	在请求中提交的对话数。
validConversationsCount	validConversationsCount	integer	对话文档数。这不包括空的、大小过大的限制或不支持的语言文档。
错误ConversationsCount	erroneousConversationsCount	integer	无效文档数。这包括空、大小过高或不支持的语言文档。

ConversationalPIITranscriptResult

个人身份信息检测和修订作对对话列表执行的结果。

名称	路径	类型	说明
lastUpdateDateTime	lastUpdateDateTime	date-time	任务的上次更新时间（UTC）。
状态	status		上次更新时任务的状态。
taskName	taskName	string
kind	kind	ConversationalPIIResultsKind	枚举支持的聊天分析任务结果。
results	results	ConversationPIITranscriptResults	每个会话的 PII 检测和修订作的结果。

ConversationalPIIResultsKind

枚举支持的聊天分析任务结果。

ConversationPIITranscriptResults

每个会话的 PII 检测和修订作的结果。

名称	路径	类型	说明
conversationItems	conversations.conversationItems	array of ConversationPIITranscriptItemResult	枚举会话中的所有聊天项的 PII 检测和修订作结果。
id	conversations.id	string	唯一的非空会话标识符。
警告	conversations.warnings	array of InputWarning	处理文档时遇到的警告。
statistics	conversations.statistics	ConversationStatistics	如果在请求中指定 showStats=true，则此字段将包含有关会话有效负载的信息。
错误	errors	array of InputError	按文档 ID 显示的错误。
statistics	statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
modelVersion	modelVersion	string	此字段指示用于评分的模型。

InputError

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

名称	路径	类型	说明
id	id	string	输入的 ID。
错误	error	Error	错误对象。

InputWarning

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

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

ConversationStatistics

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

名称	路径	类型	说明
transactionsCount	transactionsCount	integer	请求的文本单位数。

ConversationPIITranscriptItemResult

名称	路径	类型	说明
id	id	string
redactedContent	redactedContent	ConversationalPIITranscriptRedactedTranscriptContent	由服务生成的脚本内容响应，所有必需的个人身份信息都会经过修订。
entities	entities	array of Entity

ConversationalPIITranscriptRedactedTranscriptContent

由服务生成的脚本内容响应，所有必需的个人身份信息都会经过修订。

名称	路径	类型	说明
itn	itn	string	反向文本规范化格式输入的编辑输出。
maskedItn	maskedItn	string	屏蔽的反文本规范化格式输入的编辑输出。
文本消息	text	string	文本（Microsoft的语音转文本“display”）格式输入的编辑输出。
词汇的	lexical	string	词法格式输入的编辑输出。
audioTimings	audioTimings	array of AudioTiming	已编入音频段的列表。

AudioTiming

音频计时信息。

名称	路径	类型	说明
偏移	offset	integer	从语音音频的开始偏移量（以刻度为单位）。 1 刻度 = 100 ns。
duration	duration	integer	单词表达的持续时间（以刻度为单位）。 1 刻度 = 100 ns。

ConversationalPIITextJobState

包含与相关统计信息一起提交的分析对话作业的状态。

名称	路径	类型	说明
displayName	displayName	string
createdDateTime	createdDateTime	date-time
expirationDateTime	expirationDateTime	date-time
jobId	jobId	string
lastUpdatedDateTime	lastUpdatedDateTime	date-time
状态	status	string
错误	errors	array of Error
nextLink	nextLink	string
statistics	statistics	ConversationRequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
完成	tasks.completed	integer	成功完成的任务计数。
“失败”	tasks.failed	integer	失败的任务计数。
inProgress	tasks.inProgress	integer	当前正在进行的任务计数。
总	tasks.total	integer	作为作业一部分提交的任务总数。
taskResult	tasks.taskResult	ConversationalPIITextResult	个人身份信息检测和修订作对对话列表执行的结果。

ConversationalPIITextResult

个人身份信息检测和修订作对对话列表执行的结果。

名称	路径	类型	说明
lastUpdateDateTime	lastUpdateDateTime	date-time	任务的上次更新时间（UTC）。
状态	status		上次更新时任务的状态。
taskName	taskName	string
kind	kind	ConversationalPIIResultsKind	枚举支持的聊天分析任务结果。
results	results	ConversationPIITextResults	每个会话的 PII 检测和修订作的结果。

ConversationPIITextResults

每个会话的 PII 检测和修订作的结果。

名称	路径	类型	说明
conversationItems	conversations.conversationItems	array of ConversationPIITextItemResult	枚举会话中的所有聊天项的 PII 检测和修订作结果。
id	conversations.id	string	唯一的非空会话标识符。
警告	conversations.warnings	array of InputWarning	处理文档时遇到的警告。
statistics	conversations.statistics	ConversationStatistics	如果在请求中指定 showStats=true，则此字段将包含有关会话有效负载的信息。
错误	errors	array of InputError	按文档 ID 显示的错误。
statistics	statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
modelVersion	modelVersion	string	此字段指示用于评分的模型。

ConversationPIITextItemResult

名称	路径	类型	说明
id	id	string
redactedContent	redactedContent	ConversationalPIITranscriptRedactedTextContent	由服务生成的脚本内容响应，所有必需的个人身份信息都会经过修订。
entities	entities	array of Entity

ConversationalPIITranscriptRedactedTextContent

由服务生成的脚本内容响应，所有必需的个人身份信息都会经过修订。

名称	路径	类型	说明
文本消息	text	string	文本（Microsoft的语音转文本“display”）格式输入的编辑输出。

AnalyzeConversationSummarizationJobState

包含与相关统计信息一起提交的分析对话作业的状态。

名称	路径	类型	说明
displayName	displayName	string
createdDateTime	createdDateTime	date-time
expirationDateTime	expirationDateTime	date-time
jobId	jobId	string
lastUpdatedDateTime	lastUpdatedDateTime	date-time
状态	status	string
错误	errors	array of Error
nextLink	nextLink	string
statistics	statistics	ConversationRequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
完成	tasks.completed	integer	成功完成的任务计数。
“失败”	tasks.failed	integer	失败的任务计数。
inProgress	tasks.inProgress	integer	当前正在进行的任务计数。
总	tasks.total	integer	作为作业一部分提交的任务总数。
taskResult	tasks.taskResult	AnalyzeConversationSummarizationResult	对话摘要任务的结果。

AnalyzeConversationSummarizationResult

对话摘要任务的结果。

名称	路径	类型	说明
lastUpdateDateTime	lastUpdateDateTime	date-time	任务的上次更新时间（UTC）。
状态	status		上次更新时任务的状态。
taskName	taskName	string
kind	kind	ConversationalSummarizationResultsKind	枚举支持的聊天分析任务结果。
results	results	SummaryResult

ConversationalSummarizationResultsKind

枚举支持的聊天分析任务结果。

SummaryResult

名称	路径	类型	说明
summaries	conversations.summaries	array of SummaryResultItem
id	conversations.id	string	唯一的非空会话标识符。
警告	conversations.warnings	array of InputWarning	处理文档时遇到的警告。
statistics	conversations.statistics	ConversationStatistics	如果在请求中指定 showStats=true，则此字段将包含有关会话有效负载的信息。
错误	errors	array of InputError	按文档 ID 显示的错误。
statistics	statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
modelVersion	modelVersion	string	此字段指示用于评分的模型。

SummaryResultItem

名称	路径	类型	说明
方面	aspect	string
文本消息	text	string

错误

错误对象。

名称	路径	类型	说明
代码	code	ErrorCode	人工可读错误代码。
消息	message	string	错误的人工可读表示形式。
目标	target	string	错误的目标。
详情	details	array of Error	导致此报告错误的特定错误的详细信息数组。
innererror	innererror	InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

ErrorCode

人工可读错误代码。

: string

InnerErrorModel

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

名称	路径	类型	说明
代码	code	InnerErrorCode	人工可读错误代码。
消息	message	string	错误消息。
详情	details	object	错误详细信息。
目标	target	string	错误目标。
innererror	innererror	InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

内部错误代码

人工可读错误代码。

: string

LanguageCustomEntitiesResult

名称	路径	类型	说明
文件	documents	array of LanguageEntitiesDocumentResult	按文档响应

LanguageCustomLabelClassificationResult

名称	路径	类型	说明
文件	documents	array of LanguageClassificationDocumentResult	按文档响应

LanguageClassificationResult

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

LanguageClassificationDocumentResult

名称	路径	类型	说明
类	class	array of LanguageClassificationResult
id	id	string	唯一的非空文档标识符。

LanguageHealthcareResult

名称	路径	类型	说明
文件	documents	array of LanguageHealthcareEntitiesDocumentResult

LanguageHealthcareEntitiesDocumentResult

名称	路径	类型	说明
entities	entities	array of LanguageHealthcareEntity	医疗保健实体。
relations	relations	array of LanguageHealthcareRelation	医疗保健实体关系。
id	id	string	唯一的非空文档标识符。

LanguageHealthcareEntity

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

LanguageHealthcareRelation

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

名称	路径	类型	说明
relationType	relationType	string	关系类型。示例包括： `DosageOfMedication` 或“FrequencyOfMedication”等。
entities	entities	array of LanguageHealthcareRelationEntity	关系中的实体。

LanguageHealthcareAssertion

名称	路径	类型	说明
制约性	conditionality	string	描述实体的任何条件性。
确定性	certainty	string	描述实体确定性和极性。
关联	association	string	描述实体是文本的主题，还是描述其他人。

LanguageHealthcareRelationEntity

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

LanguageHealthcareEntityLink

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

LanguageSentimentResponse

名称	路径	类型	说明
文件	documents	array of LanguageSentimentDocumentResult	每个文档的情绪分析。

LanguageSentimentDocumentResult

名称	路径	类型	说明
情绪	sentiment	string	文档的预测情绪（负面、中性、积极或混合）。
confidenceScores	confidenceScores	LanguageSentimentConfidenceScorePerLabel	表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。
句子	sentences	array of LanguageSentenceSentiment	句子级别情绪分析。
id	id	string	唯一的非空文档标识符。

LanguageSentimentConfidenceScorePerLabel

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

名称	路径	类型	说明
阳性	positive	double	正面情绪的置信度分数
中性	neutral	double	中性情绪的置信度分数
阴性	negative	double	负面情绪的置信度分数

LanguageSentenceSentiment

名称	路径	类型	说明
文本消息	text	string	句子文本。
情绪	sentiment	string	句子的预测情绪。
confidenceScores	confidenceScores	LanguageSentimentConfidenceScorePerLabel	表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。
偏移	offset	integer	文档开头的句子偏移量。
length	length	integer	句子的长度。
目标	targets	array of LanguageSentenceTarget	句子目标的数组。
评估	assessments	array of LanguageSentenceAssessment	句子的评估数组。

LanguageSentenceTarget

名称	路径	类型	说明
情绪	sentiment	string	句子中的目标情绪。
confidenceScores	confidenceScores	LanguageTargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正数和负数。
偏移	offset	integer	与句子开头的目标偏移量。
length	length	integer	目标的长度。
文本消息	text	string	检测到的目标文本。
relations	relations	array of LanguageTargetRelation	与目标相关的评估或目标对象的数组。

LanguageSentenceAssessment

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

LanguageTargetRelation

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

LanguageTargetConfidenceScoreLabel

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

名称	路径	类型	说明
阳性	positive	double	正面情绪的置信度分数
阴性	negative	double	负面情绪的置信度分数

LanguageEntitiesResult

名称	路径	类型	说明
文件	documents	array of LanguageEntitiesDocumentResult	按文档响应

LanguageEntitiesDocumentResult

名称	路径	类型	说明
entities	entities	array of LanguageEntity	文档中的已识别实体。
id	id	string	唯一的非空文档标识符。

LanguageEntity

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

LanguageEntityLinkingResult

名称	路径	类型	说明
文件	documents	array of LanguageLinkedEntitiesDocumentResult	按文档响应

LanguageLinkedEntitiesDocumentResult

名称	路径	类型	说明
entities	entities	array of LanguageLinkedEntity	文档中已识别的已知实体。
id	id	string	唯一的非空文档标识符。

LanguageLinkedEntity

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

LanguageMatch

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

LanguagePiiResult

名称	路径	类型	说明
文件	documents	array of LanguagePiiEntitiesDocumentResult	按文档响应

LanguagePiiEntitiesDocumentResult

名称	路径	类型	说明
redactedText	redactedText	string	返回经过编辑的文本。
entities	entities	array of LanguageEntity	文档中的已识别实体。
id	id	string	唯一的非空文档标识符。

LanguageKeyPhraseResult

名称	路径	类型	说明
文件	documents	array of LanguageKeyPhrasesDocumentResult	按文档响应

LanguageKeyPhrasesDocumentResult

名称	路径	类型	说明
keyPhrases	keyPhrases	array of string	具有代表性的字词或短语的列表。返回的关键短语数与输入文档中的字数成正比。
id	id	string	唯一的非空文档标识符。

LanguageAnalyzeTextJobState_KPE

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageKeyPhraseExtractionLROResult

LanguageAnalyzeTextJobState_CNER

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageCustomEntityRecognitionLROResult

LanguageAnalyzeTextJobState_CSLC

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageCustomSingleLabelClassificationLROResult

LanguageAnalyzeTextJobState_CMLC

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageCustomMultiLabelClassificationLROResult

LanguageAnalyzeTextJobState_Entites

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Pii

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguagePiiEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Sentiment

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageSentimentLROResult

LanguageAnalyzeTextJobState_HealthCare

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageHealthcareLROResult

LanguageAnalyzeTextJobState_ExtractiveSummarization

名称	路径	类型	说明
taskResult	tasks.taskResult	ExtractiveSummarizationLROResult

LanguageAnalyzeTextJobState_AbstractiveSummarization

名称	路径	类型	说明
taskResult	tasks.taskResult	AbstractiveSummarizationLROResult	一个对象，表示抽象摘要任务的结果。

LanguageAnalyzeTextJobState_EntityLinking

名称	路径	类型	说明
taskResult	tasks.taskResult	LanguageEntityLinkingLROResult

LanguageEntityRecognitionLROResult

名称	路径	类型	说明
results	results	LanguageEntitiesResult

LanguageCustomEntityRecognitionLROResult

名称	路径	类型	说明
results	results	LanguageCustomEntitiesResult

LanguageCustomSingleLabelClassificationLROResult

名称	路径	类型	说明
results	results	LanguageCustomLabelClassificationResult

LanguageCustomMultiLabelClassificationLROResult

名称	路径	类型	说明
results	results	LanguageCustomLabelClassificationResult

LanguageEntityLinkingLROResult

名称	路径	类型	说明
results	results	LanguageEntityLinkingResult

LanguagePiiEntityRecognitionLROResult

名称	路径	类型	说明
results	results	LanguagePiiResult

LanguageHealthcareLROResult

名称	路径	类型	说明
results	results	LanguageHealthcareResult

LanguageSentimentLROResult

名称	路径	类型	说明
results	results	LanguageSentimentResponse

LanguageKeyPhraseExtractionLROResult

名称	路径	类型	说明
results	results	LanguageKeyPhraseResult

LanguageDocumentWarning

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

DocumentError

名称	路径	类型	说明
id	id	string	文档 ID。
错误	error	TextAnalyticsError

TextAnalyticsError

名称	路径	类型	说明
代码	code	string	错误代码。
消息	message	string	错误消息。
目标	target	string	错误目标。
innererror	innererror	InnerError
详情	details	array of TextAnalyticsError	有关导致此报告错误的特定错误的详细信息。

TextAnalyticsWarning

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

InnerError

名称	路径	类型	说明
代码	code	string	错误代码。
消息	message	string	错误消息。
详情	details	object	错误详细信息。
目标	target	string	错误目标。
innererror	innererror	InnerError

SentimentResponse

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

DocumentSentiment

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

RequestStatistics

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

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

DocumentStatistics

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

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

SentimentConfidenceScorePerLabel

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

名称	路径	类型
阳性	positive	double
中性	neutral	double
阴性	negative	double

SentenceSentiment

名称	路径	类型	说明
文本消息	text	string	句子文本。
情绪	sentiment	string	句子的预测情绪。
confidenceScores	confidenceScores	SentimentConfidenceScorePerLabel	表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。
偏移	offset	integer	文档开头的句子偏移量。
length	length	integer	Unicode 标准的句子长度。

DocumentEntities

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

PiiDocumentEntities

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

实体

名称	路径	类型	说明
文本消息	text	string	请求中显示的实体文本。
分类	category	string	实体类型，如 Person/Location/Org/SSN 等
子类别	subcategory	string	实体子类型，如 Age/Year/TimeRange 等
偏移	offset	integer	实体文本的起始位置（以 Unicode 字符为单位）。
length	length	integer	实体文本的长度（以 Unicode 字符为单位）。
confidenceScore	confidenceScore	double	提取实体的 0 到 1 之间的置信度分数。

EntityLinkingResult

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

DocumentLinkedEntities

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

LinkedEntity

名称	路径	类型	说明
姓名	name	string	实体链接形式名称。
比赛	matches	array of Match	此实体的实例列表显示在文本中。
语言	language	string	数据源中使用的语言。
id	id	string	数据源中已识别实体的唯一标识符。
网址	url	string	数据源中实体页面的 URL。
dataSource	dataSource	string	用于提取实体链接的数据源，如 Wiki/必应等。

匹配

名称	路径	类型	说明
confidenceScore	confidenceScore	double	如果识别出已知项，则会返回一个十进制数字，表示 0 和 1 之间的置信度级别。
文本消息	text	string	请求中显示的实体文本。
偏移	offset	integer	实体匹配文本的起始位置（以 Unicode 字符为单位）。
length	length	integer	实体匹配文本的长度（以 Unicode 字符为单位）。

DocumentKeyPhrases

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

DocumentLanguage

名称	路径	类型	说明
id	id	string	唯一的非空文档标识符。
detectedLanguage	detectedLanguage	DetectedLanguage
警告	warnings	array of TextAnalyticsWarning	处理文档时遇到的警告。
statistics	statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。

DetectedLanguage

名称	路径	类型	说明
姓名	name	string	检测到的语言（例如英语、法语）的长名称。
iso6391Name	iso6391Name	string	根据 ISO 639-1 标准（例如 en、fr）检测语言的两个字母表示形式。
confidenceScore	confidenceScore	double	置信度分数介于 0 和 1 之间。分数接近 1 表示 100% 确定所识别语言为 true。

KeyPhraseResultV3

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

EntitiesResultV3

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

PiiResult

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

LanguageResultV3

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

KeyPhraseResults

名称	路径	类型	说明
文件	documents	array of KeyPhraseResult

EntitiesResults

名称	路径	类型	说明
文件	documents	array of EntitiesResult

LanguageResults

名称	路径	类型	说明
文件	documents	array of LanguageResult

SentimentResults

名称	路径	类型	说明
文件	documents	array of SentimentResult

KeyPhraseResult

名称	路径	类型	说明
关键短语	keyPhrases	array of string	具有代表性的字词或短语的列表。返回的关键短语数与输入文档中的字数成正比。
Id	id	string	唯一的文档标识符。

EntitiesResult

名称	路径	类型	说明
Entities	entities	array of object	包含指向有关 Web 的详细信息（维基百科和必应）的链接的消除歧义实体的列表。
Name	entities.name	string	实体的名称。
匹配	entities.matches	array of object	实体的匹配项列表。
items	entities.matches	object
维基百科语言	entities.wikipediaLanguage	string	实体的维基百科语言。
维基百科 ID	entities.wikipediaId	string	实体的维基百科 ID。
维基百科 URL	entities.wikipediaUrl	string	实体的维基百科 URL。
必应 ID	entities.bingId	string	实体的必应 ID。
类型	entities.type	string	实体的类型。
子类型	entities.subType	string	实体的子类型。
Id	id	string	唯一的文档标识符。

LanguageResult

名称	路径	类型	说明
Id	id	string	唯一的文档标识符。
detectedLanguages	detectedLanguages	array of DetectedLanguageV2	提取的语言列表。

SentimentResult

名称	路径	类型	说明
得分	score	double	表示文档情绪的十进制数介于 0 和 1 之间。高于 0.7 的分数通常是指正文档，而分数低于 0.3 通常具有负内涵。中间值指中性文本。
Id	id	string	唯一的文档标识符。

DetectedLanguageV2

名称	路径	类型	说明
Name	name	string	检测到的语言（例如英语、法语）的长名称。
语言代码	iso6391Name	string	根据 ISO 639-1 标准（例如 en、fr）检测语言的两个字母表示形式。
得分	score	double	置信度分数介于 0 和 1 之间。分数接近 1 表示 100% 确定所识别语言为 true。

AnalyzeConversationTaskResultsKind

支持的会话任务结果的枚举

: string

ConversationalTaskResult

对话任务的结果。

名称	路径	类型	说明
kind	kind	AnalyzeConversationTaskResultsKind	支持的会话任务结果的枚举
结果	result	AnalyzeConversationResult	表示聊天分析响应。

ConversationalTaskResult_Orchestration

对话任务的结果。

名称	路径	类型	说明
kind	kind	AnalyzeConversationTaskResultsKind	支持的会话任务结果的枚举
结果	result	AnalyzeConversationResult_Orchestration	表示聊天分析响应。

AnalyzeConversationResult

表示聊天分析响应。

名称	路径	类型	说明
查询	query	string	调用方给出的对话话语。
detectedLanguage	detectedLanguage	string	系统检测到 BCP 47 语言表示形式的查询的语言。
预测	prediction	ConversationPrediction	表示对话项目的预测部分。

AnalyzeConversationResult_Orchestration

表示聊天分析响应。

名称	路径	类型	说明
查询	query	string	调用方给出的对话话语。
detectedLanguage	detectedLanguage	string	系统检测到 BCP 47 语言表示形式的查询的语言。
预测	prediction	OrchestrationPrediction	这表示业务流程项目的预测结果。

ConversationPrediction

表示对话项目的预测部分。

名称	路径	类型	说明
意向	intents	array of ConversationIntent	意向分类结果。
entities	entities	array of ConversationEntity	实体提取结果。
项目类型	projectKind	string	项目的类型。
topIntent	topIntent	string	分数最高的意向。

ConversationIntent

对话项目的意向分类结果。

名称	路径	类型	说明
分类	category	string	预测类。
confidenceScore	confidenceScore	float	类的置信度分数从 0.0 到 1.0。

ConversationEntity

对话项目的实体提取结果。

名称	路径	类型	说明
分类	category	string	实体类别。
文本消息	text	string	预测实体文本。
偏移	offset	integer	查询中此实体的起始索引。
length	length	integer	文本的长度。
confidenceScore	confidenceScore	float	实体置信度分数。
决议	resolutions	array of BaseResolution	实体解析对象的集合。
extraInformation	extraInformation	array of BaseExtraInformation	实体额外信息对象的集合。
topResolution	topResolution	BaseResolution	实体解析的抽象基类。
multipleResolutions	multipleResolutions	boolean	表示分辨率数组是否具有多个项的指示器。

BaseExtraInformation

实体额外信息的抽象基对象。

名称	路径	类型	说明
extraInformationKind	extraInformationKind	string	额外的信息对象类型。

BaseResolution

实体解析的抽象基类。

名称	路径	类型	说明
resolutionKind	resolutionKind	string	实体解析对象类型。

OrchestrationPrediction

这表示业务流程项目的预测结果。

名称	路径	类型	说明
意向	intents	object	包含所有意向的字典。键是意向名称，值是其置信度分数和目标类型。顶部意向的值还包含来自目标项目的实际响应。
项目类型	projectKind	string	项目的类型。
topIntent	topIntent	string	分数最高的意向。

ExtractiveSummarizationResult

名称	路径	类型	说明
文件	documents	array of ExtractedSummaryDocumentResultWithDetectedLanguage	按文档响应

ExtractedSummaryDocumentResultWithDetectedLanguage

名称	路径	类型	说明
句子	sentences	array of ExtractedSummarySentence	表示提取摘要的句子的排名列表。
detectedLanguage	detectedLanguage	DetectedLanguage

ExtractedSummarySentence

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

ExtractiveSummarizationLROResult

名称	路径	类型	说明
results	results	ExtractiveSummarizationResult

AbstractiveSummarizationLROResult

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

名称	路径	类型	说明
results	results	AbstractiveSummarizationResult	一个对象，表示每个文档的预生成汇总结果。

AbstractiveSummarizationResult

一个对象，表示每个文档的预生成汇总结果。

名称	路径	类型	说明
文件	documents	array of AbstractiveSummaryDocumentResultWithDetectedLanguage	按文档响应

AbstractiveSummaryDocumentResultWithDetectedLanguage

一个对象，表示具有检测到语言的单个文档的汇总结果。

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

SummaryContext

摘要的上下文。

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

AbstractiveSummary

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

名称	路径	类型	说明
文本消息	text	string	摘要的文本。
contexts	contexts	array of SummaryContext	摘要的上下文列表。

AnswersResult

表示问题解答列表。

名称	路径	类型	说明
answers	answers	array of KnowledgeBaseAnswer	表示“答案结果”列表。
isUserQuestionAmbiguous	isUserQuestionAmbiguous	boolean	如果用户的问题不明确，则返回布尔值。

KnowledgeBaseAnswer

表示项目答案。

名称	路径	类型	说明
问题	questions	array of string	与答案关联的问题列表。
答	answer	string	回答文本。
置信度阈值	confidenceScore	float	答案置信度分数，值范围为 0 到 1。
QnA ID	id	integer	QnA 结果的 ID。
源	source	string	QnA 结果的来源。
元数据	metadata	object	与答案关联的元数据，可用于对问题答案进行分类或筛选。
对话	dialog	KnowledgeBaseAnswerDialog	与答案关联的对话框。
answerSpan	answerSpan	AnswerSpan	QnA 的应答范围对象。

KnowledgeBaseAnswerDialog

与答案关联的对话框。

名称	路径	类型	说明
isContextOnly	isContextOnly	boolean	如果提示仅与前面的问题相关，则进行标记。如果为 true，请不要将此 QnA 作为没有上下文的查询的搜索结果;否则，如果为 false，则忽略上下文，并在搜索结果中包含此 QnA。
提示	prompts	array of KnowledgeBaseAnswerPrompt	与答案关联的提示列表。

KnowledgeBaseAnswerPrompt

提示输入答案。

名称	路径	类型	说明
displayOrder	displayOrder	integer	提示的索引 - 用于提示排序。
qnaId	qnaId	integer	对应于提示的 QnA ID。
displayText	displayText	string	显示用于表示后续问题提示的文本。

AnswerSpan

QnA 的应答范围对象。

名称	路径	类型	说明
文本消息	text	string	精确答案的预测文本。
置信度阈值	confidenceScore	float	精确答案的预测分数，值范围为 0 到 1。
偏移	offset	integer	与答案开头的精确答案偏移量。
length	length	integer	精确答案的长度。

通过

适用于语言的 Azure 认知服务

使用 Microsoft Entra ID 进行连接

Microsoft Entra ID 身份验证不支持的作

正在创建连接

Api 密钥

默认值 [已弃用]

限制

操作

Async CustomEntityRecognition （2022-05-01）

参数

返回

Async CustomSingleLabelClassification （2022-05-01）

参数

返回

Async EntityRecognition （2022-05-01）

参数

返回

Async PiiEntityRecognition （2022-05-01）

参数

返回

从 Project 生成答案

参数

返回

关键短语 [已弃用]

参数

返回

关键短语 [已弃用]

参数

返回

关键短语 （V2） [已弃用]

参数

返回

关键短语 （V3.0）

参数

返回

关键短语 （V3.1） （预览版）

参数

返回

关键短语 （V4） （预览版）

参数

返回

命名实体识别 （V3.0）

参数

返回

命名实体识别 （V3.1） （预览版）

参数

返回

命名实体识别 （V4） （预览版）

参数

返回

实体 [已弃用]

参数

返回

实体链接 （V3.0）

参数

返回

实体链接 （V3.1） （预览版）

参数

返回

实体链接 （V4） （预览版）

参数

返回

对话 （CLU） （2022-05-01）

参数

返回

对话 （业务流程） （2022-05-01）

参数

返回

异步 AbstractiveSummarization （2022-10-01-preview）

参数

返回

异步 CustomMultiLabelClassification （2022-05-01）

参数

返回

异步 EntityLinking （2022-05-01）

参数

返回

异步 KeyPhrases （2022-05-01）

参数

关键短语（V2） [已弃用]

关键短语（V3.0）

关键短语（V3.1）（预览版）

关键短语（V4）（预览版）

命名实体识别（V3.0）

命名实体识别（V3.1）（预览版）

命名实体识别（V4）（预览版）

实体链接（V3.0）

实体链接（V3.1）（预览版）

实体链接（V4）（预览版）

对话（CLU）（2022-05-01）

对话（业务流程）（2022-05-01）

异步医疗保健（2022-05-01）

异步对话 PII （文本）（2022-05-15-preview）

异步对话 PII （脚本）（2022-05-15-preview）

异步对话摘要（2022-05-15-preview）

情绪（V3.1）（预览版）

情绪（V4）（预览版）

检测个人信息（V3.1）

检测个人信息（V4）（预览版）

检测实体（V2） [已弃用]

检测情绪（V2） [已弃用]

检测语言（V2） [已弃用]

检测语言（V3.0）

检测语言（V3.1）（预览版）

检测语言（V4）（预览版）