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

BotFrameworkConfig class

包:

microsoft-cognitiveservices-speech-sdk

定义对话服务连接器对象的配置以使用 Bot Framework 后端的类。

Extends

DialogServiceConfigImpl

构造函数

BotFrameworkConfig()

创建 BotFrameworkConfig 的实例。

属性

applicationId	设置相应的后端应用程序标识符。
DialogTypes
outputFormat
properties	提供对自定义属性的访问。
speechRecognitionLanguage	获取语音识别语言。

方法

fromAuthorizationToken(string, string, string)	为指定的授权令牌和区域创建机器人框架配置实例。 注意：调用方必须确保授权令牌有效。 授权令牌过期之前，调用方必须通过在使用此配置创建的相应 DialogServiceConnector 实例上设置 authorizationToken 属性来刷新它。创建连接器时会复制配置对象的内容，因此在 DialogServiceConnector 上设置 authorizationToken 不会更新原始配置的授权令牌。 创建新的配置实例或设置 SpeechServiceAuthorization_Token 属性以更新现有实例（如果它将用于创建进一步的 DialogServiceConnectors）。
fromEndpoint(URL, string)	创建 BotFrameworkConfig 的实例。 此方法仅适用于使用非标准服务终结点或参数的用户。 注意：终结点 URL 中指定的查询参数不会更改，即使它们是由任何其他 API 设置的。 注意：若要将授权令牌与 fromEndpoint 一起使用，请在 fromEndpoint 方法中将一个空字符串传递给 subscriptionKey，然后在创建的 BotFrameworkConfig 实例上设置 authorizationToken=“token”，以使用授权令牌。 注意：在版本 1.15.0 中添加。
fromHost(string | URL, string, string)	创建 BotFrameworkConfig 的实例。 此方法仅适用于使用非默认服务主机的用户。 将采用标准资源路径。 对于具有非标准资源路径或根本没有路径的服务，请改用 fromEndpoint。 注意：主机 URI 中不允许使用查询参数，必须由其他 API 设置。 注意：若要将授权令牌与 fromHost 一起使用，请使用 fromHost (URL) ，然后在创建的 BotFrameworkConfig 实例上设置 AuthorizationToken 属性。 注意：在版本 1.15.0 中添加。
fromSubscription(string, string, string)	使用提供的订阅信息创建机器人框架配置实例。

继承的方法

close()	释放关联的资源。
getProperty(string | PropertyId, string)	将命名属性设置为值
setProperty(string | PropertyId, string)	将命名属性设置为值
setProxy(string, number, string, string)	设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。
setServiceProperty(string, string, UriQueryParameter)

构造函数详细信息

BotFrameworkConfig()

创建 BotFrameworkConfig 的实例。

new BotFrameworkConfig()

属性详细信息

applicationId

设置相应的后端应用程序标识符。

void applicationId

属性值

void

DialogTypes

static { BotFramework: string, CustomCommands: string } DialogTypes

属性值

{ BotFramework: string, CustomCommands: string }

outputFormat

OutputFormat outputFormat

属性值

OutputFormat

properties

提供对自定义属性的访问。

PropertyCollection properties

属性值

PropertyCollection

属性。

speechRecognitionLanguage

获取语音识别语言。

string speechRecognitionLanguage

属性值

string

方法详细信息

fromAuthorizationToken(string, string, string)

为指定的授权令牌和区域创建机器人框架配置实例。 注意：调用方必须确保授权令牌有效。 授权令牌过期之前，调用方必须通过在使用此配置创建的相应 DialogServiceConnector 实例上设置 authorizationToken 属性来刷新它。创建连接器时会复制配置对象的内容，因此在 DialogServiceConnector 上设置 authorizationToken 不会更新原始配置的授权令牌。 创建新的配置实例或设置 SpeechServiceAuthorization_Token 属性以更新现有实例（如果它将用于创建进一步的 DialogServiceConnectors）。

static function fromAuthorizationToken(authorizationToken: string, region: string, botId?: string): BotFrameworkConfig

参数

authorizationToken

string

与机器人关联的授权令牌

region

string

区域名称 (请参阅 区域页面) 。

botId

string

可选。 用于在 Azure 资源组中使用特定机器人的标识符。 等效于资源名称。

返回

BotFrameworkConfig

新的机器人框架配置实例。

fromEndpoint(URL, string)

创建 BotFrameworkConfig 的实例。 此方法仅适用于使用非标准服务终结点或参数的用户。 注意：终结点 URL 中指定的查询参数不会更改，即使它们是由任何其他 API 设置的。 注意：若要将授权令牌与 fromEndpoint 一起使用，请在 fromEndpoint 方法中将一个空字符串传递给 subscriptionKey，然后在创建的 BotFrameworkConfig 实例上设置 authorizationToken=“token”，以使用授权令牌。 注意：在版本 1.15.0 中添加。

static function fromEndpoint(endpoint: URL, subscriptionKey?: string): BotFrameworkConfig

参数

endpoint

URL

要连接到的服务终结点。

subscriptionKey

string

订阅密钥。 如果未指定订阅密钥，则必须设置授权令牌。

返回

BotFrameworkConfig

• 使用提供的终结点的新机器人框架配置实例。

fromHost(string | URL, string, string)

创建 BotFrameworkConfig 的实例。 此方法仅适用于使用非默认服务主机的用户。 将采用标准资源路径。 对于具有非标准资源路径或根本没有路径的服务，请改用 fromEndpoint。 注意：主机 URI 中不允许使用查询参数，必须由其他 API 设置。 注意：若要将授权令牌与 fromHost 一起使用，请使用 fromHost (URL) ，然后在创建的 BotFrameworkConfig 实例上设置 AuthorizationToken 属性。 注意：在版本 1.15.0 中添加。

static function fromHost(host: string | URL, subscriptionKey?: string, botId?: string): BotFrameworkConfig

参数

host

string | URL

如果提供了 URL，则将使用具有协议 (（例如 wss://your.host.com:1234) ）的完全限定主机。 如果提供了字符串，它将嵌入到 wss://{host}.convai.speech.azure.us 中。

subscriptionKey

string

订阅密钥。 如果未指定订阅密钥，则必须设置授权令牌。

botId

string

可选。 用于在 Azure 资源组中使用特定机器人的标识符。 等效于资源名称。

返回

BotFrameworkConfig

新的机器人框架配置实例。

fromSubscription(string, string, string)

使用提供的订阅信息创建机器人框架配置实例。

static function fromSubscription(subscription: string, region: string, botId?: string): BotFrameworkConfig

参数

subscription

string

与机器人关联的订阅密钥

region

string

区域名称 (请参阅 区域页面) 。

botId

string

可选。 用于在 Azure 资源组中使用特定机器人的标识符。 等效于资源名称。

返回

BotFrameworkConfig

新的机器人框架配置实例。

继承的方法详细信息

close()

释放关联的资源。

function close()

继承自 DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

将命名属性设置为值

function getProperty(name: string | PropertyId, def?: string): string

参数

name

string | PropertyId

要获取的属性。

def

string

属性未知时要返回的默认值。

返回

string

给定属性的当前值或提供的默认值。

继承自 DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

将命名属性设置为值

function setProperty(name: string | PropertyId, value: string)

参数

name

string | PropertyId

要设置的属性。

value

string

值。

继承自 DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。

function setProxy(proxyHostName: string, proxyPort: number, proxyUserName?: string, proxyPassword?: string)

参数

proxyHostName

string

代理服务器的主机名，不使用协议方案 (http：//)

proxyPort

number

代理服务器的端口号。

proxyUserName

string

代理服务器的用户名。

proxyPassword

string

代理服务器的密码。

继承自 DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter)

function setServiceProperty(name: string, value: string, channel: UriQueryParameter)

参数

name

string

value

string

channel

UriQueryParameter

继承自 DialogServiceConfigImpl.setServiceProperty