BotFrameworkConfig class
Classe qui définit des configurations pour l’objet connecteur de service de dialogue pour l’utilisation d’un back-end Bot Framework.
- Extends
-
DialogServiceConfigImpl
Constructeurs
Bot |
Crée une instance de BotFrameworkConfig. |
Propriétés
application |
Définit l’identificateur d’application back-end correspondant. |
Dialog |
|
output |
|
properties | Fournit l’accès aux propriétés personnalisées. |
speech |
Obtient la langue de reconnaissance vocale. |
Méthodes
from |
Crée un instance de configuration bot framework pour le jeton d’autorisation et la région spécifiés. Remarque : l’appelant doit s’assurer qu’un jeton d’autorisation est valide. Avant l’expiration d’un jeton d’autorisation, l’appelant doit l’actualiser en définissant la propriété authorizationToken sur le instance DialogServiceConnector correspondant créé avec cette configuration. Le contenu des objets de configuration étant copié lors de la création des connecteurs, la définition de authorizationToken sur un DialogServiceConnector ne met pas à jour le jeton d’autorisation de la configuration d’origine. Créez un instance de configuration ou définissez la propriété SpeechServiceAuthorization_Token pour mettre à jour un instance existant s’il sera utilisé pour créer d’autres DialogServiceConnectors. |
from |
Crée un instance d’un BotFrameworkConfig. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un point de terminaison ou des paramètres de service non standard. Remarque : Les paramètres de requête spécifiés dans l’URL du point de terminaison ne sont pas modifiés, même s’ils sont définis par d’autres API. Remarque : Pour utiliser le jeton d’autorisation avec fromEndpoint, passez une chaîne vide à l’subscriptionKey dans la méthode fromEndpoint, puis définissez authorizationToken="token » sur l’instance BotFrameworkConfig créé pour utiliser le jeton d’autorisation. Remarque : Ajouté dans la version 1.15.0. |
from |
Crée un instance d’un BotFrameworkConfig. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un hôte de service autre que celui par défaut. Le chemin d’accès à la ressource standard est supposé. Pour les services avec un chemin de ressource non standard ou aucun chemin d’accès du tout, utilisez plutôt fromEndpoint. Remarque : Les paramètres de requête ne sont pas autorisés dans l’URI hôte et doivent être définis par d’autres API. Remarque : Pour utiliser un jeton d’autorisation avec fromHost, utilisez fromHost(URL), puis définissez la propriété AuthorizationToken sur le instance BotFrameworkConfig créé. Remarque : Ajouté dans la version 1.15.0. |
from |
Crée une configuration d’infrastructure de bot instance avec les informations d’abonnement fournies. |
Méthodes héritées
close() | Supprimer les ressources associées. |
get |
Définit une propriété nommée comme valeur |
set |
Définit une propriété nommée comme valeur |
set |
Définit la configuration du proxy. Uniquement pertinent dans les environnements Node.js. Ajouté dans la version 1.4.0. |
set |
Détails du constructeur
BotFrameworkConfig()
Crée une instance de BotFrameworkConfig.
new BotFrameworkConfig()
Détails de la propriété
applicationId
Définit l’identificateur d’application back-end correspondant.
void applicationId
Valeur de propriété
void
DialogTypes
static { BotFramework: string, CustomCommands: string } DialogTypes
Valeur de propriété
{ BotFramework: string, CustomCommands: string }
outputFormat
properties
Fournit l’accès aux propriétés personnalisées.
PropertyCollection properties
Valeur de propriété
Propriétés.
speechRecognitionLanguage
Obtient la langue de reconnaissance vocale.
string speechRecognitionLanguage
Valeur de propriété
string
Détails de la méthode
fromAuthorizationToken(string, string, string)
Crée un instance de configuration bot framework pour le jeton d’autorisation et la région spécifiés. Remarque : l’appelant doit s’assurer qu’un jeton d’autorisation est valide. Avant l’expiration d’un jeton d’autorisation, l’appelant doit l’actualiser en définissant la propriété authorizationToken sur le instance DialogServiceConnector correspondant créé avec cette configuration. Le contenu des objets de configuration étant copié lors de la création des connecteurs, la définition de authorizationToken sur un DialogServiceConnector ne met pas à jour le jeton d’autorisation de la configuration d’origine. Créez un instance de configuration ou définissez la propriété SpeechServiceAuthorization_Token pour mettre à jour un instance existant s’il sera utilisé pour créer d’autres DialogServiceConnectors.
static function fromAuthorizationToken(authorizationToken: string, region: string, botId?: string): BotFrameworkConfig
Paramètres
- authorizationToken
-
string
Jeton d’autorisation associé au bot
- region
-
string
Nom de la région (voir la page région).
- botId
-
string
Optionnel. Identificateur pour l’utilisation d’un bot spécifique au sein d’un groupe de ressources Azure. Équivalent au nom de la ressource.
Retours
Une nouvelle configuration bot framework instance.
fromEndpoint(URL, string)
Crée un instance d’un BotFrameworkConfig. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un point de terminaison ou des paramètres de service non standard. Remarque : Les paramètres de requête spécifiés dans l’URL du point de terminaison ne sont pas modifiés, même s’ils sont définis par d’autres API. Remarque : Pour utiliser le jeton d’autorisation avec fromEndpoint, passez une chaîne vide à l’subscriptionKey dans la méthode fromEndpoint, puis définissez authorizationToken="token » sur l’instance BotFrameworkConfig créé pour utiliser le jeton d’autorisation. Remarque : Ajouté dans la version 1.15.0.
static function fromEndpoint(endpoint: URL, subscriptionKey?: string): BotFrameworkConfig
Paramètres
- endpoint
-
URL
Point de terminaison de service auquel se connecter.
- subscriptionKey
-
string
Clé d’abonnement. Si aucune clé d’abonnement n’est spécifiée, un jeton d’autorisation doit être défini.
Retours
- Une nouvelle configuration d’infrastructure de bot instance à l’aide du point de terminaison fourni.
fromHost(string | URL, string, string)
Crée un instance d’un BotFrameworkConfig. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un hôte de service autre que celui par défaut. Le chemin d’accès à la ressource standard est supposé. Pour les services avec un chemin de ressource non standard ou aucun chemin d’accès du tout, utilisez plutôt fromEndpoint. Remarque : Les paramètres de requête ne sont pas autorisés dans l’URI hôte et doivent être définis par d’autres API. Remarque : Pour utiliser un jeton d’autorisation avec fromHost, utilisez fromHost(URL), puis définissez la propriété AuthorizationToken sur le instance BotFrameworkConfig créé. Remarque : Ajouté dans la version 1.15.0.
static function fromHost(host: string | URL, subscriptionKey?: string, botId?: string): BotFrameworkConfig
Paramètres
- host
-
string | URL
Si une URL est fournie, l’hôte complet avec protocole (par exemple, wss://your.host.com:1234) est utilisé. Si une chaîne est fournie, elle sera incorporée dans wss://{host}.convai.speech.azure.us.
- subscriptionKey
-
string
Clé d’abonnement. Si aucune clé d’abonnement n’est spécifiée, un jeton d’autorisation doit être défini.
- botId
-
string
Optionnel. Identificateur pour l’utilisation d’un bot spécifique au sein d’un groupe de ressources Azure. Équivalent au nom de la ressource.
Retours
Une nouvelle instance de configuration de bot framework.
fromSubscription(string, string, string)
Crée une configuration d’infrastructure de bot instance avec les informations d’abonnement fournies.
static function fromSubscription(subscription: string, region: string, botId?: string): BotFrameworkConfig
Paramètres
- subscription
-
string
Clé d’abonnement associée au bot
- region
-
string
Nom de la région (voir la page région).
- botId
-
string
Optionnel. Identificateur pour l’utilisation d’un bot spécifique au sein d’un groupe de ressources Azure. Équivalent au nom de la ressource.
Retours
Une nouvelle instance de configuration de bot framework.
Détails de la méthode héritée
close()
Supprimer les ressources associées.
function close()
Hérité de DialogServiceConfigImpl.close
getProperty(string | PropertyId, string)
Définit une propriété nommée comme valeur
function getProperty(name: string | PropertyId, def?: string): string
Paramètres
- name
-
string | PropertyId
Propriété à obtenir.
- def
-
string
Valeur par défaut à retourner au cas où la propriété n’est pas connue.
Retours
string
Valeur actuelle, ou valeur par défaut fournie, de la propriété donnée.
Hérité de DialogServiceConfigImpl.getProperty
setProperty(string | PropertyId, string)
Définit une propriété nommée comme valeur
function setProperty(name: string | PropertyId, value: string)
Paramètres
- name
-
string | PropertyId
Propriété à obtenir.
- value
-
string
La valeur.
Hérité de DialogServiceConfigImpl.setProperty
setProxy(string, number, string, string)
Définit la configuration du proxy. Uniquement pertinent dans les environnements Node.js. Ajouté dans la version 1.4.0.
function setProxy(proxyHostName: string, proxyPort: number, proxyUserName?: string, proxyPassword?: string)
Paramètres
- proxyHostName
-
string
Nom d’hôte du serveur proxy, sans le schéma de protocole (http://)
- proxyPort
-
number
Numéro de port du serveur proxy.
- proxyUserName
-
string
Nom d’utilisateur du serveur proxy.
- proxyPassword
-
string
Mot de passe du serveur proxy.
Hérité de DialogServiceConfigImpl.setProxy
setServiceProperty(string, string, UriQueryParameter)
function setServiceProperty(name: string, value: string, channel: UriQueryParameter)
Paramètres
- name
-
string
- value
-
string
- channel
- UriQueryParameter
Hérité de DialogServiceConfigImpl.setServiceProperty