API-Referenz für Phi Silika im Windows App SDK
Wichtig
Dieses Feature ist noch nicht verfügbar. Es wird erwartet, dass es in einer bevorstehenden experimentellen Kanalversion des Windows App SDK ausgeliefert wird.
Der experimentelle Kanal des Windows App SDK enthält APIs und Features in frühen Entwicklungsphasen. Alle APIs im experimentellen Kanal unterliegen umfangreichen Überarbeitungen und Breaking Changes und können jederzeit aus nachfolgenden Versionen entfernt werden. Sie werden nicht für die Verwendung in Produktionsumgebungen unterstützt, und Apps, die experimentelle Features verwenden, können nicht im Microsoft Store veröffentlicht werden.
Erfahren Sie mehr über die Windows App SDK-APIs , die auf lokale Sprachmodelle wie Phi Silica zugreifen können, das NPU-orientierte lokale Sprachmodell von Microsoft, das die Verarbeitung und Generierung von Chats ermöglicht, gründe für Text, mathematische Lösung, Codegenerierung und vieles mehr.
Weitere Details finden Sie unter "Erste Schritte mit Phi Silica" im Windows App SDK.
Tipp
Geben Sie Feedback zu diesen APIs und deren Funktionalität, indem Sie ein neues Problem im GitHub-Repository des Windows App SDK erstellen. (Stellen Sie sicher, dass Sie Phi Silika in den Titel aufnehmen!)
Microsoft.Windows.AI.Generative Namespace
Stellt APIs für lokale, geräteinterne generative KI-Prompt-Verarbeitung und -Antworten bereit.
ImageDescriptionGenerator-Klasse
public sealed class ImageDescriptionGenerator : System.IDisposable
ImageDescriptionGenerator.Close-Methode
// This member is not implemented in C#
ImageDescriptionGenerator.CreateAsync-Methode
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageDescriptionGenerator> CreateAsync ();
ImageDescriptionGenerator.DescribeAsync(Microsoft.Windows.Imaging.ImageBuffer)-Methode
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Windows.Imaging.ImageBuffer image);
ImageDescriptionGenerator.IsAvailable-Methode
public static bool IsAvailable ();
ImageDescriptionGenerator.MakeAvailableAsync-Methode
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
LanguageModel-Klasse
public sealed class LanguageModel : System.IDisposable
Stellt ein Objekt dar, das mit einem lokalen Sprachmodell interagieren kann, um Antworten für eine bereitgestellte Eingabeaufforderung zu generieren.
LanguageModel.Close-Methode
Entfernt das Objekt und die zugeordneten Ressourcen.
Hinweise
In nicht implementiert.
LanguageModel.CreateAsync-Methode
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModel> CreateAsync ();
Erstellt asynchron eine neue Instanz der LanguageModel-Klasse.
Gibt zurück
Eine neue Instanz der TextRecognizer-Klasse.
LanguageModel.GenerateEmbeddingVector(System.String)-Methode
public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt);
LanguageModel.GenerateEmbeddingVectorAsync(System.String)-Methode
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt);
LanguageModel.GenerateResponseAsync(System.String)-Methode
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (string prompt);
Generiert und gibt eine vollständige Antwort für eine einzelne Eingabeaufforderung zurück.
Parameter
prompt
Eine Eingabeaufforderung in Form einer Frage.
Gibt zurück
Eine Antwortzeichenfolge und ein Status.
Ausnahmen
ArgumentException: Die angegebene Eingabeaufforderung ist länger als die maximale Anzahl von Token, die das Modell akzeptieren kann.
LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String)-Methode
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt);
LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector})-Methode
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromEmbeddingsWithProgressAsync (System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> promptEmbedding);
LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector})-Methode
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromEmbeddingsWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> promptEmbedding);
LanguageModel.GenerateResponseWithProgressAsync(System.String)-Methode
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,
string> GenerateResponseWithProgressAsync (string prompt);
Generiert und streamt eine Antwort über einen Statushandler. Partielle Ergebnisse können abgerufen werden, während die Generierung ausgeführt wird.
Parameter
prompt
Die Aufforderung für die Antwort.
Gibt zurück
Eine Antwortzeichenfolge und ein Status.
Das nächste Token der Zeichenkette, die der vollständigen Antwort hinzugefügt wird, wenn das Modell sie zurückgibt. Dies ist das Delta der vorherigen LanguageModelReponse, die als Ergebnis von OnProgress festgelegt wurde.
Ausnahmen
ArgumentException: Die angegebene Eingabeaufforderung ist länger als die maximale Anzahl von Token, die das Modell akzeptieren kann.
Hinweise
OnProgress-Ereignisse treten bei der Generierung jedes einzelnen Worts in der Antwort auf.
LanguageModel.IsAvailable-Methode
public static bool IsAvailable ();
Ruft ab, ob das erforderliche KI-Modell verfügbar ist.
Gibt zurück
True, wenn das erforderliche KI-Modell verfügbar ist. Andernfalls lautet der Wert false.
LanguageModel.IsPromptLargerThanContext(System.String)-Methode
public bool IsPromptLargerThanContext (string prompt);
LanguageModel.MakeAvailableAsync-Methode
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,
Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
Stellt sicher, dass das zugrunde liegende Sprachmodell installiert und zur Verwendung verfügbar ist.
Gibt zurück
Eine asynchrone Aktion mit Fortschritt, die ein PackageDeploymentResult nach Abschluss zurückgibt.
LanguageModelOptions-Klasse
public sealed class LanguageModelOptions
LanguageModelOptions.#ctor-Konstruktor
public LanguageModelOptions ();
LanguageModelOptions.#ctor(Microsoft.Windows.AI.Generative.LanguageModelSkill,System.Single,System.Single,System.UInt32)-Konstruktor
public LanguageModelOptions (Microsoft.Windows.AI.Generative.LanguageModelSkill skill, float temp, float top_p, uint top_k);
LanguageModelOptions.Skill-Eigenschaft
public Microsoft.Windows.AI.Generative.LanguageModelSkill Skill { get; set; }
LanguageModelOptions.Temp-Eigenschaft
public float Temp { get; set; }
LanguageModelOptions.Top_k-Eigenschaft
public uint Top_k { get; set; }
LanguageModelOptions.Top_p-Eigenschaft
public float Top_p { get; set; }
LanguageModelResponse-Klasse
public sealed class LanguageModelResponse
Stellt eine Antwortzeichenfolge und einen Status dar.
LanguageModelResponse.Response-Eigenschaft
public string Response { get; }
Ruft die Antwortzeichenfolge ab, die vom Sprachmodell basierend auf der bereitgestellten Eingabeaufforderung zurückgegeben wird.
Eigenschaftswert
Die Antwortzeichenfolge, die vom Sprachmodell basierend auf der bereitgestellten Eingabeaufforderung zurückgegeben wird.
LanguageModelResponse.Status-Eigenschaft
public Microsoft.Windows.AI.Generative.LanguageModelResponseStatus Status { get; }
Ruft den Antwortstatus basierend auf der bereitgestellten Eingabeaufforderung ab.
Eigenschaftswert
Die Antwortzeichenfolge, die vom Sprachmodell basierend auf der bereitgestellten Eingabeaufforderung zurückgegeben wird.
Hinweise
Ein anderer Wert als Succeeded oder InProgress gilt als Fehler.
LanguageModelResponseStatus-Aufzählung
public enum LanguageModelResponseStatus
Gibt die möglichen Antwortstatuswerte für die angegebene Eingabeaufforderung an.
Felder – Betriebssystem
Abgeschlossen: 0
Die Antwort ist abgeschlossen.
InProgress (In Bearbeitung): 1
Die Antwort wird ausgeführt.
BlockedByPolicy: 2
Die Antwort wird durch eine Richtlinieneinstellung blockiert.
PromptLargerThanContext: 3
LanguageModelSkill-Aufzählung
public enum LanguageModelSkill