Share via

BotFrameworkConfig class

  • Referens
Paket:
microsoft-cognitiveservices-speech-sdk

Klass som definierar konfigurationer för dialogtjänstens anslutningsobjekt för användning av en Bot Framework-serverdel.

Extends

DialogServiceConfigImpl

Konstruktorer

BotFrameworkConfig()

Skapar en instans av BotFrameworkConfig.

Egenskaper

applicationId

Anger motsvarande programidentifierare för serverdelen.
DialogTypes
outputFormat
properties

Ger åtkomst till anpassade egenskaper.
speechRecognitionLanguage

Hämtar taligenkänningsspråket.

Metoder

fromAuthorizationToken(string, string, string)

Skapar en konfigurationsinstans för bot framework för den angivna auktoriseringstoken och regionen. Obs! Anroparen måste se till att en auktoriseringstoken är giltig. Innan en auktoriseringstoken upphör att gälla måste anroparen uppdatera den genom att ange egenskapen authorizationToken på motsvarande DialogServiceConnector-instans som skapats med den här konfigurationen. Innehållet i konfigurationsobjekt kopieras när anslutningsappar skapas, så om du anger authorizationToken på en DialogServiceConnector uppdateras inte den ursprungliga konfigurationens auktoriseringstoken. Skapa en ny konfigurationsinstans eller ange egenskapen SpeechServiceAuthorization_Token för att uppdatera en befintlig instans om den ska användas för att skapa ytterligare DialogServiceConnectors.
fromEndpoint(URL, string)

Skapar en instans av en BotFrameworkConfig. Den här metoden är endast avsedd för användare som använder en tjänstslutpunkt eller parametrar som inte är standard. Obs! Frågeparametrarna som anges i slutpunkts-URL:en ändras inte, även om de anges av andra API:er. Obs! Om du vill använda auktoriseringstoken med fromEndpoint skickar du en tom sträng till subscriptionKey i fromEndpoint-metoden och anger sedan authorizationToken="token" på den skapade BotFrameworkConfig-instansen för att använda auktoriseringstoken. Obs! Har lagts till i version 1.15.0.
fromHost(string | URL, string, string)

Skapar en instans av en BotFrameworkConfig. Den här metoden är endast avsedd för användare som använder en tjänstvärd som inte är standard. Standardresurssökvägen antas. För tjänster med en resurssökväg som inte är standard eller ingen sökväg alls använder du frånEndpoint i stället. Obs! Frågeparametrar tillåts inte i värd-URI:n och måste anges av andra API:er. Obs! Om du vill använda en auktoriseringstoken med fromHost använder du fromHost(URL) och anger sedan egenskapen AuthorizationToken på den skapade BotFrameworkConfig-instansen. Obs! Tillagd i version 1.15.0.
fromSubscription(string, string, string)

Skapar en konfigurationsinstans för bot framework med den angivna prenumerationsinformationen.

Ärvda metoder

close()

Ta bort associerade resurser.
getProperty(string | PropertyId, string)

Anger en namngiven egenskap som värde
setProperty(string | PropertyId, string)

Anger en namngiven egenskap som värde
setProxy(string, number, string, string)

Anger proxykonfigurationen. Endast relevant i Node.js miljöer. Har lagts till i version 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Konstruktorinformation

BotFrameworkConfig()

Skapar en instans av BotFrameworkConfig.

new BotFrameworkConfig()

Egenskapsinformation

applicationId

Anger motsvarande programidentifierare för serverdelen.

void applicationId

Egenskapsvärde

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Egenskapsvärde

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Egenskapsvärde

OutputFormat

properties

Ger åtkomst till anpassade egenskaper.

PropertyCollection properties

Egenskapsvärde

PropertyCollection

Egenskaperna.

speechRecognitionLanguage

Hämtar taligenkänningsspråket.

string speechRecognitionLanguage

Egenskapsvärde

string

Metodinformation

fromAuthorizationToken(string, string, string)

Skapar en konfigurationsinstans för bot framework för den angivna auktoriseringstoken och regionen. Obs! Anroparen måste se till att en auktoriseringstoken är giltig. Innan en auktoriseringstoken upphör att gälla måste anroparen uppdatera den genom att ange egenskapen authorizationToken på motsvarande DialogServiceConnector-instans som skapats med den här konfigurationen. Innehållet i konfigurationsobjekt kopieras när anslutningsappar skapas, så om du anger authorizationToken på en DialogServiceConnector uppdateras inte den ursprungliga konfigurationens auktoriseringstoken. Skapa en ny konfigurationsinstans eller ange egenskapen SpeechServiceAuthorization_Token för att uppdatera en befintlig instans om den ska användas för att skapa ytterligare DialogServiceConnectors.

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

Parametrar

authorizationToken

string

Auktoriseringstoken som är associerad med roboten

region

string

Regionnamnet (se regionsidan).

botId

string

Valfritt. Identifierare för att använda en specifik robot i en Azure-resursgrupp. Motsvarar resursnamnet.

Returer

BotFrameworkConfig

En ny konfigurationsinstans för bot framework.

fromEndpoint(URL, string)

Skapar en instans av en BotFrameworkConfig. Den här metoden är endast avsedd för användare som använder en tjänstslutpunkt eller parametrar som inte är standard. Obs! Frågeparametrarna som anges i slutpunkts-URL:en ändras inte, även om de anges av andra API:er. Obs! Om du vill använda auktoriseringstoken med fromEndpoint skickar du en tom sträng till subscriptionKey i fromEndpoint-metoden och anger sedan authorizationToken="token" på den skapade BotFrameworkConfig-instansen för att använda auktoriseringstoken. Obs! Har lagts till i version 1.15.0.

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

Parametrar

endpoint

URL

Tjänstslutpunkten som du vill ansluta till.

subscriptionKey

string

Prenumerationsnyckeln. Om en prenumerationsnyckel inte har angetts måste en auktoriseringstoken anges.

Returer

BotFrameworkConfig
  • En ny konfigurationsinstans för bot framework med hjälp av den angivna slutpunkten.

fromHost(string | URL, string, string)

Skapar en instans av en BotFrameworkConfig. Den här metoden är endast avsedd för användare som använder en tjänstvärd som inte är standard. Standardresurssökvägen antas. För tjänster med en resurssökväg som inte är standard eller ingen sökväg alls använder du frånEndpoint i stället. Obs! Frågeparametrar tillåts inte i värd-URI:n och måste anges av andra API:er. Obs! Om du vill använda en auktoriseringstoken med fromHost använder du fromHost(URL) och anger sedan egenskapen AuthorizationToken på den skapade BotFrameworkConfig-instansen. Obs! Tillagd i version 1.15.0.

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

Parametrar

host

string | URL

Om en URL anges används den fullständigt kvalificerade värden med protokoll (t.ex. wss://your.host.com:1234). Om en sträng anges bäddas den in i wss://{host}.convai.speech.azure.us.

subscriptionKey

string

Prenumerationsnyckeln. Om en prenumerationsnyckel inte anges måste en auktoriseringstoken anges.

botId

string

Valfritt. Identifierare för användning av en specifik robot i en Azure-resursgrupp. Motsvarar resursnamnet.

Returer

BotFrameworkConfig

En ny konfigurationsinstans för bot framework.

fromSubscription(string, string, string)

Skapar en konfigurationsinstans för bot framework med den angivna prenumerationsinformationen.

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

Parametrar

subscription

string

Prenumerationsnyckel som är associerad med roboten

region

string

Regionnamnet (se regionsidan).

botId

string

Valfritt. Identifierare för användning av en specifik robot i en Azure-resursgrupp. Motsvarar resursnamnet.

Returer

BotFrameworkConfig

En ny konfigurationsinstans för bot framework.

Ärvd metodinformation

close()

Ta bort associerade resurser.

function close()

Ärvd från DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Anger en namngiven egenskap som värde

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

Parametrar

name

string | PropertyId

Egenskapen som ska hämtas.

def

string

Standardvärdet som returneras om egenskapen inte är känd.

Returer

string

Aktuellt värde, eller angivet standardvärde, för den angivna egenskapen.

Ärvd från DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Anger en namngiven egenskap som värde

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

Parametrar

name

string | PropertyId

Egenskapen som ska anges.

value

string

Värdet.

Ärvd från DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Anger proxykonfigurationen. Endast relevant i Node.js miljöer. Har lagts till i version 1.4.0.

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

Parametrar

proxyHostName

string

Proxyserverns värdnamn utan protokollschemat (http://)

proxyPort

number

Proxyserverns portnummer.

proxyUserName

string

Användarnamnet för proxyservern.

proxyPassword

string

Lösenordet för proxyservern.

Ärvd från DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parametrar

name

string

value

string

channel
UriQueryParameter

Ärvd från DialogServiceConfigImpl.setServiceProperty