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

Analyze Conversations - Analyze Conversations

参考

服务:: Azure AI Services

API 版本:: 2024-11-01

分析输入对话话语。

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-01

URI 参数

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

请求正文

ConversationalTask

对话语言理解任务的输入。

名称	必需	类型	说明
analysisInput	True	ConversationAnalysisOptions	输入 ConversationItem 及其可选参数
kind	True	string: Conversation	会话输入任务的基类。
parameters	True	ConversationTaskParameters	对话语言理解任务所需的输入参数。

响应

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

名称

类型

说明

200 OK

AnalyzeConversationTaskResult:

ConversationalTaskResult

请求已成功。

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

示例

SuccessfulAnalyzeConversations

SuccessfulAnalyzeConversationsArbitration

SuccessfulAnalyzeConversationsArbitrationDirectTarget

SuccessfulAnalyzeConversations

示例请求

HTTP

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "id": "1",
      "participantId": "1",
      "text": "play In the air tonight from Phil Collins"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "stringIndexType": "TextElement_V8"
  }
}

示例响应

状态代码:: 200

{
  "kind": "ConversationResult",
  "result": {
    "query": "play In the air tonight from Phil Collins",
    "prediction": {
      "topIntent": "PlayMusic",
      "projectKind": "Conversation",
      "intents": [
        {
          "category": "PlayMusic",
          "confidenceScore": 1
        },
        {
          "category": "SearchCreativeWork",
          "confidenceScore": 0
        },
        {
          "category": "AddToPlaylist",
          "confidenceScore": 0
        }
      ],
      "entities": [
        {
          "category": "Media.Artist",
          "text": "Phil Collins",
          "offset": 29,
          "length": 12,
          "confidenceScore": 1
        }
      ]
    }
  }
}

SuccessfulAnalyzeConversationsArbitration

示例请求

HTTP

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "participantId": "1",
      "id": "1",
      "modality": "text",
      "language": "en-GB",
      "text": "How do I integrate QnA Maker and LUIS?"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "verbose": true,
    "isLoggingEnabled": false,
    "stringIndexType": "TextElement_V8"
  }
}

示例响应

状态代码:: 200

{
  "kind": "ConversationResult",
  "result": {
    "query": "trains from London",
    "prediction": {
      "topIntent": "Rail",
      "projectKind": "Orchestration",
      "intents": {
        "Rail": {
          "confidenceScore": 1,
          "targetProjectKind": "Conversation",
          "result": {
            "query": "trains from London",
            "prediction": {
              "topIntent": "Timetable",
              "projectKind": "Conversation",
              "intents": [
                {
                  "category": "Timetable",
                  "confidenceScore": 0.99968535
                },
                {
                  "category": "Locomotive",
                  "confidenceScore": 0.000314623
                }
              ],
              "entities": []
            }
          }
        },
        "Tree": {
          "confidenceScore": 0.2641529,
          "targetProjectKind": "QuestionAnswering"
        },
        "None": {
          "confidenceScore": 0,
          "targetProjectKind": "NonLinked"
        }
      }
    }
  }
}

SuccessfulAnalyzeConversationsArbitrationDirectTarget

示例请求

HTTP

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "text": "Ports and connectors",
      "participantId": "1",
      "id": "1"
    }
  },
  "parameters": {
    "projectName": "prj1",
    "deploymentName": "dep1",
    "directTarget": "qnaProject",
    "targetProjectParameters": {
      "qnaProject": {
        "targetProjectKind": "QuestionAnswering",
        "callingOptions": {
          "context": {
            "previousUserQuery": "Meet Surface Pro 4",
            "previousQnaId": 4
          },
          "top": 1,
          "question": "App Service overview"
        }
      }
    }
  }
}

示例响应

状态代码:: 200

{
  "kind": "ConversationResult",
  "result": {
    "query": "Ports and connectors",
    "prediction": {
      "projectKind": "Orchestration",
      "topIntent": "qnaTargetApp",
      "intents": {
        "qnaTargetApp": {
          "targetProjectKind": "QuestionAnswering",
          "confidenceScore": 1,
          "result": {
            "answers": [
              {
                "questions": [
                  "App Service overview"
                ],
                "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.",
                "confidenceScore": 0.7384000000000001,
                "id": 1,
                "source": "https://docs.microsoft.com/en-us/azure/app-service/overview",
                "metadata": {},
                "dialog": {
                  "isContextOnly": false,
                  "prompts": []
                }
              }
            ]
          }
        }
      }
    }
  }
}

定义

名称	说明
AgeResolution	表示 Age 实体解析模型。
AgeUnit	度量的年龄单位
AnalyzeConversationResult	表示聊天分析响应。
AnalyzeConversationTaskKind	支持的会话任务的枚举。
AnalyzeConversationTaskResultsKind	枚举支持的聊天任务结果。
AnswersOptions	用于查询知识库的参数。
AnswerSpan	QnA 的应答范围对象。
AnswersResult	表示问题解答列表。
AreaResolution	表示区域实体解析模型。
AreaUnit	度量面积单位。
BooleanResolution	布尔表达式的解析
ConversationalTask	对话语言理解任务的输入。
ConversationalTaskResult	对话任务的结果。
ConversationAnalysisOptions	输入 ConversationItem 及其可选参数
ConversationCallingOptions	设置为调用对话项目的选项。
ConversationEntity	对话项目的实体提取结果。
ConversationIntent	对话项目的意向分类结果。
ConversationParameters	这是自定义对话项目的一组请求参数。
ConversationPrediction	表示对话项目的预测部分。
ConversationResult	对话项目返回的响应。
ConversationTargetIntentResult	对话项目响应的总结。
ConversationTaskParameters	对话任务所需的输入参数。
CurrencyResolution	表示货币实体解析模型。
DateTimeResolution	日期时间实体实例的解析。
DateTimeSubKind	Datetime SubKind。
EntitySubtype	额外信息的具体实体子类型模型。
Error	错误对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
ExtraInformationKind	额外的信息对象类型。
InformationResolution	表示信息（数据）实体解析模型。
InformationUnit	信息（数据）度量单位。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
InputModality	支持的聊天形式枚举。
KnowledgeBaseAnswer	表示知识库答案。
KnowledgeBaseAnswerContext	包含先前 QnA 信息的上下文对象。
KnowledgeBaseAnswerDialog	与答案关联的对话框。
KnowledgeBaseAnswerPrompt	提示输入答案。
LengthResolution	表示长度实体解析模型。
LengthUnit	测量的长度单位。
ListKey	列表键额外数据类型。
LogicalOperationKind	用于联接元数据筛选器的操作。
LuisCallingOptions	这会自定义服务如何调用 LUIS 正式版项目。
LuisParameters	这是 LUIS 正式发布项目的一组请求参数。
LuisTargetIntentResult	这是 LUIS 正式版响应的总结。
MetadataFilter	查找与给定元数据列表关联的 QnA。
MetadataRecord	用于为每个元数据提供键值对的对象。
NoneLinkedTargetIntentResult	非链接意向响应的总结。
NumberKind	提取的数字实体的类型。
NumberResolution	数值实体实例的解析。
NumericRangeResolution	表示数值间隔的分辨率。
OrchestrationPrediction	这表示业务流程项目的预测结果。
OrdinalResolution	序号实体实例的解析。
projectKind	项目的类型。
QueryFilters	基于知识库筛选。
QuestionAnsweringParameters	这是问答知识库的一组请求参数。
QuestionAnsweringTargetIntentResult	这是一个总结问题答案知识库响应。
RangeKind	解析对象表示的范围类型。
RankerKind	要使用的排名器的类型
RegexKey	正则表达式键额外数据类型。
RelativeTo	序号表示的引用点。
ResolutionKind	实体解析对象类型。
role	参与者的角色。
ShortAnswerOptions	配置答案范围预测功能。
SpeedResolution	表示速度实体解析模型。
SpeedUnit	测量速度单位
StringIndexType	字符串索引类型
targetProjectKind	目标服务的类型。
TemperatureResolution	表示温度实体解析模型。
TemperatureUnit	温度度量单位。
TemporalModifier	日期/时间实例的可选修饰符。
TemporalSpanResolution	表示日期和/或时间跨度的解析。
TextConversationItem	输入对话的文本形式。
VolumeResolution	表示卷实体解析模型。
VolumeUnit	测量量单位
WeightResolution	表示权重实体解析模型。
WeightUnit	度量单位的权重单位。

AgeResolution

Object

表示 Age 实体解析模型。

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

AgeUnit

枚举

度量的年龄单位

值	说明
Day	日龄单位
Month	月年龄单位
Unspecified	未指定的年龄单位
Week	周年龄单位
Year	年年龄单位

AnalyzeConversationResult

Object

表示聊天分析响应。

名称	类型	说明
detectedLanguage	string	系统检测到 BCP 47 语言表示形式的查询的语言。
prediction	BasePrediction: ConversationPrediction OrchestrationPrediction	会话项目的预测结果。
query	string	调用方给出的对话话语。

AnalyzeConversationTaskKind

枚举

支持的会话任务的枚举。

值	说明
Conversation	对话任务类型

AnalyzeConversationTaskResultsKind

枚举

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

值	说明
ConversationResult	对话结果任务类型

AnswersOptions

Object

用于查询知识库的参数。

名称	类型	说明
answerSpanRequest	ShortAnswerOptions	配置答案范围预测功能。
confidenceScoreThreshold	number (double) minimum: 0 maximum: 1	答案的最低阈值分数，值范围为 0 到 1。
context	KnowledgeBaseAnswerContext	包含先前 QnA 信息的上下文对象。
filters	QueryFilters	根据给定的元数据列表和知识库源筛选 QnA。
includeUnstructuredSources	boolean	（可选）用于启用对非结构化源的查询的标志。
qnaId	integer (int32)	要从知识库中提取的确切 QnA ID，此字段优先于问题。
question	string	要查询知识库的用户问题。
rankerType	RankerKind	要使用的排名器的类型。
top	integer (int32)	要为问题返回的最大答案数。
userId	string	用户的唯一标识符。

AnswerSpan

Object

QnA 的应答范围对象。

名称	类型	说明
confidenceScore	number (double) minimum: 0 maximum: 1	答案范围的预测分数，值范围为 0 到 1。
length	integer (int32)	答案范围的长度。
offset	integer (int32)	答案范围与答案的开始偏移量。
text	string	答案范围的预测文本。

AnswersResult

Object

表示问题解答列表。

名称	类型	说明
answers	KnowledgeBaseAnswer[]	表示“答案结果”列表。

AreaResolution

Object

表示区域实体解析模型。

名称	类型	说明
resolutionKind	string: AreaResolution	实体解析对象类型。
unit	AreaUnit	测量面积单位
value	number (double)	提取的文本表示的数值。

AreaUnit

枚举

度量面积单位。

值	说明
Acre	英亩面积单位
SquareCentimeter	平方厘米面积单位
SquareDecameter	正方形十分表面积单位
SquareDecimeter	方块分米面积单位
SquareFoot	平方英尺面积单位
SquareHectometer	正方形 hectometer 面积单位
SquareInch	平方英寸面积单位
SquareKilometer	平方公里面积单位
SquareMeter	平方米面积单位
SquareMile	平方英里面积单位
SquareMillimeter	平方毫米面积单位
SquareYard	方码面积单位
Unspecified	未指定的区域单位

BooleanResolution

Object

布尔表达式的解析

名称	类型	说明
resolutionKind	string: BooleanResolution	实体解析对象类型。
value	boolean	布尔表达式的解析

ConversationalTask

Object

对话语言理解任务的输入。

名称	类型	说明
analysisInput	ConversationAnalysisOptions	输入 ConversationItem 及其可选参数
kind	string: Conversation	会话输入任务的基类。
parameters	ConversationTaskParameters	对话语言理解任务所需的输入参数。

ConversationalTaskResult

Object

对话任务的结果。

名称	类型	说明
kind	string: ConversationResult	会话输入任务结果的基类。
result	AnalyzeConversationResult	表示聊天分析响应。

ConversationAnalysisOptions

Object

输入 ConversationItem 及其可选参数

名称	类型	说明
conversationItem	TextConversationItem	用户输入格式对话（例如文本、脚本）的抽象基础。

ConversationCallingOptions

Object

设置为调用对话项目的选项。

名称	类型	说明
isLoggingEnabled	boolean	如果为 true，将保存查询供客户进一步查看创作，以提高模型质量。
language	string	BCP 47 语言表示形式的查询语言。
verbose	boolean	如果为 true，服务将返回更详细的信息。

ConversationEntity

Object

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

名称	类型	说明
category	string	实体类别。
confidenceScore	number (float)	实体置信度分数。
extraInformation	BaseExtraInformation[]: EntitySubtype[] ListKey[] RegexKey[]	实体额外信息对象的集合。
length	integer (int32)	文本的长度。
offset	integer (int32)	查询中此实体的起始索引。
resolutions	BaseResolution[]: AgeResolution[] AreaResolution[] BooleanResolution[] CurrencyResolution[] DateTimeResolution[] InformationResolution[] LengthResolution[] NumberResolution[] NumericRangeResolution[] OrdinalResolution[] SpeedResolution[] TemperatureResolution[] TemporalSpanResolution[] VolumeResolution[] WeightResolution[]	实体解析对象的集合。
text	string	预测实体文本。

ConversationIntent

Object

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

名称	类型	说明
category	string	预测类。
confidenceScore	number (float) minimum: 0 maximum: 1	类的置信度分数从 0.0 到 1.0。

ConversationParameters

Object

这是自定义对话项目的一组请求参数。

名称	类型	说明
apiVersion	string	调用特定目标服务时要使用的 API 版本。
callingOptions	ConversationCallingOptions	设置为调用对话项目的选项。
targetProjectKind	string: Conversation	目标服务的类型

ConversationPrediction

Object

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

名称	类型	说明
entities	ConversationEntity[]	实体提取结果。
intents	ConversationIntent[]	意向分类结果。
projectKind	string: Conversation	项目的类型。
topIntent	string	分数最高的意向。

ConversationResult

Object

对话项目返回的响应。

名称	类型	说明
detectedLanguage	string	BCP 47 语言表示形式的查询中检测到的语言。
prediction	ConversationPrediction	查询的预测结果。
query	string	请求中给出的同一查询。

ConversationTargetIntentResult

Object

对话项目响应的总结。

名称	类型	说明
apiVersion	string	用于调用目标服务的 API 版本。
confidenceScore	number (double) minimum: 0 maximum: 1	预测分数，范围为 0.0 到 1.0。
result	ConversationResult	来自对话项目的实际响应。
targetProjectKind	string: Conversation	这是意向预测的基类

ConversationTaskParameters

Object

对话任务所需的输入参数。

名称	类型	默认值	说明
deploymentName	string		要使用的部署的名称。
directTarget	string		要转发请求的目标项目的名称。
isLoggingEnabled	boolean		如果为 true，服务将保留查询以供进一步查看。
projectName	string		要使用的项目的名称。
stringIndexType	StringIndexType	TextElements_v8	指定用于解释字符串偏移的方法。默认为文本元素（Graphemes），根据 Unicode v8.0.0。有关详细信息，请参阅 https://aka.ms/text-analytics-offsets。
targetProjectParameters	object		一个字典，表示每个目标项目的参数。
verbose	boolean		如果为 true，服务将在响应中返回更详细的信息。

CurrencyResolution

Object

表示货币实体解析模型。

名称	类型	说明
ISO4217	string	基于另一个 ISO 标准 ISO 3166 的字母代码，其中列出了国家/地区名称的代码。 ISO 4217 三字母代码的前两个字母与国家/地区名称的代码相同，并且，如果可能，第三个字母对应于货币名称的第一个字母。
resolutionKind	string: CurrencyResolution	实体解析对象类型。
unit	string	提取实体中捕获的金额的单位
value	number (double)	提取实体中捕获的金额

DateTimeResolution

Object

日期时间实体实例的解析。

名称	类型	说明
dateTimeSubKind	DateTimeSubKind	The DateTime SubKind
modifier	TemporalModifier	日期/时间实例的可选修饰符。
resolutionKind	string: DateTimeResolution	实体解析对象类型。
timex	string	如（https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml）中所述的延长 ISO 8601 日期/时间表示形式
value	string	提取的文本表示的实际时间。

DateTimeSubKind

枚举

Datetime SubKind。

值	说明
Date	日期子kind
DateTime	DateTime 子kind
Duration	持续时间子类
Set	设置子kind
Time	时间子类

EntitySubtype

Object

额外信息的具体实体子类型模型。

名称	类型	说明
extraInformationKind	string: EntitySubtype	额外的信息对象类型。
value	string	提取的实体类型的子类型。

Error

Object

错误对象。

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

ErrorCode

枚举

人工可读错误代码。

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

ErrorResponse

Object

错误响应。

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

ExtraInformationKind

枚举

额外的信息对象类型。

值	说明
EntitySubtype	实体子类型额外信息类型
ListKey	列出关键额外信息类型
RegexKey	正则表达式密钥额外信息类型

InformationResolution

Object

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

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

InformationUnit

枚举

信息（数据）度量单位。

值	说明
Bit	位信息单位
Byte	字节信息单元
Gigabit	千兆位信息单元
Gigabyte	千兆字节信息单元
Kilobit	千位信息单元
Kilobyte	千字节信息单元
Megabit	兆位信息单元
Megabyte	兆字节信息单元
Petabit	Petabit 信息单元
Petabyte	Pbyte 信息单元
Terabit	Terabit 信息单元
Terabyte	TB 信息单元
Unspecified	未指定的信息单元

InnerErrorCode

枚举

人工可读错误代码。

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

InnerErrorModel

Object

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

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

InputModality

枚举

支持的聊天形式枚举。

值	说明
text	文本输入形式
transcript	脚本输入形式

KnowledgeBaseAnswer

Object

表示知识库答案。

名称	类型	说明
answer	string	回答文本。
answerSpan	AnswerSpan	回答 QnA 与用户问题相关的跨度对象。
confidenceScore	number (double) minimum: 0 maximum: 1	答案置信度分数，值范围为 0 到 1。
dialog	KnowledgeBaseAnswerDialog	与答案关联的对话框。
id	integer (int32)	QnA 结果的 ID。
metadata	object	与答案关联的元数据，可用于对问题答案进行分类或筛选。
questions	string[]	与答案关联的问题列表。
source	string	QnA 结果的来源。

KnowledgeBaseAnswerContext

Object

包含先前 QnA 信息的上下文对象。

名称	类型	说明
previousQnaId	integer (int32)	上一轮热门答案结果 QnA ID。
previousUserQuery	string	以前的用户查询。

KnowledgeBaseAnswerDialog

Object

与答案关联的对话框。

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

KnowledgeBaseAnswerPrompt

Object

提示输入答案。

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

LengthResolution

Object

表示长度实体解析模型。

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

LengthUnit

枚举

测量的长度单位。

值	说明
Centimeter	厘米长度单位
Decameter	十分表长度单位
Decimeter	十分仪长度单位
Foot	脚长单位
Hectometer	Hectometer 长度单位
Inch	英寸长度单位
Kilometer	公里长单位
LightYear	光年长度单位
Meter	计量长度单位
Micrometer	微计长度单位
Mile	英里长度单位
Millimeter	毫米长度单位
Nanometer	纳米长度单位
Picometer	Picometer 长度单位
Pt	点长度单位
Unspecified	未指定的长度单位
Yard	码长单位

ListKey

Object

列表键额外数据类型。

名称	类型	说明
extraInformationKind	string: ListKey	额外的信息对象类型。
key	string	提取实体的规范形式。

LogicalOperationKind

枚举

用于联接元数据筛选器的操作。

值	说明
AND	逻辑 AND
OR	逻辑 OR

LuisCallingOptions

Object

这会自定义服务如何调用 LUIS 正式版项目。

名称	类型	说明
bing-spell-check-subscription-key	string	启用必应拼写检查时要使用的订阅密钥
log	boolean	保存日志，以便稍后在训练话语中添加。
show-all-intents	boolean	设置为 true 可显示所有意向。
spellCheck	boolean	启用拼写检查。
timezoneOffset	integer (int32)	请求位置的时区偏移量。
verbose	boolean	启用详细响应。

LuisParameters

Object

这是 LUIS 正式发布项目的一组请求参数。

名称	类型	说明
apiVersion	string	调用特定目标服务时要使用的 API 版本。
callingOptions	LuisCallingOptions	这会自定义服务如何调用 LUIS 正式版项目。
query	string maxLength: 500	要预测的话语。
targetProjectKind	string: Luis	目标服务的类型

LuisTargetIntentResult

Object

这是 LUIS 正式版响应的总结。

名称	类型	说明
apiVersion	string	用于调用目标服务的 API 版本。
confidenceScore	number (double) minimum: 0 maximum: 1	预测分数，范围为 0.0 到 1.0。
result	LuisResult	LUIS 正式版应用程序的实际响应。
targetProjectKind	string: Luis	这是意向预测的基类

MetadataFilter

Object

查找与给定元数据列表关联的 QnA。

名称	类型	默认值	说明
logicalOperation	LogicalOperationKind	AND	用于联接元数据筛选器的操作。
metadata	MetadataRecord[]		元数据列表。

MetadataRecord

Object

用于为每个元数据提供键值对的对象。

名称	类型	说明
key	string	QnA 中使用的元数据字典中的元数据密钥。
value	string	QnA 中使用的元数据字典中的元数据值。

NoneLinkedTargetIntentResult

Object

非链接意向响应的总结。

名称	类型	说明
apiVersion	string	用于调用目标服务的 API 版本。
confidenceScore	number (double) minimum: 0 maximum: 1	预测分数，范围为 0.0 到 1.0。
result	ConversationResult	来自对话项目的实际响应。
targetProjectKind	string: NonLinked	这是意向预测的基类

NumberKind

枚举

提取的数字实体的类型。

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

NumberResolution

Object

数值实体实例的解析。

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

NumericRangeResolution

Object

表示数值间隔的分辨率。

名称	类型	说明
maximum	number (double)	间隔的结束值。
minimum	number (double)	间隔的起始值。
rangeKind	RangeKind	解析对象表示的范围类型。
resolutionKind	string: NumericRangeResolution	实体解析对象类型。

OrchestrationPrediction

Object

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

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

OrdinalResolution

Object

序号实体实例的解析。

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

projectKind

枚举

项目的类型。

值	说明
Conversation	对话类型
Orchestration	业务流程类型

QueryFilters

Object

基于知识库筛选。

名称	类型	默认值	说明
logicalOperation	LogicalOperationKind	AND	用于将元数据筛选器与源筛选器联接的逻辑操作。
metadataFilter	MetadataFilter		基于知识库筛选。
sourceFilter	string[]		基于知识库筛选。

QuestionAnsweringParameters

Object

这是问答知识库的一组请求参数。

名称	类型	说明
apiVersion	string	调用特定目标服务时要使用的 API 版本。
callingOptions	AnswersOptions	发送到问答知识库的选项。
targetProjectKind	string: QuestionAnswering	目标服务的类型

QuestionAnsweringTargetIntentResult

Object

这是一个总结问题答案知识库响应。

名称	类型	说明
apiVersion	string	用于调用目标服务的 API 版本。
confidenceScore	number (double) minimum: 0 maximum: 1	预测分数，范围为 0.0 到 1.0。
result	AnswersResult	问题解答 KB 生成的答案。
targetProjectKind	string: QuestionAnswering	这是意向预测的基类

RangeKind

枚举

解析对象表示的范围类型。

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

RankerKind

枚举

要使用的排名器的类型

值	说明
Default	默认排名器。
QuestionOnly	仅询问排名器。

RegexKey

Object

正则表达式键额外数据类型。

名称	类型	说明
extraInformationKind	string: RegexKey	额外的信息对象类型。
key	string	提取实体时使用的正则表达式模式的键。
regexPattern	string	提取实体时使用的 .NET 正则表达式模式。有关 .NET 正则表达式的详细信息，请访问 https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions。

RelativeTo

枚举

序号表示的引用点。

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

ResolutionKind

枚举

实体解析对象类型。

值	说明
AgeResolution	年龄实体的解析
AreaResolution	区域实体的解析
BooleanResolution	布尔实体的解析
CurrencyResolution	货币实体解析
DateTimeResolution	日期/时间实体的解析
InformationResolution	信息实体的解析
LengthResolution	长度实体的解析
NumberResolution	数字实体的解析
NumericRangeResolution	数值范围实体的解析
OrdinalResolution	序号实体的解析
SpeedResolution	速度实体的解析
TemperatureResolution	温度实体的解析
TemporalSpanResolution	临时跨度实体的解析
VolumeResolution	卷实体的解析
WeightResolution	权重实体的解析

role

枚举

参与者的角色。

值	说明
agent	参与者是代理。
customer	参与者是客户。
generic	这是一般参与者。

ShortAnswerOptions

Object

配置答案范围预测功能。

名称	类型	默认值	说明
confidenceScoreThreshold	number (double) minimum: 0 maximum: 1		包含答案范围所需的最小阈值分数，值范围为 0 到 1。
enable	boolean	True	启用或禁用答案范围预测。
topAnswersWithSpan	integer (int32) minimum: 1 maximum: 10		要考虑从 1 到 10 的跨度预测的排名靠前的答案数。

SpeedResolution

Object

表示速度实体解析模型。

名称	类型	说明
resolutionKind	string: SpeedResolution	实体解析对象类型。
unit	SpeedUnit	测量速度单位
value	number (double)	提取的文本表示的数值。

SpeedUnit

枚举

测量速度单位

值	说明
CentimetersPerMillisecond	每毫秒速度单位厘米
FootPerMinute	每分钟速度单位的脚数
FootPerSecond	每秒脚速单位
KilometersPerHour	每小时公里速度单位
KilometersPerMillisecond	每毫秒速度单位的公里数
KilometersPerMinute	每分钟速度单位公里数
KilometersPerSecond	每秒公里速单位
Knot	结速单位
MetersPerMillisecond	米/毫秒速度单位
MetersPerSecond	每秒计量速度单位
MilesPerHour	每小时英里的速度单位
Unspecified	未指定的速度单位
YardsPerMinute	每分钟速度单位的码数
YardsPerSecond	每秒速度单位码数

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）编写的，请使用此选项。

targetProjectKind

枚举

目标服务的类型。

值	说明
Conversation	对话目标服务类型
Luis	Luis 目标服务类型
NonLinked	NonLinked 目标服务类型
QuestionAnswering	QuestionAnswering 目标服务类型

TemperatureResolution

Object

表示温度实体解析模型。

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

TemperatureUnit

枚举

温度度量单位。

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

TemporalModifier

枚举

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

值	说明
After	临时修饰符之后
AfterApprox	AfterApprox 时态修饰符
AfterMid	AfterMid 时态修饰符
AfterStart	AfterStart 临时修饰符
Approx	近似时态修饰符
Before	在临时修饰符之前
BeforeApprox	BeforeApprox 时态修饰符
BeforeEnd	BeforeEnd 临时修饰符
BeforeStart	BeforeStart 临时修饰符
End	结束临时修饰符
Less	更少的时态修饰符
Mid	中时态修饰符
More	更多时态修饰符
ReferenceUndefined	ReferenceUndefined 时态修饰符
Since	由于时态修饰符
SinceEnd	SinceEnd 临时修饰符
Start	启动临时修饰符
Until	在临时修饰符之前

TemporalSpanResolution

Object

表示日期和/或时间跨度的解析。

名称	类型	说明
begin	string	表示日期和/或时间跨度的解析。如（https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml）中所述的延长 ISO 8601 日期/时间表示形式
duration	string	基于 ISO 8601（https://en.wikipedia.org/wiki/ISO_8601#Durations）格式的可选持续时间值
end	string	表示日期和/或时间跨度的解析。如（https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml）中所述的延长 ISO 8601 日期/时间表示形式
modifier	TemporalModifier	日期/时间实例的可选修饰符。
resolutionKind	string: TemporalSpanResolution	实体解析对象类型。
timex	string	一个可选的三元列，其中包含开头、结尾和持续时间，所有表示为 ISO 8601 格式的字符串。

TextConversationItem

Object

输入对话的文本形式。

名称	类型	说明
id	string	会话项的 ID。
language	string	BCP 47 语言表示形式的对话项的替代语言。
modality	InputModality	支持的聊天形式枚举。
participantId	string	会话项的参与者 ID。
role	role	参与者的角色。
text	string	文本输入

VolumeResolution

Object

表示卷实体解析模型。

名称	类型	说明
resolutionKind	string: VolumeResolution	实体解析对象类型。
unit	VolumeUnit	测量量单位
value	number (double)	提取的文本表示的数值。

VolumeUnit

枚举

测量量单位

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

WeightResolution

Object

表示权重实体解析模型。

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

WeightUnit

枚举

度量单位的权重单位。

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

通过

Analyze Conversations - Analyze Conversations

URI 参数

请求正文

ConversationalTask

响应

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

作用域

示例

SuccessfulAnalyzeConversations

示例请求

示例响应

SuccessfulAnalyzeConversationsArbitration

示例请求

示例响应

SuccessfulAnalyzeConversationsArbitrationDirectTarget

示例请求

示例响应

定义

AgeResolution

AgeUnit

AnalyzeConversationResult

AnalyzeConversationTaskKind

AnalyzeConversationTaskResultsKind

AnswersOptions

AnswerSpan

AnswersResult

AreaResolution

AreaUnit

BooleanResolution

ConversationalTask

ConversationalTaskResult

ConversationAnalysisOptions

ConversationCallingOptions

ConversationEntity

ConversationIntent

ConversationParameters

ConversationPrediction

ConversationResult

ConversationTargetIntentResult

ConversationTaskParameters

CurrencyResolution

DateTimeResolution

DateTimeSubKind

EntitySubtype

Error

ErrorCode

ErrorResponse

ExtraInformationKind

InformationResolution

InformationUnit

InnerErrorCode

InnerErrorModel

InputModality

KnowledgeBaseAnswer

KnowledgeBaseAnswerContext

KnowledgeBaseAnswerDialog

KnowledgeBaseAnswerPrompt

LengthResolution

LengthUnit

ListKey

LogicalOperationKind

LuisCallingOptions

LuisParameters

LuisTargetIntentResult

MetadataFilter

MetadataRecord

NoneLinkedTargetIntentResult

NumberKind

NumberResolution

NumericRangeResolution

OrchestrationPrediction

OrdinalResolution

projectKind

QueryFilters

QuestionAnsweringParameters

QuestionAnsweringTargetIntentResult

RangeKind