類別 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< constSpeechRecognitionEventArgs & > Recognized;
包含語音辨識結果的事件訊號。
識別
語法: public EventSignal< constSpeechRecognitionEventArgs & > Recognizing;
包含中繼辨識結果的事件訊號。
SessionStarted
語法: public EventSignal< constSessionEventArgs & > SessionStarted;
表示接聽會話開始的訊號。
SessionStopped
語法: public EventSignal< constSessionEventArgs & > SessionStopped;
表示接聽會話結尾的訊號。
SpeechStartDetected
語法: public EventSignal< constRecognitionEventArgs & > SpeechStartDetected;
表示目前片語中第一次偵測語音數據的訊號。
SpeechEndDetected
語法: public EventSignal< constRecognitionEventArgs & > SpeechEndDetected;
表示目前片語語音數據偵測到結尾的訊號。
已取消
語法: public EventSignal< constSpeechRecognitionCanceledEventArgs & > Canceled;
與取消互動相關的事件訊號。 事件會指出原因是否為直接取消或錯誤。
ActivityReceived
語法: public EventSignal< constActivityReceivedEventArgs & > ActivityReceived;
表示活動已從後端接收。
TurnStatusReceived
語法: public EventSignal< constTurnStatusReceivedEventArgs & > 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 時,我們會參考繼承自它的其中一個類別。 要使用的特定類別取決於所使用的對話框後端:
適用於 DirectLineSpeech 的 BotFrameworkConfig