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

DialogServiceConnector class

包:

microsoft-cognitiveservices-speech-sdk

对话框服务连接器

Extends

Recognizer

构造函数

DialogServiceConnector(DialogServiceConfig, AudioConfig)

初始化 DialogServiceConnector 的实例。

属性

activityReceived	事件 activityReceived 表示已收到活动。
authorizationToken	获取用于与服务通信的授权令牌。
canceled	事件已取消，表明识别期间发生了错误。
internalData
properties	为此 DialogServiceConnector 定义的属性及其值的集合。
recognized	识别的事件表示收到最终识别结果的信号。
recognizing	识别事件表示收到中间识别结果的信号。
speechActivityTemplate	获取服务从语音生成的活动的模板。 模板中的属性将在生成的活动上标记。 它可以为空
telemetryEnabled	此方法返回遥测设置的当前状态。
turnStatusReceived	事件 turnStatusReceived 指示已收到轮次状态消息。 这些消息与交互和对话相关联。 它们用于在与对话后端发生交互失败时通知客户端，例如，如果出现网络问题、超时、崩溃或其他问题。

继承属性

sessionStarted	定义会话启动事件的事件处理程序。
sessionStopped	定义会话停止事件的事件处理程序。
speechEndDetected	定义语音停止事件的事件处理程序。
speechStartDetected	定义语音启动事件的事件处理程序。

方法

close(() => void, (error: string) => void)	关闭此类的实例持有的所有外部资源。
connect(() => void, (error: string) => void)	启动与服务的连接。 用户可以选择调用 connect () ，以在开始交互之前提前手动设置连接。 注意：返回时，连接可能尚未准备就绪。 请订阅 Connected 事件，以在建立连接时收到通知。
disconnect(() => void, (error: string) => void)	关闭服务的连接。 用户可以选择调用 disconnect () 来手动关闭关联的 DialogServiceConnector 的连接。 如果在识别过程中调用 disconnect () ，则识别将失败并取消并显示错误。
listenOnceAsync((e: SpeechRecognitionResult) => void, (e: string) => void)	开始识别并在识别第一个言语后停止。
sendActivityAsync(string, () => void, (error: string) => void)

继承的方法

enableTelemetry(boolean)

此方法全局启用或禁用遥测。

构造函数详细信息

DialogServiceConnector(DialogServiceConfig, AudioConfig)

初始化 DialogServiceConnector 的实例。

new DialogServiceConnector(dialogConfig: DialogServiceConfig, audioConfig?: AudioConfig)

参数

dialogConfig

DialogServiceConfig

用于配置此识别器的属性集。

audioConfig

AudioConfig

与识别器关联的可选音频配置

属性详细信息

activityReceived

事件 activityReceived 表示已收到活动。

public activityReceived: (sender: DialogServiceConnector, event: ActivityReceivedEventArgs) => void

属性值

(sender: DialogServiceConnector, event: ActivityReceivedEventArgs) => void

authorizationToken

获取用于与服务通信的授权令牌。

string authorizationToken

属性值

string

授权令牌。

canceled

事件已取消，表明识别期间发生了错误。

public canceled: (sender: DialogServiceConnector, event: SpeechRecognitionCanceledEventArgs) => void

属性值

(sender: DialogServiceConnector, event: SpeechRecognitionCanceledEventArgs) => void

internalData

object internalData

属性值

object

properties

为此 DialogServiceConnector 定义的属性及其值的集合。

PropertyCollection properties

属性值

PropertyCollection

为此 DialogServiceConnector 定义的属性及其值的集合。

recognized

识别的事件表示收到最终识别结果的信号。

public recognized: (sender: DialogServiceConnector, event: SpeechRecognitionEventArgs) => void

属性值

(sender: DialogServiceConnector, event: SpeechRecognitionEventArgs) => void

recognizing

识别事件表示收到中间识别结果的信号。

public recognizing: (sender: DialogServiceConnector, event: SpeechRecognitionEventArgs) => void

属性值

(sender: DialogServiceConnector, event: SpeechRecognitionEventArgs) => void

speechActivityTemplate

获取服务从语音生成的活动的模板。 模板中的属性将在生成的活动上标记。 它可以为空

string speechActivityTemplate

属性值

string

telemetryEnabled

此方法返回遥测设置的当前状态。

static boolean telemetryEnabled

属性值

boolean

如果启用遥测，则为 true;否则为 false。

turnStatusReceived

事件 turnStatusReceived 指示已收到轮次状态消息。 这些消息与交互和对话相关联。 它们用于在与对话后端发生交互失败时通知客户端，例如，如果出现网络问题、超时、崩溃或其他问题。

public turnStatusReceived: (sender: DialogServiceConnector, event: TurnStatusReceivedEventArgs) => void

属性值

(sender: DialogServiceConnector, event: TurnStatusReceivedEventArgs) => void

继承属性详细信息

sessionStarted

定义会话启动事件的事件处理程序。

public sessionStarted: (sender: Recognizer, event: SessionEventArgs) => void

属性值

(sender: Recognizer, event: SessionEventArgs) => void

继承自Recognizer.sessionStarted

sessionStopped

定义会话停止事件的事件处理程序。

public sessionStopped: (sender: Recognizer, event: SessionEventArgs) => void

属性值

(sender: Recognizer, event: SessionEventArgs) => void

继承自Recognizer.sessionStopped

speechEndDetected

定义语音停止事件的事件处理程序。

public speechEndDetected: (sender: Recognizer, event: RecognitionEventArgs) => void

属性值

(sender: Recognizer, event: RecognitionEventArgs) => void

继承自Recognizer.speechEndDetected

speechStartDetected

定义语音启动事件的事件处理程序。

public speechStartDetected: (sender: Recognizer, event: RecognitionEventArgs) => void

属性值

(sender: Recognizer, event: RecognitionEventArgs) => void

继承自Recognizer.speechStartDetected

方法详细信息

close(() => void, (error: string) => void)

关闭此类的实例持有的所有外部资源。

function close(cb?: () => void, err?: (error: string) => void)

参数

cb

() => void

err

(error: string) => void

connect(() => void, (error: string) => void)

启动与服务的连接。 用户可以选择调用 connect () ，以在开始交互之前提前手动设置连接。

注意：返回时，连接可能尚未准备就绪。 请订阅 Connected 事件，以在建立连接时收到通知。

function connect(cb?: () => void, err?: (error: string) => void)

参数

cb

() => void

err

(error: string) => void

disconnect(() => void, (error: string) => void)

关闭服务的连接。 用户可以选择调用 disconnect () 来手动关闭关联的 DialogServiceConnector 的连接。

如果在识别过程中调用 disconnect () ，则识别将失败并取消并显示错误。

function disconnect(cb?: () => void, err?: (error: string) => void)

参数

cb

() => void

err

(error: string) => void

listenOnceAsync((e: SpeechRecognitionResult) => void, (e: string) => void)

开始识别并在识别第一个言语后停止。

function listenOnceAsync(cb?: (e: SpeechRecognitionResult) => void, err?: (e: string) => void)

参数

cb

(e: SpeechRecognitionResult) => void

在 reco 完成时接收结果的回调。

err

(e: string) => void

发生错误时调用的回调。

sendActivityAsync(string, () => void, (error: string) => void)

function sendActivityAsync(activity: string, cb?: () => void, errCb?: (error: string) => void)

参数

activity

string

cb

() => void

errCb

(error: string) => void

继承的方法详细信息

enableTelemetry(boolean)

此方法全局启用或禁用遥测。

static function enableTelemetry(enabled: boolean)

参数

enabled

boolean

遥测收集的全局设置。 如果设置为 true，则会收集麦克风错误、识别错误等遥测信息并将其发送给 Microsoft。 如果设置为 false，则不会向 Microsoft 发送遥测数据。

继承自Recognizer.enableTelemetry