Freigeben über

BotFrameworkConfig class

  • Referenz
Paket:
microsoft-cognitiveservices-speech-sdk

Klasse, die Konfigurationen für das Dialogdienstconnectorobjekt für die Verwendung eines Bot Framework-Back-End definiert.

Extends

DialogServiceConfigImpl

Konstruktoren

BotFrameworkConfig()

Erstellt eine Instanz von BotFrameworkConfig.

Eigenschaften

applicationId

Legt den entsprechenden Back-End-Anwendungsbezeichner fest.
DialogTypes
outputFormat
properties

Bietet Zugriff auf benutzerdefinierte Eigenschaften.
speechRecognitionLanguage

Ruft die Spracherkennungssprache ab.

Methoden

fromAuthorizationToken(string, string, string)

Erstellt eine Bot-Framework-Konfigurationsinstanz für das angegebene Autorisierungstoken und die angegebene Region. Hinweis: Der Aufrufer muss sicherstellen, dass ein Autorisierungstoken gültig ist. Bevor ein Autorisierungstoken abläuft, muss der Aufrufer es aktualisieren, indem die AuthorizationToken-Eigenschaft für die entsprechende DialogServiceConnector-Instanz festgelegt wird, die mit dieser Konfiguration erstellt wurde. Der Inhalt von Konfigurationsobjekten wird kopiert, wenn Connectors erstellt werden, sodass das Festlegen von AuthorizationToken für einen DialogServiceConnector das Autorisierungstoken der ursprünglichen Konfiguration nicht aktualisiert. Erstellen Sie eine neue Konfigurationsinstanz, oder legen Sie die SpeechServiceAuthorization_Token-Eigenschaft fest, um eine vorhandene Instanz zu aktualisieren, wenn sie zum Erstellen weiterer DialogServiceConnectors verwendet wird.
fromEndpoint(URL, string)

Erstellt eine Instanz eines BotFrameworkConfig. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Dienstendpunkt oder Parameter verwenden. Hinweis: Die in der Endpunkt-URL angegebenen Abfrageparameter werden nicht geändert, auch wenn sie von anderen APIs festgelegt werden. Hinweis: Um autorisierungstoken mit fromEndpoint zu verwenden, übergeben Sie eine leere Zeichenfolge an den subscriptionKey in der fromEndpoint-Methode, und legen Sie dann "authorizationToken="token" für die erstellte BotFrameworkConfig-Instanz fest, um das Autorisierungstoken zu verwenden. Hinweis: In Version 1.15.0 hinzugefügt.
fromHost(string | URL, string, string)

Erstellt eine Instanz eines BotFrameworkConfig. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Diensthost verwenden. Der Standardressourcenpfad wird angenommen. Verwenden Sie für Dienste mit einem nicht standardmäßigen Ressourcenpfad oder gar keinem Pfad stattdessen fromEndpoint. Hinweis: Abfrageparameter sind im Host-URI nicht zulässig und müssen von anderen APIs festgelegt werden. Hinweis: Um ein Autorisierungstoken mit fromHost zu verwenden, verwenden Sie fromHost(URL) und legen Sie dann die AuthorizationToken-Eigenschaft für die erstellte BotFrameworkConfig-Instanz fest. Hinweis: In Version 1.15.0 hinzugefügt.
fromSubscription(string, string, string)

Erstellt eine Bot-Framework-Konfigurationsinstanz mit den bereitgestellten Abonnementinformationen.

Geerbte Methoden

close()

Verwerfen von zugeordneten Ressourcen.
getProperty(string | PropertyId, string)

Legt eine benannte Eigenschaft als Wert fest.
setProperty(string | PropertyId, string)

Legt eine benannte Eigenschaft als Wert fest.
setProxy(string, number, string, string)

Legt die Proxykonfiguration fest. Nur in Node.js Umgebungen relevant. In Version 1.4.0 hinzugefügt.
setServiceProperty(string, string, UriQueryParameter)

Details zum Konstruktor

BotFrameworkConfig()

Erstellt eine Instanz von BotFrameworkConfig.

new BotFrameworkConfig()

Details zur Eigenschaft

applicationId

Legt den entsprechenden Back-End-Anwendungsbezeichner fest.

void applicationId

Eigenschaftswert

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Eigenschaftswert

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Eigenschaftswert

OutputFormat

properties

Bietet Zugriff auf benutzerdefinierte Eigenschaften.

PropertyCollection properties

Eigenschaftswert

PropertyCollection

Die Eigenschaften.

speechRecognitionLanguage

Ruft die Spracherkennungssprache ab.

string speechRecognitionLanguage

Eigenschaftswert

string

Details zur Methode

fromAuthorizationToken(string, string, string)

Erstellt eine Bot-Framework-Konfigurationsinstanz für das angegebene Autorisierungstoken und die angegebene Region. Hinweis: Der Aufrufer muss sicherstellen, dass ein Autorisierungstoken gültig ist. Bevor ein Autorisierungstoken abläuft, muss der Aufrufer es aktualisieren, indem die AuthorizationToken-Eigenschaft für die entsprechende DialogServiceConnector-Instanz festgelegt wird, die mit dieser Konfiguration erstellt wurde. Der Inhalt von Konfigurationsobjekten wird kopiert, wenn Connectors erstellt werden, sodass das Festlegen von AuthorizationToken für einen DialogServiceConnector das Autorisierungstoken der ursprünglichen Konfiguration nicht aktualisiert. Erstellen Sie eine neue Konfigurationsinstanz, oder legen Sie die SpeechServiceAuthorization_Token-Eigenschaft fest, um eine vorhandene Instanz zu aktualisieren, wenn sie zum Erstellen weiterer DialogServiceConnectors verwendet wird.

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

Parameter

authorizationToken

string

Das dem Bot zugeordnete Autorisierungstoken

region

string

Der Regionsname (siehe Bereichsseite).

botId

string

Wahlfrei. Bezeichner für die Verwendung eines bestimmten Bots innerhalb einer Azure-Ressourcengruppe. Entspricht dem Ressourcennamen.

Gibt zurück

BotFrameworkConfig

Eine neue Bot-Framework-Konfigurationsinstanz.

fromEndpoint(URL, string)

Erstellt eine Instanz eines BotFrameworkConfig. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Dienstendpunkt oder Parameter verwenden. Hinweis: Die in der Endpunkt-URL angegebenen Abfrageparameter werden nicht geändert, auch wenn sie von anderen APIs festgelegt werden. Hinweis: Um autorisierungstoken mit fromEndpoint zu verwenden, übergeben Sie eine leere Zeichenfolge an den subscriptionKey in der fromEndpoint-Methode, und legen Sie dann "authorizationToken="token" für die erstellte BotFrameworkConfig-Instanz fest, um das Autorisierungstoken zu verwenden. Hinweis: In Version 1.15.0 hinzugefügt.

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

Parameter

endpoint

URL

Der Dienstendpunkt, mit dem eine Verbindung hergestellt werden soll.

subscriptionKey

string

Der Abonnementschlüssel. Wenn kein Abonnementschlüssel angegeben ist, muss ein Autorisierungstoken festgelegt werden.

Gibt zurück

BotFrameworkConfig
  • Eine neue Bot-Framework-Konfigurationsinstanz mit dem bereitgestellten Endpunkt.

fromHost(string | URL, string, string)

Erstellt eine Instanz eines BotFrameworkConfig. Diese Methode ist nur für Benutzer vorgesehen, die einen nicht standardmäßigen Diensthost verwenden. Der Standardressourcenpfad wird angenommen. Verwenden Sie für Dienste mit einem nicht standardmäßigen Ressourcenpfad oder gar keinem Pfad stattdessen fromEndpoint. Hinweis: Abfrageparameter sind im Host-URI nicht zulässig und müssen von anderen APIs festgelegt werden. Hinweis: Um ein Autorisierungstoken mit fromHost zu verwenden, verwenden Sie fromHost(URL) und legen Sie dann die AuthorizationToken-Eigenschaft für die erstellte BotFrameworkConfig-Instanz fest. Hinweis: In Version 1.15.0 hinzugefügt.

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

Parameter

host

string | URL

Wenn eine URL angegeben wird, wird der vollqualifizierte Host mit Protokoll (z. B. wss://your.host.com:1234) verwendet. Wenn eine Zeichenfolge angegeben wird, wird sie in wss://{host}.convai.speech.azure.us eingebettet.

subscriptionKey

string

Der Abonnementschlüssel. Wenn kein Abonnementschlüssel angegeben ist, muss ein Autorisierungstoken festgelegt werden.

botId

string

Wahlfrei. Bezeichner für die Verwendung eines bestimmten Bots innerhalb einer Azure-Ressourcengruppe. Entspricht dem Ressourcennamen.

Gibt zurück

BotFrameworkConfig

Eine neue Bot-Framework-Konfigurationsinstanz.

fromSubscription(string, string, string)

Erstellt eine Bot-Framework-Konfigurationsinstanz mit den bereitgestellten Abonnementinformationen.

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

Parameter

subscription

string

Abonnementschlüssel, der dem Bot zugeordnet ist

region

string

Der Regionsname (siehe Bereichsseite).

botId

string

Wahlfrei. Bezeichner für die Verwendung eines bestimmten Bots innerhalb einer Azure-Ressourcengruppe. Entspricht dem Ressourcennamen.

Gibt zurück

BotFrameworkConfig

Eine neue Bot-Framework-Konfigurationsinstanz.

Details zur geerbten Methode

close()

Verwerfen von zugeordneten Ressourcen.

function close()

Geerbt von DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Legt eine benannte Eigenschaft als Wert fest.

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

Parameter

name

string | PropertyId

Die abzurufende Eigenschaft.

def

string

Der Standardwert, der zurückgegeben werden soll, falls die Eigenschaft nicht bekannt ist.

Gibt zurück

string

Der aktuelle Wert oder der angegebene Standardwert der angegebenen Eigenschaft.

Geerbt von DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Legt eine benannte Eigenschaft als Wert fest.

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

Parameter

name

string | PropertyId

Die festzulegende Eigenschaft.

value

string

Der Wert.

Geerbt von DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Legt die Proxykonfiguration fest. Nur in Node.js Umgebungen relevant. In Version 1.4.0 hinzugefügt.

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

Parameter

proxyHostName

string

Der Hostname des Proxyservers ohne das Protokollschema (http://)

proxyPort

number

Die Portnummer des Proxyservers.

proxyUserName

string

Der Benutzername des Proxyservers.

proxyPassword

string

Das Kennwort des Proxyservers.

Geerbt von DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parameter

name

string

value

string

channel
UriQueryParameter

Geerbt von DialogServiceConfigImpl.setServiceProperty