類別 Dialog::D ialogServiceConnector

class Dialog::DialogServiceConnector
  : public std::enable_shared_from_this< DialogServiceConnector >
  : public Utils::NonCopyable
  : public Utils::NonMovable

用來連接 DirectLineSpeech 或 CustomCommands 的物件。

此類型的對像是透過 FromConfig Factory 方法建立。

成員

已認列

語法:public EventSignal< const SpeechRecognitionEventArgs & > Recognized;

包含語音辨識結果的事件訊號。

識別

語法:public EventSignal< const SpeechRecognitionEventArgs & > Recognizing;

包含中繼辨識結果的事件訊號。

SessionStarted

語法:public EventSignal< const SessionEventArgs & > SessionStarted;

表示接聽會話開始的訊號。

SessionStopped

語法:public EventSignal< const SessionEventArgs & > SessionStopped;

表示接聽會話結束的訊號。

SpeechStartDetected

語法:public EventSignal< const RecognitionEventArgs & > SpeechStartDetected;

表示目前片語中第一次偵測語音數據的訊號。

SpeechEndDetected

語法:public EventSignal< const RecognitionEventArgs & > SpeechEndDetected;

表示目前片語語音數據偵測到結尾的訊號。

已取消

語法:public EventSignal< const SpeechRecognitionCanceledEventArgs & > Canceled;

與取消互動相關的事件訊號。 事件指出原因是否為直接取消或錯誤。

ActivityReceived

語法:public EventSignal< const ActivityReceivedEventArgs & > ActivityReceived;

表示已從後端接收活動。

TurnStatusReceived

語法:public EventSignal< const TurnStatusReceivedEventArgs & > TurnStatusReceived;

訊號指出已從後端接收回合狀態更新。

屬性

語法:public PropertyCollection & Properties;

針對這個 DialogServiceConnector 定義的屬性及其值集合。

~DialogServiceConnector

語法:public inline virtual ~DialogServiceConnector ( );

終結 實例。

ConnectAsync

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

與後端連線。

退貨

啟動連接的異步作。

DisconnectAsync

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

中斷與後端的連接。

退貨

啟動中斷連線的異步作。

SendActivityAsync

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

將活動傳送至備份對話框。

參數

  • 要傳送 activity 活動

退貨

啟動作業的異步作。

StartKeywordRecognitionAsync

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

起始關鍵詞辨識。

參數

  • model 指定要使用的關鍵詞模型。

退貨

啟動作業的異步作。

StopKeywordRecognitionAsync

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

停止關鍵詞辨識。

退貨

啟動作業的異步作。

ListenOnceAsync

語法:public inline std::future< std::shared_ptr< SpeechRecognitionResult > > ListenOnceAsync ( );

啟動在第一個語句之後終止的接聽會話。

退貨

啟動作業的異步作。

StopListeningAsync

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

要求主動式接聽作業會立即完成、中斷任何進行中的說話,並提供結果,以反映到目前為止已擷取的任何音頻數據。

退貨

工作,表示停止作用中接聽會話的異步作。

SetAuthorizationToken

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

設定將用於連線至服務的授權令牌。 注意:呼叫端必須確定授權令牌有效。 授權令牌到期之前,呼叫端必須以新的有效令牌呼叫此 setter 來重新整理它。 否則,連接器會在作業期間發生錯誤。

參數

  • token 授權令牌。

GetAuthorizationToken

語法:public inline std::string GetAuthorizationToken ( );

取得授權令牌。

退貨

授權令牌

SetSpeechActivityTemplate

語法:public inline void SetSpeechActivityTemplate ( const std::string & activityTemplate );

設定 JSON 範本,此範本會提供給下一個交談的語音服務。 服務會嘗試將此範本合併到傳送至對話後端的所有活動,不論是由用戶端使用 SendActivityAsync 或由服務產生,就如同語音轉換文字結果的情況一樣。

參數

  • activityTemplate 要合併至所有適用活動訊息的活動承載,做為 JSON 字串。

GetSpeechActivityTemplate

語法:public inline std::string GetSpeechActivityTemplate ( );

取得將提供給下一個交談之語音服務的 JSON 範本。 服務會嘗試將此範本合併到傳送至對話後端的所有活動,不論是由用戶端使用 SendActivityAsync 或由服務產生,就如同語音轉換文字結果的情況一樣。

退貨

JSON 活動範本目前設定,將在後續要求上使用。

FromConfig

語法:public inline static std::shared_ptr< DialogServiceConnector > FromConfig ( std::shared_ptr< DialogServiceConfig > connectorConfig , std::shared_ptr< Audio::AudioConfig > audioConfig );

從 DialogServiceConfig 和 Audio::AudioConfig建立對話框服務連接器。 用戶應該使用此函式來建立對話服務連接器。

參數

  • connectorConfig 對話框服務組態。

  • audioConfig 音訊設定。

退貨

所建立對話框服務連接器的共享智能指標。

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

談到 dialogServiceConfig 時 我們指的是其中一個繼承自它的類別。 要使用的特定類別取決於所使用的對話框後端: