BotFrameworkConfig class

  • Referência
Pacote:
microsoft-cognitiveservices-speech-sdk

Classe que define configurações para o objeto do conector do serviço de diálogo para utilizar um back-end do Bot Framework.

Extends

DialogServiceConfigImpl

Construtores

BotFrameworkConfig()

Cria uma instância de BotFrameworkConfig.

Propriedades

applicationId

Define o identificador de aplicação de back-end correspondente.
DialogTypes
outputFormat
properties

Fornece acesso a propriedades personalizadas.
speechRecognitionLanguage

Obtém o idioma de reconhecimento de voz.

Métodos

fromAuthorizationToken(string, string, string)

Cria uma instância de configuração do bot framework para o token de autorização e região especificados. Nota: o autor da chamada tem de garantir que um token de autorização é válido. Antes de expirar um token de autorização, o autor da chamada tem de atualize-o ao definir a propriedade authorizationToken na instância dialogServiceConnector correspondente criada com esta configuração. Os conteúdos dos objetos de configuração são copiados quando os conectores são criados, pelo que definir authorizationToken num DialogServiceConnector não atualizará o token de autorização da configuração original. Crie uma nova instância de configuração ou defina a propriedade SpeechServiceAuthorization_Token para atualizar uma instância existente, se for utilizada para criar mais DialogServiceConnectors.
fromEndpoint(URL, string)

Cria uma instância de um BotFrameworkConfig. Este método destina-se apenas a utilizadores que utilizam um ponto final de serviço ou parâmetros não padrão. Nota: os parâmetros de consulta especificados no URL do ponto final não são alterados, mesmo que sejam definidos por outras APIs. Nota: para utilizar o token de autorização com fromEndpoint, transmita uma cadeia vazia para subscriptionKey no método fromEndpoint e, em seguida, defina authorizationToken="token" na instância do BotFrameworkConfig criada para utilizar o token de autorização. Nota: adicionado na versão 1.15.0.
fromHost(string | URL, string, string)

Cria uma instância de um BotFrameworkConfig. Este método destina-se apenas a utilizadores que utilizam um anfitrião de serviço não predefinido. O caminho de recurso padrão será assumido. Para serviços com um caminho de recurso não padrão ou nenhum caminho, utilize fromEndpoint como alternativa. Nota: os parâmetros de consulta não são permitidos no URI do anfitrião e têm de ser definidos por outras APIs. Nota: para utilizar um token de autorização com fromHost, utilize fromHost(URL) e, em seguida, defina a propriedade AuthorizationToken na instância botFrameworkConfig criada. Nota: adicionado na versão 1.15.0.
fromSubscription(string, string, string)

Cria uma instância de configuração do bot framework com as informações de subscrição fornecidas.

Métodos Herdados

close()

Eliminar recursos associados.
getProperty(string | PropertyId, string)

Define uma propriedade com nome como valor
setProperty(string | PropertyId, string)

Define uma propriedade com nome como valor
setProxy(string, number, string, string)

Define a configuração do proxy. Apenas relevante em ambientes Node.js. Adicionado na versão 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Detalhes do Construtor

BotFrameworkConfig()

Cria uma instância de BotFrameworkConfig.

new BotFrameworkConfig()

Detalhes de Propriedade

applicationId

Define o identificador de aplicação de back-end correspondente.

void applicationId

Valor de Propriedade

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Valor de Propriedade

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Valor de Propriedade

OutputFormat

properties

Fornece acesso a propriedades personalizadas.

PropertyCollection properties

Valor de Propriedade

PropertyCollection

As propriedades.

speechRecognitionLanguage

Obtém o idioma de reconhecimento de voz.

string speechRecognitionLanguage

Valor de Propriedade

string

Detalhes de Método

fromAuthorizationToken(string, string, string)

Cria uma instância de configuração do bot framework para o token de autorização e região especificados. Nota: o autor da chamada tem de garantir que um token de autorização é válido. Antes de expirar um token de autorização, o autor da chamada tem de atualize-o ao definir a propriedade authorizationToken na instância dialogServiceConnector correspondente criada com esta configuração. Os conteúdos dos objetos de configuração são copiados quando os conectores são criados, pelo que definir authorizationToken num DialogServiceConnector não atualizará o token de autorização da configuração original. Crie uma nova instância de configuração ou defina a propriedade SpeechServiceAuthorization_Token para atualizar uma instância existente, se for utilizada para criar mais DialogServiceConnectors.

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

Parâmetros

authorizationToken

string

O token de autorização associado ao bot

region

string

O nome da região (veja a página da região).

botId

string

Opcional. Identificador para utilizar um bot específico num grupo de recursos do Azure. Equivalente ao nome do recurso.

Devoluções

BotFrameworkConfig

Uma nova instância de configuração do bot framework.

fromEndpoint(URL, string)

Cria uma instância de um BotFrameworkConfig. Este método destina-se apenas a utilizadores que utilizam um ponto final de serviço ou parâmetros não padrão. Nota: os parâmetros de consulta especificados no URL do ponto final não são alterados, mesmo que sejam definidos por outras APIs. Nota: para utilizar o token de autorização com fromEndpoint, transmita uma cadeia vazia para subscriptionKey no método fromEndpoint e, em seguida, defina authorizationToken="token" na instância do BotFrameworkConfig criada para utilizar o token de autorização. Nota: adicionado na versão 1.15.0.

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

Parâmetros

endpoint

URL

O ponto final de serviço ao qual ligar.

subscriptionKey

string

A chave de subscrição. Se não for especificada uma chave de subscrição, tem de ser definido um token de autorização.

Devoluções

BotFrameworkConfig
  • Uma nova instância de configuração do bot framework com o ponto final fornecido.

fromHost(string | URL, string, string)

Cria uma instância de um BotFrameworkConfig. Este método destina-se apenas a utilizadores que utilizam um anfitrião de serviço não predefinido. O caminho de recurso padrão será assumido. Para serviços com um caminho de recurso não padrão ou nenhum caminho, utilize fromEndpoint como alternativa. Nota: os parâmetros de consulta não são permitidos no URI do anfitrião e têm de ser definidos por outras APIs. Nota: para utilizar um token de autorização com fromHost, utilize fromHost(URL) e, em seguida, defina a propriedade AuthorizationToken na instância botFrameworkConfig criada. Nota: adicionado na versão 1.15.0.

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

Parâmetros

host

string | URL

Se for fornecido um URL, será utilizado o anfitrião completamente qualificado com o protocolo (por exemplo, wss://your.host.com:1234). Se for fornecida uma cadeia, esta será incorporada em wss://{host}.convai.speech.azure.us.

subscriptionKey

string

A chave de subscrição. Se não for especificada uma chave de subscrição, tem de ser definido um token de autorização.

botId

string

Opcional. Identificador para utilizar um bot específico num grupo de recursos do Azure. Equivalente ao nome do recurso.

Devoluções

BotFrameworkConfig

Uma nova instância de configuração do bot framework.

fromSubscription(string, string, string)

Cria uma instância de configuração do bot framework com as informações de subscrição fornecidas.

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

Parâmetros

subscription

string

Chave de subscrição associada ao bot

region

string

O nome da região (veja a página da região).

botId

string

Opcional. Identificador para utilizar um bot específico num grupo de recursos do Azure. Equivalente ao nome do recurso.

Devoluções

BotFrameworkConfig

Uma nova instância de configuração do bot framework.

Detalhes do Método Herdado

close()

Eliminar recursos associados.

function close()

Herdado de DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Define uma propriedade com nome como valor

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

Parâmetros

name

string | PropertyId

A propriedade a obter.

def

string

O valor predefinido a devolver caso a propriedade não seja conhecida.

Devoluções

string

O valor atual, ou predefinido, da propriedade especificada.

Herdado de DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Define uma propriedade com nome como valor

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

Parâmetros

name

string | PropertyId

A propriedade a definir.

value

string

O valor.

Herdado de DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Define a configuração do proxy. Apenas relevante em ambientes Node.js. Adicionado na versão 1.4.0.

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

Parâmetros

proxyHostName

string

O nome do anfitrião do servidor proxy, sem o esquema de protocolo (http://)

proxyPort

number

O número de porta do servidor proxy.

proxyUserName

string

O nome de utilizador do servidor proxy.

proxyPassword

string

A palavra-passe do servidor proxy.

Herdado de DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parâmetros

name

string

value

string

channel
UriQueryParameter

Herdado de DialogServiceConfigImpl.setServiceProperty