ConversationalAgentSession Classe

Definição

Namespace:

Windows.ApplicationModel.ConversationalAgent

O canal de comunicação entre o assistente digital e a plataforma do Agente de Conversação do 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

Herança

Object Platform::Object IInspectable ConversationalAgentSession

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implementações

IClosable IDisposable

Requisitos do Windows

Família de dispositivos	Windows 10, version 1903 (introduzida na 10.0.18362.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v8.0)

Comentários

O ConversationalAgentSession normalmente é criado por meio da ativação de voz quando um enunciado palavra-chave como "Hey Cortana" ou "Alexa" é reconhecido.

Uma ConversationalAgentSession pode ser criada de várias outras maneiras, incluindo Bluetooth (quando um enunciado palavra-chave é transmitido por meio de um fone de ouvido ou microfone), aceleradores de teclado do sistema (como Win+C para Cortana) e o início de interações de fala de dentro de seu aplicativo (talvez por meio de algum tipo de interface do usuário de conversação).

Propriedades

AgentState	Obtém o estado da assistente digital.
IsIndicatorLightAvailable	Obtém se a luz do indicador está disponível.
IsInterrupted	Obtém se ConversationalAgentSession está sendo interrompido.
IsInterruptible	Obtém se ConversationalAgentSession pode ser interrompido.
IsScreenAvailable	Obtém se a tela pode ser ativada.
IsUserAuthenticated	Obtém se o usuário está autenticado (por exemplo, o dispositivo está bloqueado).
IsVoiceActivationAvailable	Obtém se a assistente digital pode ser ativada pela entrada de fala.
Signal	O Signal que ativou a assistente digital, como um enunciado palavra-chave, transmissão Bluetooth, acelerador de teclado do sistema, reconhecimento de fala no aplicativo ou outros sons (door slam, detector de fumaça).

Métodos

Close()	Encerra ConversationalAgentSession.
CreateAudioDeviceInputNode(AudioGraph)	Cria de forma síncrona um nó de entrada de grafo de áudio. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar CreateAudioDeviceInputNodeAsync .
CreateAudioDeviceInputNodeAsync(AudioGraph)	Cria de forma assíncrona um nó de entrada de grafo de áudio.
Dispose()	Realiza tarefas definidas pelo aplicativo associadas à liberação ou à redefinição de recursos não gerenciados.
GetAudioCaptureDeviceId()	Recupera de forma síncrona a ID do dispositivo para o dispositivo de entrada de fala atual. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar GetAudioCaptureDeviceIdAsync .
GetAudioCaptureDeviceIdAsync()	Recupera de forma assíncrona a ID do dispositivo para o dispositivo de entrada de fala atual.
GetAudioClient()	Recupera de forma síncrona um objeto IAudioClient que cria e inicializa um fluxo de áudio entre o aplicativo e o dispositivo de renderização de áudio. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar GetAudioClientAsync .
GetAudioClientAsync()	Recupera de forma assíncrona um objeto IAudioClient que cria e inicializa um fluxo de áudio entre seu aplicativo e o dispositivo de renderização de áudio.
GetAudioRenderDeviceId()	Recupera de forma síncrona a ID do dispositivo para o dispositivo de saída de fala atual. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar GetAudioRenderDeviceIdAsync .
GetAudioRenderDeviceIdAsync()	Recupera de forma assíncrona a ID do dispositivo para o dispositivo de saída de fala atual.
GetCurrentSessionAsync()	Recupera de forma assíncrona uma referência ao ConversationalAgentSession atual.
GetCurrentSessionSync()	Recupera de forma síncrona uma referência ao ConversationalAgentSession atual. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar GetCurrentSessionAsync .
GetMissingPrerequisites()	Obtém os pré-requisitos ausentes necessários para que a ativação de voz fique disponível e funcione corretamente.
GetMissingPrerequisitesAsync()	Obtém pré-requisitos ausentes para que a ativação de voz fique disponível e funcione corretamente.
GetSignalModelId()	Recupera o identificador de modelo exclusivo do Signal que ativou o agente de conversa. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar GetSignalModelIdAsync .
GetSignalModelIdAsync()	Recupera de forma assíncrona o identificador de modelo exclusivo do Signal que ativou o agente de conversa.
GetSupportedSignalModelIds()	Recupera a coleção de identificadores exclusivos do modelo signal com suporte do agente de conversa. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar GetSupportedSignalModelIdsAsync .
GetSupportedSignalModelIdsAsync()	Recupera de forma assíncrona a coleção de identificadores de modelo do Signal exclusivos compatíveis com o agente de conversação.
RequestActivation(ConversationalAgentActivationKind)	Solicita que o assistente digital seja ativado em primeiro plano.
RequestActivationAsync(ConversationalAgentActivationKind)	Solicita de forma assíncrona que o assistente digital seja ativado em primeiro plano.
RequestAgentStateChange(ConversationalAgentState)	Solicita de forma síncrona uma alteração de estado para o ConversationalAgentSession atual. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar RequestAgentStateChangeAsync .
RequestAgentStateChangeAsync(ConversationalAgentState)	Solicita de forma assíncrona uma alteração de estado para o ConversationalAgentSession atual.
RequestForegroundActivation()	Solicita de forma síncrona que o assistente digital seja ativado em primeiro plano. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar RequestForegroundActivationAsync .
RequestForegroundActivationAsync()	Solicita de forma assíncrona que o assistente digital seja ativado em primeiro plano.
RequestInterruptible(Boolean)	Solicita de forma síncrona que essa ConversationalAgentSession seja interrompível se o palavra-chave para outro assistente digital for detectado. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar RequestInterruptibleAsync .
RequestInterruptibleAsync(Boolean)	Solicita de forma assíncrona que essa ConversationalAgentSession seja interruptível se o palavra-chave de outro assistente digital for detectado.
SetSignalModelId(UInt32)	Atribui um identificador exclusivo ao modelo que representa o sinal de áudio de ativação do agente de conversa. Importante Para evitar possíveis problemas de simultaneidade, recomendamos usar SetSignalModelIdAsync .
SetSignalModelIdAsync(UInt32)	Atribui de forma assíncrona um identificador exclusivo ao modelo que representa o sinal de áudio de ativação do agente de conversa.
SetSupportLockScreenActivation(Boolean)	Habilita ou desabilita o suporte para ativação da tela de bloqueio do agente de conversa.
SetSupportLockScreenActivationAsync(Boolean)	Habilita ou desabilita de forma assíncrona o suporte para ativação da tela de bloqueio do agente de conversa.

Eventos

SessionInterrupted	Ocorre quando outro sinal de ativação de assistente digital foi detectado.
SignalDetected	Ocorre quando um Signal para ativar uma assistente digital é detectado.
SystemStateChanged	Ocorre quando o sistema ou o usuário altera uma configuração que restringe a capacidade do assistente digital de executar uma ou mais ações.