Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions xml/Microsoft.Extensions.AI/AIContent.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides a base class for all content used with AI services.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -69,7 +69,9 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIContent" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -89,7 +91,7 @@
<ReturnType>Microsoft.Extensions.AI.AdditionalPropertiesDictionary</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets additional properties for the content.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -116,9 +118,13 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the raw representation of the content from an underlying implementation.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
If an <see cref="T:Microsoft.Extensions.AI.AIContent" /> is created to represent some underlying object from another object
model, this property can be used to store that original object. This can be useful for debugging or
for enabling a consumer to access the underlying object model if needed.
</remarks>
</Docs>
</Member>
</Members>
Expand Down
21 changes: 11 additions & 10 deletions xml/Microsoft.Extensions.AI/AIFunction.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represents a function that can be described to an AI service and invoked.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -77,10 +77,10 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="arguments">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="arguments">The arguments to pass to the function's invocation.</param>
<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>
<summary>Invokes the <see cref="T:Microsoft.Extensions.AI.AIFunction" /> and returns its result.</summary>
<returns>The result of the function's execution.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -117,10 +117,10 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="arguments">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="arguments">The arguments to pass to the function's invocation.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests.</param>
<summary>Invokes the <see cref="T:Microsoft.Extensions.AI.AIFunction" /> and returns its result.</summary>
<returns>The result of the function's execution.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -140,7 +140,7 @@
<ReturnType>Microsoft.Extensions.AI.AIFunctionMetadata</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets metadata describing the function.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -165,6 +165,7 @@
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
14 changes: 10 additions & 4 deletions xml/Microsoft.Extensions.AI/AIFunctionContext.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,14 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<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>
<remarks>
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
of type <see cref="T:Microsoft.Extensions.AI.AIFunctionContext" />. Whereas all other parameters are passed by name from the supplied collection of arguments,
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
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)" />
method is available from the <see cref="P:Microsoft.Extensions.AI.AIFunctionContext.CancellationToken" /> property.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -31,7 +37,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIFunctionContext" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -51,7 +57,7 @@
<ReturnType>System.Threading.CancellationToken</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a <see cref="P:Microsoft.Extensions.AI.AIFunctionContext.CancellationToken" /> related to the operation.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
58 changes: 35 additions & 23 deletions xml/Microsoft.Extensions.AI/AIFunctionFactory.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides factory methods for creating commonly-used implementations of <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,10 +51,10 @@
</Parameter>
</Parameters>
<Docs>
<param name="method">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="options">Metadata to use to override defaults inferred from <paramref name="method" />.</param>
<summary>Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via a delegate.</summary>
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -93,11 +93,17 @@
</Parameter>
</Parameters>
<Docs>
<param name="method">To be added.</param>
<param name="target">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="target">
The target object for the <paramref name="method" /> if it represents an instance method.
This should be <see langword="null" /> if and only if <paramref name="method" /> is a static method.
</param>
<param name="options">Metadata to use to override defaults inferred from <paramref name="method" />.</param>
<summary>
Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via an <see cref="T:System.Reflection.MethodInfo" /> instance
and an optional target object if the method is an instance method.
</summary>
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -135,12 +141,12 @@
<Parameter Name="serializerOptions" Type="System.Text.Json.JsonSerializerOptions" />
</Parameters>
<Docs>
<param name="method">To be added.</param>
<param name="name">To be added.</param>
<param name="description">To be added.</param>
<param name="serializerOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="name">The name to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="description">The description to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="serializerOptions">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> used to marshal function parameters and any return value.</param>
<summary>Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via a delegate.</summary>
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -179,13 +185,19 @@
<Parameter Name="serializerOptions" Type="System.Text.Json.JsonSerializerOptions" />
</Parameters>
<Docs>
<param name="method">To be added.</param>
<param name="target">To be added.</param>
<param name="name">To be added.</param>
<param name="description">To be added.</param>
<param name="serializerOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="method">The method to be represented via the created <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="target">
The target object for the <paramref name="method" /> if it represents an instance method.
This should be <see langword="null" /> if and only if <paramref name="method" /> is a static method.
</param>
<param name="name">The name to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="description">The description to use for the <see cref="T:Microsoft.Extensions.AI.AIFunction" />.</param>
<param name="serializerOptions">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> used to marshal function parameters and return value.</param>
<summary>
Creates an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> instance for a method, specified via an <see cref="T:System.Reflection.MethodInfo" /> instance
and an optional target object if the method is an instance method.
</summary>
<returns>The created <see cref="T:Microsoft.Extensions.AI.AIFunction" /> for invoking <paramref name="method" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
43 changes: 30 additions & 13 deletions xml/Microsoft.Extensions.AI/AIFunctionFactoryCreateOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>
Options that can be provided when creating an <see cref="T:Microsoft.Extensions.AI.AIFunction" /> from a method.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -37,7 +39,9 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.AIFunctionFactoryCreateOptions" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -63,9 +67,13 @@
<ReturnType>System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.Object&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
Gets or sets additional values that will be stored on the resulting <see cref="P:Microsoft.Extensions.AI.AIFunctionMetadata.AdditionalProperties" /> property.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
This can be used to provide arbitrary information about the function.
</remarks>
</Docs>
</Member>
<Member MemberName="Description">
Expand All @@ -84,9 +92,12 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the description to use for the function.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
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
(e.g. via a <see cref="T:System.ComponentModel.DescriptionAttribute" /> on the method).
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
Expand All @@ -105,9 +116,11 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the name to use for the function.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
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" />.
</remarks>
</Docs>
</Member>
<Member MemberName="Parameters">
Expand All @@ -132,9 +145,11 @@
<ReturnType>System.Collections.Generic.IReadOnlyList&lt;Microsoft.Extensions.AI.AIFunctionParameterMetadata&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets metadata for the parameters of the function.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
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" />.
</remarks>
</Docs>
</Member>
<Member MemberName="ReturnParameter">
Expand All @@ -153,9 +168,11 @@
<ReturnType>Microsoft.Extensions.AI.AIFunctionReturnParameterMetadata</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets metadata for function's return parameter.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
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" />.
</remarks>
</Docs>
</Member>
<Member MemberName="SerializerOptions">
Expand All @@ -180,7 +197,7 @@
<ReturnType>System.Text.Json.JsonSerializerOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the <see cref="T:System.Text.Json.JsonSerializerOptions" /> used to marshal .NET values being passed to the underlying delegate.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading