ConversationalAgentSession クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
デジタル アシスタントと Windows Conversational Agent プラットフォームの間の通信チャネル。
public ref class ConversationalAgentSession sealed : IClosable/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 524288)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ConversationalAgentSession final : IClosable[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 524288)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ConversationalAgentSession : System.IDisposablePublic NotInheritable Class ConversationalAgentSession
Implements IDisposable- 継承
- 属性
- 実装
Windows の要件
| デバイス ファミリ |
Windows 10, version 1903 (10.0.18362.0 で導入)
|
| API contract |
Windows.Foundation.UniversalApiContract (v8.0 で導入)
|
注釈
ConversationalAgentSession は、通常、"Hey Cortana" や "Alexa" などのキーワード (keyword)発話が認識されたときに、音声のアクティブ化によって作成されます。
ConversationalAgentSession は、Bluetooth (ヘッドセットまたはマイクを介してキーワード (keyword)発話が送信される場合)、システム キーボード アクセラレータ (Cortana の場合は Win+C など)、アプリ内からの音声操作の開始 (場合によっては、何らかの種類のプレスツートーク UI を介して) など、さまざまな方法で作成できます。
プロパティ
| AgentState |
デジタル アシスタントの状態を取得します。 |
| IsIndicatorLightAvailable |
インジケーター ライトを使用できるかどうかを取得します。 |
| IsInterrupted |
ConversationalAgentSession が中断されているかどうかを取得します。 |
| IsInterruptible |
ConversationalAgentSession を中断できるかどうかを取得します。 |
| IsScreenAvailable |
画面を有効にできるかどうかを取得します。 |
| IsUserAuthenticated |
ユーザーが認証されているかどうかを取得します (デバイスがロックされているなど)。 |
| IsVoiceActivationAvailable |
音声入力によってデジタル アシスタントをアクティブにできるかどうかを取得します。 |
| Signal |
キーワード (keyword)発話、Bluetooth 伝送、システム キーボード アクセラレータ、アプリ内音声認識、またはその他の音 (ドア スラム、煙探知器) など、デジタル アシスタントをアクティブ化したシグナル。 |
メソッド
| Close() |
ConversationalAgentSession を終了します。 |
| CreateAudioDeviceInputNode(AudioGraph) |
オーディオ グラフ入力ノードを同期的に作成します。 重要 コンカレンシーの問題を回避するには、代わりに CreateAudioDeviceInputNodeAsync を使用することをお勧めします。 |
| CreateAudioDeviceInputNodeAsync(AudioGraph) |
オーディオ グラフ入力ノードを非同期的に作成します。 |
| Dispose() |
アンマネージ リソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。 |
| GetAudioCaptureDeviceId() |
現在の音声入力デバイスのデバイス ID を同期的に取得します。 重要 コンカレンシーの問題を回避するには、代わりに GetAudioCaptureDeviceIdAsync を使用することをお勧めします。 |
| GetAudioCaptureDeviceIdAsync() |
現在の音声入力デバイスのデバイス ID を非同期的に取得します。 |
| GetAudioClient() |
アプリケーションとオーディオ レンダリング デバイスの間でオーディオ ストリームを作成および初期化する IAudioClient オブジェクトを同期的に取得します。 重要 コンカレンシーの問題を回避するには、代わりに GetAudioClientAsync を使用することをお勧めします。 |
| GetAudioClientAsync() |
アプリケーションとオーディオ レンダリング デバイスの間でオーディオ ストリームを作成および初期化する IAudioClient オブジェクトを非同期的に取得します。 |
| GetAudioRenderDeviceId() |
現在の音声出力デバイスのデバイス ID を同期的に取得します。 重要 コンカレンシーの問題を回避するには、代わりに GetAudioRenderDeviceIdAsync を使用することをお勧めします。 |
| GetAudioRenderDeviceIdAsync() |
現在の音声出力デバイスのデバイス ID を非同期的に取得します。 |
| GetCurrentSessionAsync() |
現在の ConversationalAgentSession への参照を非同期的に取得します。 |
| GetCurrentSessionSync() |
現在の ConversationalAgentSession への参照を同期的に取得します。 重要 コンカレンシーの問題を回避するには、代わりに GetCurrentSessionAsync を使用することをお勧めします。 |
| GetMissingPrerequisites() |
音声アクティブ化が使用可能になり、正常に機能するために必要な前提条件が不足しています。 |
| GetMissingPrerequisitesAsync() |
音声アクティブ化が使用可能になり、正常に機能するための前提条件が不足しています。 |
| GetSignalModelId() |
会話エージェントをアクティブ化した Signal の一意のモデル識別子を取得します。 重要 コンカレンシーの問題を回避するには、代わりに GetSignalModelIdAsync を使用することをお勧めします。 |
| GetSignalModelIdAsync() |
会話エージェントをアクティブ化した Signal の一意のモデル識別子を非同期的に取得します。 |
| GetSupportedSignalModelIds() |
会話エージェントでサポートされている一意の Signal モデル識別子のコレクションを取得します。 重要 コンカレンシーの問題を回避するには、代わりに GetSupportedSignalModelIdsAsync を使用することをお勧めします。 |
| GetSupportedSignalModelIdsAsync() |
会話エージェントでサポートされている一意の Signal モデル識別子のコレクションを非同期的に取得します。 |
| RequestActivation(ConversationalAgentActivationKind) |
デジタル アシスタントフォアグラウンドでアクティブ化することを要求します。 |
| RequestActivationAsync(ConversationalAgentActivationKind) |
デジタル アシスタントをフォアグラウンドにアクティブ化することを非同期的に要求します。 |
| RequestAgentStateChange(ConversationalAgentState) |
現在の ConversationalAgentSession の状態変更を同期的に要求します。 重要 コンカレンシーの問題を回避するには、代わりに RequestAgentStateChangeAsync を使用することをお勧めします。 |
| RequestAgentStateChangeAsync(ConversationalAgentState) |
現在の ConversationalAgentSession の状態変更を非同期的に要求します。 |
| RequestForegroundActivation() |
デジタル アシスタントをフォアグラウンドにアクティブ化することを同期的に要求します。 重要 コンカレンシーの問題を回避するには、代わりに RequestForegroundActivationAsync を使用することをお勧めします。 |
| RequestForegroundActivationAsync() |
デジタル アシスタントをフォアグラウンドにアクティブ化することを非同期的に要求します。 |
| RequestInterruptible(Boolean) |
別のデジタル アシスタントのキーワード (keyword)が検出された場合、この ConversationalAgentSession を中断可能にすることを同期的に要求します。 重要 コンカレンシーの問題を回避するには、代わりに RequestInterruptibleAsync を使用することをお勧めします。 |
| RequestInterruptibleAsync(Boolean) |
別のデジタル アシスタントのキーワード (keyword)が検出された場合、この ConversationalAgentSession を中断可能にすることを非同期的に要求します。 |
| SetSignalModelId(UInt32) |
会話エージェントのアクティブ化オーディオ信号を表す一意識別子をモデルに割り当てます。 重要 コンカレンシーの問題を回避するには、代わりに SetSignalModelIdAsync を使用することをお勧めします。 |
| SetSignalModelIdAsync(UInt32) |
会話エージェントのアクティブ化オーディオ信号を表す一意の識別子をモデルに非同期的に割り当てます。 |
| SetSupportLockScreenActivation(Boolean) |
会話型エージェントのロック画面のアクティブ化のサポートを有効または無効にします。 |
| SetSupportLockScreenActivationAsync(Boolean) |
会話型エージェントのロック画面のアクティブ化のサポートを非同期的に有効または無効にします。 |
イベント
| SessionInterrupted |
別のデジタル アシスタントアクティブ化シグナルが検出されたときに発生します。 |
| SignalDetected |
デジタル アシスタントをアクティブ化するためのシグナルが検出されたときに発生します。 |
| SystemStateChanged |
デジタル アシスタントが 1 つ以上のアクションを実行する機能を制限する設定をシステムまたはユーザーが変更したときに発生します。 |