Model
April 22, 2026 · View on GitHub
Namespace: Microsoft.AI.Foundry.Local
public class Model : IModel
Inheritance Object → Model
Implements IModel
Attributes NullableContextAttribute, NullableAttribute
Properties
Variants
public IReadOnlyList<IModel> Variants { get; }
Property Value
Alias
public string Alias { get; set; }
Property Value
Id
public string Id { get; }
Property Value
Info
public ModelInfo Info { get; }
Property Value
Methods
IsCachedAsync(Nullable<CancellationToken>)
Is the currently selected variant cached locally?
public Task<bool> IsCachedAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
IsLoadedAsync(Nullable<CancellationToken>)
Is the currently selected variant loaded in memory?
public Task<bool> IsLoadedAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
SelectVariant(IModel)
Select a specific model variant from Model.Variants to use for IModel operations.
public void SelectVariant(IModel variant)
Parameters
variant IModel
Model variant to select. Must be one of the variants in Model.Variants.
Exceptions
FoundryLocalException
If variant is not valid for this model.
GetPathAsync(Nullable<CancellationToken>)
public Task<string> GetPathAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
DownloadAsync(Action<Single>, Nullable<CancellationToken>)
public Task DownloadAsync(Action<float> downloadProgress, Nullable<CancellationToken> ct)
Parameters
downloadProgress Action<Single>
ct Nullable<CancellationToken>
Returns
LoadAsync(Nullable<CancellationToken>)
public Task LoadAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
GetChatClientAsync(Nullable<CancellationToken>)
public Task<OpenAIChatClient> GetChatClientAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
GetAudioClientAsync(Nullable<CancellationToken>)
public Task<OpenAIAudioClient> GetAudioClientAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
GetEmbeddingClientAsync(Nullable<CancellationToken>)
public Task<OpenAIEmbeddingClient> GetEmbeddingClientAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
UnloadAsync(Nullable<CancellationToken>)
public Task UnloadAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>
Returns
RemoveFromCacheAsync(Nullable<CancellationToken>)
public Task RemoveFromCacheAsync(Nullable<CancellationToken> ct)
Parameters
ct Nullable<CancellationToken>