Skip to content

Commit 4942e02

Browse files
Copilotbaijumeswani
andcommitted
Update C# API docs to reflect IModel changes: ICatalog returns IModel, Model uses IModel variants
Agent-Logs-Url: https://github.com/microsoft/Foundry-Local/sessions/8082508c-1338-48b2-bdd3-6c2c8e35e195 Co-authored-by: baijumeswani <12852605+baijumeswani@users.noreply.github.com>
1 parent 97bee1e commit 4942e02

4 files changed

Lines changed: 96 additions & 46 deletions

sdk/cs/docs/api/microsoft.ai.foundry.local.icatalog.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public abstract string Name { get; }
2929
List the available models in the catalog.
3030

3131
```csharp
32-
Task<List<Model>> ListModelsAsync(Nullable<CancellationToken> ct)
32+
Task<List<IModel>> ListModelsAsync(Nullable<CancellationToken> ct)
3333
```
3434

3535
#### Parameters
@@ -39,15 +39,15 @@ Optional CancellationToken.
3939

4040
#### Returns
4141

42-
[Task&lt;List&lt;Model&gt;&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
43-
List of Model instances.
42+
[Task&lt;List&lt;IModel&gt;&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
43+
List of IModel instances.
4444

4545
### **GetModelAsync(String, Nullable&lt;CancellationToken&gt;)**
4646

4747
Lookup a model by its alias.
4848

4949
```csharp
50-
Task<Model> GetModelAsync(string modelAlias, Nullable<CancellationToken> ct)
50+
Task<IModel> GetModelAsync(string modelAlias, Nullable<CancellationToken> ct)
5151
```
5252

5353
#### Parameters
@@ -60,15 +60,15 @@ Optional CancellationToken.
6060

6161
#### Returns
6262

63-
[Task&lt;Model&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
64-
The matching Model, or null if no model with the given alias exists.
63+
[Task&lt;IModel&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
64+
The matching IModel, or null if no model with the given alias exists.
6565

6666
### **GetModelVariantAsync(String, Nullable&lt;CancellationToken&gt;)**
6767

6868
Lookup a model variant by its unique model id.
6969

7070
```csharp
71-
Task<ModelVariant> GetModelVariantAsync(string modelId, Nullable<CancellationToken> ct)
71+
Task<IModel> GetModelVariantAsync(string modelId, Nullable<CancellationToken> ct)
7272
```
7373

7474
#### Parameters
@@ -81,15 +81,15 @@ Optional CancellationToken.
8181

8282
#### Returns
8383

84-
[Task&lt;ModelVariant&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
85-
The matching ModelVariant, or null if no variant with the given id exists.
84+
[Task&lt;IModel&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
85+
The matching IModel, or null if no variant with the given id exists.
8686

8787
### **GetCachedModelsAsync(Nullable&lt;CancellationToken&gt;)**
8888

8989
Get a list of currently downloaded models from the model cache.
9090

9191
```csharp
92-
Task<List<ModelVariant>> GetCachedModelsAsync(Nullable<CancellationToken> ct)
92+
Task<List<IModel>> GetCachedModelsAsync(Nullable<CancellationToken> ct)
9393
```
9494

9595
#### Parameters
@@ -99,15 +99,15 @@ Optional CancellationToken.
9999

100100
#### Returns
101101

102-
[Task&lt;List&lt;ModelVariant&gt;&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
103-
List of ModelVariant instances.
102+
[Task&lt;List&lt;IModel&gt;&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
103+
List of IModel instances.
104104

105105
### **GetLoadedModelsAsync(Nullable&lt;CancellationToken&gt;)**
106106

107107
Get a list of the currently loaded models.
108108

109109
```csharp
110-
Task<List<ModelVariant>> GetLoadedModelsAsync(Nullable<CancellationToken> ct)
110+
Task<List<IModel>> GetLoadedModelsAsync(Nullable<CancellationToken> ct)
111111
```
112112

113113
#### Parameters
@@ -117,5 +117,27 @@ Optional CancellationToken.
117117

118118
#### Returns
119119

120-
[Task&lt;List&lt;ModelVariant&gt;&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
121-
List of ModelVariant instances.
120+
[Task&lt;List&lt;IModel&gt;&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
121+
List of IModel instances.
122+
123+
### **GetLatestVersionAsync(IModel, Nullable&lt;CancellationToken&gt;)**
124+
125+
Get the latest version of a model.
126+
This is used to check if a newer version of a model is available in the catalog for download.
127+
128+
```csharp
129+
Task<IModel> GetLatestVersionAsync(IModel model, Nullable<CancellationToken> ct)
130+
```
131+
132+
#### Parameters
133+
134+
`model` [IModel](./microsoft.ai.foundry.local.imodel.md)<br>
135+
The model to check for the latest version.
136+
137+
`ct` [Nullable&lt;CancellationToken&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)<br>
138+
Optional CancellationToken.
139+
140+
#### Returns
141+
142+
[Task&lt;IModel&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
143+
The latest version of the model. Will match the input if it is the latest version.

sdk/cs/docs/api/microsoft.ai.foundry.local.imodel.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,42 @@ public abstract string Alias { get; }
3030

3131
[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
3232

33+
### **Info**
34+
35+
Full catalog metadata for this model or variant.
36+
37+
```csharp
38+
public abstract ModelInfo Info { get; }
39+
```
40+
41+
#### Property Value
42+
43+
[ModelInfo](./microsoft.ai.foundry.local.modelinfo.md)<br>
44+
45+
### **Variants**
46+
47+
Variants of the model that are available. Variants are optimized for different devices.
48+
49+
```csharp
50+
public abstract IReadOnlyList<IModel> Variants { get; }
51+
```
52+
53+
#### Property Value
54+
55+
[IReadOnlyList&lt;IModel&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlylist-1)<br>
56+
57+
### **SelectedVariant**
58+
59+
Currently selected model variant in use.
60+
61+
```csharp
62+
public abstract IModel SelectedVariant { get; }
63+
```
64+
65+
#### Property Value
66+
67+
[IModel](./microsoft.ai.foundry.local.imodel.md)<br>
68+
3369
## Methods
3470

3571
### **IsCachedAsync(Nullable&lt;CancellationToken&gt;)**
@@ -185,3 +221,16 @@ Optional cancellation token.
185221

186222
[Task&lt;OpenAIAudioClient&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
187223
OpenAI.AudioClient
224+
225+
### **SelectVariant(IModel)**
226+
227+
Select a specific model variant from Variants to use for IModel operations.
228+
229+
```csharp
230+
void SelectVariant(IModel variant)
231+
```
232+
233+
#### Parameters
234+
235+
`variant` [IModel](./microsoft.ai.foundry.local.imodel.md)<br>
236+
Model variant to select. Must be one of the variants in Variants.

sdk/cs/docs/api/microsoft.ai.foundry.local.model.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@ Attributes [NullableContextAttribute](https://docs.microsoft.com/en-us/dotnet/ap
1515
### **Variants**
1616

1717
```csharp
18-
public List<ModelVariant> Variants { get; internal set; }
18+
public IReadOnlyList<IModel> Variants { get; }
1919
```
2020

2121
#### Property Value
2222

23-
[List&lt;ModelVariant&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)<br>
23+
[IReadOnlyList&lt;IModel&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlylist-1)<br>
2424

2525
### **SelectedVariant**
2626

2727
```csharp
28-
public ModelVariant SelectedVariant { get; internal set; }
28+
public IModel SelectedVariant { get; internal set; }
2929
```
3030

3131
#### Property Value
3232

33-
[ModelVariant](./microsoft.ai.foundry.local.modelvariant.md)<br>
33+
[IModel](./microsoft.ai.foundry.local.imodel.md)<br>
3434

3535
### **Alias**
3636

@@ -86,47 +86,24 @@ public Task<bool> IsLoadedAsync(Nullable<CancellationToken> ct)
8686

8787
[Task&lt;Boolean&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
8888

89-
### **SelectVariant(ModelVariant)**
89+
### **SelectVariant(IModel)**
9090

9191
Select a specific model variant from [Model.Variants](./microsoft.ai.foundry.local.model.md#variants) to use for [IModel](./microsoft.ai.foundry.local.imodel.md) operations.
9292

9393
```csharp
94-
public void SelectVariant(ModelVariant variant)
94+
public void SelectVariant(IModel variant)
9595
```
9696

9797
#### Parameters
9898

99-
`variant` [ModelVariant](./microsoft.ai.foundry.local.modelvariant.md)<br>
99+
`variant` [IModel](./microsoft.ai.foundry.local.imodel.md)<br>
100100
Model variant to select. Must be one of the variants in [Model.Variants](./microsoft.ai.foundry.local.model.md#variants).
101101

102102
#### Exceptions
103103

104104
[FoundryLocalException](./microsoft.ai.foundry.local.foundrylocalexception.md)<br>
105105
If variant is not valid for this model.
106106

107-
### **GetLatestVersion(ModelVariant)**
108-
109-
Get the latest version of the specified model variant.
110-
111-
```csharp
112-
public ModelVariant GetLatestVersion(ModelVariant variant)
113-
```
114-
115-
#### Parameters
116-
117-
`variant` [ModelVariant](./microsoft.ai.foundry.local.modelvariant.md)<br>
118-
Model variant.
119-
120-
#### Returns
121-
122-
[ModelVariant](./microsoft.ai.foundry.local.modelvariant.md)<br>
123-
ModelVariant for latest version. Same as `variant` if that is the latest version.
124-
125-
#### Exceptions
126-
127-
[FoundryLocalException](./microsoft.ai.foundry.local.foundrylocalexception.md)<br>
128-
If variant is not valid for this model.
129-
130107
### **GetPathAsync(Nullable&lt;CancellationToken&gt;)**
131108

132109
```csharp

sdk/cs/docs/api/microsoft.ai.foundry.local.modelvariant.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
Namespace: Microsoft.AI.Foundry.Local
44

5+
> **Note:** `ModelVariant` is an internal implementation detail. Use [`IModel`](./microsoft.ai.foundry.local.imodel.md) in public API code.
6+
57
```csharp
6-
public class ModelVariant : IModel
8+
internal class ModelVariant : IModel
79
```
810

911
Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ModelVariant](./microsoft.ai.foundry.local.modelvariant.md)<br>

0 commit comments

Comments
 (0)