Partilhar via

API ref para Phi Silica no SDK do Aplicativo Windows

  • Artigo

Importante

Disponível no canal experimental mais recente versão do SDK de Aplicativos Windows.

O canal experimental do SDK de Aplicativos Windows inclui APIs e recursos em estágios iniciais de desenvolvimento. Todas as APIs no canal experimental estão sujeitas a extensas revisões e alterações disruptivas, podendo ser removidas de versões subsequentes a qualquer momento. Os recursos experimentais não são suportados para uso em ambientes de produção e os aplicativos que os usam não podem ser publicados na Microsoft Store.

  • Phi Silica não está disponível na China continental.
  • Não há suporte para aplicativos autônomos.

Saiba mais sobre as APIs SDK de Aplicativos Windows que podem acessar modelos de idioma local, como o Phi Silica, o modelo de idioma local ajustado para NPU mais poderoso da Microsoft que permite o processamento no dispositivo e a geração de bate-papo, raciocínio sobre texto, resolução de matemática, geração de código e muito mais.

Para obter mais detalhes, consulte Introdução ao Phi Silica no Windows App SDK.

Dica

Forneça feedback sobre estas APIs e a sua funcionalidade criando um novo problema no repositório GitHub do SDK de Aplicações Windows (inclua Phi Silica no título) ou respondendo a um problema existente.

Namespace Microsoft.Windows.AI.Generative

Fornece APIs para processamento de prompts de IA generativa e respostas localmente no dispositivo.

Classe ImageDescriptionGenerator

public sealed class ImageDescriptionGenerator : System.IDisposable

Método ImageDescriptionGenerator.Close

// This member is not implemented in C#
Comentários

Não implementado em C#.

Método ImageDescriptionGenerator.CreateAsync

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

Método ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer)

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

Advertência

Ao chamar ImageDescriptionGenerator.DescribeAsync() numa imagem, às vezes ocorre um erro. Este erro pode ser ignorado, permitindo que o depurador continue e gere a saída correta. O erro só é visível no ambiente do desenvolvedor, não para os usuários finais (clientes que usam seu aplicativo). Usar compilações de depuração ou versão acionará esse erro. O erro aparece intermitentemente e não em todas as iterações.

Método ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer,Microsoft.Windows.AI.Generative.ImageDescriptionScenario)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Graphics.Imaging.ImageBuffer image, Microsoft.Windows.AI.Generative.ImageDescriptionScenario scenario);
Parâmetros
imagem
cenário
Devoluções
Comentários

Método ImageDescriptionGenerator.DescribeAsync(Microsoft.Graphics.Imaging.ImageBuffer,Microsoft.Windows.AI.Generative.ImageDescriptionScenario,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> DescribeAsync (Microsoft.Graphics.Imaging.ImageBuffer image, Microsoft.Windows.AI.Generative.ImageDescriptionScenario scenario, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
imagem
cenário
opções de filtragem de conteúdo
Devoluções
Comentários

Método ImageDescriptionGenerator.IsAvailable

public static bool IsAvailable ();

Método ImageDescriptionGenerator.MakeAvailableAsync

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

Enumerador de Descrição de Imagem Cenário

public enum ImageDescriptionScenario

Campos

Acessibilidade: 1
Legenda: 2
Narração detalhada: 3
Gráficos do Office: 4

Classe ImageLLMAdapterCreator

public sealed class ImageLLMAdapterCreator : System.IDisposable

Método ImageLLMAdapterCreator.Close

// This member is not implemented in C#
Comentários

Não implementado em C#.

Método ImageLLMAdapterCreator.CreateAsync

public static Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.ImageLLMAdapterCreator> CreateAsync ();
Devoluções

Método ImageLLMAdapterCreator.GetImageLLMEmbeddings(Microsoft.Windows.SemanticSearch.EmbeddingVector)

public System.Collections.Generic.IReadOnlyList<float> GetImageLLMEmbeddings (Microsoft.Windows.SemanticSearch.EmbeddingVector embeddings);
Parâmetros
incorporações
Devoluções

Método ImageLLMAdapterCreator.GetImageLLMEmbeddingsAsync(Microsoft.Windows.SemanticSearch.EmbeddingVector)

public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<float>> GetImageLLMEmbeddingsAsync (Microsoft.Windows.SemanticSearch.EmbeddingVector embeddings);
Parâmetros
incorporações
Devoluções

Método ImageLLMAdapterCreator.GetModelInputSize

public uint GetModelInputSize ();
Devoluções

Método ImageLLMAdapterCreator.GetModelOutputSize

public uint GetModelOutputSize ();
Devoluções

Método ImageLLMAdapterCreator.IsAvailable

public static bool IsAvailable ();
Devoluções

Método ImageLLMAdapterCreator.MakeAvailableAsync

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

Classe ModeloDeLinguagem

public sealed class LanguageModel : System.IDisposable

Representa um objeto que pode interagir com um modelo de idioma local para gerar respostas para um prompt fornecido.

Método LanguageModel.Close

Elimina o objeto e os recursos associados.

Comentários

Não implementado em C#.

Método LanguageModel.CreateAsync

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

Cria de forma assíncrona uma nova instância da classe LanguageModel.

Devoluções

Uma nova instância da classe TextRecognizer.

Método LanguageModel.CreateContext

public Microsoft.Windows.AI.Generative.LanguageModelContext CreateContext ();
Devoluções
Comentários

Método LanguageModel.CreateContext(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public Microsoft.Windows.AI.Generative.LanguageModelContext CreateContext (string systemPrompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
sistemaPrompt
opções de filtragem de conteúdo
Devoluções
Comentários

Método LanguageModel.GenerateEmbeddingVector(System.String, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Sugestão
opções de filtragem de conteúdo
Devoluções
Comentários

Método LanguageModel.GenerateEmbeddingVector(System.String)

public System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector> GenerateEmbeddingVector (string prompt);
Parâmetros
Sugestão
Devoluções
Comentários

Método LanguageModel.GenerateEmbeddingVectorAsync(System.String)

public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt);
Parâmetros
Sugestão
Devoluções
Comentários

Método LanguageModel.GenerateEmbeddingVectorAsync(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Microsoft.Windows.SemanticSearch.EmbeddingVector>> GenerateEmbeddingVectorAsync (string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Sugestão
opções de filtragem de conteúdo
Devoluções
Comentários

Método LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Opções
Sugestão
opções de filtragem de conteúdo
Devoluções
Comentários

Método LanguageModel.GenerateResponseAsync(System.String)

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

Gera e retorna uma resposta completa para um único prompt.

Parâmetros
Sugestão

Um prompt na forma de uma pergunta.

Devoluções

Uma cadeia de caracteres e um status de resposta.

Exceções

ArgumentException: O prompt especificado é maior do que o número máximo de tokens que o modelo pode aceitar.

Método LanguageModel.GenerateResponseAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext)

public Windows.Foundation.IAsyncOperation<Microsoft.Windows.AI.Generative.LanguageModelResponse> GenerateResponseAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parâmetros
Opções
Sugestão
opções de filtragem de conteúdo
Contexto
Devoluções
Comentários

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);
Parâmetros
Opções
Sugestão
Devoluções
Comentários

Método LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext)

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.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parâmetros
Opções
promptIncorporação
opções de filtragem de conteúdo
Contexto
Devoluções
Comentários

Método LanguageModel.GenerateResponseFromEmbeddingsWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{Microsoft.Windows.SemanticSearch.EmbeddingVector},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

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.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Opções
promptIncorporação
opções de filtragem de conteúdo
Devoluções
Comentários

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);
Parâmetros
promptIncorporação
Devoluções
Comentários

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);
Parâmetros
Opções
promptIncorporação
Devoluções

Método LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64})

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromTokensWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<long> promptTokens);
Parâmetros
Opções
promptTokens
Devoluções

Método LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromTokensWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<long> promptTokens, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parâmetros
Opções
promptTokens
opções de filtragem de conteúdo
Contexto
Devoluções

Método LanguageModel.GenerateResponseFromTokensWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,Windows.Foundation.Collections.IVectorView{System.Int64},Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseFromTokensWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, System.Collections.Generic.IReadOnlyList<long> promptTokens, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Opções
promptTokens
opções de filtragem de conteúdo
Devoluções

Método LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Opções
Sugestão
opções de filtragem de conteúdo
Devoluções

Método LanguageModel.GenerateResponseWithProgressAsync(System.String)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (string prompt);
Parâmetros
Sugestão
Devoluções

Método LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt);
Parâmetros
Opções
Sugestão
Devoluções

Método LanguageModel.GenerateResponseWithProgressAsync(Microsoft.Windows.AI.Generative.LanguageModelOptions,System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions,Microsoft.Windows.AI.Generative.LanguageModelContext)

public Windows.Foundation.IAsyncOperationWithProgress<Microsoft.Windows.AI.Generative.LanguageModelResponse,string> GenerateResponseWithProgressAsync (Microsoft.Windows.AI.Generative.LanguageModelOptions options, string prompt, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions, Microsoft.Windows.AI.Generative.LanguageModelContext context);
Parâmetros
Opções
Sugestão
opções de filtragem de conteúdo
Contexto
Devoluções

Método LanguageModel.GenerateTokens(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public System.Collections.Generic.IReadOnlyList<long> GenerateTokens (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Texto
opções de filtragem de conteúdo
Devoluções

Método LanguageModel.GenerateTokens(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public System.Collections.Generic.IReadOnlyList<long> GenerateTokens (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Texto
opções de filtragem de conteúdo
Devoluções

Método LanguageModel.GenerateTokensAsync(System.String)

public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<long>> GenerateTokensAsync (string text);
Parâmetros
Texto
Devoluções

Método LanguageModel.GenerateTokensAsync(System.String,Microsoft.Windows.AI.ContentModeration.ContentFilterOptions)

public Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<long>> GenerateTokensAsync (string text, Microsoft.Windows.AI.ContentModeration.ContentFilterOptions contentFilterOptions);
Parâmetros
Texto
opções de filtragem de conteúdo
Devoluções

Método LanguageModel.IsAvailable

public static bool IsAvailable ();
Devoluções

Método LanguageModel.IsPromptLargerThanContext(Microsoft.Windows.AI.Generative.LanguageModelContext,System.String)

public bool IsPromptLargerThanContext (Microsoft.Windows.AI.Generative.LanguageModelContext context, string prompt);
Parâmetros
Contexto
Sugestão
Devoluções

Método LanguageModel.IsPromptLargerThanContext(System.String)

public bool IsPromptLargerThanContext (string prompt);
Parâmetros
Sugestão
Devoluções

Método LanguageModel.MakeAvailableAsync

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

Classe LanguageModelContext

public sealed class LanguageModelContext

Classe LanguageModelOptions

public sealed class LanguageModelOptions

Construtor LanguageModelOptions.#ctor

public LanguageModelOptions ();

Construtor de 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);
Parâmetros
competência
temp
top_p
top_k

Propriedade LanguageModelOptions.Skill

public Microsoft.Windows.AI.Generative.LanguageModelSkill Skill { get; set; }
Valor do imóvel

Propriedade LanguageModelOptions.Temp

public float Temp { get; set; }
Valor do imóvel

Propriedade LanguageModelOptions.Top_k

public uint Top_k { get; set; }
Valor do imóvel

Propriedade Top_p de LanguageModelOptions

public float Top_p { get; set; }
Valor do imóvel

Classe LanguageModelResponse

public sealed class LanguageModelResponse

Construtor LanguageModelResponse.#ctor(System.String,Microsoft.Windows.AI.Generative.LanguageModelResponseStatus)

public LanguageModelResponse (string response, Microsoft.Windows.AI.Generative.LanguageModelResponseStatus status);
Parâmetros
resposta
Situação

Propriedade LanguageModelResponse.Response

public string Response { get; }
Valor do imóvel

"Propriedade 'LanguageModelResponse.Status'"

public Microsoft.Windows.AI.Generative.LanguageModelResponseStatus Status { get; }
Valor do imóvel

Enumeração de Estado de Resposta do Modelo de Linguagem

public enum LanguageModelResponseStatus

Campos

Completo: 0
Em andamento: 1
BloqueadoPorPolítica: 2
PromptLargerThanContext: 3
PromptBloqueadoPorPolítica: 4
RespostaBloqueadaPorPolítica: 5

Enumeração de Habilidades do Modelo de Linguagem

public enum LanguageModelSkill

Campos

Geral: 0
TextToTable: 1
Resuma: 2
Reescrever: 3

Conteúdo relacionado