BotFrameworkConfig class

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

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

Extends

DialogServiceConfigImpl

Construtores

BotFrameworkConfig()

Cria uma instância de BotFrameworkConfig.

Propriedades

applicationId

Define o identificador de aplicativo de back-end correspondente.
DialogTypes
outputFormat
properties

Fornece acesso a propriedades personalizadas.
speechRecognitionLanguage

Obtém o idioma de reconhecimento de fala.

Métodos

fromAuthorizationToken(string, string, string)

Cria uma instância de configuração da estrutura de bot para o token de autorização e a região especificados. Observação: o chamador deve garantir que um token de autorização seja válido. Antes que um token de autorização expire, o chamador deve atualizá-lo definindo a propriedade authorizationToken na instância dialogServiceConnector correspondente criada com essa configuração. O conteúdo dos objetos de configuração é copiado quando os conectores são criados, portanto, definir authorizationToken em um 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 ela for usada para criar mais DialogServiceConnectors.
fromEndpoint(URL, string)

Cria uma instância de um BotFrameworkConfig. Esse método destina-se apenas a usuários que usam um ponto de extremidade de serviço ou parâmetros não padrão. Observação: os parâmetros de consulta especificados na URL do ponto de extremidade não são alterados, mesmo que sejam definidos por qualquer outra APIs. Observação: para usar o token de autorização com fromEndpoint, passe uma cadeia de caracteres vazia para subscriptionKey no método fromEndpoint e, em seguida, defina authorizationToken="token" na instância de BotFrameworkConfig criada para usar o token de autorização. Observação: adicionado na versão 1.15.0.
fromHost(string | URL, string, string)

Cria uma instância de um BotFrameworkConfig. Esse método destina-se apenas a usuários que usam um host de serviço não padrão. O caminho do recurso padrão será assumido. Para serviços com um caminho de recurso não padrão ou nenhum caminho, use fromEndpoint. Observação: os parâmetros de consulta não são permitidos no URI do host e devem ser definidos por outras APIs. Observação: para usar um token de autorização com fromHost, use fromHost(URL) e defina a propriedade AuthorizationToken na instância do BotFrameworkConfig criada. Observação: adicionado na versão 1.15.0.
fromSubscription(string, string, string)

Cria uma instância de configuração da estrutura de bot com as informações de assinatura fornecidas.

Métodos herdados

close()

Descarte os recursos associados.
getProperty(string | PropertyId, string)

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

Define uma propriedade nomeada como valor
setProxy(string, number, string, string)

Define a configuração de proxy. Relevante apenas 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 da propriedade

applicationId

Define o identificador de aplicativo de back-end correspondente.

void applicationId

Valor da propriedade

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Valor da propriedade

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Valor da propriedade

OutputFormat

properties

Fornece acesso a propriedades personalizadas.

PropertyCollection properties

Valor da propriedade

PropertyCollection

As propriedades.

speechRecognitionLanguage

Obtém o idioma de reconhecimento de fala.

string speechRecognitionLanguage

Valor da propriedade

string

Detalhes do método

fromAuthorizationToken(string, string, string)

Cria uma instância de configuração da estrutura de bot para o token de autorização e a região especificados. Observação: o chamador deve garantir que um token de autorização seja válido. Antes que um token de autorização expire, o chamador deve atualizá-lo definindo a propriedade authorizationToken na instância dialogServiceConnector correspondente criada com essa configuração. O conteúdo dos objetos de configuração é copiado quando os conectores são criados, portanto, definir authorizationToken em um 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 ela for usada 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 (consulte a página da região).

botId

string

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

Retornos

BotFrameworkConfig

Uma nova instância de configuração da estrutura de bot.

fromEndpoint(URL, string)

Cria uma instância de um BotFrameworkConfig. Esse método destina-se apenas a usuários que usam um ponto de extremidade de serviço ou parâmetros não padrão. Observação: os parâmetros de consulta especificados na URL do ponto de extremidade não são alterados, mesmo que sejam definidos por qualquer outra APIs. Observação: para usar o token de autorização com fromEndpoint, passe uma cadeia de caracteres vazia para subscriptionKey no método fromEndpoint e, em seguida, defina authorizationToken="token" na instância de BotFrameworkConfig criada para usar o token de autorização. Observação: adicionado na versão 1.15.0.

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

Parâmetros

endpoint

URL

O ponto de extremidade de serviço ao qual se conectar.

subscriptionKey

string

A chave de assinatura. Se uma chave de assinatura não for especificada, um token de autorização deverá ser definido.

Retornos

BotFrameworkConfig
  • Uma nova instância de configuração da estrutura de bot usando o ponto de extremidade fornecido.

fromHost(string | URL, string, string)

Cria uma instância de um BotFrameworkConfig. Esse método destina-se apenas a usuários que usam um host de serviço não padrão. O caminho do recurso padrão será assumido. Para serviços com um caminho de recurso não padrão ou nenhum caminho, use fromEndpoint. Observação: os parâmetros de consulta não são permitidos no URI do host e devem ser definidos por outras APIs. Observação: para usar um token de autorização com fromHost, use fromHost(URL) e defina a propriedade AuthorizationToken na instância do BotFrameworkConfig criada. Observação: adicionado na versão 1.15.0.

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

Parâmetros

host

string | URL

Se uma URL for fornecida, o host totalmente qualificado com protocolo (por exemplo, wss://your.host.com:1234) será usado. Se uma cadeia de caracteres for fornecida, ela será inserida em wss://{host}.convai.speech.azure.us.

subscriptionKey

string

A chave de assinatura. Se uma chave de assinatura não for especificada, um token de autorização deverá ser definido.

botId

string

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

Retornos

BotFrameworkConfig

Uma nova instância de configuração da estrutura de bot.

fromSubscription(string, string, string)

Cria uma instância de configuração da estrutura de bot com as informações de assinatura fornecidas.

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

Parâmetros

subscription

string

Chave de assinatura associada ao bot

region

string

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

botId

string

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

Retornos

BotFrameworkConfig

Uma nova instância de configuração da estrutura de bot.

Detalhes do método herdado

close()

Descarte os recursos associados.

function close()

Herdado de DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Define uma propriedade nomeada como valor

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

Parâmetros

name

string | PropertyId

A propriedade a ser obtida.

def

string

O valor padrão a ser retornado caso a propriedade não seja conhecida.

Retornos

string

O valor atual, ou padrão fornecido, da propriedade fornecida.

Herdado de DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Define uma propriedade nomeada como valor

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

Parâmetros

name

string | PropertyId

A propriedade a ser definida.

value

string

O valor.

Herdado de DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Define a configuração de proxy. Relevante apenas 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 host do servidor proxy, sem o esquema de protocolo (http://)

proxyPort

number

O número da porta do servidor proxy.

proxyUserName

string

O nome de usuário do servidor proxy.

proxyPassword

string

A senha 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