DialogServiceConnector Classe

Objet qui communique avec un système de boîte de dialogue à extension vocale à l’aide de Bot Framework ou de commandes personnalisées. Ce type reçoit les résultats de la reconnaissance vocale et facilite également l’envoi et la réception asynchrones de données d’activité de dialogue non vocale.

Héritage

builtins.object

DialogServiceConnector

Constructeur

DialogServiceConnector(dialog_service_config: DialogServiceConfig, audio_config: AudioConfig | None = None)

Paramètres

Nom	Description
dialog_service_config Obligatoire	Configuration du service de boîte de dialogue, soit pour l’infrastructure de bot, soit pour les commandes personnalisées.
audio_config	Configuration de l’entrée audio. valeur par défaut: None

Méthodes

connect	Établit de manière synchrone une connexion avec le service. La connexion est effectuée automatiquement si nécessaire, mais cet appel manuel peut être utile pour vérifier que la connexion est active avant sa première utilisation afin de réduire la latence initiale. Au retour, la connexion n’est peut-être pas encore prête. Veuillez vous abonner à l’événement connecté de l’instance De connexion pour être averti lorsque la connexion au service est établie. Connection Utilisez pour récupérer l’instance à l’aide de la from_dialog_service_connector méthode .
connect_async	Établit de manière asynchrone une connexion avec le service. La connexion est effectuée automatiquement si nécessaire, mais cet appel manuel peut être utile pour vérifier que la connexion est active avant sa première utilisation afin de réduire la latence initiale.
disconnect	Se déconnecte de manière synchrone du service. Les appels suivants qui nécessitent une connexion se reconnectent toujours automatiquement après une déconnexion manuelle.
disconnect_async	Se déconnecte de manière asynchrone du service. Les appels suivants qui nécessitent une connexion se reconnectent toujours automatiquement après une déconnexion manuelle.
listen_once	Démarre de manière synchrone une interaction de reconnaissance vocale avec ce connecteur et bloque jusqu’à ce qu’un résultat final de reconnaissance vocale unique soit reçu. Le résultat de la reconnaissance vocale reçu est également fourni à l’implémentation de boîte de dialogue configurée et ce système de dialogue peut produire n’importe quel nombre de charges utiles d’activité en réponse à l’interaction vocale. Les interactions vocales peuvent être corrélées avec des activités via des données spécifiques au dialogue dans la charge utile de l’activité.
listen_once_async	Démarre de manière asynchrone une interaction de reconnaissance vocale avec ce connecteur et bloque jusqu’à ce qu’un résultat final de reconnaissance vocale unique soit reçu. Le résultat de la reconnaissance vocale reçu est également fourni à l’implémentation de boîte de dialogue configurée et ce système de dialogue peut produire n’importe quel nombre de charges utiles d’activité en réponse à l’interaction vocale. Les interactions vocales peuvent être corrélées avec des activités via des données spécifiques au dialogue dans la charge utile de l’activité.
send_activity	Envoie de manière synchrone une charge utile de données au service principal de dialogue auquel cette instance DialogServiceConnector est connectée. Il s’agit généralement d’un document JSON dont le schéma est déterminé par l’implémentation du dialogue dans le service et le contenu d’une activité envoyée doit être renseigné avec des connaissances sur le format et les attentes de contenu du système de dialogue. Les activités envoyées ne sont associées à aucune autre interaction et génèrent leur propre identificateur d’interaction autonome lorsqu’elles sont traitées par le service. La corrélation des conversations et d’autres interactions doit être effectuée via la charge utile d’activité elle-même à l’aide des fonctionnalités de l’implémentation de dialogue utilisée.
send_activity_async	Envoie de manière asynchrone une activité à la boîte de dialogue de stockage. Consultez les détails de la description à l’adresse send_activity
start_keyword_recognition	Démarre de manière synchrone une interaction de reconnaissance vocale avec ce connecteur à l’aide d’un mot clé. Cette interaction utilise le modèle de mot clé fourni pour écouter indéfiniment un mot clé, pendant lequel l’audio n’est pas envoyé au service vocal et tout le traitement est effectué localement. Lorsqu’un mot clé est reconnu, le DialogServiceConnector se connecte automatiquement au service speech et commence à envoyer des données audio à partir de juste avant le mot clé comme s’il listen_once_async avait été appelé. Une fois reçus, les résultats de reconnaissance vocale peuvent être traités par le gestionnaire de résultats fourni ou récupérés via un abonnement à l’événement reconnu. Le résultat de la reconnaissance vocale généré par cette opération est également fourni à l’implémentation de dialogue configurée et ce système de dialogue peut produire n’importe quel nombre de charges utiles d’activité en réponse à l’interaction vocale. Les interactions vocales peuvent être corrélées avec des activités via des données spécifiques au dialogue dans la charge utile de l’activité. Appelez stop_keyword_recognition_async pour arrêter la reconnaissance lancée par le mot clé.
start_keyword_recognition_async	Configure de manière asynchrone le connecteur de service de dialogue avec le modèle de mot clé donné. Après avoir appelé cette méthode, le connecteur écoute le mot clé pour démarrer la reconnaissance. Appelez stop_keyword_recognition_async pour arrêter la reconnaissance lancée par le mot clé. Pour obtenir une description détaillée de la fonctionnalité, consultez start_keyword_recognition .
stop_keyword_recognition	Arrête de façon synchrone la reconnaissance lancée par le mot clé.
stop_keyword_recognition_async	Arrête de façon asynchrone la reconnaissance lancée par le mot clé.
stop_listening	Demande un arrêt immédiat à toute opération d’écoute active. Cela peut interrompre une interaction vocale en cours et tout résultat de reconnaissance vocale reçu peut représenter une entrée vocale incomplète. Les méthodes synchrones ne doivent pas être appelées lors de la gestion d’un événement. Utilisez stop_listening_async si un arrêt est souhaité en réponse à un événement.
stop_listening_async	Demande un arrêt immédiat à toute opération d’écoute active. Cela peut interrompre une interaction vocale en cours et tout résultat de reconnaissance vocale reçu peut représenter une entrée vocale incomplète.

connect

Établit de manière synchrone une connexion avec le service. La connexion est effectuée automatiquement si nécessaire, mais cet appel manuel peut être utile pour vérifier que la connexion est active avant sa première utilisation afin de réduire la latence initiale.

Au retour, la connexion n’est peut-être pas encore prête. Veuillez vous abonner à l’événement connecté de l’instance De connexion pour être averti lorsque la connexion au service est établie. Connection Utilisez pour récupérer l’instance à l’aide de la from_dialog_service_connector méthode .

connect()

connect_async

Établit de manière asynchrone une connexion avec le service. La connexion est effectuée automatiquement si nécessaire, mais cet appel manuel peut être utile pour vérifier que la connexion est active avant sa première utilisation afin de réduire la latence initiale.

connect_async()

Retours

Type	Description
	Un avenir qui est réalisé une fois la connexion initialisée.

disconnect

Se déconnecte de manière synchrone du service. Les appels suivants qui nécessitent une connexion se reconnectent toujours automatiquement après une déconnexion manuelle.

disconnect()

disconnect_async

Se déconnecte de manière asynchrone du service. Les appels suivants qui nécessitent une connexion se reconnectent toujours automatiquement après une déconnexion manuelle.

disconnect_async()

Retours

Type	Description
	Un avenir qui se réalise lorsqu’il est déconnecté.

listen_once

Démarre de manière synchrone une interaction de reconnaissance vocale avec ce connecteur et bloque jusqu’à ce qu’un résultat final de reconnaissance vocale unique soit reçu. Le résultat de la reconnaissance vocale reçu est également fourni à l’implémentation de boîte de dialogue configurée et ce système de dialogue peut produire n’importe quel nombre de charges utiles d’activité en réponse à l’interaction vocale. Les interactions vocales peuvent être corrélées avec des activités via des données spécifiques au dialogue dans la charge utile de l’activité.

listen_once() -> SpeechRecognitionResult

Retours

Type	Description
	résultat de la reconnaissance vocale.

listen_once_async

Démarre de manière asynchrone une interaction de reconnaissance vocale avec ce connecteur et bloque jusqu’à ce qu’un résultat final de reconnaissance vocale unique soit reçu. Le résultat de la reconnaissance vocale reçu est également fourni à l’implémentation de boîte de dialogue configurée et ce système de dialogue peut produire n’importe quel nombre de charges utiles d’activité en réponse à l’interaction vocale. Les interactions vocales peuvent être corrélées avec des activités via des données spécifiques au dialogue dans la charge utile de l’activité.

listen_once_async() -> ResultFuture

Retours

Type	Description
	Futur contenant la valeur de résultat de reconnaissance vocale de la reconnaissance asynchrone.

send_activity

Envoie de manière synchrone une charge utile de données au service principal de dialogue auquel cette instance DialogServiceConnector est connectée. Il s’agit généralement d’un document JSON dont le schéma est déterminé par l’implémentation du dialogue dans le service et le contenu d’une activité envoyée doit être renseigné avec des connaissances sur le format et les attentes de contenu du système de dialogue. Les activités envoyées ne sont associées à aucune autre interaction et génèrent leur propre identificateur d’interaction autonome lorsqu’elles sont traitées par le service. La corrélation des conversations et d’autres interactions doit être effectuée via la charge utile d’activité elle-même à l’aide des fonctionnalités de l’implémentation de dialogue utilisée.

send_activity(activity: str) -> str

Paramètres

Nom	Description
activity Obligatoire	charge utile sérialisée d’une activité à envoyer.

Retours

Type

Description

identificateur d’interaction acquis lorsque l’activité est reconnue par le service. Cela peut se produire avant que l’activité ne soit traitée et évaluée par l’implémentation de la boîte de dialogue et que la réception d’un identificateur d’interaction n’indique pas de réussite ou d’échec du traitement de l’activité. Les informations sur la réussite ou l’échec peuvent être obtenues via des activités de réponse avec des données de corrélation ou avec des événements TurnStatusReceived qui sont corrélés à cet identificateur d’interaction.

send_activity_async

Envoie de manière asynchrone une activité à la boîte de dialogue de stockage. Consultez les détails de la description à l’adresse send_activity

send_activity_async(activity: str) -> ResultFuture

Paramètres

Nom	Description
activity Obligatoire	charge utile sérialisée d’une activité à envoyer.

Retours

Type	Description
	Futur contenant la valeur de résultat de l’opération d’envoi de l’activité asynchrone.

start_keyword_recognition

Démarre de manière synchrone une interaction de reconnaissance vocale avec ce connecteur à l’aide d’un mot clé. Cette interaction utilise le modèle de mot clé fourni pour écouter indéfiniment un mot clé, pendant lequel l’audio n’est pas envoyé au service vocal et tout le traitement est effectué localement. Lorsqu’un mot clé est reconnu, le DialogServiceConnector se connecte automatiquement au service speech et commence à envoyer des données audio à partir de juste avant le mot clé comme s’il listen_once_async avait été appelé. Une fois reçus, les résultats de reconnaissance vocale peuvent être traités par le gestionnaire de résultats fourni ou récupérés via un abonnement à l’événement reconnu. Le résultat de la reconnaissance vocale généré par cette opération est également fourni à l’implémentation de dialogue configurée et ce système de dialogue peut produire n’importe quel nombre de charges utiles d’activité en réponse à l’interaction vocale. Les interactions vocales peuvent être corrélées avec des activités via des données spécifiques au dialogue dans la charge utile de l’activité.

Appelez stop_keyword_recognition_async pour arrêter la reconnaissance lancée par le mot clé.

start_keyword_recognition(model: KeywordRecognitionModel)

Paramètres

Nom	Description
model Obligatoire	modèle de reconnaissance de mot clé qui spécifie le mot clé à reconnaître.

start_keyword_recognition_async

Configure de manière asynchrone le connecteur de service de dialogue avec le modèle de mot clé donné. Après avoir appelé cette méthode, le connecteur écoute le mot clé pour démarrer la reconnaissance. Appelez stop_keyword_recognition_async pour arrêter la reconnaissance lancée par le mot clé.

Pour obtenir une description détaillée de la fonctionnalité, consultez start_keyword_recognition .

start_keyword_recognition_async(model: KeywordRecognitionModel)

Paramètres

Nom	Description
model Obligatoire	modèle de reconnaissance de mot clé qui spécifie le mot clé à reconnaître.

Retours

Type	Description
	Un avenir qui se réalise une fois la reconnaissance initialisée.

stop_keyword_recognition

Arrête de façon synchrone la reconnaissance lancée par le mot clé.

stop_keyword_recognition()

stop_keyword_recognition_async

Arrête de façon asynchrone la reconnaissance lancée par le mot clé.

stop_keyword_recognition_async()

Retours

Type	Description
	Un avenir qui se réalise une fois la reconnaissance arrêtée.

stop_listening

Demande un arrêt immédiat à toute opération d’écoute active. Cela peut interrompre une interaction vocale en cours et tout résultat de reconnaissance vocale reçu peut représenter une entrée vocale incomplète.

Les méthodes synchrones ne doivent pas être appelées lors de la gestion d’un événement. Utilisez stop_listening_async si un arrêt est souhaité en réponse à un événement.

stop_listening()

Retours

Type	Description
	Un avenir qui se réalise une fois que l’écoute a été arrêtée.

stop_listening_async

Demande un arrêt immédiat à toute opération d’écoute active. Cela peut interrompre une interaction vocale en cours et tout résultat de reconnaissance vocale reçu peut représenter une entrée vocale incomplète.

stop_listening_async()

Retours

Type	Description
	Un avenir qui se réalise une fois que l’écoute a été arrêtée.

Attributs

activity_received

Signale qu’une activité a été reçue du back-end.

Les rappels connectés à ce signal sont appelés avec une ActivityReceivedEventArgsinstance , comme argument unique, dépendant du type de module de reconnaissance.

authorization_token

Jeton d’autorisation qui sera utilisé pour la connexion au service.

Notes

L’appelant doit s’assurer que le jeton d’autorisation est valide. Avant le

le jeton d’autorisation expire, l’appelant doit l’actualiser en appelant ce setter avec un

nouveau jeton valide. Dans le cas contraire, le module de reconnaissance rencontrera des erreurs lors de la reconnaissance.

canceled

Signal pour les événements contenant des résultats de reconnaissance annulés (indiquant une tentative de reconnaissance qui a été annulée en conséquence ou une demande d’annulation directe ou, sinon, une défaillance de transport ou de protocole).

Les rappels connectés à ce signal sont appelés avec une SpeechRecognitionCanceledEventArgsinstance , comme argument unique.

recognized

Signal pour les événements contenant les résultats finaux de la reconnaissance (indiquant une tentative de reconnaissance réussie).

Les rappels connectés à ce signal sont appelés avec une SpeechRecognitionEventArgsinstance , comme argument unique, dépendant du type de module de reconnaissance.

recognizing

Signal pour les événements contenant des résultats de reconnaissance intermédiaires.

Les rappels connectés à ce signal sont appelés avec une SpeechRecognitionEventArgsinstance , comme argument unique.

session_started

Signal pour les événements indiquant le début d’une session de reconnaissance (opération).

Les rappels connectés à ce signal sont appelés avec une SessionEventArgs instance comme argument unique.

session_stopped

Signal pour les événements indiquant la fin d’une session de reconnaissance (opération).

Les rappels connectés à ce signal sont appelés avec une SessionEventArgs instance comme argument unique.

speech_activity_template

Obtient le modèle JSON qui sera fourni au service speech pour la conversation suivante. Le service tente de fusionner ce modèle dans toutes les activités envoyées au back-end de dialogue, qu’elles proviennent du client avec SendActivityAsync ou qu’elles soient générées par le service, comme c’est le cas pour les résultats de reconnaissance vocale.

speech_end_detected

Signal pour les événements indiquant la fin de la parole.

Les rappels connectés à ce signal sont appelés avec une RecognitionEventArgs instance comme argument unique.

speech_start_detected

Signal pour les événements indiquant le début de la parole.

Les rappels connectés à ce signal sont appelés avec une RecognitionEventArgs instance comme argument unique.

turn_status_received

Signale qu’une mise à jour de l’état de tour a été reçue du back-end.

Les rappels connectés à ce signal sont appelés avec une TurnStatusReceivedEventArgsinstance , comme argument unique.