ConversationalAgentSession Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Канал связи между цифровым помощник и платформой Агента бесед Windows.
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.IDisposable
Public NotInheritable Class ConversationalAgentSession
Implements IDisposable
- Наследование
- Атрибуты
- Реализации
Требования к Windows
Семейство устройств |
Windows 10, version 1903 (появилось в 10.0.18362.0)
|
API contract |
Windows.Foundation.UniversalApiContract (появилось в v8.0)
|
Комментарии
ConversationalAgentSession обычно создается с помощью голосовой активации, когда распознается ключевое слово высказывание, например "Привет, Кортана" или "Alexa".
ConversationalAgentSession можно создать различными способами, включая Bluetooth (когда ключевое слово речевой фрагмент передается через гарнитуру или микрофон), системные ускорители клавиатуры (например, Win+C для Кортаны) и инициирование речевых взаимодействий из приложения (возможно, через какой-то пользовательский интерфейс нажатия).
Свойства
AgentState |
Возвращает состояние цифрового помощник. |
IsIndicatorLightAvailable |
Возвращает значение, указывая, доступен ли индикатор. |
IsInterrupted |
Возвращает значение, указывая, прерывается ли ConversationalAgentSession . |
IsInterruptible |
Возвращает значение, указывая, можно ли прервать conversationalAgentSession . |
IsScreenAvailable |
Возвращает значение, указываемое на возможность включения экрана. |
IsUserAuthenticated |
Возвращает значение, указывающее, прошел ли пользователь проверку подлинности (например, устройство заблокировано). |
IsVoiceActivationAvailable |
Возвращает значение, указываемое на возможность активации цифрового помощник путем ввода речи. |
Signal |
Сигнал, активируемый цифровой помощник, такой как ключевое слово речевой фрагмент, передача Bluetooth, системный ускоритель клавиатуры, распознавание речи в приложении или другие звуки (хлопание двери, детектор дыма). |
Методы
Close() |
Завершает conversationalAgentSession. |
CreateAudioDeviceInputNode(AudioGraph) |
Синхронно создает входной узел звукового графа. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать createAudioDeviceInputNodeAsync . |
CreateAudioDeviceInputNodeAsync(AudioGraph) |
Асинхронно создает входной узел звукового графа. |
Dispose() |
Выполняет определяемые приложением задачи, связанные с удалением, высвобождением или сбросом неуправляемых ресурсов. |
GetAudioCaptureDeviceId() |
Синхронно извлекает идентификатор устройства для текущего устройства ввода речи. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать getAudioCaptureDeviceIdAsync . |
GetAudioCaptureDeviceIdAsync() |
Асинхронно извлекает идентификатор устройства для текущего устройства ввода речи. |
GetAudioClient() |
Синхронно извлекает объект IAudioClient , который создает и инициализирует аудиопоток между приложением и устройством отрисовки звука. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать GetAudioClientAsync . |
GetAudioClientAsync() |
Асинхронно извлекает объект IAudioClient , который создает и инициализирует аудиопоток между приложением и устройством отрисовки звука. |
GetAudioRenderDeviceId() |
Синхронно извлекает идентификатор устройства для текущего устройства вывода речи. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать GetAudioRenderDeviceIdAsync . |
GetAudioRenderDeviceIdAsync() |
Асинхронно извлекает идентификатор устройства для текущего устройства вывода речи. |
GetCurrentSessionAsync() |
Асинхронно извлекает ссылку на текущее ConversationalAgentSession. |
GetCurrentSessionSync() |
Синхронно извлекает ссылку на текущее ConversationalAgentSession. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать GetCurrentSessionAsync . |
GetMissingPrerequisites() |
Получает отсутствующие предварительные требования, необходимые для обеспечения доступности голосовой активации и правильной работы. |
GetMissingPrerequisitesAsync() |
Получает отсутствующие предварительные требования для голосовой активации, чтобы она стала доступной и правильно функционировала. |
GetSignalModelId() |
Извлекает уникальный идентификатор модели signal , активировал агент беседы. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать GetSignalModelIdAsync . |
GetSignalModelIdAsync() |
Асинхронно извлекает уникальный идентификатор модели signal , активировал агент общения. |
GetSupportedSignalModelIds() |
Извлекает коллекцию уникальных идентификаторов модели сигналов , поддерживаемых агентом беседы. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать GetSupportedSignalModelIdsAsync . |
GetSupportedSignalModelIdsAsync() |
Асинхронно извлекает коллекцию уникальных идентификаторов модели сигналов , поддерживаемых агентом общения. |
RequestActivation(ConversationalAgentActivationKind) |
Запрашивает активацию цифрового помощник на переднем плане. |
RequestActivationAsync(ConversationalAgentActivationKind) |
Асинхронно запрашивает активацию цифрового помощник на переднем плане. |
RequestAgentStateChange(ConversationalAgentState) |
Синхронно запрашивает изменение состояния для текущего ConversationalAgentSession. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать RequestAgentStateChangeAsync . |
RequestAgentStateChangeAsync(ConversationalAgentState) |
Асинхронно запрашивает изменение состояния для текущего ConversationalAgentSession. |
RequestForegroundActivation() |
Синхронно запрашивает активацию цифрового помощник на переднем плане. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать вместо него RequestForegroundActivationAsync . |
RequestForegroundActivationAsync() |
Асинхронно запрашивает активацию цифрового помощник на переднем плане. |
RequestInterruptible(Boolean) |
Синхронно запрашивает прерывание этого ConversationalAgentSession при обнаружении ключевое слово для другого цифрового помощник. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать вместо него RequestInterruptibleAsync . |
RequestInterruptibleAsync(Boolean) |
Асинхронно запрашивает прерывание этого ConversationalAgentSession при обнаружении ключевое слово для другого цифрового помощник. |
SetSignalModelId(UInt32) |
Назначает уникальный идентификатор модели, представляющей звуковой сигнал активации для агента общения. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать SetSignalModelIdAsync . |
SetSignalModelIdAsync(UInt32) |
Асинхронно назначает уникальный идентификатор модели, представляющей звуковой сигнал активации для агента общения. |
SetSupportLockScreenActivation(Boolean) |
Включает или отключает поддержку активации с экрана блокировки агента беседы. |
SetSupportLockScreenActivationAsync(Boolean) |
Асинхронно включает или отключает поддержку активации с экрана блокировки для агента беседы. |
События
SessionInterrupted |
Происходит при обнаружении другого цифрового сигнала активации помощник. |
SignalDetected |
Происходит при обнаружении сигнала для активации цифрового помощник. |
SystemStateChanged |
Происходит при изменении системой или пользователем параметра, ограничивающего возможности цифрового помощник выполнять одно или несколько действий. |