Api ref for PhiLice in the SDK de Aplicaciones para Windows
Importante
Esta característica aún no está disponible. Se espera que se envíe en una próxima versión experimental del canal de la SDK de Aplicaciones para Windows.
El canal experimental del SDK de Aplicaciones para Windows incluye API y características que se encuentran en las primeras fases del desarrollo. Todas las API del canal experimental están sujetas a revisiones exhaustivas y cambios importantes y se pueden eliminar de versiones posteriores en cualquier momento. No son compatibles para el uso en entornos de producción, y las aplicaciones que utilizan las características experimentales no se pueden publicar en Microsoft Store.
Obtenga información sobre las API de SDK de Aplicaciones para Windows que pueden acceder a modelos de lenguaje local como PhiLice, el modelo de lenguaje local más eficaz de NPU optimizado para NPU que permite el procesamiento en el dispositivo y la generación de chats, razonamiento sobre texto, resolución matemática, generación de código, etc.
Para obtener más información, consulte Introducción a PhiLice en la SDK de Aplicaciones para Windows.
Sugerencia
Proporcione comentarios sobre estas API y su funcionalidad mediante la creación de un nuevo problema en el repositorio de GitHub de SDK de Aplicaciones para Windows. (Asegúrese de incluir PhiLice en el título!)
Espacio de nombres Microsoft.Windows.AI.Generative
Proporcione API para el procesamiento local y en el dispositivo de consultas de IA generativa y las respuestas.
Clase ImageDescriptionGenerator
public sealed class ImageDescriptionGenerator : System.IDisposable
Método ImageDescriptionGenerator.Close
// This member is not implemented in C#
Método ImageDescriptionGenerator.CreateAsync
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageDescriptionGenerator> CreateAsync ();
Método ImageDescriptionGenerator.DescribeAsync(Microsoft.Windows.Imaging.ImageBuffer)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Windows.Imaging.ImageBuffer image);
Método ImageDescriptionGenerator.IsAvailable
public static bool IsAvailable ();
Método MakeAvailableAsync de ImageDescriptionGenerator
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
Clase LanguageModel
public sealed class LanguageModel : System.IDisposable
Representa un objeto que puede interactuar con un modelo de lenguaje local para generar respuestas para un mensaje proporcionado.
Método LanguageModel.Close
Elimina el objeto y los recursos asociados.
Comentarios
No se implementa en C#.
Método LanguageModel.CreateAsync
public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModel> CreateAsync ();
Crea de forma asíncrona una nueva instancia de la clase LanguageModel.
Devoluciones
Nueva instancia de la clase TextRecognizer.
Método LanguageModel.GenerateEmbeddingVector(System.String)
public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt);
Método LanguageModel.GenerateEmbeddingVectorAsync(System.String)
public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt);
Método LanguageModel.GenerateResponseAsync(System.String)
public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (string prompt);
Genera y devuelve una respuesta completa para una consulta única.
Parámetros
símbolo del sistema
Una consulta en forma de pregunta.
Devoluciones
Una cadena de respuesta y estado.
Excepciones
ArgumentException: la consulta especificada es mayor que el número máximo de tokens que puede aceptar el modelo.
Método 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);
Método 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);
Método 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);
Método LanguageModel.GenerateResponseWithProgressAsync(System.String)
public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,
string> GenerateResponseWithProgressAsync (string prompt);
Genera y transmite una respuesta a través de un controlador de progreso. Los resultados parciales se pueden recuperar mientras la generación está en curso.
Parámetros
símbolo del sistema
La consulta de la respuesta.
Devoluciones
Una cadena de respuesta y estado.
El siguiente token de la cadena que se va a añadir a la respuesta completa a medida que el modelo lo devuelve, es la diferencia del conjunto LanguageModelReponse anterior como resultado OnProgress.
Excepciones
ArgumentException: la consulta especificada es mayor que el número máximo de tokens que puede aceptar el modelo.
Comentarios
Los eventos OnProgress se producen en la generación de cada palabra en la respuesta.
Método LanguageModel.IsAvailable
public static bool IsAvailable ();
Recupera si el modelo de IA necesario está disponible.
Devoluciones
True, si es necesario que el modelo de IA esté disponible. De lo contrario, se devuelve el valor False.
Método LanguageModel.IsPromptLargerThanContext(System.String)
public bool IsPromptLargerThanContext (string prompt);
Método MakeAvailableAsync de LanguageModel
public static Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.Management.Deployment.PackageDeploymentResult,
Microsoft.Windows.Management.Deployment.PackageDeploymentProgress> MakeAvailableAsync ();
Garantiza que el modelo de lenguaje subyacente está instalado y disponible para su uso.
Devoluciones
Acción asincrónica con progreso que devuelve un elemento PackageDeploymentResult al finalizar.
Clase LanguageModelOptions
public sealed class LanguageModelOptions
Constructor LanguageModelOptions.#ctor
public LanguageModelOptions ();
Constructor 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);
Propiedad LanguageModelOptions.Skill
public Microsoft.Windows.AI.Generative.LanguageModelSkill Skill { get; set; }
Propiedad LanguageModelOptions.Temp
public float Temp { get; set; }
Propiedad LanguageModelOptions.Top_k
public uint Top_k { get; set; }
Propiedad LanguageModelOptions.Top_p
public float Top_p { get; set; }
Clase LanguageModelResponse
public sealed class LanguageModelResponse
Representa una cadena de respuesta y un estado.
Propiedad LanguageModelResponse.Response
public string Response { get; }
Obtiene la cadena de respuesta devuelta por el modelo de lenguaje en función de la consulta proporcionada.
Valor de propiedad
Cadena de respuesta devuelta por el modelo de lenguaje en función de la consulta proporcionada.
Propiedad LanguageModelResponse.Status
public Microsoft.Windows.AI.Generative.LanguageModelResponseStatus Status { get; }
Obtiene el estado de respuesta en función de la consulta proporcionada.
Valor de propiedad
Cadena de respuesta devuelta por el modelo de lenguaje en función de la consulta proporcionada.
Comentarios
Cualquier valor distinto de Succeeded o InProgress se considera un error.
Enumeración LanguageModelResponseStatus
public enum LanguageModelResponseStatus
Especifica los posibles valores de estado de respuesta para la consulta proporcionada.
Campos: sistema operativo
Complete: 0
La respuesta se ha completado.
InProgress: 1
La respuesta está en curso.
BlockedByPolicy: 2
Una configuración de directiva bloquea la respuesta.
PromptLargerThanContext: 3
Enumeración LanguageModelSkill
public enum LanguageModelSkill