Delen via

BotFrameworkConfig class

  • Referentie
Pakket:
microsoft-cognitiveservices-speech-sdk

Klasse die configuraties definieert voor het dialoogvensterserviceconnectorobject voor het gebruik van een Bot Framework-back-end.

Extends

DialogServiceConfigImpl

Constructors

BotFrameworkConfig()

Hiermee maakt u een exemplaar van BotFrameworkConfig.

Eigenschappen

applicationId

Hiermee stelt u de bijbehorende id van de back-endtoepassing in.
DialogTypes
outputFormat
properties

Biedt toegang tot aangepaste eigenschappen.
speechRecognitionLanguage

Hiermee haalt u de taal voor spraakherkenning op.

Methoden

fromAuthorizationToken(string, string, string)

Hiermee maakt u een bot framework-configuratie-exemplaar voor het opgegeven autorisatietoken en de opgegeven regio. Opmerking: de aanroeper moet ervoor zorgen dat een autorisatietoken geldig is. Voordat een autorisatietoken verloopt, moet de aanroeper het vernieuwen door de eigenschap authorizationToken in te stellen op het bijbehorende DialogServiceConnector-exemplaar dat met deze configuratie is gemaakt. De inhoud van configuratieobjecten wordt gekopieerd wanneer connectors worden gemaakt, dus als u authorizationToken instelt op een DialogServiceConnector, wordt het autorisatietoken van de oorspronkelijke configuratie niet bijgewerkt. Maak een nieuw configuratie-exemplaar of stel de eigenschap SpeechServiceAuthorization_Token in om een bestaand exemplaar bij te werken als deze wordt gebruikt om verdere DialogServiceConnectors te maken.
fromEndpoint(URL, string)

Hiermee maakt u een exemplaar van een BotFrameworkConfig. Deze methode is alleen bedoeld voor gebruikers die een niet-standaard service-eindpunt of -parameters gebruiken. Opmerking: de queryparameters die zijn opgegeven in de eindpunt-URL, worden niet gewijzigd, zelfs niet als ze zijn ingesteld door andere API's. Opmerking: als u een autorisatietoken wilt gebruiken met fromEndpoint, geeft u een lege tekenreeks door aan de subscriptionKey in de methode fromEndpoint en stelt u vervolgens authorizationToken="token" in op het gemaakte BotFrameworkConfig-exemplaar om het autorisatietoken te gebruiken. Opmerking: Toegevoegd in versie 1.15.0.
fromHost(string | URL, string, string)

Hiermee maakt u een exemplaar van een BotFrameworkConfig. Deze methode is alleen bedoeld voor gebruikers die een niet-standaardservicehost gebruiken. Het standaardresourcepad wordt uitgegaan. Voor services met een niet-standaard resourcepad of helemaal geen pad, gebruikt u fromEndpoint. Opmerking: Queryparameters zijn niet toegestaan in de host-URI en moeten worden ingesteld door andere API's. Opmerking: als u een autorisatietoken wilt gebruiken met fromHost, gebruikt u fromHost(URL) en stelt u vervolgens de eigenschap AuthorizationToken in op het gemaakte BotFrameworkConfig-exemplaar. Opmerking: toegevoegd in versie 1.15.0.
fromSubscription(string, string, string)

Hiermee maakt u een bot framework-configuratie-exemplaar met de opgegeven abonnementsgegevens.

Overgenomen methoden

close()

Verwijder gekoppelde resources.
getProperty(string | PropertyId, string)

Hiermee stelt u een benoemde eigenschap in als waarde
setProperty(string | PropertyId, string)

Hiermee stelt u een benoemde eigenschap in als waarde
setProxy(string, number, string, string)

Hiermee stelt u de proxyconfiguratie in. Alleen relevant in Node.js omgevingen. Toegevoegd in versie 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Constructordetails

BotFrameworkConfig()

Hiermee maakt u een exemplaar van BotFrameworkConfig.

new BotFrameworkConfig()

Eigenschapdetails

applicationId

Hiermee stelt u de bijbehorende id van de back-endtoepassing in.

void applicationId

Waarde van eigenschap

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Waarde van eigenschap

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Waarde van eigenschap

OutputFormat

properties

Biedt toegang tot aangepaste eigenschappen.

PropertyCollection properties

Waarde van eigenschap

PropertyCollection

De eigenschappen.

speechRecognitionLanguage

Hiermee haalt u de taal voor spraakherkenning op.

string speechRecognitionLanguage

Waarde van eigenschap

string

Methodedetails

fromAuthorizationToken(string, string, string)

Hiermee maakt u een bot framework-configuratie-exemplaar voor het opgegeven autorisatietoken en de opgegeven regio. Opmerking: de aanroeper moet ervoor zorgen dat een autorisatietoken geldig is. Voordat een autorisatietoken verloopt, moet de aanroeper het vernieuwen door de eigenschap authorizationToken in te stellen op het bijbehorende DialogServiceConnector-exemplaar dat met deze configuratie is gemaakt. De inhoud van configuratieobjecten wordt gekopieerd wanneer connectors worden gemaakt, dus als u authorizationToken instelt op een DialogServiceConnector, wordt het autorisatietoken van de oorspronkelijke configuratie niet bijgewerkt. Maak een nieuw configuratie-exemplaar of stel de eigenschap SpeechServiceAuthorization_Token in om een bestaand exemplaar bij te werken als deze wordt gebruikt om verdere DialogServiceConnectors te maken.

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

Parameters

authorizationToken

string

Het autorisatietoken dat is gekoppeld aan de bot

region

string

De regionaam (zie de regiopagina).

botId

string

Optioneel. Id voor het gebruik van een specifieke bot binnen een Azure-resourcegroep. Gelijk aan de resourcenaam.

Retouren

BotFrameworkConfig

Een nieuw configuratie-exemplaar van botframework.

fromEndpoint(URL, string)

Hiermee maakt u een exemplaar van een BotFrameworkConfig. Deze methode is alleen bedoeld voor gebruikers die een niet-standaard service-eindpunt of -parameters gebruiken. Opmerking: de queryparameters die zijn opgegeven in de eindpunt-URL, worden niet gewijzigd, zelfs niet als ze zijn ingesteld door andere API's. Opmerking: als u een autorisatietoken wilt gebruiken met fromEndpoint, geeft u een lege tekenreeks door aan de subscriptionKey in de methode fromEndpoint en stelt u vervolgens authorizationToken="token" in op het gemaakte BotFrameworkConfig-exemplaar om het autorisatietoken te gebruiken. Opmerking: Toegevoegd in versie 1.15.0.

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

Parameters

endpoint

URL

Het service-eindpunt waarmee verbinding moet worden gemaakt.

subscriptionKey

string

De abonnementssleutel. Als er geen abonnementssleutel is opgegeven, moet een autorisatietoken worden ingesteld.

Retouren

BotFrameworkConfig
  • Een nieuw configuratie-exemplaar van botframework met behulp van het opgegeven eindpunt.

fromHost(string | URL, string, string)

Hiermee maakt u een exemplaar van een BotFrameworkConfig. Deze methode is alleen bedoeld voor gebruikers die een niet-standaardservicehost gebruiken. Het standaardresourcepad wordt uitgegaan. Voor services met een niet-standaard resourcepad of helemaal geen pad, gebruikt u fromEndpoint. Opmerking: Queryparameters zijn niet toegestaan in de host-URI en moeten worden ingesteld door andere API's. Opmerking: als u een autorisatietoken wilt gebruiken met fromHost, gebruikt u fromHost(URL) en stelt u vervolgens de eigenschap AuthorizationToken in op het gemaakte BotFrameworkConfig-exemplaar. Opmerking: toegevoegd in versie 1.15.0.

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

Parameters

host

string | URL

Als er een URL wordt opgegeven, wordt de volledig gekwalificeerde host met protocol (bijvoorbeeld wss://your.host.com:1234) gebruikt. Als er een tekenreeks wordt opgegeven, wordt deze ingesloten in wss://{host}.convai.speech.azure.us.

subscriptionKey

string

De abonnementssleutel. Als er geen abonnementssleutel is opgegeven, moet er een autorisatietoken worden ingesteld.

botId

string

Optioneel. Id voor het gebruik van een specifieke bot binnen een Azure-resourcegroep. Gelijk aan de resourcenaam.

Retouren

BotFrameworkConfig

Een nieuw configuratie-exemplaar van botframework.

fromSubscription(string, string, string)

Hiermee maakt u een bot framework-configuratie-exemplaar met de opgegeven abonnementsgegevens.

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

Parameters

subscription

string

Abonnementssleutel die is gekoppeld aan de bot

region

string

De regionaam (zie de regiopagina).

botId

string

Optioneel. Id voor het gebruik van een specifieke bot binnen een Azure-resourcegroep. Gelijk aan de resourcenaam.

Retouren

BotFrameworkConfig

Een nieuw configuratie-exemplaar van botframework.

Details overgenomen methode

close()

Verwijder gekoppelde resources.

function close()

Overgenomen van DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Hiermee stelt u een benoemde eigenschap in als waarde

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

Parameters

name

string | PropertyId

De eigenschap om te krijgen.

def

string

De standaardwaarde die moet worden geretourneerd als de eigenschap niet bekend is.

Retouren

string

De huidige waarde, of standaardwaarde, van de opgegeven eigenschap.

Overgenomen van DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Hiermee stelt u een benoemde eigenschap in als waarde

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

Parameters

name

string | PropertyId

De eigenschap die moet worden ingesteld.

value

string

De waarde.

Overgenomen van DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Hiermee stelt u de proxyconfiguratie in. Alleen relevant in Node.js omgevingen. Toegevoegd in versie 1.4.0.

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

Parameters

proxyHostName

string

De hostnaam van de proxyserver, zonder het protocolschema (http://)

proxyPort

number

Het poortnummer van de proxyserver.

proxyUserName

string

De gebruikersnaam van de proxyserver.

proxyPassword

string

Het wachtwoord van de proxyserver.

Overgenomen van DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parameters

name

string

value

string

channel
UriQueryParameter

Overgenomen van DialogServiceConfigImpl.setServiceProperty