Referenční příručka API pro Phi Silica ve Windows App SDK
Důležitý
k dispozici v nejnovějším experimentálním kanálu vydání sady Windows App SDK.
Experimentální kanál sady Windows App SDK zahrnuje rozhraní API a funkce v počátečních fázích vývoje. Všechna rozhraní API v experimentálním kanálu podléhají rozsáhlým revizem a zásadním změnám a je možné je kdykoli odebrat z následujících verzí. Experimentální funkce nejsou podporovány pro použití v produkčních prostředích a aplikacích, které je používají, nelze publikovat do Microsoft Storu.
- Phi Silica není k dispozici v pevninské Číně.
- Samostatné aplikace se nepodporují.
Přečtěte si o rozhraních API pro sady Windows App SDK, která mají přístup k místním jazykovým modelům, jako je Phi Silica, nejvýkonnější místní jazykový model NPU od Microsoftu, který umožňuje zpracování a generování chatu na zařízení, vysvětlení textu, řešení matematiky, generování kódu a další.
Další podrobnosti najdete v tématu Začínáme s Phi Silica v sadě Windows App SDK.
Spropitné
Poskytněte zpětnou vazbu k těmto rozhraním API a jejich funkcím vytvořením nového problému v úložišti GitHub sady Windows App SDK (včetně Phi Silica v názvu) nebo reagováním na existující problém.
Microsoft.Windows.AI.Generative – jmenný prostor
Poskytuje rozhraní API pro zpracování výzev a odpovědí generativní AI přímo na zařízení.
Třída ImageDescriptionGenerator
public sealed class ImageDescriptionGenerator : System.IDisposable
Metoda: ImageDescriptionGenerator.Close
// This member is not implemented in C#
Poznámky
V jazyce C# není implementováno.
Metoda ImageDescriptionGenerator.CreateAsync
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageDescriptionGenerator> CreateAsync ();
Metoda ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Graphics.Imaging.ImageBuffer image);
Varování
Při volání ImageDescriptionGenerator.DescribeAsync()
na obrázku se někdy vyvolá chyba. Tuto chybu je možné přeskočit, což ladicímu programu umožní pokračovat a vygenerovat správný výstup. Chyba se zobrazuje jenom ve vývojářském prostředí, ne pro koncové uživatele (zákazníci používající vaši aplikaci). Použití sestavení ladění nebo vývojové verze spustí tuto chybu. K chybě dochází přerušovaně a ne při každém spuštění.
ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer,Microsoft.Windows.AI.Generative.ImageDescriptionScenario) method
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Graphics.Imaging.ImageBuffer image, Microsoft.Windows.AI.Generative.ImageDescriptionScenario scenario);
Parametry
obrázek
scénář
Návraty
Poznámky
Metoda 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);
Parametry
obrázek
scénář
Možnosti filtru obsahu
Návraty
Poznámky
Metoda ImageDescriptionGenerator.IsAvailable
public static bool IsAvailable ();
Metoda ImageDescriptionGenerator.MakeAvailableAsync
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
ImageDescriptionScenario enumerator
public enum ImageDescriptionScenario
Pole
Přístupnost: 1
Titulek: 2
Podrobný popis: 3
OfficeCharts: 4
Třída ImageLLMAdapterCreator
public sealed class ImageLLMAdapterCreator : System.IDisposable
Metoda ImageLLMAdapterCreator.Close
// This member is not implemented in C#
Poznámky
V jazyce C# není implementováno.
Metoda ImageLLMAdapterCreator.CreateAsync
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageLLMAdapterCreator> CreateAsync ();
Návraty
Metoda ImageLLMAdapterCreator.GetImageLLMEmbeddings(Microsoft.Windows.SemanticSearch.EmbeddingVector)
public System.Collections.Generic.IReadOnlyList<float> GetImageLLMEmbeddings (Microsoft.Windows.SemanticSearch.EmbeddingVector embeddings);
Parametry
vkládání
Návraty
Metoda ImageLLMAdapterCreator.GetImageLLMEmbeddingsAsync(Microsoft.Windows.SemanticSearch.EmbeddingVector)
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<float>> GetImageLLMEmbeddingsAsync (Microsoft.Windows.SemanticSearch.EmbeddingVector embeddings);
Parametry
vkládání
Návraty
Metoda ImageLLMAdapterCreator.GetModelInputSize
public uint GetModelInputSize ();
Návraty
Metoda ImageLLMAdapterCreator.GetModelOutputSize
public uint GetModelOutputSize ();
Návraty
Metoda ImageLLMAdapterCreator.IsAvailable
public static bool IsAvailable ();
Návraty
Metoda "ImageLLMAdapterCreator.MakeAvailableAsync"
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
Návraty
Třída LanguageModel
public sealed class LanguageModel : System.IDisposable
Představuje objekt, který může pracovat s místním jazykovým modelem za účelem generování odpovědí pro poskytnutou výzvu.
Metoda LanguageModel.Close
Odstraní objekt a přidružené prostředky.
Poznámky
V jazyce C# není implementováno.
Metoda LanguageModel.CreateAsync
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModel> CreateAsync ();
Asynchronně vytvoří novou instanci Třídy LanguageModel.
Návraty
Nová instance Třídy TextRecognizer.
Metoda LanguageModel.CreateContext
public Microsoft.Windows.AI.Generative.LanguageModelContext CreateContext ();
Návraty
Poznámky
Metoda LanguageModel.CreateContext(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public Microsoft.Windows.AI.Generative.LanguageModelContext CreateContext (string systemPrompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametry
systemPrompt
Možnosti filtru obsahu
Návraty
Poznámky
Metoda LanguageModel.GenerateEmbeddingVector(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametry
výzva
Možnosti filtru obsahu
Návraty
Poznámky
Metoda LanguageModel.GenerateEmbeddingVector(System.String)
public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt);
Parametry
výzva
Návraty
Poznámky
LanguageModel.GenerateEmbeddingVectorAsync(System.String) – metoda
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt);
Parametry
výzva
Návraty
Poznámky
Metoda LanguageModel.GenerateEmbeddingVectorAsync(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametry
výzva
Možnosti filtru obsahu
Návraty
Poznámky
LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions): metoda
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametry
možnosti
výzva
Možnosti filtru obsahu
Návraty
Poznámky
Metoda LanguageModel.GenerateResponseAsync(System.String)
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (string prompt);
Vygeneruje a vrátí úplnou odpověď na jednu výzvu.
Parametry
výzva
Výzva ve formě otázky
Návraty
Řetězec odpovědi a stav.
Výjimky
ArgumentException: Zadaný dotaz je delší než maximální počet tokenů, které může model přijmout.
LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext)
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);
Parametry
možnosti
výzva
Možnosti filtru obsahu
kontext
Návraty
Poznámky
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);
Parametry
možnosti
výzva
Návraty
Poznámky
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);
Parametry
možnosti
promptEmbedding
Možnosti filtru obsahu
kontext
Návraty
Poznámky
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);
Parametry
možnosti
promptEmbedding
Možnosti filtru obsahu
Návraty
Poznámky
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);
Parametry
promptEmbedding
Návraty
Poznámky
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);
Parametry
možnosti
promptEmbedding
Návraty
LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64}) metoda
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromTokensWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<long> promptTokens);
Parametry
možnosti
promptTokens
Návraty
LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions, Windows.Foundation.Collections.IVectorView{System.Int64}, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext) metoda
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);
Parametry
možnosti
promptTokens
Možnosti filtru obsahu
kontext
Návraty
LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions) metoda
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);
Parametry
možnosti
promptTokens
Možnosti filtru obsahu
Návraty
LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions) metoda
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);
Parametry
možnosti
výzva
Možnosti filtru obsahu
Návraty
Metoda LanguageModel.GenerateResponseWithProgressAsync(System.String)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (string prompt);
Parametry
výzva
Návraty
LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String) metoda
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt);
Parametry
možnosti
výzva
Návraty
LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext) method
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);
Parametry
možnosti
výzva
Možnosti filtru obsahu
kontext
Návraty
Metoda LanguageModel.GenerateTokens(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public System.Collections.Generic.IReadOnlyList<long> GenerateTokens (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametry
Text
Možnosti filtru obsahu
Návraty
Metoda LanguageModel.GenerateTokens(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)
public System.Collections.Generic.IReadOnlyList<long> GenerateTokens (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parametry
Text
Možnosti filtru obsahu
Návraty
Metoda LanguageModel.GenerateTokensAsync(System.String)
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<long>> GenerateTokensAsync (string text);
Parametry
Text
Návraty
Metoda 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);
Parametry
Text
Možnosti filtru obsahu
Návraty
Metoda LanguageModel.IsAvailable
public static bool IsAvailable ();
Návraty
Metoda LanguageModel.IsPromptLargerThanContext(Microsoft.Windows.AI.Generative.LanguageModelContext,System.String)
public bool IsPromptLargerThanContext (Microsoft.Windows.AI.Generative.LanguageModelContext context, string prompt);
Parametry
kontext
výzva
Návraty
Metoda LanguageModel.IsPromptLargerThanContext(System.String)
public bool IsPromptLargerThanContext (string prompt);
Parametry
výzva
Návraty
Metoda LanguageModel.MakeAvailableAsync
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
Návraty
LanguageModelContext – třída
public sealed class LanguageModelContext
Třída 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);
Parametry
dovednost
temp
top_p
top_k
LanguageModelOptions.Skill – vlastnost
public Microsoft.Windows.AI.Generative.LanguageModelSkill Skill { get; set; }
Hodnota vlastnosti
LanguageModelOptions.Temp – vlastnost
public float Temp { get; set; }
Hodnota vlastnosti
vlastnost Top_k v LanguageModelOptions
public uint Top_k { get; set; }
Hodnota vlastnosti
vlastnost LanguageModelOptions.Top_p
public float Top_p { get; set; }
Hodnota vlastnosti
Třída LanguageModelResponse
public sealed class LanguageModelResponse
LanguageModelResponse.#ctor(System.String,Microsoft.Windows.AI.Generative.LanguageModelResponseStatus) – konstruktor
public LanguageModelResponse (string response, Microsoft.Windows.AI.Generative.LanguageModelResponseStatus status);
Parametry
odpověď
stav
LanguageModelResponse.Response – vlastnost
public string Response { get; }
Hodnota vlastnosti
LanguageModelResponse.Status – vlastnost
public Microsoft.Windows.AI.Generative.LanguageModelResponseStatus Status { get; }
Hodnota vlastnosti
LanguageModelResponseStatus – výčet
public enum LanguageModelResponseStatus
Pole
Dokončeno: 0
InProgress: 1
BlokovánoPolitikou: 2
PromptLargerThanContext: 3
Výzva zablokována zásadou: 4
OdpověďZablokovánaPolitikou: 5
LanguageModelSkill – výčet
public enum LanguageModelSkill