Delen via


API-ref voor PhiSilium in de Windows App SDK

Belangrijk

Deze functie is nog niet beschikbaar. Het wordt naar verwachting verzonden in een komende experimentele release van het -kanaal van de Windows App SDK.

De Windows App SDK experimenteel kanaal bevat API's en functies in vroege ontwikkelingsfasen. Alle API's in het experimentele kanaal zijn onderhevig aan uitgebreide revisies en ingrijpende wijzigingen en kunnen te allen tijde uit volgende releases worden verwijderd. Ze worden niet ondersteund voor gebruik in productieomgevingen en apps die gebruikmaken van experimentele functies kunnen niet worden gepubliceerd naar de Microsoft Store.

Meer informatie over de Windows App SDK API's die toegang hebben tot lokale taalmodellen, zoals PhiSilium, het krachtigste NPU-afgestemde lokale taalmodel van Microsoft waarmee het verwerken en genereren van chats op apparaten mogelijk is, redeneren over tekst, wiskundige oplossingen, codegeneratie en meer.

Zie Aan de slag met Phi Silicium in de Windows App SDKvoor meer informatie.

Fooi

Geef feedback over deze API's en hun functionaliteit door een nieuw probleem te maken in de GitHub-opslagplaats van de Windows App SDK. (Zorg ervoor dat u Phi Silicium in de titel opneemt!)


Microsoft.Windows.AI.Generative namespace

Biedt API's voor lokale, apparaatgeneratieve AI-promptverwerking en -antwoorden.

Klasse ImageDescriptionGenerator

public sealed class ImageDescriptionGenerator : System.IDisposable

ImageDescriptionGenerator.Close-methode

// This member is not implemented in C#

Methode ImageDescriptionGenerator.CreateAsync

public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageDescriptionGenerator> CreateAsync ();

Methode ImageDescriptionGenerator.DescribeAsync(Microsoft.Windows.Imaging.ImageBuffer)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Windows.Imaging.ImageBuffer image);

Methode ImageDescriptionGenerator.IsAvailable

public static bool IsAvailable ();

De methode ImageDescriptionGenerator.MakeAvailableAsync

public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();

LanguageModel-klasse

public sealed class LanguageModel : System.IDisposable

Vertegenwoordigt een object dat kan communiceren met een lokaal taalmodel om antwoorden te genereren voor een opgegeven prompt.

methode LanguageModel.Close

Hiermee verwijdert u het object en de bijbehorende resources.

Opmerkingen

Niet geïmplementeerd in C#.

Methode LanguageModel.CreateAsync

public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModel> CreateAsync ();

Asynchroon wordt er een nieuw exemplaar van de LanguageModel-klasse gemaakt.

Retouren

Een nieuw exemplaar van de klasse TextRecognizer.

Methode LanguageModel.GenerateEmbeddingVector(System.String)

public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt);

De LanguageModel.GenerateEmbeddingVectorAsync(System.String)-methode

public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt);

Methode LanguageModel.GenerateResponseAsync(System.String)

public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (string prompt);

Genereert en retourneert een volledig antwoord voor één prompt.

Parameters
aanmoediging

Een prompt in de vorm van een vraag.

Retouren

Een antwoordtekenreeks en -status.

Uitzonderingen

ArgumentException: de opgegeven prompt is langer dan het maximum aantal tokens dat het model kan accepteren.

Methode LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String)

public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt);

Methode LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector})

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromEmbeddingsWithProgressAsync (System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> promptEmbedding);

Methode LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector})

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);

Methode LanguageModel.GenerateResponseWithProgressAsync(System.String)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse, 
string> GenerateResponseWithProgressAsync (string prompt);

Genereert en streamt een antwoord via een voortgangshandler. Gedeeltelijke resultaten kunnen worden opgehaald terwijl het genereren wordt uitgevoerd.

Parameters
aanmoediging

De prompt voor het antwoord.

Retouren

Een antwoordtekenreeks en -status.

Het volgende token van de tekenreeks die aan het volledige antwoord wordt toegevoegd terwijl het model het retourneert; dit is de delta ten opzichte van de vorige LanguageModelResponse-set, zoals het resultaat OnProgress.

Uitzonderingen

ArgumentException: de opgegeven prompt is langer dan het maximum aantal tokens dat het model kan accepteren.

Opmerkingen

OnProgress-gebeurtenissen vinden plaats bij het genereren van elk woord in het antwoord.

De methode LanguageModel.IsAvailable

public static bool IsAvailable ();

Hiermee wordt opgehaald of het vereiste AI-model beschikbaar is.

Retouren

Waar, indien het vereiste AI-model beschikbaar is. Anders, onwaar.

Methode LanguageModel.IsPromptLargerThanContext(System.String)

public bool IsPromptLargerThanContext (string prompt);

LanguageModel.MakeAvailableAsync-methode

public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult, 
Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();

Zorgt ervoor dat het onderliggende taalmodel is geïnstalleerd en beschikbaar is voor gebruik.

Retouren

Een asynchrone actie waarbij voortgang wordt geboekt en die bij voltooiing een PackageDeploymentResult retourneert.

Klasse LanguageModelOptions

public sealed class LanguageModelOptions

LanguageModelOptions.#ctor constructor

public LanguageModelOptions ();

LanguageModelOptions.#ctor(Microsoft.Windows.AI.Generative.LanguageModelSkill,System.Single,System.Single,System.UInt32) constructor

public LanguageModelOptions (Microsoft.Windows.AI.Generative.LanguageModelSkill skill, float temp, float top_p, uint top_k);

Eigenschap van LanguageModelOptions.Skill

public Microsoft.Windows.AI.Generative.LanguageModelSkill Skill { get; set; }

Eigenschap LanguageModelOptions.Temp

public float Temp { get; set; }

Eigenschap LanguageModelOptions.Top_k

public uint Top_k { get; set; }

LanguageModelOptions.Top_p-eigenschap

public float Top_p { get; set; }

Klasse LanguageModelResponse

public sealed class LanguageModelResponse

Vertegenwoordigt een antwoordtekenreeks en -status.

Eigenschap van LanguageModelResponse.Response

public string Response { get; }

Hiermee haalt u de antwoordtekenreeks op die door het taalmodel wordt geretourneerd op basis van de opgegeven prompt.

Eigenschapswaarde

De antwoordtekenreeks die door het taalmodel wordt geretourneerd op basis van de opgegeven prompt.

De LanguageModelResponse.Status-eigenschap

public Microsoft.Windows.AI.Generative.LanguageModelResponseStatus Status { get; }

Hiermee haalt u de antwoordstatus op op basis van de opgegeven prompt.

Eigenschapswaarde

De antwoordtekenreeks die door het taalmodel wordt geretourneerd op basis van de opgegeven prompt.

Opmerkingen

Een andere waarde dan Succeeded of InProgress wordt beschouwd als een fout.

Enum LanguageModelResponseStatus

public enum LanguageModelResponseStatus

Hiermee geeft u de mogelijke antwoordstatuswaarden voor de opgegeven prompt.

Velden - besturingssysteem

Voltooid: 0

Het antwoord is voltooid.

InProgress: 1

Reactie is in behandeling.

GeblokkeerdDoorBeleid: 2

Het antwoord wordt geblokkeerd door een beleidsinstelling.

PromptLargerThanContext: 3

LanguageModelVaardigheid-enumeratie

public enum LanguageModelSkill

Velden

Algemeen: 0
TextToTable: 1