REF API untuk Phi Silica di SDK Aplikasi Windows

Penting

Fitur ini belum tersedia. Hal ini diharapkan untuk dikirim dalam rilis saluran eksperimental yang akan datang dari SDK Aplikasi Windows.

Saluran eksperimental SDK Aplikasi Windows mencakup API dan fitur pada tahap awal pengembangan. Semua API di saluran eksperimental tunduk pada revisi yang luas dan melanggar perubahan dan dapat dihapus dari rilis berikutnya kapan saja. Mereka tidak didukung untuk digunakan di lingkungan produksi, dan aplikasi yang menggunakan fitur eksperimental tidak dapat diterbitkan ke Microsoft Store.

Pelajari tentang API SDK Aplikasi Windows yang dapat mengakses model bahasa lokal seperti Phi Silica, model bahasa lokal microsoft yang paling kuat yang disetel NPU yang memungkinkan pemrosesan dan pembuatan obrolan di perangkat, penalaran atas teks, pemecahan matematika, pembuatan kode, dan banyak lagi.

Untuk detail selengkapnya, lihat Mulai menggunakan Phi Silica di SDK Aplikasi Windows.

Tip

Berikan umpan balik tentang API ini dan fungsionalitasnya dengan membuat Masalah baru di repositori GitHub SDK Aplikasi Windows. (Pastikan Anda menyertakan Phi Silica dalam judul!)


Namespace Microsoft.Windows.AI.Generative

Menyediakan API untuk pemrosesan dan respons permintaan AI generatif lokal di perangkat.

Kelas ImageDescriptionGenerator

public sealed class ImageDescriptionGenerator : System.IDisposable

Metode ImageDescriptionGenerator.Close

// This member is not implemented in C#

Metode PembuatDeskripsiGambar.CreateAsync

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

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

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

Metode ImageDescriptionGenerator.IsAvailable

public static bool IsAvailable ();

Metode ImageDescriptionGenerator.MakeAvailableAsync

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

Kelas LanguageModel

public sealed class LanguageModel : System.IDisposable

Mewakili objek yang dapat berinteraksi dengan model bahasa lokal untuk menghasilkan respons untuk permintaan yang disediakan.

Metode Close pada LanguageModel

Membuang objek dan sumber daya terkait.

Keterangan

Tidak diimplementasikan dalam C#.

Metode LanguageModel.CreateAsync

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

Secara asinkron membuat instans baru kelas LanguageModel.

Mengembalikan

Instans baru kelas TextRecognizer.

Metode LanguageModel.GenerateEmbeddingVector(System.String)

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

Metode LanguageModel.GenerateEmbeddingVectorAsync(System.String)

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

Metode LanguageModel.GenerateResponseAsync(System.String)

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

Menghasilkan dan mengembalikan respons lengkap untuk satu perintah.

Parameter
perintah

Permintaan dalam bentuk pertanyaan.

Mengembalikan

String dan status respons.

Pengecualian

ArgumentException: Perintah yang ditentukan lebih panjang dari jumlah maksimum token yang dapat diterima model.

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

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

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}) metode

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

Metode dari LanguageModel.GenerateResponseWithProgressAsync(System.String)

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

Menghasilkan dan mengalirkan respons melalui handler kemajuan. Hasil parsial dapat diambil saat pembuatan sedang berlangsung.

Parameter
perintah

Perintah untuk respons.

Mengembalikan

String dan status respons.

Token berikutnya dari string yang ditambahkan ke respons penuh saat model mengembalikannya, ini adalah delta dari languageModelReponse sebelumnya yang ditetapkan sebagai hasil OnProgress.

Pengecualian

ArgumentException: Perintah yang ditentukan lebih panjang dari jumlah maksimum token yang dapat diterima model.

Keterangan

Peristiwa OnProgress terjadi pada pembuatan setiap kata tunggal dalam respons.

Metode LanguageModel.IsAvailable

public static bool IsAvailable ();

Mengambil apakah Model AI yang diperlukan tersedia.

Mengembalikan

Benar, jika Model AI yang diperlukan tersedia. Jika tidak, salah.

Metode LanguageModel.IsPromptLargerThanContext(System.String)

public bool IsPromptLargerThanContext (string prompt);

Metode LanguageModel.MakeAvailableAsync

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

Memastikan model bahasa yang mendasar diinstal dan tersedia untuk digunakan.

Mengembalikan

Tindakan asinkron dengan kemajuan yang mengembalikan PackageDeploymentResult setelah selesai.

Kelas LanguageModelOptions

public sealed class LanguageModelOptions

Konstruktor LanguageModelOptions.#ctor

public LanguageModelOptions ();

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

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

Properti LanguageModelOptions.Skill

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

Properti LanguageModelOptions.Temp

public float Temp { get; set; }

properti LanguageModelOptions.Top_k

public uint Top_k { get; set; }

properti LanguageModelOptions.Top_p

public float Top_p { get; set; }

Kelas LanguageModelResponse

public sealed class LanguageModelResponse

Mewakili string respons dan status.

Properti Respons dari LanguageModelResponse

public string Response { get; }

Mendapatkan string respons yang dikembalikan oleh model bahasa berdasarkan perintah yang disediakan.

Nilai properti

String respons yang dikembalikan oleh model bahasa berdasarkan perintah yang disediakan.

Properti Status dari LanguageModelResponse

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

Mendapatkan status respons berdasarkan perintah yang disediakan.

Nilai properti

String respons yang dikembalikan oleh model bahasa berdasarkan perintah yang disediakan.

Keterangan

Nilai apa pun selain Succeeded atau InProgress dianggap gagal.

Enum LanguageModelResponseStatus

public enum LanguageModelResponseStatus

Menentukan kemungkinan nilai status respons untuk perintah yang disediakan.

Bidang - OS

Selesai: 0

Respons selesai.

InProgress: 1

Respons sedang berlangsung.

BlockedByPolicy: 2

Respons diblokir oleh pengaturan kebijakan.

PromptLargerThanContext: 3

Enum KeterampilanModelBahasa

public enum LanguageModelSkill

Bidang

Umum: 0
TextToTable: 1