Поделиться через


Ссылка на API для Phi Silica в пакете SDK для приложений Windows

Совет

Предоставьте отзыв об этих API и их функциональных возможностях, создав новую проблему в репозитории GitHub пакета SDK для приложений Windows. (Убедитесь, что вы включаете Phi Silica в название!)

Узнайте о API-интерфейсах пакета SDK для приложений Windows, которые могут получить доступ к локальным языковым моделям, таким как Phi Silica, самой мощной локальной языковой модели Корпорации Майкрософт, которая обеспечивает обработку и создание чата на устройстве, анализ текста, математические решения, создание кода и многое другое.

Дополнительные сведения см. в статье "Начало работы с Phi Silica" в пакете SDK для приложений Windows.

Внимание

Эта функция пока недоступна. Ожидается, что он будет отправлен в предстоящем экспериментальном выпуске пакета SDK для приложений Windows.

Экспериментальный канал пакета SDK для приложений Windows включает API и функции на ранних этапах разработки. Все API-интерфейсы в экспериментальном канале подвергаются обширным исправлениям и критическим изменениям и могут быть удалены из последующих выпусков в любое время. Они не поддерживаются для использования в рабочих средах, а приложения, использующие экспериментальные функции, не могут быть опубликованы в Microsoft Store.


Пространство имен Microsoft.Windows.AI.Generative

Предоставляет API для локальной обработки и ответов, создаваемых с помощью искусственного интеллекта на устройстве.

Класс Microsoft.Windows.AI.Generative.ImageDescriptionGenerator

public sealed class ImageDescriptionGenerator : System.IDisposable

Метод Microsoft.Windows.AI.Generative.ImageDescriptionGenerator.Close

// This member is not implemented in C#

Метод Microsoft.Windows.AI.Generative.ImageDescriptionGenerator.CreateAsync

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

Метод Microsoft.Windows.AI.Generative.ImageDescriptionGenerator.DescribeAsync(Microsoft.Windows.Imaging.ImageBuffer)

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

Метод Microsoft.Windows.AI.Generative.ImageDescriptionGenerator.IsAvailable

public static bool IsAvailable ();

Метод Microsoft.Windows.AI.Generative.ImageDescriptionGenerator.MakeAvailableAsync

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

Класс 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.Generateive.LanguageModel.GenerateEmbeddingVector(System.String)

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

Метод Microsoft.Windows.AI.Generateive.LanguageModel.GenerateEmbeddingVectorAsync(System.String)

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

Метод Microsoft.Windows.AI.Generateive.LanguageModel.GenerateResponseAsync(System.String)

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

Создает и возвращает полный ответ для одного запроса.

Параметры
prompt

Запрос в виде вопроса.

Возвраты

Строка ответа и состояние.

Исключения

ArgumentException: указанная строка длиннее максимального числа маркеров, которые может принимать модель.

Метод Microsoft.Windows.AI.Generateive.LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generateive.LanguageModelOptions,System.String)

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

Метод Microsoft.Windows.AI.Generateive.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);

Метод Microsoft.Windows.AI.Generateive.LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generateive.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);

Метод Microsoft.Windows.AI.Generateive.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 ();

Извлекает, доступна ли требуемая модель ИИ.

Возвраты

Значение true, если требуется модель искусственного интеллекта. В противном случае — значение false.

Метод Microsoft.Windows.AI.Generative.LanguageModel.IsPromptLargerThanContext(System.String)

public bool IsPromptLargerThanContext (string prompt);

Метод 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.LanguageModelOptions

public sealed class LanguageModelOptions

Конструктор Microsoft.Windows.AI.Generative.LanguageModelOptions.#ctor

public LanguageModelOptions ();

Конструктор Microsoft.Windows.AI.Generative.LanguageModelOptions.#ctor(Microsoft.Windows.AI.Generative.LanguageModelSkill,System.Single,System.UInt32)

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

Свойство Microsoft.Windows.AI.Generative.LanguageModelOptions.Skill

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

Свойство Microsoft.Windows.AI.Generative.LanguageModelOptions.Temp

public float Temp { get; set; }

свойство Microsoft.Windows.AI.Generative.LanguageModelOptions.Top_k

public uint Top_k { get; set; }

свойство Microsoft.Windows.AI.Generative.LanguageModelOptions.Top_p

public float Top_p { get; set; }

Класс 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; }

Возвращает состояние ответа на основе предоставленного запроса.

Значение свойства

Строка ответа, возвращаемая языковой моделью на основе предоставленного запроса.

Замечания

Любое значение, отличное от Succeeded или InProgress считается сбоем.

Перечисление Microsoft.Windows.AI.Generative.LanguageModelResponseStatus

public enum LanguageModelResponseStatus

Указывает возможные значения состояния ответа для предоставленного запроса.

Поля перечисления

Завершено: 0

Ответ завершен.

InProgress: 1

Ответ выполняется.

BlockedByPolicy: 2

Ответ блокируется параметром политики.

PromptLargerThanContext: 3

Перечисление Microsoft.Windows.AI.Generative.LanguageModelSkill

public enum LanguageModelSkill

Поля перечисления

Общие: 0
TextToTable: 1