Skip to content

Commit ddea98d

Browse files
gewarrengewarren
committed
microsoft.extensions
1 parent eddc828 commit ddea98d

File tree

749 files changed

+2902
-6109
lines changed

Some content is hidden

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

749 files changed

+2902
-6109
lines changed

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

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
</Attribute>
5353
</Attributes>
5454
<Docs>
55-
<summary>Provides a base class for all content used with AI services.</summary>
55+
<summary>To be added.</summary>
5656
<remarks>To be added.</remarks>
5757
</Docs>
5858
<Members>
@@ -69,9 +69,7 @@
6969
</AssemblyInfo>
7070
<Parameters />
7171
<Docs>
72-
<summary>
73-
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIContent" /> class.
74-
</summary>
72+
<summary>To be added.</summary>
7573
<remarks>To be added.</remarks>
7674
</Docs>
7775
</Member>
@@ -91,7 +89,7 @@
9189
<ReturnType>Microsoft.Extensions.AI.AdditionalPropertiesDictionary</ReturnType>
9290
</ReturnValue>
9391
<Docs>
94-
<summary>Gets or sets additional properties for the content.</summary>
92+
<summary>To be added.</summary>
9593
<value>To be added.</value>
9694
<remarks>To be added.</remarks>
9795
</Docs>
@@ -118,13 +116,9 @@
118116
<ReturnType>System.Object</ReturnType>
119117
</ReturnValue>
120118
<Docs>
121-
<summary>Gets or sets the raw representation of the content from an underlying implementation.</summary>
119+
<summary>To be added.</summary>
122120
<value>To be added.</value>
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>
121+
<remarks>To be added.</remarks>
128122
</Docs>
129123
</Member>
130124
</Members>

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>Represents a function that can be described to an AI service and invoked.</summary>
27+
<summary>To be added.</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">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>
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>
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">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>
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>
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>Gets metadata describing the function.</summary>
143+
<summary>To be added.</summary>
144144
<value>To be added.</value>
145145
<remarks>To be added.</remarks>
146146
</Docs>
@@ -165,7 +165,6 @@
165165
<summary>To be added.</summary>
166166
<returns>To be added.</returns>
167167
<remarks>To be added.</remarks>
168-
<inheritdoc />
169168
</Docs>
170169
</Member>
171170
</Members>

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

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,8 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
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>
17+
<summary>To be added.</summary>
18+
<remarks>To be added.</remarks>
2519
</Docs>
2620
<Members>
2721
<Member MemberName=".ctor">
@@ -37,7 +31,7 @@
3731
</AssemblyInfo>
3832
<Parameters />
3933
<Docs>
40-
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIFunctionContext" /> class.</summary>
34+
<summary>To be added.</summary>
4135
<remarks>To be added.</remarks>
4236
</Docs>
4337
</Member>
@@ -57,7 +51,7 @@
5751
<ReturnType>System.Threading.CancellationToken</ReturnType>
5852
</ReturnValue>
5953
<Docs>
60-
<summary>Gets or sets a <see cref="P:Microsoft.Extensions.AI.AIFunctionContext.CancellationToken" /> related to the operation.</summary>
54+
<summary>To be added.</summary>
6155
<value>To be added.</value>
6256
<remarks>To be added.</remarks>
6357
</Docs>

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

Lines changed: 23 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>Provides factory methods for creating commonly-used implementations of <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</summary>
23+
<summary>To be added.</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">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>
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>
5858
<remarks>To be added.</remarks>
5959
</Docs>
6060
</Member>
@@ -93,17 +93,11 @@
9393
</Parameter>
9494
</Parameters>
9595
<Docs>
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>
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>
107101
<remarks>To be added.</remarks>
108102
</Docs>
109103
</Member>
@@ -141,12 +135,12 @@
141135
<Parameter Name="serializerOptions" Type="System.Text.Json.JsonSerializerOptions" />
142136
</Parameters>
143137
<Docs>
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>
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>
150144
<remarks>To be added.</remarks>
151145
</Docs>
152146
</Member>
@@ -185,19 +179,13 @@
185179
<Parameter Name="serializerOptions" Type="System.Text.Json.JsonSerializerOptions" />
186180
</Parameters>
187181
<Docs>
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>
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>
201189
<remarks>To be added.</remarks>
202190
</Docs>
203191
</Member>

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

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>
24-
Options that can be provided when creating an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> from a method.
25-
</summary>
23+
<summary>To be added.</summary>
2624
<remarks>To be added.</remarks>
2725
</Docs>
2826
<Members>
@@ -39,9 +37,7 @@
3937
</AssemblyInfo>
4038
<Parameters />
4139
<Docs>
42-
<summary>
43-
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIFunctionFactoryCreateOptions" /> class.
44-
</summary>
40+
<summary>To be added.</summary>
4541
<remarks>To be added.</remarks>
4642
</Docs>
4743
</Member>
@@ -67,13 +63,9 @@
6763
<ReturnType>System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.Object&gt;</ReturnType>
6864
</ReturnValue>
6965
<Docs>
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>
66+
<summary>To be added.</summary>
7367
<value>To be added.</value>
74-
<remarks>
75-
This can be used to provide arbitrary information about the function.
76-
</remarks>
68+
<remarks>To be added.</remarks>
7769
</Docs>
7870
</Member>
7971
<Member MemberName="Description">
@@ -92,12 +84,9 @@
9284
<ReturnType>System.String</ReturnType>
9385
</ReturnValue>
9486
<Docs>
95-
<summary>Gets or sets the description to use for the function.</summary>
87+
<summary>To be added.</summary>
9688
<value>To be added.</value>
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>
89+
<remarks>To be added.</remarks>
10190
</Docs>
10291
</Member>
10392
<Member MemberName="Name">
@@ -116,11 +105,9 @@
116105
<ReturnType>System.String</ReturnType>
117106
</ReturnValue>
118107
<Docs>
119-
<summary>Gets or sets the name to use for the function.</summary>
108+
<summary>To be added.</summary>
120109
<value>To be added.</value>
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>
110+
<remarks>To be added.</remarks>
124111
</Docs>
125112
</Member>
126113
<Member MemberName="Parameters">
@@ -145,11 +132,9 @@
145132
<ReturnType>System.Collections.Generic.IReadOnlyList&lt;Microsoft.Extensions.AI.AIFunctionParameterMetadata&gt;</ReturnType>
146133
</ReturnValue>
147134
<Docs>
148-
<summary>Gets or sets metadata for the parameters of the function.</summary>
135+
<summary>To be added.</summary>
149136
<value>To be added.</value>
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>
137+
<remarks>To be added.</remarks>
153138
</Docs>
154139
</Member>
155140
<Member MemberName="ReturnParameter">
@@ -168,11 +153,9 @@
168153
<ReturnType>Microsoft.Extensions.AI.AIFunctionReturnParameterMetadata</ReturnType>
169154
</ReturnValue>
170155
<Docs>
171-
<summary>Gets or sets metadata for function's return parameter.</summary>
156+
<summary>To be added.</summary>
172157
<value>To be added.</value>
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>
158+
<remarks>To be added.</remarks>
176159
</Docs>
177160
</Member>
178161
<Member MemberName="SerializerOptions">
@@ -197,7 +180,7 @@
197180
<ReturnType>System.Text.Json.JsonSerializerOptions</ReturnType>
198181
</ReturnValue>
199182
<Docs>
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>
183+
<summary>To be added.</summary>
201184
<value>To be added.</value>
202185
<remarks>To be added.</remarks>
203186
</Docs>

0 commit comments

Comments
 (0)