Windows 應用程式 SDK 中 Phi Silica API 的 API 參考
瞭解將隨附於 Windows 應用程式 SDK 的新人工智慧(AI)Phi矽 API,並可用於存取裝置上的語言模型(包括 Phi 二氧化膠,我們最強大的 NPU 微調本地語言模型),以便進行本機處理和產生聊天、數學解決、程式代碼產生、推論文字等等。
如需詳細資訊,請參閱 Windows 應用程式 SDK 中的 Phi 矽。
重要
Windows 應用程式 SDK 實驗通道包含開發初期的 API 和功能。 實驗通道中的所有 API 都受限於廣泛的修訂和中斷性變更,而且可以隨時從後續版本中移除。 不支援在生產環境中使用,且使用實驗性功能的應用程式無法發佈至 Microsoft 市集。
Microsoft.Windows.AI.Generative 命名空間
提供本機、裝置上產生的 AI 提示處理和回應的 API。
Microsoft.Windows.AI.Generative.LanguageModel 類別
public sealed class LanguageModel : System.IDisposable
表示可以與本機語言模型互動的物件,以產生所提供提示的回應。
Microsoft.Windows.AI.Generative.LanguageModel.Close 方法
處置 對象和相關聯的資源。
備註
未在 C# 中實作。
Microsoft.Windows.AI.Generative.LanguageModel.CreateAsync 方法
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModel> CreateAsync ();
以異步方式建立 LanguageModel 類別的新實例。
傳回
TextRecognizer 類別的新實例。
Microsoft.Windows.AI.Generative.LanguageModel.GenerateResponseAsync(System.String) 方法
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (string prompt);
產生並傳回單一提示的完整回應。
參數
prompt
以問題形式出現提示。
傳回
回應字串和狀態。
例外狀況
ArgumentException:指定的提示時間超過模型可接受的令牌數目上限。
Microsoft.Windows.AI.Generative.LanguageModel.GenerateResponseWithProgressAsync(System.String) 方法
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,
string> GenerateResponseWithProgressAsync (string prompt);
透過進度處理程式產生並串流回應。 產生正在進行時,可以擷取部分結果。
參數
prompt
回應的提示。
傳回
回應字串和狀態。
當模型傳回時,要新增至完整回應的字串下一個標記,這是上一個 LanguageModelReponse 設定為結果 OnProgress 的差異。
例外狀況
ArgumentException:指定的提示時間超過模型可接受的令牌數目上限。
備註
OnProgress 事件會在響應中產生每個單一單字時發生。
Microsoft.Windows.AI.Generative.LanguageModel.IsAvailable 方法
public static bool IsAvailable ();
擷取所需的 AI 模型是否可用。
傳回
True 是表示 如果需要的 AI 模型可供使用。 否則為 false。
Microsoft.Windows.AI.Generative.LanguageModel.MakeAvailableAsync 方法
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,
Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
確定已安裝基礎語言模型並可供使用。
傳回
異步動作,其進度會在完成時傳 回 PackageDeploymentResult 。
Microsoft.Windows.AI.Generative.LanguageModelResponse 類別
public sealed class LanguageModelResponse
表示回應字串和狀態。
Microsoft.Windows.AI.Generative.LanguageModelResponse.Response 属性
public string Response { get; }
根據提供的提示,取得語言模型所傳回的回應字串。
屬性值
根據提供的提示,語言模型傳回的回應字串。
Microsoft.Windows.AI.Generative.LanguageModelResponse.Status 属性
public Microsoft.Windows.AI.Generative.LanguageModelResponseStatus Status { get; }
根據提供的提示取得響應狀態。
屬性值
根據提供的提示,語言模型傳回的回應字串。
備註
或 InProgress
以外的Succeeded
任何值都會被視為失敗。
Microsoft.Windows.AI.Generative.LanguageModelResponseStatus 列舉
public enum LanguageModelResponseStatus
指定所提供提示的可能響應狀態值。
列舉欄位
完成:0
回應已完成。
InProgress: 1
回應正在進行中。
BlockedByPolicy:2
原則設定會封鎖回應。