Skip to content

Commit db9888e

Browse files
gewarrengewarren
authored
CI Update - Add M.E.AI docs (dotnet#10657)
1 parent ca3cac6 commit db9888e

File tree

85 files changed

+1896
-1076
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+1896
-1076
lines changed

‎xml/Microsoft.Extensions.AI/AIContent.xml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
</Attribute>
5353
</Attributes>
5454
<Docs>
55-
<summary>To be added.</summary>
55+
<summary>Provides a base class for all content used with AI services.</summary>
5656
<remarks>To be added.</remarks>
5757
</Docs>
5858
<Members>
@@ -69,7 +69,9 @@
6969
</AssemblyInfo>
7070
<Parameters />
7171
<Docs>
72-
<summary>To be added.</summary>
72+
<summary>
73+
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIContent" /> class.
74+
</summary>
7375
<remarks>To be added.</remarks>
7476
</Docs>
7577
</Member>
@@ -89,7 +91,7 @@
8991
<ReturnType>Microsoft.Extensions.AI.AdditionalPropertiesDictionary</ReturnType>
9092
</ReturnValue>
9193
<Docs>
92-
<summary>To be added.</summary>
94+
<summary>Gets or sets additional properties for the content.</summary>
9395
<value>To be added.</value>
9496
<remarks>To be added.</remarks>
9597
</Docs>
@@ -116,9 +118,13 @@
116118
<ReturnType>System.Object</ReturnType>
117119
</ReturnValue>
118120
<Docs>
119-
<summary>To be added.</summary>
121+
<summary>Gets or sets the raw representation of the content from an underlying implementation.</summary>
120122
<value>To be added.</value>
121-
<remarks>To be added.</remarks>
123+
<remarks>
124+
If an <see cref="T:Microsoft.Extensions.AI.AIContent" /> is created to represent some underlying object from another object
125+
model, this property can be used to store that original object. This can be useful for debugging or
126+
for enabling a consumer to access the underlying object model if needed.
127+
</remarks>
122128
</Docs>
123129
</Member>
124130
</Members>

‎xml/Microsoft.Extensions.AI/AIFunction.xml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>Represents a function that can be described to an AI service and invoked.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>
@@ -77,10 +77,10 @@
7777
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
7878
</Parameters>
7979
<Docs>
80-
<param name="arguments">To be added.</param>
81-
<param name="cancellationToken">To be added.</param>
82-
<summary>To be added.</summary>
83-
<returns>To be added.</returns>
80+
<param name="arguments">The arguments to pass to the function's invocation.</param>
81+
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests. The default is <see cref="P:System.Threading.CancellationToken.None" />.</param>
82+
<summary>Invokes the <see cref="T:Microsoft.Extensions.AI.AIFunction" /> and returns its result.</summary>
83+
<returns>The result of the function's execution.</returns>
8484
<remarks>To be added.</remarks>
8585
</Docs>
8686
</Member>
@@ -117,10 +117,10 @@
117117
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
118118
</Parameters>
119119
<Docs>
120-
<param name="arguments">To be added.</param>
121-
<param name="cancellationToken">To be added.</param>
122-
<summary>To be added.</summary>
123-
<returns>To be added.</returns>
120+
<param name="arguments">The arguments to pass to the function's invocation.</param>
121+
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests.</param>
122+
<summary>Invokes the <see cref="T:Microsoft.Extensions.AI.AIFunction" /> and returns its result.</summary>
123+
<returns>The result of the function's execution.</returns>
124124
<remarks>To be added.</remarks>
125125
</Docs>
126126
</Member>
@@ -140,7 +140,7 @@
140140
<ReturnType>Microsoft.Extensions.AI.AIFunctionMetadata</ReturnType>
141141
</ReturnValue>
142142
<Docs>
143-
<summary>To be added.</summary>
143+
<summary>Gets metadata describing the function.</summary>
144144
<value>To be added.</value>
145145
<remarks>To be added.</remarks>
146146
</Docs>
@@ -165,6 +165,7 @@
165165
<summary>To be added.</summary>
166166
<returns>To be added.</returns>
167167
<remarks>To be added.</remarks>
168+
<inheritdoc />
168169
</Docs>
169170
</Member>
170171
</Members>

‎xml/Microsoft.Extensions.AI/AIFunctionContext.xml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,14 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
18-
<remarks>To be added.</remarks>
17+
<summary>Provides additional context to the invocation of an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> created by <see cref="T:Microsoft.Extensions.AI.AIFunctionFactory" />.</summary>
18+
<remarks>
19+
A delegate or <see cref="T:System.Reflection.MethodInfo" /> passed to <see cref="T:Microsoft.Extensions.AI.AIFunctionFactory" /> methods may represent a method that has a parameter
20+
of type <see cref="T:Microsoft.Extensions.AI.AIFunctionContext" />. Whereas all other parameters are passed by name from the supplied collection of arguments,
21+
a <see cref="T:Microsoft.Extensions.AI.AIFunctionContext" /> parameter is passed specially by the <see cref="T:Microsoft.Extensions.AI.AIFunction" /> implementation, in order to pass relevant
22+
context into the method's invocation. For example, any <see cref="P:Microsoft.Extensions.AI.AIFunctionContext.CancellationToken" /> passed to the <see cref="M:Microsoft.Extensions.AI.AIFunction.InvokeAsync(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}},System.Threading.CancellationToken)" />
23+
method is available from the <see cref="P:Microsoft.Extensions.AI.AIFunctionContext.CancellationToken" /> property.
24+
</remarks>
1925
</Docs>
2026
<Members>
2127
<Member MemberName=".ctor">
@@ -31,7 +37,7 @@
3137
</AssemblyInfo>
3238
<Parameters />
3339
<Docs>
34-
<summary>To be added.</summary>
40+
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIFunctionContext" /> class.</summary>
3541
<remarks>To be added.</remarks>
3642
</Docs>
3743
</Member>
@@ -51,7 +57,7 @@
5157
<ReturnType>System.Threading.CancellationToken</ReturnType>
5258
</ReturnValue>
5359
<Docs>
54-
<summary>To be added.</summary>
60+
<summary>Gets or sets a <see cref="P:Microsoft.Extensions.AI.AIFunctionContext.CancellationToken" /> related to the operation.</summary>
5561
<value>To be added.</value>
5662
<remarks>To be added.</remarks>
5763
</Docs>

‎xml/Microsoft.Extensions.AI/AIFunctionFactory.xml

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Provides factory methods for creating commonly-used implementations of <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -51,10 +51,10 @@
5151
</Parameter>
5252
</Parameters>
5353
<Docs>
54-
<param name="method">To be added.</param>
55-
<param name="options">To be added.</param>
56-
<summary>To be added.</summary>
57-
<returns>To be added.</returns>
54+
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
55+
<param name="options">Metadata to use to override defaults inferred from <paramref name="method" />.</param>
56+
<summary>Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via a delegate.</summary>
57+
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
5858
<remarks>To be added.</remarks>
5959
</Docs>
6060
</Member>
@@ -93,11 +93,17 @@
9393
</Parameter>
9494
</Parameters>
9595
<Docs>
96-
<param name="method">To be added.</param>
97-
<param name="target">To be added.</param>
98-
<param name="options">To be added.</param>
99-
<summary>To be added.</summary>
100-
<returns>To be added.</returns>
96+
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
97+
<param name="target">
98+
The target object for the <paramref name="method" /> if it represents an instance method.
99+
This should be <see langword="null" /> if and only if <paramref name="method" /> is a static method.
100+
</param>
101+
<param name="options">Metadata to use to override defaults inferred from <paramref name="method" />.</param>
102+
<summary>
103+
Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via an <see cref="T:System.Reflection.MethodInfo" /> instance
104+
and an optional target object if the method is an instance method.
105+
</summary>
106+
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
101107
<remarks>To be added.</remarks>
102108
</Docs>
103109
</Member>
@@ -135,12 +141,12 @@
135141
<Parameter Name="serializerOptions" Type="System.Text.Json.JsonSerializerOptions" />
136142
</Parameters>
137143
<Docs>
138-
<param name="method">To be added.</param>
139-
<param name="name">To be added.</param>
140-
<param name="description">To be added.</param>
141-
<param name="serializerOptions">To be added.</param>
142-
<summary>To be added.</summary>
143-
<returns>To be added.</returns>
144+
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
145+
<param name="name">The name to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
146+
<param name="description">The description to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
147+
<param name="serializerOptions">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> used to marshal function parameters and any return value.</param>
148+
<summary>Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via a delegate.</summary>
149+
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
144150
<remarks>To be added.</remarks>
145151
</Docs>
146152
</Member>
@@ -179,13 +185,19 @@
179185
<Parameter Name="serializerOptions" Type="System.Text.Json.JsonSerializerOptions" />
180186
</Parameters>
181187
<Docs>
182-
<param name="method">To be added.</param>
183-
<param name="target">To be added.</param>
184-
<param name="name">To be added.</param>
185-
<param name="description">To be added.</param>
186-
<param name="serializerOptions">To be added.</param>
187-
<summary>To be added.</summary>
188-
<returns>To be added.</returns>
188+
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
189+
<param name="target">
190+
The target object for the <paramref name="method" /> if it represents an instance method.
191+
This should be <see langword="null" /> if and only if <paramref name="method" /> is a static method.
192+
</param>
193+
<param name="name">The name to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
194+
<param name="description">The description to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
195+
<param name="serializerOptions">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> used to marshal function parameters and return value.</param>
196+
<summary>
197+
Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via an <see cref="T:System.Reflection.MethodInfo" /> instance
198+
and an optional target object if the method is an instance method.
199+
</summary>
200+
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
189201
<remarks>To be added.</remarks>
190202
</Docs>
191203
</Member>

‎xml/Microsoft.Extensions.AI/AIFunctionFactoryCreateOptions.xml

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>
24+
Options that can be provided when creating an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> from a method.
25+
</summary>
2426
<remarks>To be added.</remarks>
2527
</Docs>
2628
<Members>
@@ -37,7 +39,9 @@
3739
</AssemblyInfo>
3840
<Parameters />
3941
<Docs>
40-
<summary>To be added.</summary>
42+
<summary>
43+
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIFunctionFactoryCreateOptions" /> class.
44+
</summary>
4145
<remarks>To be added.</remarks>
4246
</Docs>
4347
</Member>
@@ -63,9 +67,13 @@
6367
<ReturnType>System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.Object&gt;</ReturnType>
6468
</ReturnValue>
6569
<Docs>
66-
<summary>To be added.</summary>
70+
<summary>
71+
Gets or sets additional values that will be stored on the resulting <see cref="P:Microsoft.Extensions.AI.AIFunctionMetadata.AdditionalProperties" /> property.
72+
</summary>
6773
<value>To be added.</value>
68-
<remarks>To be added.</remarks>
74+
<remarks>
75+
This can be used to provide arbitrary information about the function.
76+
</remarks>
6977
</Docs>
7078
</Member>
7179
<Member MemberName="Description">
@@ -84,9 +92,12 @@
8492
<ReturnType>System.String</ReturnType>
8593
</ReturnValue>
8694
<Docs>
87-
<summary>To be added.</summary>
95+
<summary>Gets or sets the description to use for the function.</summary>
8896
<value>To be added.</value>
89-
<remarks>To be added.</remarks>
97+
<remarks>
98+
If <see langword="null" />, it will default to one derived from the passed <see cref="T:System.Delegate" /> or <see cref="T:System.Reflection.MethodInfo" />, if possible
99+
(e.g. via a <see cref="T:System.ComponentModel.DescriptionAttribute" /> on the method).
100+
</remarks>
90101
</Docs>
91102
</Member>
92103
<Member MemberName="Name">
@@ -105,9 +116,11 @@
105116
<ReturnType>System.String</ReturnType>
106117
</ReturnValue>
107118
<Docs>
108-
<summary>To be added.</summary>
119+
<summary>Gets or sets the name to use for the function.</summary>
109120
<value>To be added.</value>
110-
<remarks>To be added.</remarks>
121+
<remarks>
122+
If <see langword="null" />, it will default to one derived from the method represented by the passed <see cref="T:System.Delegate" /> or <see cref="T:System.Reflection.MethodInfo" />.
123+
</remarks>
111124
</Docs>
112125
</Member>
113126
<Member MemberName="Parameters">
@@ -132,9 +145,11 @@
132145
<ReturnType>System.Collections.Generic.IReadOnlyList&lt;Microsoft.Extensions.AI.AIFunctionParameterMetadata&gt;</ReturnType>
133146
</ReturnValue>
134147
<Docs>
135-
<summary>To be added.</summary>
148+
<summary>Gets or sets metadata for the parameters of the function.</summary>
136149
<value>To be added.</value>
137-
<remarks>To be added.</remarks>
150+
<remarks>
151+
If <see langword="null" />, it will default to metadata derived from the passed <see cref="T:System.Delegate" /> or <see cref="T:System.Reflection.MethodInfo" />.
152+
</remarks>
138153
</Docs>
139154
</Member>
140155
<Member MemberName="ReturnParameter">
@@ -153,9 +168,11 @@
153168
<ReturnType>Microsoft.Extensions.AI.AIFunctionReturnParameterMetadata</ReturnType>
154169
</ReturnValue>
155170
<Docs>
156-
<summary>To be added.</summary>
171+
<summary>Gets or sets metadata for function's return parameter.</summary>
157172
<value>To be added.</value>
158-
<remarks>To be added.</remarks>
173+
<remarks>
174+
If <see langword="null" />, it will default to one derived from the passed <see cref="T:System.Delegate" /> or <see cref="T:System.Reflection.MethodInfo" />.
175+
</remarks>
159176
</Docs>
160177
</Member>
161178
<Member MemberName="SerializerOptions">
@@ -180,7 +197,7 @@
180197
<ReturnType>System.Text.Json.JsonSerializerOptions</ReturnType>
181198
</ReturnValue>
182199
<Docs>
183-
<summary>To be added.</summary>
200+
<summary>Gets or sets the <see cref="T:System.Text.Json.JsonSerializerOptions" /> used to marshal .NET values being passed to the underlying delegate.</summary>
184201
<value>To be added.</value>
185202
<remarks>To be added.</remarks>
186203
</Docs>

0 commit comments

Comments
 (0)