API-referens för Phi Silica i Windows App SDK
Viktig
Tillgänglig i den senaste experimentella kanalen version av Windows App SDK.
Windows App SDK:s experimentella kanal innehåller API:er och funktioner i tidiga utvecklingsstadier. Alla API:er i den experimentella kanalen kan genomgå stora förändringar och tas bort när som helst från senare versioner. Experimentella funktioner stöds inte för användning i produktionsmiljöer och appar som använder dem kan inte publiceras till Microsoft Store.
- Phi Silica är inte tillgängligt på kinas fastland.
- Fristående appar stöds inte.
Lär dig mer om Windows App SDK API:er som kan komma åt lokala språkmodeller som Phi Silica, Microsofts mest kraftfulla NPU-anpassade lokala språkmodell som möjliggör bearbetning på enheten och generering av chatt, resonemang över text, matematisk lösning, kodgenerering och mycket mer.
Mer information finns i Komma igång med Phi Silica i Windows App SDK.
Tips
Ge feedback om dessa API:er och deras funktioner genom att skapa en nya i GitHub-lagringsplatsen för Windows App SDK (inkludera Phi Silica- i rubriken) eller genom att svara på ett befintligt problem.
Microsoft.Windows.AI.Generative-namnområde
Tillhandahåller API:er för lokal generativ AI-promptbearbetning på enheten och svar.
ImageDescriptionGenerator-klass
public sealed class ImageDescriptionGenerator : System.IDisposable
ImageDescriptionGenerator.Close-metoden
// This member is not implemented in C#
Anmärkningar
Inte implementerad i C#.
ImageDescriptionGenerator.CreateAsync-metod
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageDescriptionGenerator> CreateAsync ();
ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer)-metod
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Graphics.Imaging.ImageBuffer image);
Varning
När du anropar ImageDescriptionGenerator.DescribeAsync() på en bild utlöses ibland ett fel. Det här felet kan ignoreras, vilket gör att felsökaren kan fortsätta och generera korrekt resultat. Felet visas bara i utvecklarmiljön, inte för slutanvändare (kunder som använder din app). Det här felet kommer att utlösas vid användning av debug-versioner eller release-versioner. Felet uppträder intermittent och inte vid varje körning.
ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer,Microsoft.Windows.AI.Generative.ImageDescriptionScenario) metod
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Graphics.Imaging.ImageBuffer image, Microsoft.Windows.AI.Generative.ImageDescriptionScenario scenario);
Parametrar
bild
scenario
Returnerar
Anmärkningar
ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer,Microsoft.Windows.AI.Generative.ImageDescriptionScenario,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Graphics.Imaging.ImageBuffer image, Microsoft.Windows.AI.Generative.ImageDescriptionScenario scenario, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
bild
scenario
innehållsfilteralternativ
Returnerar
Anmärkningar
ImageDescriptionGenerator.IsAvailable-metoden
public static bool IsAvailable ();
ImageDescriptionGenerator.MakeAvailableAsync-metod
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
ImageDescriptionScenario-uppräknare
public enum ImageDescriptionScenario
Fält
Hjälpmedel: 1
Bildtext: 2
DetailedNarration: 3
OfficeCharts: 4
ImageLLMAdapterCreator-klass
public sealed class ImageLLMAdapterCreator : System.IDisposable
ImageLLMAdapterCreator.Close-metod
// This member is not implemented in C#
Anmärkningar
Inte implementerad i C#.
ImageLLMAdapterCreator.CreateAsync-metoden
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageLLMAdapterCreator> CreateAsync ();
Returnerar
ImageLLMAdapterCreator.GetImageLLMEmbeddings(Microsoft.Windows.SemanticSearch.EmbeddingVector)-metod
public System.Collections.Generic.IReadOnlyList<float> GetImageLLMEmbeddings (Microsoft.Windows.SemanticSearch.EmbeddingVector embeddings);
Parametrar
inbäddningar
Returnerar
ImageLLMAdapterCreator.GetImageLLMEmbeddingsAsync(Microsoft.Windows.SemanticSearch.EmbeddingVector)-metod
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<float>> GetImageLLMEmbeddingsAsync (Microsoft.Windows.SemanticSearch.EmbeddingVector embeddings);
Parametrar
inbäddningar
Returnerar
ImageLLMAdapterCreator.GetModelInputSize metod
public uint GetModelInputSize ();
Returnerar
ImageLLMAdapterCreator.GetModelOutputSize-metoden
public uint GetModelOutputSize ();
Returnerar
ImageLLMAdapterCreator.IsAvailable-metoden
public static bool IsAvailable ();
Returnerar
ImageLLMAdapterCreator.MakeAvailableAsync metod
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
Returnerar
LanguageModel-klass
public sealed class LanguageModel : System.IDisposable
Representerar ett objekt som kan interagera med en lokal språkmodell för att generera svar för en angivet prompt.
LanguageModel.Close-metod
Gör sig av med objektet och associerade resurser.
Anmärkningar
Inte implementerad i C#.
LanguageModel.CreateAsync-metod
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModel> CreateAsync ();
Asynkront skapar en ny instans av klassen LanguageModel.
Returnerar
En ny instans av klassen TextRecognizer.
LanguageModel.CreateContext-metod
public Microsoft.Windows.AI.Generative.LanguageModelContext CreateContext ();
Returnerar
Anmärkningar
LanguageModel.CreateContext(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)-metod
public Microsoft.Windows.AI.Generative.LanguageModelContext CreateContext (string systemPrompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
systemPrompt
innehållsfilteralternativ
Returnerar
Anmärkningar
LanguageModel.GenerateEmbeddingVector(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions) metod
public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
snabb
innehållsfilteralternativ
Returnerar
Anmärkningar
LanguageModel.GenerateEmbeddingVector(System.String) -metod
public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt);
Parametrar
snabb
Returnerar
Anmärkningar
LanguageModel.GenerateEmbeddingVectorAsync(System.String)-metod
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt);
Parametrar
snabb
Returnerar
Anmärkningar
LanguageModel.GenerateEmbeddingVectorAsync(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions) metod
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
snabb
innehållsfilteralternativ
Returnerar
Anmärkningar
LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
Alternativ
snabb
innehållsfilteralternativ
Returnerar
Anmärkningar
LanguageModel.GenerateResponseAsync(System.String)-metod
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (string prompt);
Genererar och returnerar ett fullständigt svar för en enda fråga.
Parametrar
snabb
En uppmaning i form av en fråga.
Returnerar
En svarssträng och status.
Undantag
ArgumentException: Den angivna prompten är längre än det maximala antalet token som modellen kan acceptera.
LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext) method
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parametrar
Alternativ
snabb
innehållsfilteralternativ
sammanhang
Returnerar
Anmärkningar
LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String) metod
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt);
Parametrar
Alternativ
snabb
Returnerar
Anmärkningar
LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext)
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, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parametrar
Alternativ
promptEmbedding
innehållsfilteralternativ
sammanhang
Returnerar
Anmärkningar
LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
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, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
Alternativ
promptEmbedding
innehållsfilteralternativ
Returnerar
Anmärkningar
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);
Parametrar
promptEmbedding
Returnerar
Anmärkningar
LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector})-metoden
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);
Parametrar
Alternativ
promptEmbedding
Returnerar
LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64})
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromTokensWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<long> promptTokens);
Parametrar
Alternativ
promptTokens
Returnerar
LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext) method
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromTokensWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<long> promptTokens, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parametrar
Alternativ
promptTokens
innehållsfilteralternativ
sammanhang
Returnerar
LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromTokensWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<long> promptTokens, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
Alternativ
promptTokens
innehållsfilteralternativ
Returnerar
LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
Alternativ
snabb
innehållsfilteralternativ
Returnerar
LanguageModel.GenerateResponseWithProgressAsync(System.String)-metoden
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (string prompt);
Parametrar
snabb
Returnerar
Metoden LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt);
Parametrar
Alternativ
snabb
Returnerar
LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parametrar
Alternativ
snabb
innehållsfilteralternativ
sammanhang
Returnerar
LanguageModel.GenerateTokens(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions) metod
public System.Collections.Generic.IReadOnlyList<long> GenerateTokens (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
text
innehållsfilteralternativ
Returnerar
LanguageModel.GenerateTokens(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions) metod
public System.Collections.Generic.IReadOnlyList<long> GenerateTokens (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
text
innehållsfilteralternativ
Returnerar
LanguageModel.GenerateTokensAsync(System.String)-metod
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<long>> GenerateTokensAsync (string text);
Parametrar
text
Returnerar
LanguageModel.GenerateTokensAsync(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<long>> GenerateTokensAsync (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametrar
text
innehållsfilteralternativ
Returnerar
LanguageModel.IsAvailable-metod
public static bool IsAvailable ();
Returnerar
LanguageModel.IsPromptLargerThanContext(Microsoft.Windows.AI.Generative.LanguageModelContext,System.String) metod
public bool IsPromptLargerThanContext (Microsoft.Windows.AI.Generative.LanguageModelContext context, string prompt);
Parametrar
sammanhang
snabb
Returnerar
LanguageModel.IsPromptLargerThanContext(System.String)-metoden
public bool IsPromptLargerThanContext (string prompt);
Parametrar
snabb
Returnerar
LanguageModel.MakeAvailableAsync-metod
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
Returnerar
LanguageModelContext-klass
public sealed class LanguageModelContext
Klassen "LanguageModelOptions"
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);
Parametrar
kompetens
temp
top_p
top_k
LanguageModelOptions.Skill-egenskapen
public Microsoft.Windows.AI.Generative.LanguageModelSkill Skill { get; set; }
Egenskapsvärde
Egenskapen LanguageModelOptions.Temp
public float Temp { get; set; }
Egenskapsvärde
LanguageModelOptions.Top_k-egenskapen
public uint Top_k { get; set; }
Egenskapsvärde
LanguageModelOptions.Top_p egenskap
public float Top_p { get; set; }
Egenskapsvärde
LanguageModelResponse-klass
public sealed class LanguageModelResponse
LanguageModelResponse.#ctor(System.String,Microsoft.Windows.AI.Generative.LanguageModelResponseStatus) konstruktor
public LanguageModelResponse (string response, Microsoft.Windows.AI.Generative.LanguageModelResponseStatus status);
Parametrar
svar
tillstånd
Egenskapen LanguageModelResponse.Response
public string Response { get; }
Egenskapsvärde
Egenskapen "Status" i LanguageModelResponse
public Microsoft.Windows.AI.Generative.LanguageModelResponseStatus Status { get; }
Egenskapsvärde
Uppräkning av språkmodesvarstatus
public enum LanguageModelResponseStatus
Fält
Slutförd: 0
InProgress: 1
BlockeradAvPolicy: 2
PromptLargerThanContext: 3
Blockerad av policy: 4
SvarBlockeratAvPolicy: 5
Språkmodellfärdighets-uppräkning
public enum LanguageModelSkill