BotFrameworkConfig class

套件:

microsoft-cognitiveservices-speech-sdk

類別，定義使用 Bot Framework 後端之對話服務連接器物件的組態。

Extends

DialogServiceConfigImpl

建構函式

BotFrameworkConfig()

建立 BotFrameworkConfig 的實例。

屬性

applicationId	設定對應的後端應用程式識別碼。
DialogTypes
outputFormat
properties	提供自訂屬性的存取權。
speechRecognitionLanguage	取得語音辨識語言。

方法

fromAuthorizationToken(string, string, string)	為指定的授權令牌和區域建立 Bot Framework 組態實例。 注意：呼叫端必須確保授權令牌有效。 在授權令牌到期之前，呼叫端必須在使用此設定所建立的對應 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)	使用提供的訂用帳戶資訊建立 Bot Framework 組態實例。

繼承的方法

close()	處置相關聯的資源。
getProperty(string | PropertyId, string)	將具名屬性設定為值
setProperty(string | PropertyId, string)	將具名屬性設定為值
setProxy(string, number, string, string)	設定 Proxy 組態。 僅與 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)

為指定的授權令牌和區域建立 Bot Framework 組態實例。 注意：呼叫端必須確保授權令牌有效。 在授權令牌到期之前，呼叫端必須在使用此設定所建立的對應 DialogServiceConnector 實例上設定 authorizationToken 屬性來重新整理它。建立連接器時會複製組態對象的內容，因此在 DialogServiceConnector 上設定 authorizationToken 將不會更新原始組態的授權令牌。 建立新的組態實例，或設定 SpeechServiceAuthorization_Token 屬性，以更新現有的實例，如果它將用來建立進一步的 DialogServiceConnectors。

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

參數

authorizationToken

string

與 Bot 相關聯的授權令牌

region

string

區域名稱（請參閱 區域頁面）。

botId

string

自選。 在 Azure 資源群組內使用特定 Bot 的識別碼。 相當於資源名稱。

傳回

BotFrameworkConfig

新的 Bot Framework 組態實例。

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

• 使用提供的端點的新 Bot Framework 組態實例。

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 資源群組內使用特定 Bot 的識別碼。 相當於資源名稱。

傳回

BotFrameworkConfig

新的 Bot Framework 組態實例。

fromSubscription(string, string, string)

使用提供的訂用帳戶資訊建立 Bot Framework 組態實例。

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

參數

subscription

string

與 Bot 相關聯的訂用帳戶金鑰

region

string

區域名稱（請參閱 區域頁面）。

botId

string

自選。 在 Azure 資源群組內使用特定 Bot 的識別碼。 相當於資源名稱。

傳回

BotFrameworkConfig

新的 Bot Framework 組態實例。

繼承的方法的詳細資料

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)

設定 Proxy 組態。 僅與 Node.js 環境相關。 已在1.4.0版中新增。

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

參數

proxyHostName

string

Proxy 伺服器的主機名，不含通訊協定配置 （http://）

proxyPort

number

Proxy 伺服器的埠號碼。

proxyUserName

string

Proxy 伺服器的用戶名稱。

proxyPassword

string

Proxy 伺服器的密碼。

繼承自 DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter)

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

參數

name

string

value

string

channel

UriQueryParameter

繼承自 DialogServiceConfigImpl.setServiceProperty