BotFrameworkConfig class

  • Reference
Balíček:
microsoft-cognitiveservices-speech-sdk

Třída, která definuje konfigurace pro objekt konektoru služby dialogového okna pro použití back-endu Bot Framework.

Extends

DialogServiceConfigImpl

Konstruktory

BotFrameworkConfig()

Vytvoří instanci BotFrameworkConfig.

Vlastnosti

applicationId

Nastaví odpovídající identifikátor back-endové aplikace.
DialogTypes
outputFormat
properties

Poskytuje přístup k vlastním vlastnostem.
speechRecognitionLanguage

Získá jazyk rozpoznávání řeči.

Metody

fromAuthorizationToken(string, string, string)

Vytvoří instanci konfigurace bot Framework pro zadaný autorizační token a oblast. Poznámka: Volající musí ověřit platnost autorizačního tokenu. Před vypršením platnosti autorizačního tokenu ho volající musí aktualizovat nastavením vlastnosti authorizationToken v odpovídající instanci DialogServiceConnector vytvořené s touto konfigurací. Obsah objektů konfigurace se zkopíruje při vytváření konektorů, takže nastavení authorizationTokenu v DialogServiceConnector neaktualizuje autorizační token původní konfigurace. Vytvořte novou instanci konfigurace nebo nastavte vlastnost SpeechServiceAuthorization_Token, aby se aktualizovala existující instance, pokud se použije k vytvoření dalších DialogServiceConnectors.
fromEndpoint(URL, string)

Vytvoří instanci BotFrameworkConfig. Tato metoda je určená jenom uživatelům, kteří používají nestandardní koncový bod služby nebo parametry. Poznámka: Parametry dotazu zadané v adrese URL koncového bodu se nezmění, a to ani v případě, že jsou nastavené jinými rozhraními API. Poznámka: Pokud chcete použít autorizační token s parametrem fromEndpoint, předejte prázdný řetězec subscriptionKey v metodě fromEndpoint a pak nastavte authorizationToken="token" ve vytvořené instanci BotFrameworkConfig tak, aby používala autorizační token. Poznámka: Přidáno ve verzi 1.15.0.
fromHost(string | URL, string, string)

Vytvoří instanci BotFrameworkConfig. Tato metoda je určena pouze pro uživatele, kteří používají jiné než výchozí hostitele služby. Předpokládá se standardní cesta k prostředku. Pro služby s nestandardní cestou k prostředku nebo vůbec žádnou cestou použijte fromEndpoint. Poznámka: Parametry dotazu nejsou v identifikátoru URI hostitele povolené a musí je nastavit jiná rozhraní API. Poznámka: Pokud chcete použít autorizační token s parametrem fromHost, použijte fromHost(URL) a pak nastavte vlastnost AuthorizationToken ve vytvořené instanci BotFrameworkConfig. Poznámka: Přidáno ve verzi 1.15.0.
fromSubscription(string, string, string)

Vytvoří instanci konfigurace bot Framework s poskytnutými informacemi o předplatném.

Zděděné metody

close()

Vyřaďte přidružené prostředky.
getProperty(string | PropertyId, string)

Nastaví pojmenovanou vlastnost jako hodnotu.
setProperty(string | PropertyId, string)

Nastaví pojmenovanou vlastnost jako hodnotu.
setProxy(string, number, string, string)

Nastaví konfiguraci proxy serveru. Relevantní pouze v Node.js prostředích. Přidáno ve verzi 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Podrobnosti konstruktoru

BotFrameworkConfig()

Vytvoří instanci BotFrameworkConfig.

new BotFrameworkConfig()

Podrobnosti vlastnosti

applicationId

Nastaví odpovídající identifikátor back-endové aplikace.

void applicationId

Hodnota vlastnosti

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Hodnota vlastnosti

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Hodnota vlastnosti

OutputFormat

properties

Poskytuje přístup k vlastním vlastnostem.

PropertyCollection properties

Hodnota vlastnosti

PropertyCollection

Vlastnosti.

speechRecognitionLanguage

Získá jazyk rozpoznávání řeči.

string speechRecognitionLanguage

Hodnota vlastnosti

string

Podrobnosti metody

fromAuthorizationToken(string, string, string)

Vytvoří instanci konfigurace bot Framework pro zadaný autorizační token a oblast. Poznámka: Volající musí ověřit platnost autorizačního tokenu. Před vypršením platnosti autorizačního tokenu ho volající musí aktualizovat nastavením vlastnosti authorizationToken v odpovídající instanci DialogServiceConnector vytvořené s touto konfigurací. Obsah objektů konfigurace se zkopíruje při vytváření konektorů, takže nastavení authorizationTokenu v DialogServiceConnector neaktualizuje autorizační token původní konfigurace. Vytvořte novou instanci konfigurace nebo nastavte vlastnost SpeechServiceAuthorization_Token, aby se aktualizovala existující instance, pokud se použije k vytvoření dalších DialogServiceConnectors.

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

Parametry

authorizationToken

string

Autorizační token přidružený k robotovi

region

string

Název oblasti (viz stránka oblasti).

botId

string

Nepovinný parametr. Identifikátor pro použití konkrétního robota v rámci skupiny prostředků Azure. Odpovídá názvu prostředku.

Návraty

BotFrameworkConfig

Nová instance konfigurace služby Bot Framework

fromEndpoint(URL, string)

Vytvoří instanci BotFrameworkConfig. Tato metoda je určená jenom uživatelům, kteří používají nestandardní koncový bod služby nebo parametry. Poznámka: Parametry dotazu zadané v adrese URL koncového bodu se nezmění, a to ani v případě, že jsou nastavené jinými rozhraními API. Poznámka: Pokud chcete použít autorizační token s parametrem fromEndpoint, předejte prázdný řetězec subscriptionKey v metodě fromEndpoint a pak nastavte authorizationToken="token" ve vytvořené instanci BotFrameworkConfig tak, aby používala autorizační token. Poznámka: Přidáno ve verzi 1.15.0.

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

Parametry

endpoint

URL

Koncový bod služby, ke kterému se chcete připojit.

subscriptionKey

string

Klíč předplatného. Pokud není klíč předplatného zadaný, musí se nastavit autorizační token.

Návraty

BotFrameworkConfig
  • Nová instance konfigurace bot Frameworku s využitím zadaného koncového bodu

fromHost(string | URL, string, string)

Vytvoří instanci BotFrameworkConfig. Tato metoda je určena pouze pro uživatele, kteří používají jiné než výchozí hostitele služby. Předpokládá se standardní cesta k prostředku. Pro služby s nestandardní cestou k prostředku nebo vůbec žádnou cestou použijte fromEndpoint. Poznámka: Parametry dotazu nejsou v identifikátoru URI hostitele povolené a musí je nastavit jiná rozhraní API. Poznámka: Pokud chcete použít autorizační token s parametrem fromHost, použijte fromHost(URL) a pak nastavte vlastnost AuthorizationToken ve vytvořené instanci BotFrameworkConfig. Poznámka: Přidáno ve verzi 1.15.0.

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

Parametry

host

string | URL

Pokud zadáte adresu URL, použije se plně kvalifikovaný hostitel s protokolem (např. wss://your.host.com:1234). Pokud je zadaný řetězec, vloží se do wss://{host}.convai.speech.azure.us.

subscriptionKey

string

Klíč předplatného. Pokud klíč předplatného není zadaný, musí být nastavený autorizační token.

botId

string

Nepovinný parametr. Identifikátor pro použití konkrétního robota v rámci skupiny prostředků Azure Ekvivalent k názvu prostředku.

Návraty

BotFrameworkConfig

Nová instance konfigurace rozhraní bot Framework.

fromSubscription(string, string, string)

Vytvoří instanci konfigurace bot Framework s poskytnutými informacemi o předplatném.

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

Parametry

subscription

string

Klíč předplatného přidružený k robotovi

region

string

Název oblasti (viz stránka oblasti).

botId

string

Nepovinný parametr. Identifikátor pro použití konkrétního robota v rámci skupiny prostředků Azure Ekvivalent k názvu prostředku.

Návraty

BotFrameworkConfig

Nová instance konfigurace rozhraní bot Framework.

Podrobnosti zděděných metod

close()

Vyřaďte přidružené prostředky.

function close()

Zděděno z DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Nastaví pojmenovanou vlastnost jako hodnotu.

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

Parametry

name

string | PropertyId

Vlastnost, která se má získat.

def

string

Výchozí hodnota, která se má vrátit v případě, že vlastnost není známa.

Návraty

string

Aktuální nebo zadaná výchozí hodnota dané vlastnosti.

Zděděno z DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Nastaví pojmenovanou vlastnost jako hodnotu.

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

Parametry

name

string | PropertyId

Vlastnost, kterou chcete nastavit.

value

string

Hodnota

Zděděno z DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Nastaví konfiguraci proxy serveru. Relevantní pouze v Node.js prostředích. Přidáno ve verzi 1.4.0.

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

Parametry

proxyHostName

string

Název hostitele proxy serveru bez schématu protokolu (http://)

proxyPort

number

Číslo portu proxy serveru.

proxyUserName

string

Uživatelské jméno proxy serveru.

proxyPassword

string

Heslo proxy serveru.

Zděděno z DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parametry

name

string

value

string

channel
UriQueryParameter

Zděděno z DialogServiceConfigImpl.setServiceProperty