@azure/ai-language-conversations package

类

AzureKeyCredential

支持更新基础密钥值的基于静态密钥的凭据。

ConversationAnalysisClient

用于与 Azure 认知语言服务中的对话语言理解功能交互的客户端。 客户端需要语言资源的终结点和身份验证方法，例如 API 密钥或 AAD。 可以在 Azure 门户的语言资源页中找到 API 密钥和终结点。 它们位于资源管理的“密钥和终结点”页中。 身份验证示例： API 密钥 import { AzureKeyCredential } from "@azure/core-auth"; import { ConversationAnalysisClient } from "@azure/ai-language-conversations"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new AzureKeyCredential("<api key>"); const client = new ConversationAnalysisClient(endpoint, credential); Azure Active Directory 有关使用 Azure Active Directory 进行身份验证的详细信息，请参阅 @azure/identity 包。 import { ConversationAnalysisClient } from "@azure/ai-language-conversations"; import { DefaultAzureCredential } from "@azure/identity"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new DefaultAzureCredential(); const client = new ConversationAnalysisClient(endpoint, credential);

接口

AgeResolution	表示 Age 实体解析模型。
AnalysisParameters	这是业务流程项目本身或目标服务之一的参数集。
AnalyzeConversationJobResult	会话作业中所有任务的结果的容器。
AnalyzeConversationJobState	包含与相关统计信息一起提交的分析对话作业的状态。
AnalyzeConversationJobStatistics	包含提交的作业的统计信息。
AnalyzeConversationJobsInput
AnalyzeConversationLROTask	长时间运行的会话输入任务的基类。
AnalyzeConversationOptionalParams	可选参数。
AnalyzeConversationPIIResult	个人身份信息检测和修订操作对对话列表执行的结果。
AnalyzeConversationPIITask	对话中 PII 修订的任务定义。
AnalyzeConversationResult	表示聊天分析响应。
AnalyzeConversationSummarizationResult	对话摘要任务的结果。
AnalyzeConversationSummarizationTask	会话摘要的任务定义。
AnalyzeConversationTask	会话输入任务的基类。
AnalyzeConversationTaskResult	会话任务结果的基类。
AnswerSpan	QnA 的应答范围对象。
AnswersOptions	用于查询知识库的参数。
AnswersResult	表示问题解答列表。
AreaResolution	表示区域实体解析模型。
AudioTiming	音频计时信息。
BaseExtraInformation	实体额外信息的抽象基对象。
BasePrediction	这是预测的基类
BaseResolution	实体解析的抽象基类。
BooleanResolution	布尔表达式的解析
Conversation	要用于分析的一个或多个说话人的完整有序陈述集（口述或书面）。
ConversationAnalysisClientAnalyzeConversationExceptionHeaders	定义ConversationAnalysisClient_analyzeConversation操作的标头。
ConversationAnalysisClientConversationAnalysisHeaders	定义ConversationAnalysisClient_conversationAnalysis操作的标头。
ConversationAnalysisClientOptionalParams	可选参数。
ConversationAnalysisOptionalParams	可选参数。
ConversationAnalysisOptions	输入 ConversationItem 及其可选参数
ConversationCallingOptions	设置为调用对话项目的选项。
ConversationEntity	对话项目的实体提取结果。
ConversationIntent	对话项目的意向分类结果。
ConversationItemBase	用户输入格式对话（例如文本、脚本）的抽象基础。
ConversationPIIItemResult
ConversationPIIResult	每个会话的 PII 检测和修订操作的结果。
ConversationPIIResults	每个会话的 PII 检测和修订操作的结果。
ConversationPIIResultsConversationsItem	每个会话的 PII 检测和修订操作的结果。
ConversationPIITaskParameters	会话 PII 检测和修订任务支持的参数。
ConversationParameters	这是自定义对话项目的一组请求参数。
ConversationPrediction	表示对话项目的预测部分。
ConversationRequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
ConversationResult	对话项目返回的响应。
ConversationResultBase	所有对话任务结果的共享属性。
ConversationStatistics	如果在请求中指定 showStats=true，则此字段将包含有关会话有效负载的信息。
ConversationSummarizationTaskParameters	会话摘要任务支持的参数。
ConversationTargetIntentResult	对话项目响应的总结。
ConversationTaskParameters	对话任务所需的输入参数。
ConversationTasksState	包含正在执行的任务的状态，作为提交的分析会话作业的一部分。
ConversationTasksStateTasks
ConversationalTask	自定义聊天任务的输入。
ConversationalTaskResult	对话任务的结果。
ConversationsSummaryResult
ConversationsSummaryResultSummariesItem
CurrencyResolution	表示货币实体解析模型。
DateTimeResolution	日期时间实体实例的解析。
Entity
EntitySubtype	额外信息的具体实体子类型模型。
ErrorModel	错误对象。
ErrorResponse	错误响应。
InformationResolution	表示信息（数据）实体解析模型。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
InputError	包含作业执行期间遇到的错误的详细信息。
InputWarning	包含作业执行期间遇到的警告的详细信息。
JobStateAutoGenerated
KnowledgeBaseAnswer	表示知识库答案。
KnowledgeBaseAnswerContext	包含先前 QnA 信息的上下文对象。
KnowledgeBaseAnswerDialog	与答案关联的对话框。
KnowledgeBaseAnswerPrompt	提示输入答案。
LengthResolution	表示长度实体解析模型。
ListKey	列表键额外数据类型。
LuisCallingOptions	这会自定义服务如何调用 LUIS 正式版项目。
LuisParameters	这是 LUIS 正式发布项目的一组请求参数。
LuisTargetIntentResult	这是 LUIS 正式版响应的总结。
MetadataFilter	查找与给定元数据列表关联的 QnA。
MetadataRecord	用于为每个元数据提供键值对的对象。
MultiLanguageConversationAnalysisInput
NoneLinkedTargetIntentResult	非链接意向响应的总结。
NumberResolution	数值实体实例的解析。
NumericRangeResolution	表示数值间隔的分辨率。
OrchestrationPrediction	这表示业务流程项目的预测结果。
OrdinalResolution	序号实体实例的解析。
PreBuiltResult
PreBuiltTaskParameters	使用预建模型的文本分析任务的参数对象。
QuantityResolution	表示数量的解决方案。
QueryFilters	基于知识库筛选。
QuestionAnsweringParameters	这是问答知识库的一组请求参数。
QuestionAnsweringTargetIntentResult	这是一个总结问题答案知识库响应。
RedactedTranscriptContent	由服务生成的脚本内容响应，所有必需的个人身份信息都会经过修订。
RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
ShortAnswerOptions	配置答案范围预测功能。
SpeedResolution	表示速度实体解析模型。
SummaryResult
SummaryResultConversationsItem	所有对话任务结果的共享属性。
SummaryResultItem
TargetIntentResult	这是意向预测的基类
TaskIdentifier	基本任务对象。
TaskParameters	文本分析任务的基参数对象。
TaskStateAutoGenerated	返回任务的当前状态。
TemperatureResolution	表示温度实体解析模型。
TemporalSpanResolution	表示日期和/或时间跨度的解析。
TextConversation	要用于分析的一个或多个说话人的完整有序陈述集（口述或书面）。
TextConversationItem	输入对话的文本形式。
TranscriptConversation	要用于分析的一个或多个说话人的完整有序陈述集（口述或书面）。
TranscriptConversationItem	支持脚本对话的其他属性。
VolumeResolution	表示卷实体解析模型。
WeightResolution	表示权重实体解析模型。
WordLevelTiming	语音转文本 API 生成的单词级计时信息。 此对象中的单词应具有与“词法”输入的 1：1 对应，以便进行音频修订。

类型别名

AgeUnit	定义 AgeUnit 的值。 KnownAgeUnit 可与 AgeUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定的年月周日
AnalysisParametersUnion
AnalyzeConversationJobResultUnion
AnalyzeConversationLROTaskKind	定义 AnalyzeConversationLROTaskKind 的值。 KnownAnalyzeConversationLROTaskKind 可与 AnalyzeConversationLROTaskKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 ConversationalPIITaskConversationalSummarizationTask
AnalyzeConversationLROTaskUnion
AnalyzeConversationResponse	包含 analyzeConversation 操作的响应数据。
AnalyzeConversationResultsKind	定义 AnalyzeConversationResultsKind 的值。 KnownAnalyzeConversationResultsKind 可与 AnalyzeConversationResultsKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 ConversationalPIIResultsConversationalSummarizationResults
AnalyzeConversationTaskKind	定义 AnalyzeConversationTaskKind 的值。 KnownAnalyzeConversationTaskKind 可与 AnalyzeConversationTaskKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 聊天
AnalyzeConversationTaskResultUnion
AnalyzeConversationTaskResultsKind	定义 AnalyzeConversationTaskResultsKind 的值。 KnownAnalyzeConversationTaskResultsKind 可与 AnalyzeConversationTaskResultsKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 ConversationResult
AnalyzeConversationTaskUnion
AreaUnit	定义 AreaUnit 的值。 KnownAreaUnit 可与 AreaUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定的SquareKilometerSquareHectometerSquareDecameterSquareDecimeterSquareCentcimeterSquareCentimeterSquareCentimeterSquareInchSquareFootSquareMileSquareYardAcre
BaseExtraInformationUnion
BasePredictionUnion
BaseResolutionUnion
ConversationAnalysisResponse	包含 conversationAnalysis 操作的响应数据。
ConversationDomain	定义 ConversationDomain 的值。 KnownConversationDomain 可与 ConversationDomain 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 财务医疗保健通用
ConversationPIICategory	定义 ConversationPIICategory 的值。 KnownConversationPIICategory 可与 ConversationPIICategory 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 地址信用卡电子邮件名称NumericIdentifierPhoneNumber所有默认
ConversationUnion
DateTimeSubKind	定义 DateTimeSubKind 的值。 KnownDateTimeSubKind 可与 DateTimeSubKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 日期DateTime持续时间设置
ErrorCode	定义 ErrorCode 的值。 KnownErrorCode 可与 ErrorCode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 InvalidRequestInvalidArgumentUnauthorizedNotFoundNotFoundProjectNotFoundOperationNotFoundAzureCognitiveSearchNotFoundAzureCognitiveSearchIndexNotFoundTooManyAzureCognitiveSearchThrottlingAzureCognitiveSearchIndexLimitReachedInternalServerErrorServiceUnavailableTimeoutQuotaExceededed冲突警告
ExtraInformationKind	定义 ExtraInformationKind 的值。 KnownExtraInformationKind 可与 ExtraInformationKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 EntitySubtypeListKey
InformationUnit	定义 InformationUnit 的值。 KnownInformationUnit 可以与 InformationUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定位千兆位 千兆位千兆字节 千兆位 千兆位 太位千兆位 千
InnerErrorCode	定义 InnerErrorCode 的值。 KnownInnerErrorCode 可以与 InnerErrorCode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无效请求无效参数值知识库未找到AzureCognitiveSearch未找到AzureCognitiveSearchThrottlingExtractionFailureInvalidRequestBodyFormatEmptyRequestMissingInputDocumentsInvalidDocumentModelVersionIncorrectInvalidDocumentBatchUnsupportedLanguageCodeInvalidCountryHint
InputModality	定义 InputModality 的值。 KnownInputModality 可与 InputModality 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 脚本文本
JobState	定义 JobState 的值。 KnownJobState 可与 JobState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未启动运行成功部分完成取消取消
LengthUnit	定义 LengthUnit 的值。 KnownLengthUnit 可与 LengthUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定公里百米十米米分米厘米毫米微米纳米皮米英里码英寸英尺光年Pt
LogicalOperationKind	定义 LogicalOperationKind 的值。 KnownLogicalOperationKind 可与 LogicalOperationKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 和或
NumberKind	定义 NumberKind 的值。 KnownNumberKind 可与 NumberKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 整数十进制电源分数百分比未指定
ProjectKind	定义 ProjectKind 的值。 KnownProjectKind 可与 ProjectKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 对话业务流程
RangeKind	定义 RangeKind 的值。 KnownRangeKind 可与 RangeKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 数值速度重量长度量区域年龄信息温度货币
RankerKind	定义 RankerKind 的值。 KnownRankerKind 可与 RankerKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 QuestionOnly：仅提问排名器。 默认：默认排名器。
RelativeTo	定义 RelativeTo 的值。 KnownRelativeTo 可与 RelativeTo 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 当前结束开始
ResolutionKind	定义 ResolutionKind 的值。 KnownResolutionKind 可与 ResolutionKind 互换，此枚举包含服务支持的已知值。 服务支持的已知值 布尔DateTime数字序号速度重量长度量区域年龄信息温度货币NumericRangeTemporalSpan
Role	定义 Role 的值。 KnownRole 可与 Role 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 代理客户通用
SpeedUnit	定义 SpeedUnit 的值。 KnownSpeedUnit 可与 SpeedUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定的MetersPerSecondKmsPerHourkmsPerMinutekmsPerSecondmilesPerHourknotfootPerSecondfootPerMinute码PerMinute码PerSecondMeterPerMillisecond厘米公里PerMillisecond
StringIndexType	定义 StringIndexType 的值。 KnownStringIndexType 可与 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）编写的，请使用此选项。
SummaryAspect	定义 SummaryAspect 的值。 KnownSummaryAspect 可与 SummaryAspect 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 问题解决
TargetIntentResultUnion
TargetProjectKind	定义 TargetProjectKind 的值。 KnownTargetProjectKind 可与 TargetProjectKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Luis对话QuestionAnsweringNonLinked
TaskState	定义 TaskState 的值。 KnownTaskState 可与 TaskState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未启动运行成功失败，取消
TemperatureUnit	定义 TemperatureUnit 的值。 KnownTemperatureUnit 可与 TemperatureUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定华氏凯尔文兰吉恩摄氏度
TemporalModifier	定义 TemporalModifier 的值。 KnownTemporalModifier 可以与 TemporalModifier 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 AfterApprox之前BeforeStartApproxReferenceUndefinedSinceEndAfterMidStartAfterBeforeEndUntilEnd LesssinceAfterStartBeforeApproxMidMore
TranscriptContentType	定义 TranscriptContentType 的值。 KnownTranscriptContentType 可与 TranscriptContentType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 词法它maskedItn文本
VolumeUnit	定义 VolumeUnit 的值。 KnownVolumeUnit 可以与 VolumeUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定立方米立方厘米 立方毫米 百升十升升厘米毫升立方码 立方英寸立方英尺立方英里液量盎司茶匙汤匙品脱夸脱杯鳃捏液Dram桶最小值绳啄蒲式耳大桶头
WeightUnit	定义 WeightUnit 的值。 KnownWeightUnit 可与 WeightUnit 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未指定的公斤克米利格拉姆加仑吨磅盎司佩妮重量LongTonBritishShortTonUSShortHundredWeightUSDramDram

枚举

KnownAgeUnit	服务的 AgeUnit 的已知值。
KnownAnalyzeConversationLROTaskKind	AnalyzeConversationLROTaskKind 服务的已知值。
KnownAnalyzeConversationResultsKind	AnalyzeConversationResultsKind 服务的已知值。
KnownAnalyzeConversationTaskKind	AnalyzeConversationTaskKind 服务的已知值。
KnownAnalyzeConversationTaskResultsKind	AnalyzeConversationTaskResultsKind 服务的已知值。
KnownAreaUnit	服务的 AreaUnit 的已知值。
KnownConversationDomain	服务接受的 ConversationDomain 的已知值。
KnownConversationPIICategory	服务接受的 ConversationPIICategory 的已知值。
KnownDateTimeSubKind	服务的 DateTimeSubKind 的已知值。
KnownErrorCode	ErrorCode 服务的已知值。
KnownExtraInformationKind	服务的 ExtraInformationKind 的已知值。
KnownInformationUnit	InformationUnit 的已知值 服务接受的值。
KnownInnerErrorCode	InnerErrorCode 的已知值 服务接受的值。
KnownInputModality	服务的 InputModality 已知值。
KnownJobState	服务的 JobState 的已知值。
KnownLengthUnit	服务的 LengthUnit 已知值。
KnownLogicalOperationKind	LogicalOperationKind 服务的已知值。
KnownNumberKind	服务的 NumberKind 已知值。
KnownProjectKind	服务的 ProjectKind 已知值。
KnownRangeKind	服务的 RangeKind 已知值。
KnownRankerKind	服务的 RankerKind 已知值。
KnownRelativeTo	服务的 RelativeTo 已知值。
KnownResolutionKind	服务的 ResolutionKind 已知值。
KnownRole	服务的 角色 的已知值。
KnownSpeedUnit	服务接受的 SpeedUnit 的已知值。
KnownStringIndexType	StringIndexType 服务的已知值。
KnownSummaryAspect	SummaryAspect 服务的已知值。
KnownTargetProjectKind	服务的 TargetProjectKind 的已知值。
KnownTaskState	服务接受的 TaskState 的已知值。
KnownTemperatureUnit	服务接受的 TemperatureUnit 已知值。
KnownTemporalModifier	服务接受的 TemporalModifier 的已知值。
KnownTranscriptContentType	服务接受的 TranscriptContentType 的已知值。
KnownVolumeUnit	服务的 VolumeUnit 已知值。
KnownWeightUnit	服务的 WeightUnit 的已知值。