Szerkesztés

Megosztás a következőn keresztül:

API ref for Phi Silica APIs in the Windows App SDK

  • Cikk

Learn about the new Artificial Intelligence (AI) Phi Silica APIs that will ship with the Windows App SDK and can be used to access on-device language models (including Phi Silica, our most powerful NPU-tuned local language model yet) for local processing and generation of chat, math solving, code generation, reasoning over text, and more.

For more details, see Phi Silica in the Windows App SDK.

Important

The Windows App SDK experimental channel includes APIs and features in early stages of development. All APIs in the experimental channel are subject to extensive revisions and breaking changes and may be removed from subsequent releases at any time. They are not supported for use in production environments, and apps that use experimental features cannot be published to the Microsoft Store.

Microsoft.Windows.AI.Generative namespace

Provides APIs for local, on-device generative AI prompt processing and responses.

Microsoft.Windows.AI.Generative.LanguageModel class

public sealed class LanguageModel : System.IDisposable

Represents an object that can interact with a local language model to generate responses for a provided prompt.

Microsoft.Windows.AI.Generative.LanguageModel.Close method

Disposes of the object and associated resources.

Remarks

Not implemented in C#.

Microsoft.Windows.AI.Generative.LanguageModel.CreateAsync method

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

Asynchronously creates a new instance of the LanguageModel class.

Returns

A new instance of the TextRecognizer class.

Microsoft.Windows.AI.Generative.LanguageModel.GenerateResponseAsync(System.String) method

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

Generates and returns a complete response for a single prompt.

Parameters
prompt

A prompt in the form of a question.

Returns

A response string and status.

Exceptions

ArgumentException: The specified prompt is longer than the maximum number of tokens the model can accept.

Microsoft.Windows.AI.Generative.LanguageModel.GenerateResponseWithProgressAsync(System.String) method

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

Generates and streams a response through a progress handler. Partial results can be retrieved while generation is in progress.

Parameters
prompt

The prompt for the response.

Returns

A response string and status.

The next token of the string that is being added to the full response as the model returns it, this is the delta from the previous LanguageModelReponse set as the result OnProgress.

Exceptions

ArgumentException: The specified prompt is longer than the maximum number of tokens the model can accept.

Remarks

OnProgress events occur on generation of each single word in the response.

Microsoft.Windows.AI.Generative.LanguageModel.IsAvailable method

public static bool IsAvailable ();

Retrieves whether the required AI Model is available.

Returns

True, if required AI Model is available. Otherwise, false.

Microsoft.Windows.AI.Generative.LanguageModel.MakeAvailableAsync method

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

Ensures the underlying language model is installed and available for use.

Returns

An asynchronous action with progress that returns a PackageDeploymentResult on completion.

Microsoft.Windows.AI.Generative.LanguageModelResponse class

public sealed class LanguageModelResponse

Represents a response string and status.

Microsoft.Windows.AI.Generative.LanguageModelResponse.Response property

public string Response { get; }

Gets the response string returned by the language model based on the provided prompt.

Property value

The response string returned by the language model based on the provided prompt.

Microsoft.Windows.AI.Generative.LanguageModelResponse.Status property

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

Gets the response status based on the provided prompt.

Property value

The response string returned by the language model based on the provided prompt.

Remarks

Any value other than Succeeded or InProgress is considered a failure.

Microsoft.Windows.AI.Generative.LanguageModelResponseStatus enum

public enum LanguageModelResponseStatus

Specifies the possible response status values for the provided prompt.

Enum fields

Complete: 0

Response is complete.

InProgress: 1

Response is in progress.

BlockedByPolicy: 2

Response is blocked by a policy setting.

Related content