Skip to content

Commit 94a6aa0

Browse files
bmehta001Copilot
bmehta001
and
Copilot
committed
Clean up generated C# docs: remove inherited-member noise
- Strip compiler-generated record members (EqualityContract, Clone, PrintMembers, copy ctor) from EpInfo and EpDownloadResult docs. - Reset docs for types we didn't change (ModelSettings, Parameter, Runtime, PromptTemplate, Model, ModelInfo, IModel, AudioClient, ChatClient, FoundryLocalException) to origin/main versions. - Remove docs for types that never had docs on main and aren't part of this PR (LiveAudioTranscriptionResponse/Session, ResponseFormat). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent e4c639d commit 94a6aa0

15 files changed

+39
-902
lines changed

‎sdk/cs/docs/api/microsoft.ai.foundry.local.epdownloadresult.md‎

Lines changed: 1 addition & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,11 @@ Namespace: Microsoft.AI.Foundry.Local
55
Result of an explicit EP download and registration operation.
66

77
```csharp
8-
public class EpDownloadResult : System.IEquatable`1[[Microsoft.AI.Foundry.Local.EpDownloadResult, Microsoft.AI.Foundry.Local, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
8+
public record EpDownloadResult
99
```
1010

11-
Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EpDownloadResult](./microsoft.ai.foundry.local.epdownloadresult.md)<br>
12-
Implements [IEquatable&lt;EpDownloadResult&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.iequatable-1)<br>
13-
Attributes [NullableContextAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.nullablecontextattribute), [NullableAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.nullableattribute), [RequiredMemberAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.requiredmemberattribute)
14-
1511
## Properties
1612

17-
### **EqualityContract**
18-
19-
```csharp
20-
protected Type EqualityContract { get; }
21-
```
22-
23-
#### Property Value
24-
25-
[Type](https://docs.microsoft.com/en-us/dotnet/api/system.type)<br>
26-
2713
### **Success**
2814

2915
True if all requested EPs were successfully downloaded and registered.
@@ -71,101 +57,3 @@ public String[] FailedEps { get; set; }
7157
#### Property Value
7258

7359
[String[]](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
74-
75-
## Constructors
76-
77-
### **EpDownloadResult(EpDownloadResult)**
78-
79-
```csharp
80-
protected EpDownloadResult(EpDownloadResult original)
81-
```
82-
83-
#### Parameters
84-
85-
`original` [EpDownloadResult](./microsoft.ai.foundry.local.epdownloadresult.md)<br>
86-
87-
### **EpDownloadResult()**
88-
89-
#### Caution
90-
91-
Constructors of types with required members are not supported in this version of your compiler.
92-
93-
---
94-
95-
```csharp
96-
public EpDownloadResult()
97-
```
98-
99-
## Methods
100-
101-
### **ToString()**
102-
103-
```csharp
104-
public string ToString()
105-
```
106-
107-
#### Returns
108-
109-
[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
110-
111-
### **PrintMembers(StringBuilder)**
112-
113-
```csharp
114-
protected bool PrintMembers(StringBuilder builder)
115-
```
116-
117-
#### Parameters
118-
119-
`builder` [StringBuilder](https://docs.microsoft.com/en-us/dotnet/api/system.text.stringbuilder)<br>
120-
121-
#### Returns
122-
123-
[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
124-
125-
### **GetHashCode()**
126-
127-
```csharp
128-
public int GetHashCode()
129-
```
130-
131-
#### Returns
132-
133-
[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)<br>
134-
135-
### **Equals(Object)**
136-
137-
```csharp
138-
public bool Equals(object obj)
139-
```
140-
141-
#### Parameters
142-
143-
`obj` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)<br>
144-
145-
#### Returns
146-
147-
[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
148-
149-
### **Equals(EpDownloadResult)**
150-
151-
```csharp
152-
public bool Equals(EpDownloadResult other)
153-
```
154-
155-
#### Parameters
156-
157-
`other` [EpDownloadResult](./microsoft.ai.foundry.local.epdownloadresult.md)<br>
158-
159-
#### Returns
160-
161-
[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
162-
163-
### **&lt;Clone&gt;$()**
164-
165-
```csharp
166-
public EpDownloadResult <Clone>$()
167-
```
168-
169-
#### Returns
170-
171-
[EpDownloadResult](./microsoft.ai.foundry.local.epdownloadresult.md)<br>

‎sdk/cs/docs/api/microsoft.ai.foundry.local.epinfo.md‎

Lines changed: 1 addition & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,11 @@ Namespace: Microsoft.AI.Foundry.Local
55
Describes a discoverable execution provider bootstrapper.
66

77
```csharp
8-
public class EpInfo : System.IEquatable`1[[Microsoft.AI.Foundry.Local.EpInfo, Microsoft.AI.Foundry.Local, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
8+
public record EpInfo
99
```
1010

11-
Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EpInfo](./microsoft.ai.foundry.local.epinfo.md)<br>
12-
Implements [IEquatable&lt;EpInfo&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.iequatable-1)<br>
13-
Attributes [NullableContextAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.nullablecontextattribute), [NullableAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.nullableattribute), [RequiredMemberAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.requiredmemberattribute)
14-
1511
## Properties
1612

17-
### **EqualityContract**
18-
19-
```csharp
20-
protected Type EqualityContract { get; }
21-
```
22-
23-
#### Property Value
24-
25-
[Type](https://docs.microsoft.com/en-us/dotnet/api/system.type)<br>
26-
2713
### **Name**
2814

2915
The identifier of the bootstrapper/execution provider (e.g. "CUDAExecutionProvider").
@@ -47,101 +33,3 @@ public bool IsRegistered { get; set; }
4733
#### Property Value
4834

4935
[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
50-
51-
## Constructors
52-
53-
### **EpInfo(EpInfo)**
54-
55-
```csharp
56-
protected EpInfo(EpInfo original)
57-
```
58-
59-
#### Parameters
60-
61-
`original` [EpInfo](./microsoft.ai.foundry.local.epinfo.md)<br>
62-
63-
### **EpInfo()**
64-
65-
#### Caution
66-
67-
Constructors of types with required members are not supported in this version of your compiler.
68-
69-
---
70-
71-
```csharp
72-
public EpInfo()
73-
```
74-
75-
## Methods
76-
77-
### **ToString()**
78-
79-
```csharp
80-
public string ToString()
81-
```
82-
83-
#### Returns
84-
85-
[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
86-
87-
### **PrintMembers(StringBuilder)**
88-
89-
```csharp
90-
protected bool PrintMembers(StringBuilder builder)
91-
```
92-
93-
#### Parameters
94-
95-
`builder` [StringBuilder](https://docs.microsoft.com/en-us/dotnet/api/system.text.stringbuilder)<br>
96-
97-
#### Returns
98-
99-
[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
100-
101-
### **GetHashCode()**
102-
103-
```csharp
104-
public int GetHashCode()
105-
```
106-
107-
#### Returns
108-
109-
[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)<br>
110-
111-
### **Equals(Object)**
112-
113-
```csharp
114-
public bool Equals(object obj)
115-
```
116-
117-
#### Parameters
118-
119-
`obj` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)<br>
120-
121-
#### Returns
122-
123-
[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
124-
125-
### **Equals(EpInfo)**
126-
127-
```csharp
128-
public bool Equals(EpInfo other)
129-
```
130-
131-
#### Parameters
132-
133-
`other` [EpInfo](./microsoft.ai.foundry.local.epinfo.md)<br>
134-
135-
#### Returns
136-
137-
[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
138-
139-
### **&lt;Clone&gt;$()**
140-
141-
```csharp
142-
public EpInfo <Clone>$()
143-
```
144-
145-
#### Returns
146-
147-
[EpInfo](./microsoft.ai.foundry.local.epinfo.md)<br>

‎sdk/cs/docs/api/microsoft.ai.foundry.local.foundrylocalexception.md‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -115,17 +115,3 @@ public FoundryLocalException(string message, Exception innerException)
115115
`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
116116

117117
`innerException` [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)<br>
118-
119-
## Events
120-
121-
### **SerializeObjectState**
122-
123-
#### Caution
124-
125-
BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.
126-
127-
---
128-
129-
```csharp
130-
protected event EventHandler<SafeSerializationEventArgs> SerializeObjectState;
131-
```

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

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

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

33-
### **Info**
34-
35-
```csharp
36-
public abstract ModelInfo Info { get; }
37-
```
38-
39-
#### Property Value
40-
41-
[ModelInfo](./microsoft.ai.foundry.local.modelinfo.md)<br>
42-
43-
### **Variants**
44-
45-
Variants of the model that are available. Variants of the model are optimized for different devices.
46-
47-
```csharp
48-
public abstract IReadOnlyList<IModel> Variants { get; }
49-
```
50-
51-
#### Property Value
52-
53-
[IReadOnlyList&lt;IModel&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlylist-1)<br>
54-
5533
## Methods
5634

5735
### **IsCachedAsync(Nullable&lt;CancellationToken&gt;)**
@@ -207,22 +185,3 @@ Optional cancellation token.
207185

208186
[Task&lt;OpenAIAudioClient&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)<br>
209187
OpenAI.AudioClient
210-
211-
### **SelectVariant(IModel)**
212-
213-
Select a model variant from [IModel.Variants](./microsoft.ai.foundry.local.imodel.md#variants) to use for [IModel](./microsoft.ai.foundry.local.imodel.md) operations.
214-
An IModel from `Variants` can also be used directly.
215-
216-
```csharp
217-
void SelectVariant(IModel variant)
218-
```
219-
220-
#### Parameters
221-
222-
`variant` [IModel](./microsoft.ai.foundry.local.imodel.md)<br>
223-
Model variant to select. Must be one of the variants in [IModel.Variants](./microsoft.ai.foundry.local.imodel.md#variants).
224-
225-
#### Exceptions
226-
227-
[FoundryLocalException](./microsoft.ai.foundry.local.foundrylocalexception.md)<br>
228-
If variant is not valid for this model.

0 commit comments

Comments
 (0)