ConversationalAgentSession Klasse

Definition

Namespace:

Windows.ApplicationModel.ConversationalAgent

Der Kommunikationskanal zwischen dem digitalen Assistent und der Windows Conversational Agent-Plattform.

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

Vererbung

Object Platform::Object IInspectable ConversationalAgentSession

Attribute

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implementiert

IClosable IDisposable

Windows-Anforderungen

Gerätefamilie	Windows 10, version 1903 (eingeführt in 10.0.18362.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v8.0)

Hinweise

ConversationalAgentSession wird in der Regel durch Sprachaktivierung erstellt, wenn eine Schlüsselwort (keyword) Äußerung wie "Hey Cortana" oder "Alexa" erkannt wird.

Eine ConversationalAgentSession kann auf verschiedene andere Weise erstellt werden, einschließlich Bluetooth (wenn eine Schlüsselwort (keyword) Äußerung über ein Headset oder Mikrofon übertragen wird), Systemtastaturbeschleuniger (z. B. Win+C für Cortana) und Initiierung von Sprachinteraktionen innerhalb Ihrer App (vielleicht über eine Art Press-to-Talk-Benutzeroberfläche).

Eigenschaften

AgentState	Ruft den Zustand des digitalen Assistent ab.
IsIndicatorLightAvailable	Ruft ab, ob die Indikatorleuchte verfügbar ist.
IsInterrupted	Ruft ab, ob conversationalAgentSession unterbrochen wird.
IsInterruptible	Ruft ab, ob conversationalAgentSession unterbrochen werden kann.
IsScreenAvailable	Ruft ab, ob der Bildschirm aktiviert werden kann.
IsUserAuthenticated	Ruft ab, ob der Benutzer authentifiziert ist (z. B. das Gerät ist gesperrt).
IsVoiceActivationAvailable	Ruft ab, ob die digitale Assistent durch Spracheingabe aktiviert werden kann.
Signal	Das Signal, das die digitale Assistent aktiviert hat, z. B. eine Schlüsselwort (keyword) Äußerung, Bluetooth-Übertragung, Systemtastataturbeschleuniger, In-App-Spracherkennung oder andere Geräusche (Türlamm, Rauchmelder).

Methoden

Close()	Beendet conversationalAgentSession.
CreateAudioDeviceInputNode(AudioGraph)	Erstellt synchron einen Audiographeingabeknoten. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen die Verwendung von CreateAudioDeviceInputNodeAsync empfohlen.
CreateAudioDeviceInputNodeAsync(AudioGraph)	Erstellt asynchron einen Audiographeingabeknoten.
Dispose()	Führt anwendungsspezifische Aufgaben durch, die mit der Freigabe, der Zurückgabe oder dem Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen.
GetAudioCaptureDeviceId()	Ruft synchron die Geräte-ID für das aktuelle Spracheingabegerät ab. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen getAudioCaptureDeviceIdAsync empfohlen.
GetAudioCaptureDeviceIdAsync()	Ruft die Geräte-ID für das aktuelle Spracheingabegerät asynchron ab.
GetAudioClient()	Ruft synchron ein IAudioClient-Objekt ab, das einen Audiodatenstrom zwischen Ihrer Anwendung und dem Audiorenderinggerät erstellt und initialisiert. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen getAudioClientAsync empfohlen.
GetAudioClientAsync()	Ruft asynchron ein IAudioClient-Objekt ab, das einen Audiodatenstrom zwischen Ihrer Anwendung und dem Audiorenderinggerät erstellt und initialisiert.
GetAudioRenderDeviceId()	Ruft synchron die Geräte-ID für das aktuelle Sprachausgabegerät ab. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen getAudioRenderDeviceIdAsync empfohlen.
GetAudioRenderDeviceIdAsync()	Ruft die Geräte-ID für das aktuelle Sprachausgabegerät asynchron ab.
GetCurrentSessionAsync()	Ruft asynchron einen Verweis auf die aktuelle ConversationalAgentSession ab.
GetCurrentSessionSync()	Ruft synchron einen Verweis auf die aktuelle ConversationalAgentSession ab. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen getCurrentSessionAsync empfohlen.
GetMissingPrerequisites()	Ruft fehlende Voraussetzungen ab, die erforderlich sind, damit die Sprachaktivierung verfügbar wird und ordnungsgemäß funktioniert.
GetMissingPrerequisitesAsync()	Ruft fehlende Voraussetzungen für die Sprachaktivierung ab, um verfügbar zu werden und ordnungsgemäß zu funktionieren.
GetSignalModelId()	Ruft den eindeutigen Modellbezeichner des Signals ab, das den Konversations-Agent aktiviert hat. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen getSignalModelIdAsync empfohlen.
GetSignalModelIdAsync()	Ruft asynchron den eindeutigen Modellbezeichner des Signals ab, das den Konversations-Agent aktiviert hat.
GetSupportedSignalModelIds()	Ruft die Sammlung eindeutiger Signalmodellbezeichner ab, die vom Konversations-Agent unterstützt werden. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen getSupportedSignalModelIdsAsync empfohlen.
GetSupportedSignalModelIdsAsync()	Ruft asynchron die Sammlung eindeutiger Signalmodellbezeichner ab, die vom Konversations-Agent unterstützt werden.
RequestActivation(ConversationalAgentActivationKind)	Fordert an, dass die digitale Assistent im Vordergrund aktiviert wird.
RequestActivationAsync(ConversationalAgentActivationKind)	Fordert asynchron an, dass die digitale Assistent im Vordergrund aktiviert wird.
RequestAgentStateChange(ConversationalAgentState)	Fordert synchron eine Zustandsänderung für die aktuelle ConversationalAgentSession an. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen die Verwendung von RequestAgentStateChangeAsync empfohlen.
RequestAgentStateChangeAsync(ConversationalAgentState)	Fordert asynchron eine Zustandsänderung für die aktuelle ConversationalAgentSession an.
RequestForegroundActivation()	Fordert synchron an, dass die digitale Assistent im Vordergrund aktiviert wird. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen die Verwendung von RequestForegroundActivationAsync empfohlen.
RequestForegroundActivationAsync()	Fordert asynchron an, dass die digitale Assistent im Vordergrund aktiviert wird.
RequestInterruptible(Boolean)	Fordert synchron an, dass diese ConversationalAgentSession unterbrochen werden kann, wenn die Schlüsselwort (keyword) für eine andere digitale Assistent erkannt wird. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen die Verwendung von RequestInterruptibleAsync empfohlen.
RequestInterruptibleAsync(Boolean)	Fordert asynchron an, dass diese ConversationalAgentSession unterbrochen werden kann, wenn die Schlüsselwort (keyword) für eine andere digitale Assistent erkannt wird.
SetSignalModelId(UInt32)	Weist dem Modell, das das Aktivierungsaudiosignal für den Konversations-Agent darstellt, einen eindeutigen Bezeichner zu. Wichtig Um mögliche Parallelitätsprobleme zu vermeiden, wird stattdessen die Verwendung von SetSignalModelIdAsync empfohlen.
SetSignalModelIdAsync(UInt32)	Weist dem Modell asynchron einen eindeutigen Bezeichner zu, der das Aktivierungsaudiosignal für den Konversations-Agent darstellt.
SetSupportLockScreenActivation(Boolean)	Aktiviert oder deaktiviert die Unterstützung für die Aktivierung des Sperrbildschirms des Konversations-Agents.
SetSupportLockScreenActivationAsync(Boolean)	Aktiviert oder deaktiviert asynchron die Unterstützung für die Aktivierung des Sperrbildschirms des Konversations-Agents.

Ereignisse

SessionInterrupted	Tritt auf, wenn ein weiteres digitales Assistent Aktivierungssignal erkannt wurde.
SignalDetected	Tritt auf, wenn ein Signal zum Aktivieren einer digitalen Assistent erkannt wird.
SystemStateChanged	Tritt auf, wenn entweder das System oder der Benutzer eine Einstellung ändert, die die Fähigkeit des digitalen Assistent einschränkt, eine oder mehrere Aktionen auszuführen.