Share via

BotFrameworkConfig class

  • Odwołanie
Pakiet:
microsoft-cognitiveservices-speech-sdk

Klasa definiująca konfiguracje obiektu łącznika usługi dialogowej na potrzeby korzystania z zaplecza platformy Bot Framework.

Extends

DialogServiceConfigImpl

Konstruktory

BotFrameworkConfig()

Tworzy wystąpienie elementu BotFrameworkConfig.

Właściwości

applicationId

Ustawia odpowiedni identyfikator aplikacji zaplecza.
DialogTypes
outputFormat
properties

Zapewnia dostęp do właściwości niestandardowych.
speechRecognitionLanguage

Pobiera język rozpoznawania mowy.

Metody

fromAuthorizationToken(string, string, string)

Tworzy wystąpienie konfiguracji platformy bota dla określonego tokenu autoryzacji i regionu. Uwaga: obiekt wywołujący musi upewnić się, że token autoryzacji jest prawidłowy. Przed wygaśnięciem tokenu autoryzacji obiekt wywołujący musi go odświeżyć, ustawiając właściwość authorizationToken w odpowiednim wystąpieniu DialogServiceConnector utworzonym za pomocą tej konfiguracji. Zawartość obiektów konfiguracji jest kopiowana podczas tworzenia łączników, dlatego ustawienie parametru authorizationToken w oknie dialogowymServiceConnector nie spowoduje zaktualizowania tokenu autoryzacji oryginalnej konfiguracji. Utwórz nowe wystąpienie konfiguracji lub ustaw właściwość SpeechServiceAuthorization_Token w celu zaktualizowania istniejącego wystąpienia, jeśli zostanie ono użyte do utworzenia dalszych połączeń DialogServiceConnectors.
fromEndpoint(URL, string)

Tworzy wystąpienie botFrameworkConfig. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z niestandardowego punktu końcowego lub parametrów usługi. Uwaga: parametry zapytania określone w adresie URL punktu końcowego nie są zmieniane, nawet jeśli są ustawione przez inne interfejsy API. Uwaga: Aby użyć tokenu autoryzacji z parametrem fromEndpoint, przekaż pusty ciąg do elementu subscriptionKey w metodzie fromEndpoint, a następnie ustaw wartość authorizationToken="token" w utworzonym wystąpieniu BotFrameworkConfig, aby użyć tokenu autoryzacji. Uwaga: dodano w wersji 1.15.0.
fromHost(string | URL, string, string)

Tworzy wystąpienie botFrameworkConfig. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z hosta usługi innej niż domyślna. Założono, że zostanie założona standardowa ścieżka zasobu. W przypadku usług z niestandardową ścieżką zasobu lub żadną ścieżką należy zamiast tego użyć polecenia fromEndpoint. Uwaga: parametry zapytania nie są dozwolone w identyfikatorze URI hosta i muszą być ustawione przez inne interfejsy API. Uwaga: aby użyć tokenu autoryzacji z parametrem fromHost, użyj właściwości fromHost(URL), a następnie ustaw właściwość AuthorizationToken na utworzonym wystąpieniu BotFrameworkConfig. Uwaga: dodano w wersji 1.15.0.
fromSubscription(string, string, string)

Tworzy wystąpienie konfiguracji platformy bota z podanymi informacjami o subskrypcji.

Metody dziedziczone

close()

Usuwanie skojarzonych zasobów.
getProperty(string | PropertyId, string)

Ustawia nazwaną właściwość jako wartość
setProperty(string | PropertyId, string)

Ustawia nazwaną właściwość jako wartość
setProxy(string, number, string, string)

Ustawia konfigurację serwera proxy. Dotyczy tylko środowisk Node.js. Dodano w wersji 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Szczegóły konstruktora

BotFrameworkConfig()

Tworzy wystąpienie elementu BotFrameworkConfig.

new BotFrameworkConfig()

Szczegóły właściwości

applicationId

Ustawia odpowiedni identyfikator aplikacji zaplecza.

void applicationId

Wartość właściwości

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Wartość właściwości

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Wartość właściwości

OutputFormat

properties

Zapewnia dostęp do właściwości niestandardowych.

PropertyCollection properties

Wartość właściwości

PropertyCollection

Właściwości.

speechRecognitionLanguage

Pobiera język rozpoznawania mowy.

string speechRecognitionLanguage

Wartość właściwości

string

Szczegóły metody

fromAuthorizationToken(string, string, string)

Tworzy wystąpienie konfiguracji platformy bota dla określonego tokenu autoryzacji i regionu. Uwaga: obiekt wywołujący musi upewnić się, że token autoryzacji jest prawidłowy. Przed wygaśnięciem tokenu autoryzacji obiekt wywołujący musi go odświeżyć, ustawiając właściwość authorizationToken w odpowiednim wystąpieniu DialogServiceConnector utworzonym za pomocą tej konfiguracji. Zawartość obiektów konfiguracji jest kopiowana podczas tworzenia łączników, dlatego ustawienie parametru authorizationToken w oknie dialogowymServiceConnector nie spowoduje zaktualizowania tokenu autoryzacji oryginalnej konfiguracji. Utwórz nowe wystąpienie konfiguracji lub ustaw właściwość SpeechServiceAuthorization_Token w celu zaktualizowania istniejącego wystąpienia, jeśli zostanie ono użyte do utworzenia dalszych połączeń DialogServiceConnectors.

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

Parametry

authorizationToken

string

Token autoryzacji skojarzony z botem

region

string

Nazwa regionu (zobacz stronę regionów).

botId

string

Opcjonalny. Identyfikator użycia określonego bota w grupie zasobów platformy Azure. Odpowiednik nazwy zasobu.

Zwraca

BotFrameworkConfig

Nowe wystąpienie konfiguracji platformy botów.

fromEndpoint(URL, string)

Tworzy wystąpienie botFrameworkConfig. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z niestandardowego punktu końcowego lub parametrów usługi. Uwaga: parametry zapytania określone w adresie URL punktu końcowego nie są zmieniane, nawet jeśli są ustawione przez inne interfejsy API. Uwaga: Aby użyć tokenu autoryzacji z parametrem fromEndpoint, przekaż pusty ciąg do elementu subscriptionKey w metodzie fromEndpoint, a następnie ustaw wartość authorizationToken="token" w utworzonym wystąpieniu BotFrameworkConfig, aby użyć tokenu autoryzacji. Uwaga: dodano w wersji 1.15.0.

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

Parametry

endpoint

URL

Punkt końcowy usługi do nawiązania połączenia.

subscriptionKey

string

Klucz subskrypcji. Jeśli klucz subskrypcji nie zostanie określony, należy ustawić token autoryzacji.

Zwraca

BotFrameworkConfig
  • Nowe wystąpienie konfiguracji platformy botów przy użyciu podanego punktu końcowego.

fromHost(string | URL, string, string)

Tworzy wystąpienie botFrameworkConfig. Ta metoda jest przeznaczona tylko dla użytkowników korzystających z hosta usługi innej niż domyślna. Założono, że zostanie założona standardowa ścieżka zasobu. W przypadku usług z niestandardową ścieżką zasobu lub żadną ścieżką należy zamiast tego użyć polecenia fromEndpoint. Uwaga: parametry zapytania nie są dozwolone w identyfikatorze URI hosta i muszą być ustawione przez inne interfejsy API. Uwaga: aby użyć tokenu autoryzacji z parametrem fromHost, użyj właściwości fromHost(URL), a następnie ustaw właściwość AuthorizationToken na utworzonym wystąpieniu BotFrameworkConfig. Uwaga: dodano w wersji 1.15.0.

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

Parametry

host

string | URL

Jeśli zostanie podany adres URL, zostanie użyty w pełni kwalifikowany host z protokołem (np. wss://your.host.com:1234). Jeśli zostanie podany ciąg, zostanie on osadzony w wss://{host}.convai.speech.azure.us.

subscriptionKey

string

Klucz subskrypcji. Jeśli klucz subskrypcji nie zostanie określony, należy ustawić token autoryzacji.

botId

string

Opcjonalny. Identyfikator użycia określonego bota w grupie zasobów platformy Azure. Odpowiednik nazwy zasobu.

Zwraca

BotFrameworkConfig

Nowe wystąpienie konfiguracji platformy botów.

fromSubscription(string, string, string)

Tworzy wystąpienie konfiguracji platformy bota z podanymi informacjami o subskrypcji.

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

Parametry

subscription

string

Klucz subskrypcji skojarzony z botem

region

string

Nazwa regionu (zobacz stronę regionów).

botId

string

Opcjonalny. Identyfikator użycia określonego bota w grupie zasobów platformy Azure. Odpowiednik nazwy zasobu.

Zwraca

BotFrameworkConfig

Nowe wystąpienie konfiguracji platformy botów.

Szczegóły metody dziedziczonej

close()

Usuwanie skojarzonych zasobów.

function close()

Dziedziczone z DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Ustawia nazwaną właściwość jako wartość

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

Parametry

name

string | PropertyId

Właściwość do pobrania.

def

string

Wartość domyślna zwracana w przypadku, gdy właściwość nie jest znana.

Zwraca

string

Bieżąca wartość lub podana wartość domyślna danej właściwości.

Dziedziczone z DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Ustawia nazwaną właściwość jako wartość

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

Parametry

name

string | PropertyId

Właściwość do ustawienia.

value

string

Wartość.

Dziedziczone z DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Ustawia konfigurację serwera proxy. Dotyczy tylko środowisk Node.js. Dodano w wersji 1.4.0.

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

Parametry

proxyHostName

string

Nazwa hosta serwera proxy bez schematu protokołu (http://)

proxyPort

number

Numer portu serwera proxy.

proxyUserName

string

Nazwa użytkownika serwera proxy.

proxyPassword

string

Hasło serwera proxy.

Dziedziczone z DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parametry

name

string

value

string

channel
UriQueryParameter

Dziedziczone z DialogServiceConfigImpl.setServiceProperty