Compartir a través de

BotFrameworkConfig class

  • Referencia
Paquete:
microsoft-cognitiveservices-speech-sdk

Clase que define configuraciones para el objeto de conector de servicio de diálogo para usar un back-end de Bot Framework.

Extends

DialogServiceConfigImpl

Constructores

BotFrameworkConfig()

Crea una instancia de BotFrameworkConfig.

Propiedades

applicationId

Establece el identificador de aplicación back-end correspondiente.
DialogTypes
outputFormat
properties

Proporciona acceso a propiedades personalizadas.
speechRecognitionLanguage

Obtiene el idioma de reconocimiento de voz.

Métodos

fromAuthorizationToken(string, string, string)

Crea una instancia de configuración de Bot Framework para el token de autorización y la región especificados. Nota: El autor de la llamada debe asegurarse de que un token de autorización es válido. Antes de que expire un token de autorización, el autor de la llamada debe actualizarlo estableciendo la propiedad authorizationToken en la instancia de DialogServiceConnector correspondiente creada con esta configuración. El contenido de los objetos de configuración se copia cuando se crean conectores, por lo que establecer authorizationToken en un DialogServiceConnector no actualizará el token de autorización de la configuración original. Cree una nueva instancia de configuración o establezca la propiedad SpeechServiceAuthorization_Token para actualizar una instancia existente si se usará para crear más DialogServiceConnectors.
fromEndpoint(URL, string)

Crea una instancia de BotFrameworkConfig. Este método solo está pensado para los usuarios que usan un punto de conexión de servicio o parámetros no estándar. Nota: Los parámetros de consulta especificados en la dirección URL del punto de conexión no se cambian, incluso si se establecen mediante otras API. Nota: Para usar el token de autorización con fromEndpoint, pase una cadena vacía a subscriptionKey en el método fromEndpoint y, a continuación, establezca authorizationToken="token" en la instancia de BotFrameworkConfig creada para usar el token de autorización. Nota: Se ha agregado en la versión 1.15.0.
fromHost(string | URL, string, string)

Crea una instancia de BotFrameworkConfig. Este método solo está pensado para los usuarios que usan un host de servicio no predeterminado. Se presupone la ruta de acceso del recurso estándar. En el caso de los servicios con una ruta de acceso de recursos no estándar o ninguna ruta de acceso, use fromEndpoint en su lugar. Nota: Los parámetros de consulta no se permiten en el URI del host y deben establecerse mediante otras API. Nota: Para usar un token de autorización con fromHost, use fromHost(URL) y establezca la propiedad AuthorizationToken en la instancia de BotFrameworkConfig creada. Nota: Se ha agregado en la versión 1.15.0.
fromSubscription(string, string, string)

Crea una instancia de configuración de Bot Framework con la información de suscripción proporcionada.

Métodos heredados

close()

Elimine los recursos asociados.
getProperty(string | PropertyId, string)

Establece una propiedad con nombre como valor
setProperty(string | PropertyId, string)

Establece una propiedad con nombre como valor
setProxy(string, number, string, string)

Establece la configuración del proxy. Solo es relevante en entornos de Node.js. Se agregó en la versión 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Detalles del constructor

BotFrameworkConfig()

Crea una instancia de BotFrameworkConfig.

new BotFrameworkConfig()

Detalles de las propiedades

applicationId

Establece el identificador de aplicación back-end correspondiente.

void applicationId

Valor de propiedad

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Valor de propiedad

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Valor de propiedad

OutputFormat

properties

Proporciona acceso a propiedades personalizadas.

PropertyCollection properties

Valor de propiedad

PropertyCollection

Propiedades.

speechRecognitionLanguage

Obtiene el idioma de reconocimiento de voz.

string speechRecognitionLanguage

Valor de propiedad

string

Detalles del método

fromAuthorizationToken(string, string, string)

Crea una instancia de configuración de Bot Framework para el token de autorización y la región especificados. Nota: El autor de la llamada debe asegurarse de que un token de autorización es válido. Antes de que expire un token de autorización, el autor de la llamada debe actualizarlo estableciendo la propiedad authorizationToken en la instancia de DialogServiceConnector correspondiente creada con esta configuración. El contenido de los objetos de configuración se copia cuando se crean conectores, por lo que establecer authorizationToken en un DialogServiceConnector no actualizará el token de autorización de la configuración original. Cree una nueva instancia de configuración o establezca la propiedad SpeechServiceAuthorization_Token para actualizar una instancia existente si se usará para crear más DialogServiceConnectors.

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

Parámetros

authorizationToken

string

Token de autorización asociado al bot

region

string

Nombre de la región (consulte la página región).

botId

string

Opcional. Identificador para usar un bot específico dentro de un grupo de recursos de Azure. Equivalente al nombre del recurso.

Devoluciones

BotFrameworkConfig

Nueva instancia de configuración de Bot Framework.

fromEndpoint(URL, string)

Crea una instancia de BotFrameworkConfig. Este método solo está pensado para los usuarios que usan un punto de conexión de servicio o parámetros no estándar. Nota: Los parámetros de consulta especificados en la dirección URL del punto de conexión no se cambian, incluso si se establecen mediante otras API. Nota: Para usar el token de autorización con fromEndpoint, pase una cadena vacía a subscriptionKey en el método fromEndpoint y, a continuación, establezca authorizationToken="token" en la instancia de BotFrameworkConfig creada para usar el token de autorización. Nota: Se ha agregado en la versión 1.15.0.

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

Parámetros

endpoint

URL

Punto de conexión de servicio al que se va a conectar.

subscriptionKey

string

Clave de suscripción. Si no se especifica una clave de suscripción, se debe establecer un token de autorización.

Devoluciones

BotFrameworkConfig
  • Nueva instancia de configuración de Bot Framework mediante el punto de conexión proporcionado.

fromHost(string | URL, string, string)

Crea una instancia de BotFrameworkConfig. Este método solo está pensado para los usuarios que usan un host de servicio no predeterminado. Se presupone la ruta de acceso del recurso estándar. En el caso de los servicios con una ruta de acceso de recursos no estándar o ninguna ruta de acceso, use fromEndpoint en su lugar. Nota: Los parámetros de consulta no se permiten en el URI del host y deben establecerse mediante otras API. Nota: Para usar un token de autorización con fromHost, use fromHost(URL) y establezca la propiedad AuthorizationToken en la instancia de BotFrameworkConfig creada. Nota: Se ha agregado en la versión 1.15.0.

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

Parámetros

host

string | URL

Si se proporciona una dirección URL, se usará el host completo con protocolo (por ejemplo, wss://your.host.com:1234). Si se proporciona una cadena, se insertará en wss://{host}.convai.speech.azure.us.

subscriptionKey

string

Clave de suscripción. Si no se especifica una clave de suscripción, se debe establecer un token de autorización.

botId

string

Opcional. Identificador para usar un bot específico dentro de un grupo de recursos de Azure. Equivalente al nombre del recurso.

Devoluciones

BotFrameworkConfig

Nueva instancia de configuración de Bot Framework.

fromSubscription(string, string, string)

Crea una instancia de configuración de Bot Framework con la información de suscripción proporcionada.

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

Parámetros

subscription

string

Clave de suscripción asociada al bot

region

string

El nombre de la región (consulte la página región).

botId

string

Opcional. Identificador para usar un bot específico dentro de un grupo de recursos de Azure. Equivalente al nombre del recurso.

Devoluciones

BotFrameworkConfig

Nueva instancia de configuración de Bot Framework.

Detalles de los métodos heredados

close()

Elimine los recursos asociados.

function close()

Heredado de DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Establece una propiedad con nombre como valor

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

Parámetros

name

string | PropertyId

Propiedad que se va a obtener.

def

string

El valor predeterminado que se va a devolver en caso de que no se conozca la propiedad.

Devoluciones

string

Valor actual o predeterminado proporcionado de la propiedad especificada.

Heredado de DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Establece una propiedad con nombre como valor

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

Parámetros

name

string | PropertyId

Propiedad que se va a establecer.

value

string

Valor.

Heredado de DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Establece la configuración del proxy. Solo es relevante en entornos de Node.js. Se agregó en la versión 1.4.0.

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

Parámetros

proxyHostName

string

Nombre de host del servidor proxy, sin el esquema de protocolo (http://)

proxyPort

number

Número de puerto del servidor proxy.

proxyUserName

string

Nombre de usuario del servidor proxy.

proxyPassword

string

Contraseña del servidor proxy.

Heredado de DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parámetros

name

string

value

string

channel
UriQueryParameter

Heredado de DialogServiceConfigImpl.setServiceProperty