class Dialog::D ialogServiceConnector
class Dialog::DialogServiceConnector
: public std::enable_shared_from_this< DialogServiceConnector >
: public Utils::NonCopyable
: public Utils::NonMovable
Objekt, das zum Verbinden von DirectLineSpeech oder CustomCommands verwendet wird.
Objekte dieses Typs werden über die FromConfig Factorymethode erstellt.
Elemente
Erkannt
Syntax: public EventSignal< const SpeechRecognitionEventArgs & > Recognized;
Signal für Ereignisse, die Spracherkennungsergebnisse enthalten.
Erkennend
Syntax: public EventSignal< const SpeechRecognitionEventArgs & > Recognizing;
Signal für Ereignisse, die Zwischenerkennungsergebnisse enthalten.
SessionStarted
Syntax: public EventSignal< const SessionEventArgs & > SessionStarted;
Signale, die den Start einer Überwachungssitzung angibt.
SessionStopped
Syntax: public EventSignal< const SessionEventArgs & > SessionStopped;
Signal, das das Ende einer Überwachungssitzung angibt.
SpeechStartDetected
Syntax: public EventSignal< const RecognitionEventArgs & > SpeechStartDetected;
Signal, das die erste Erkennung von Sprachdaten im aktuellen Ausdruck angibt.
SpeechEndDetected
Syntax: public EventSignal< const RecognitionEventArgs & > SpeechEndDetected;
Signal, das das erkannte Ende der Sprachdaten des aktuellen Ausdrucks angibt.
Abgesagt
Syntax: public EventSignal< const SpeechRecognitionCanceledEventArgs & > Canceled;
Signal für Ereignisse im Zusammenhang mit der Abbruch einer Interaktion. Das Ereignis gibt an, ob es sich bei dem Grund um einen direkten Abbruch oder einen Fehler handelt.
ActivityReceived
Syntax: public EventSignal< const ActivityReceivedEventArgs & > ActivityReceived;
Signal, dass eine Aktivität vom Back-End empfangen wurde.
TurnStatusReceived
Syntax: public EventSignal< const TurnStatusReceivedEventArgs & > TurnStatusReceived;
Signal, dass eine Turnstatusaktualisierung vom Back-End empfangen wurde.
Eigenschaften
Syntax: public PropertyCollection & Properties;
Eine Auflistung von Eigenschaften und deren Werten, die für diesen DialogServiceConnector definiert sind.
~DialogServiceConnector
Syntax: public inline virtual ~DialogServiceConnector ( );
Zerstört die Instanz.
ConnectAsync
Syntax: public inline std::future< void > ConnectAsync ( );
Stellt eine Verbindung mit dem Back-End her.
Rückgaben
Ein asynchroner Vorgang, der die Verbindung startet.
DisconnectAsync
Syntax: public inline std::future< void > DisconnectAsync ( );
Trennt sich vom Back-End.
Rückgaben
Ein asynchroner Vorgang, der die Verbindung startet.
SendActivityAsync
Syntax: public inline std::future< std::string > SendActivityAsync ( const std::string & activity );
Sendet eine Aktivität an das Sicherungsdialogfeld.
Die Parameter
-
activity
Zu sendende Aktivität
Rückgaben
Ein asynchroner Vorgang, der den Vorgang startet.
StartKeywordRecognitionAsync
Syntax: public inline std::future< void > StartKeywordRecognitionAsync ( std::shared_ptr< KeywordRecognitionModel > model );
Initiiert die Schlüsselworterkennung.
Die Parameter
-
model
Gibt das zu verwendende Schlüsselwortmodell an.
Rückgaben
Ein asynchroner Vorgang, der den Vorgang startet.
StopKeywordRecognitionAsync
Syntax: public inline std::future< void > StopKeywordRecognitionAsync ( );
Beenden sie die Schlüsselworterkennung.
Rückgaben
Ein asynchroner Vorgang, der den Vorgang startet.
ListenOnceAsync
Syntax: public inline std::future< std::shared_ptr< SpeechRecognitionResult > > ListenOnceAsync ( );
Startet eine Überwachungssitzung, die nach der ersten Äußerung beendet wird.
Rückgaben
Ein asynchroner Vorgang, der den Vorgang startet.
StopListeningAsync
Syntax: public inline std::future< void > StopListeningAsync ( );
Fordert an, dass ein aktiver Überwachungsvorgang sofort beendet, alle laufenden Sprechvorgänge unterbrochen und ein Ergebnis bereitstellt, das alle bisher erfassten Audiodaten widerspiegelt.
Rückgaben
Eine Aufgabe, die den asynchronen Vorgang darstellt, der eine aktive Überwachungssitzung beendet.
SetAuthorizationToken
Syntax: public inline void SetAuthorizationToken ( const std::string & token );
Legt das Autorisierungstoken fest, das für die Verbindung mit dem Dienst verwendet wird. Hinweis: Der Aufrufer muss sicherstellen, dass das Autorisierungstoken gültig ist. Bevor das Autorisierungstoken abläuft, muss der Aufrufer es aktualisieren, indem er diesen Setter mit einem neuen gültigen Token aufruft. Andernfalls tritt der Connector während des Vorgangs auf Fehler auf.
Die Parameter
-
token
Das Autorisierungstoken.
GetAuthorizationToken
Syntax: public inline std::string GetAuthorizationToken ( );
Ruft das Autorisierungstoken ab.
Rückgaben
Autorisierungstoken
SetSpeechActivityTemplate
Syntax: public inline void SetSpeechActivityTemplate ( const std::string & activityTemplate );
Legt eine JSON-Vorlage fest, die dem Sprachdienst für die nächste Unterhaltung bereitgestellt wird. Der Dienst versucht, diese Vorlage in alle Aktivitäten zusammenzuführen, die an das Dialog-Back-End gesendet werden, unabhängig davon, ob sie vom Client mit SendActivityAsync stammen oder vom Dienst generiert wurden, wie es bei Sprach-zu-Text-Ergebnissen der Fall ist.
Die Parameter
-
activityTemplate
Die Aktivitätsnutzlast als JSON-Zeichenfolge, die in alle anwendbaren Aktivitätsmeldungen zusammengeführt werden soll.
GetSpeechActivityTemplate
Syntax: public inline std::string GetSpeechActivityTemplate ( );
Ruft die JSON-Vorlage ab, die dem Sprachdienst für die nächste Unterhaltung bereitgestellt wird. Der Dienst versucht, diese Vorlage in alle Aktivitäten zusammenzuführen, die an das Dialog-Back-End gesendet werden, unabhängig davon, ob sie vom Client mit SendActivityAsync stammen oder vom Dienst generiert wurden, wie es bei Sprach-zu-Text-Ergebnissen der Fall ist.
Rückgaben
Die JSON-Aktivitätsvorlage wird derzeit festgelegt, die für nachfolgende Anforderungen verwendet wird.
FromConfig
Syntax: public inline static std::shared_ptr< DialogServiceConnector > FromConfig ( std::shared_ptr< DialogServiceConfig > connectorConfig , std::shared_ptr< Audio::AudioConfig > audioConfig );
Erstellt einen Dialogdienstconnector aus einem DialogServiceConfig- und einem Audio::AudioConfig-. Benutzer sollten diese Funktion verwenden, um einen Dialogdienstconnector zu erstellen.
Die Parameter
connectorConfig
Dialogdienstkonfiguration.audioConfig
Audiokonfiguration.
Rückgaben
Der freigegebene intelligente Zeiger des erstellten Dialogdienstconnectors.
auto audioConfig = [Audio::AudioConfig::FromDefaultMicrophoneInput](audio-audioconfig.md#fromdefaultmicrophoneinput)();
auto config = [CustomCommandsConfig::FromAuthorizationToken](dialog-customcommandsconfig.md#fromauthorizationtoken)("my_app_id","my_auth_token", "my_region");
auto connector = [DialogServiceConnector::FromConfig](#fromconfig)(config, audioConfig);
Bei der Rede von DialogServiceConfig verweisen wir auf eine der Klassen, die von ihr erben. Die zu verwendende Klasse hängt vom verwendeten Dialog-Back-End ab:
BotFrameworkConfig- für DirectLineSpeech
CustomCommandsConfig- für CustomCommands