Klasse Dialog::D ialogServiceConnector

  • Artikel 
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 Factory-Methode erstellt.

Member

Erkannt

Syntax: public EventSignal< constSpeechRecognitionEventArgs & > Recognized;

Signal für Ereignisse, die Ergebnisse der Spracherkennung enthalten.

Erkennen

Syntax: public EventSignal< constSpeechRecognitionEventArgs & > Recognizing;

Signal für Ereignisse, die Zwischenerkennungsergebnisse enthalten.

SessionStarted

Syntax: public EventSignal< constSessionEventArgs & > SessionStarted;

Signale, die den Beginn einer Abhörsitzung angibt.

SessionStopped

Syntax: public EventSignal< constSessionEventArgs & > SessionStopped;

Signal, das das Ende einer Abhörsitzung angibt.

SpeechStartDetected

Syntax: public EventSignal< constRecognitionEventArgs & > SpeechStartDetected;

Signal, das die erste Erkennung von Sprachdaten im aktuellen Ausdruck angibt.

SpeechEndDetected

Syntax: public EventSignal< constRecognitionEventArgs & > SpeechEndDetected;

Signal, das das erkannte Ende der Sprachdaten des aktuellen Ausdrucks angibt.

Canceled

Syntax: public EventSignal< constSpeechRecognitionCanceledEventArgs & > Canceled;

Signal für Ereignisse im Zusammenhang mit dem Abbruch einer Interaktion. Das Ereignis gibt an, ob der Grund ein direkter Abbruch oder ein Fehler ist.

ActivityReceived

Syntax: public EventSignal< constActivityReceivedEventArgs & > ActivityReceived;

Signalisiert, dass eine Aktivität vom Back-End empfangen wurde.

TurnStatusReceived

Syntax: public EventSignal< constTurnStatusReceivedEventArgs & > TurnStatusReceived;

Signalisiert, dass ein Turn status Update 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 den instance.

Connectasync

Syntax: public inline std::future< void > ConnectAsync ( );

Stellt eine Verbindung mit dem Back-End her.

Gibt zurück

Ein asynchroner Vorgang, der die Verbindung startet.

DisconnectAsync

Syntax: public inline std::future< void > DisconnectAsync ( );

Trennt sich vom Back-End.

Gibt zurück

Ein asynchroner Vorgang, der die Trennung startet.

SendActivityAsync

Syntax: public inline std::future< std::string > SendActivityAsync ( const std::string & activity );

Sendet eine Aktivität an das Unterstützungsdialogfeld.

Parameter

  • activity Zu sendende Aktivität

Gibt zurück

Ein asynchroner Vorgang, der den Vorgang startet.

StartKeywordRecognitionAsync

Syntax: public inline std::future< void > StartKeywordRecognitionAsync ( std::shared_ptr< KeywordRecognitionModel > model );

Initiiert Schlüsselwort (keyword) Erkennung.

Parameter

  • modelGibt das Schlüsselwort (keyword) Modell an, das verwendet werden soll.

Gibt zurück

Ein asynchroner Vorgang, der den Vorgang startet.

StopKeywordRecognitionAsync

Syntax: public inline std::future< void > StopKeywordRecognitionAsync ( );

Beenden Sie Schlüsselwort (keyword) Erkennung.

Gibt zurück

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.

Gibt zurück

Ein asynchroner Vorgang, der den Vorgang startet.

StopListeningAsync

Syntax: public inline std::future< void > StopListeningAsync ( );

Fordert an, dass ein aktiver Abhörvorgang sofort beendet wird, indem alle laufenden Vorträge unterbrochen und ein Ergebnis bereitgestellt wird, das die bisher erfassten Audiodaten widerspiegelt.

Gibt zurück

Eine Aufgabe, die den asynchronen Vorgang darstellt, der eine aktive Lauschsitzung beendet.

SetAuthorizationToken

Syntax: public inline void SetAuthorizationToken ( const std::string & token );

Legt das Autorisierungstoken fest, das zum Herstellen einer 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 treten beim Connector während des Vorgangs Fehler auf.

Parameter

  • token Das Autorisierungstoken.

GetAuthorizationToken

Syntax: public inline std::string GetAuthorizationToken ( );

Ruft das Autorisierungstoken ab.

Gibt zurück

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 mit allen 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 Spracherkennungsergebnissen der Fall ist.

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 allen Aktivitäten zusammenzuführen, die an das Dialog-Back-End gesendet werden, unabhängig davon, ob sie vom Client mit SendActivityAsync oder vom Dienst generiert wurden, wie dies bei Spracherkennungsergebnissen der Fall ist.

Gibt zurück

Die derzeit festgelegte JSON-Aktivitätsvorlage, 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 einer DialogServiceConfig und einer Audio::AudioConfig. Benutzer sollten diese Funktion verwenden, um einen Dialogdienstconnector zu erstellen.

Parameter

  • connectorConfig Dialogdienstkonfiguration.

  • audioConfig Audiokonfiguration.

Gibt zurück

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);

Wenn wir von DialogServiceConfig sprechen, beziehen wir uns auf eine der Klassen, die von ihr erben. Die zu verwendende Klasse hängt vom verwendeten Dialog-Back-End ab: