ConversationalAgentSession Класс

Определение

Пространство имен:

Windows.ApplicationModel.ConversationalAgent

Канал связи между цифровой помощник и платформой агента диалога 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

Наследование

Object Platform::Object IInspectable ConversationalAgentSession

Атрибуты

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Реализации

IClosable 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()	Извлекает уникальный идентификатор модели сигнала , активированного агентом диалога. Важно! Чтобы избежать возможных проблем с параллелизмом, рекомендуется использовать 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	Происходит при изменении системой или пользователем параметра, ограничивающего возможность цифрового помощник выполнять одно или несколько действий.