Condividi tramite

BotFrameworkConfig class

  • Riferimento
Pacchetto:
microsoft-cognitiveservices-speech-sdk

Classe che definisce le configurazioni per l'oggetto del connettore del servizio di dialogo per l'uso di un back-end di Bot Framework.

Extends

DialogServiceConfigImpl

Costruttori

BotFrameworkConfig()

Crea un'istanza di BotFrameworkConfig.

Proprietà

applicationId

Imposta l'identificatore dell'applicazione back-end corrispondente.
DialogTypes
outputFormat
properties

Fornisce l'accesso alle proprietà personalizzate.
speechRecognitionLanguage

Ottiene la lingua di riconoscimento vocale.

Metodi

fromAuthorizationToken(string, string, string)

Crea un'istanza di configurazione del framework bot per il token di autorizzazione e l'area specificati. Nota: il chiamante deve assicurarsi che un token di autorizzazione sia valido. Prima della scadenza di un token di autorizzazione, il chiamante deve aggiornarlo impostando la proprietà authorizationToken nell'istanza di DialogServiceConnector corrispondente creata con questa configurazione. Il contenuto degli oggetti di configurazione viene copiato quando vengono creati i connettori, quindi l'impostazione dell'autorizzazioneToken in un DialogServiceConnector non aggiornerà il token di autorizzazione della configurazione originale. Creare una nuova istanza di configurazione o impostare la proprietà SpeechServiceAuthorization_Token per aggiornare un'istanza esistente se verrà usata per creare ulteriori DialogServiceConnectors.
fromEndpoint(URL, string)

Crea un'istanza di BotFrameworkConfig. Questo metodo è destinato solo agli utenti che usano un endpoint o parametri di servizio non standard. Nota: i parametri di query specificati nell'URL dell'endpoint non vengono modificati, anche se vengono impostati da qualsiasi altra API. Nota: per usare il token di autorizzazione con fromEndpoint, passare una stringa vuota alla sottoscrizioneKey nel metodo fromEndpoint e quindi impostare authorizationToken="token" nell'istanza creata di BotFrameworkConfig per usare il token di autorizzazione. Nota: aggiunta nella versione 1.15.0.
fromHost(string | URL, string, string)

Crea un'istanza di BotFrameworkConfig. Questo metodo è destinato solo agli utenti che usano un host di servizio non predefinito. Verrà assunto il percorso della risorsa standard. Per i servizi con un percorso di risorse non standard o nessun percorso, usare invece fromEndpoint. Nota: i parametri di query non sono consentiti nell'URI host e devono essere impostati da altre API. Nota: per usare un token di autorizzazione con fromHost, usare fromHost(URL) e quindi impostare la proprietà AuthorizationToken nell'istanza di BotFrameworkConfig creata. Nota: aggiunta nella versione 1.15.0.
fromSubscription(string, string, string)

Crea un'istanza di configurazione del framework bot con le informazioni sulla sottoscrizione fornite.

Metodi ereditati

close()

Eliminare le risorse associate.
getProperty(string | PropertyId, string)

Imposta una proprietà denominata come valore
setProperty(string | PropertyId, string)

Imposta una proprietà denominata come valore
setProxy(string, number, string, string)

Imposta la configurazione del proxy. Solo rilevanti negli ambienti Node.js. Aggiunta nella versione 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Dettagli costruttore

BotFrameworkConfig()

Crea un'istanza di BotFrameworkConfig.

new BotFrameworkConfig()

Dettagli proprietà

applicationId

Imposta l'identificatore dell'applicazione back-end corrispondente.

void applicationId

Valore della proprietà

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Valore della proprietà

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Valore della proprietà

OutputFormat

properties

Fornisce l'accesso alle proprietà personalizzate.

PropertyCollection properties

Valore della proprietà

PropertyCollection

Proprietà.

speechRecognitionLanguage

Ottiene la lingua di riconoscimento vocale.

string speechRecognitionLanguage

Valore della proprietà

string

Dettagli metodo

fromAuthorizationToken(string, string, string)

Crea un'istanza di configurazione del framework bot per il token di autorizzazione e l'area specificati. Nota: il chiamante deve assicurarsi che un token di autorizzazione sia valido. Prima della scadenza di un token di autorizzazione, il chiamante deve aggiornarlo impostando la proprietà authorizationToken nell'istanza di DialogServiceConnector corrispondente creata con questa configurazione. Il contenuto degli oggetti di configurazione viene copiato quando vengono creati i connettori, quindi l'impostazione dell'autorizzazioneToken in un DialogServiceConnector non aggiornerà il token di autorizzazione della configurazione originale. Creare una nuova istanza di configurazione o impostare la proprietà SpeechServiceAuthorization_Token per aggiornare un'istanza esistente se verrà usata per creare ulteriori DialogServiceConnectors.

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

Parametri

authorizationToken

string

Token di autorizzazione associato al bot

region

string

Nome area (vedere la pagina area).

botId

string

Facoltativa. Identificatore per l'uso di un bot specifico all'interno di un gruppo di risorse di Azure. Equivalente al nome della risorsa.

Restituisce

BotFrameworkConfig

Nuova istanza di configurazione del framework bot.

fromEndpoint(URL, string)

Crea un'istanza di BotFrameworkConfig. Questo metodo è destinato solo agli utenti che usano un endpoint o parametri di servizio non standard. Nota: i parametri di query specificati nell'URL dell'endpoint non vengono modificati, anche se vengono impostati da qualsiasi altra API. Nota: per usare il token di autorizzazione con fromEndpoint, passare una stringa vuota alla sottoscrizioneKey nel metodo fromEndpoint e quindi impostare authorizationToken="token" nell'istanza creata di BotFrameworkConfig per usare il token di autorizzazione. Nota: aggiunta nella versione 1.15.0.

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

Parametri

endpoint

URL

Endpoint del servizio a cui connettersi.

subscriptionKey

string

Chiave di sottoscrizione. Se non è specificata una chiave di sottoscrizione, è necessario impostare un token di autorizzazione.

Restituisce

BotFrameworkConfig
  • Nuova istanza di configurazione del framework bot usando l'endpoint specificato.

fromHost(string | URL, string, string)

Crea un'istanza di BotFrameworkConfig. Questo metodo è destinato solo agli utenti che usano un host di servizio non predefinito. Verrà assunto il percorso della risorsa standard. Per i servizi con un percorso di risorse non standard o nessun percorso, usare invece fromEndpoint. Nota: i parametri di query non sono consentiti nell'URI host e devono essere impostati da altre API. Nota: per usare un token di autorizzazione con fromHost, usare fromHost(URL) e quindi impostare la proprietà AuthorizationToken nell'istanza di BotFrameworkConfig creata. Nota: aggiunta nella versione 1.15.0.

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

Parametri

host

string | URL

Se viene fornito un URL, verrà usato l'host completo con protocollo ,ad esempio wss://your.host.com:1234. Se viene fornita una stringa, verrà incorporata in wss://{host}.convai.speech.azure.us.

subscriptionKey

string

Chiave di sottoscrizione. Se non è specificata una chiave di sottoscrizione, è necessario impostare un token di autorizzazione.

botId

string

Facoltativa. Identificatore per l'uso di un bot specifico all'interno di un gruppo di risorse di Azure. Equivalente al nome della risorsa.

Restituisce

BotFrameworkConfig

Nuova istanza di configurazione del framework bot.

fromSubscription(string, string, string)

Crea un'istanza di configurazione del framework bot con le informazioni sulla sottoscrizione fornite.

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

Parametri

subscription

string

Chiave di sottoscrizione associata al bot

region

string

Nome area (vedere la pagina area).

botId

string

Facoltativa. Identificatore per l'uso di un bot specifico all'interno di un gruppo di risorse di Azure. Equivalente al nome della risorsa.

Restituisce

BotFrameworkConfig

Nuova istanza di configurazione del framework bot.

Dettagli dei metodi ereditati

close()

Eliminare le risorse associate.

function close()

Ereditato da DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Imposta una proprietà denominata come valore

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

Parametri

name

string | PropertyId

Proprietà da ottenere.

def

string

Valore predefinito da restituire nel caso in cui la proprietà non sia nota.

Restituisce

string

Valore corrente, o specificato per impostazione predefinita, della proprietà specificata.

Ereditato da DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Imposta una proprietà denominata come valore

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

Parametri

name

string | PropertyId

Proprietà da impostare.

value

string

Valore.

Ereditato da DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Imposta la configurazione del proxy. Solo rilevanti negli ambienti Node.js. Aggiunta nella versione 1.4.0.

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

Parametri

proxyHostName

string

Nome host del server proxy, senza lo schema di protocollo (http://)

proxyPort

number

Numero di porta del server proxy.

proxyUserName

string

Nome utente del server proxy.

proxyPassword

string

Password del server proxy.

Ereditato da DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parametri

name

string

value

string

channel
UriQueryParameter

Ereditato da DialogServiceConfigImpl.setServiceProperty