Skip to content

Latest commit

 

History

History
219 lines (128 loc) · 5.79 KB

File metadata and controls

219 lines (128 loc) · 5.79 KB

Model

Namespace: Microsoft.AI.Foundry.Local

public class Model : IModel

Inheritance ObjectModel
Implements IModel
Attributes NullableContextAttribute, NullableAttribute

Properties

Variants

public IReadOnlyList<IModel> Variants { get; }

Property Value

IReadOnlyList<IModel>

Alias

public string Alias { get; set; }

Property Value

String

Id

public string Id { get; }

Property Value

String

Info

public ModelInfo Info { get; }

Property Value

ModelInfo

Methods

IsCachedAsync(Nullable<CancellationToken>)

Is the currently selected variant cached locally?

public Task<bool> IsCachedAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task<Boolean>

IsLoadedAsync(Nullable<CancellationToken>)

Is the currently selected variant loaded in memory?

public Task<bool> IsLoadedAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task<Boolean>

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

Task<String>

DownloadAsync(Action<Single>, Nullable<CancellationToken>)

public Task DownloadAsync(Action<float> downloadProgress, Nullable<CancellationToken> ct)

Parameters

downloadProgress Action<Single>

ct Nullable<CancellationToken>

Returns

Task

LoadAsync(Nullable<CancellationToken>)

public Task LoadAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task

GetChatClientAsync(Nullable<CancellationToken>)

public Task<OpenAIChatClient> GetChatClientAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task<OpenAIChatClient>

GetAudioClientAsync(Nullable<CancellationToken>)

public Task<OpenAIAudioClient> GetAudioClientAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task<OpenAIAudioClient>

GetEmbeddingClientAsync(Nullable<CancellationToken>)

public Task<OpenAIEmbeddingClient> GetEmbeddingClientAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task<OpenAIEmbeddingClient>

UnloadAsync(Nullable<CancellationToken>)

public Task UnloadAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task

RemoveFromCacheAsync(Nullable<CancellationToken>)

public Task RemoveFromCacheAsync(Nullable<CancellationToken> ct)

Parameters

ct Nullable<CancellationToken>

Returns

Task