ConversationalAgentSession Clase

Definición

Canal de comunicación entre el asistente digital y la plataforma del agente de conversación de 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
Herencia
Object Platform::Object IInspectable ConversationalAgentSession
Atributos
Implementaciones

Requisitos de Windows

Familia de dispositivos
Windows 10, version 1903 (se introdujo en la versión 10.0.18362.0)
API contract
Windows.Foundation.UniversalApiContract (se introdujo en la versión v8.0)

Comentarios

ConversationalAgentSession se crea normalmente a través de la activación por voz cuando se reconoce una expresión de palabra clave como "Hey Cortana" o "Alexa".

ConversationalAgentSession se puede crear de otras maneras, como Bluetooth (cuando una expresión de palabra clave se transmite a través de un auricular o un micrófono), aceleradores de teclado del sistema (como Win+C para Cortana) e iniciación de interacciones de voz desde dentro de la aplicación (quizás a través de algún tipo de interfaz de usuario de prensa para hablar).

Propiedades

AgentState

Obtiene el estado del asistente digital.

IsIndicatorLightAvailable

Obtiene si la luz del indicador está disponible.

IsInterrupted

Obtiene si conversationalAgentSession se está interrumpiendo.

IsInterruptible

Obtiene si conversationalAgentSession se puede interrumpir.

IsScreenAvailable

Obtiene si la pantalla se puede activar.

IsUserAuthenticated

Obtiene si el usuario está autenticado (por ejemplo, el dispositivo está bloqueado).

IsVoiceActivationAvailable

Obtiene si la entrada de voz puede activar el asistente digital.

Signal

Señal que activó el asistente digital, como una expresión de palabra clave, la transmisión bluetooth, el acelerador de teclado del sistema, el reconocimiento de voz en la aplicación u otros sonidos (door slam, smoke detector).

Métodos

Close()

Finaliza conversationalAgentSession.

CreateAudioDeviceInputNode(AudioGraph)

Crea de forma sincrónica un nodo de entrada de grafo de audio.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar CreateAudioDeviceInputNodeAsync en su lugar.

CreateAudioDeviceInputNodeAsync(AudioGraph)

Crea de forma asincrónica un nodo de entrada de grafo de audio.

Dispose()

Realiza tareas definidas por la aplicación asociadas a la liberación o al restablecimiento de recursos no administrados.

GetAudioCaptureDeviceId()

Recupera sincrónicamente el identificador del dispositivo de entrada de voz actual.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar GetAudioCaptureDeviceIdAsync en su lugar.

GetAudioCaptureDeviceIdAsync()

Recupera de forma asincrónica el identificador del dispositivo de entrada de voz actual.

GetAudioClient()

Recupera de forma sincrónica un objeto IAudioClient que crea e inicializa una secuencia de audio entre la aplicación y el dispositivo de representación de audio.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar GetAudioClientAsync en su lugar.

GetAudioClientAsync()

Recupera de forma asincrónica un objeto IAudioClient que crea e inicializa una secuencia de audio entre la aplicación y el dispositivo de representación de audio.

GetAudioRenderDeviceId()

Recupera sincrónicamente el identificador del dispositivo de salida de voz actual.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar GetAudioRenderDeviceIdAsync en su lugar.

GetAudioRenderDeviceIdAsync()

Recupera de forma asincrónica el identificador del dispositivo de salida de voz actual.

GetCurrentSessionAsync()

Recupera de forma asincrónica una referencia a conversationalAgentSession actual.

GetCurrentSessionSync()

Recupera sincrónicamente una referencia a conversationalAgentSession actual.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar GetCurrentSessionAsync en su lugar.

GetMissingPrerequisites()

Obtiene los requisitos previos que faltan para que la activación por voz esté disponible y funcione correctamente.

GetMissingPrerequisitesAsync()

Obtiene los requisitos previos que faltan para que la activación por voz esté disponible y funcione correctamente.

GetSignalModelId()

Recupera el identificador de modelo único de la señal que activó el agente conversacional.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar GetSignalModelIdAsync en su lugar.

GetSignalModelIdAsync()

Recupera de forma asincrónica el identificador de modelo único de la señal que activó el agente conversacional.

GetSupportedSignalModelIds()

Recupera la colección de identificadores de modelo de Signal únicos admitidos por el agente de conversación.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar GetSupportedSignalModelIdsAsync en su lugar.

GetSupportedSignalModelIdsAsync()

Recupera de forma asincrónica la colección de identificadores de modelo de Signal únicos admitidos por el agente de conversación.

RequestActivation(ConversationalAgentActivationKind)

Solicita que el asistente se active en primer plano.

RequestActivationAsync(ConversationalAgentActivationKind)

Solicita de forma asincrónica que el asistente se active en primer plano.

RequestAgentStateChange(ConversationalAgentState)

Solicita de forma sincrónica un cambio de estado para conversationalAgentSession actual.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar RequestAgentStateChangeAsync en su lugar.

RequestAgentStateChangeAsync(ConversationalAgentState)

Solicita de forma asincrónica un cambio de estado para conversationalAgentSession actual.

RequestForegroundActivation()

Solicita sincrónicamente que el asistente se active en primer plano.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar RequestForegroundActivationAsync en su lugar.

RequestForegroundActivationAsync()

Solicita de forma asincrónica que el asistente se active en primer plano.

RequestInterruptible(Boolean)

Solicita sincrónicamente que esta ConversationalAgentSession sea interrumpible si se detecta la palabra clave para otro asistente digital.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar RequestInterruptibleAsync en su lugar.

RequestInterruptibleAsync(Boolean)

Solicita de forma asincrónica que esta ConversationalAgentSession sea interrumpible si se detecta la palabra clave para otro asistente digital.

SetSignalModelId(UInt32)

Asigna un identificador único al modelo que representa la señal de audio de activación para el agente conversacional.

Importante

Para evitar posibles problemas de simultaneidad, se recomienda usar SetSignalModelIdAsync en su lugar.

SetSignalModelIdAsync(UInt32)

Asigna de forma asincrónica un identificador único al modelo que representa la señal de audio de activación para el agente conversacional.

SetSupportLockScreenActivation(Boolean)

Habilita o deshabilita la compatibilidad con la activación de la pantalla de bloqueo del agente conversacional.

SetSupportLockScreenActivationAsync(Boolean)

Habilita o deshabilita de forma asincrónica la compatibilidad con la activación de la pantalla de bloqueo del agente conversacional.

Eventos

SessionInterrupted

Se produce cuando se ha detectado otra señal de activación de asistente digital.

SignalDetected

Se produce cuando se detecta una señal para activar un asistente digital.

SystemStateChanged

Se produce cuando el sistema o el usuario cambian una configuración que restringe la capacidad del asistente digital para realizar una o varias acciones.

Se aplica a