AIFunctionArguments Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.Abstractions.dll

Package:: Microsoft.Extensions.AI.Abstractions v9.4.0-preview.1.25207.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents arguments to be used with InvokeAsync(AIFunctionArguments, CancellationToken).

public ref class AIFunctionArguments sealed : System::Collections::Generic::ICollection<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>, System::Collections::Generic::IDictionary<System::String ^, System::Object ^>, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>, System::Collections::Generic::IReadOnlyCollection<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>, System::Collections::Generic::IReadOnlyDictionary<System::String ^, System::Object ^>

public sealed class AIFunctionArguments : System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IDictionary<string,object>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IReadOnlyDictionary<string,object>

type AIFunctionArguments = class
    interface IDictionary<string, obj>
    interface ICollection<KeyValuePair<string, obj>>
    interface seq<KeyValuePair<string, obj>>
    interface IEnumerable
    interface IReadOnlyDictionary<string, obj>
    interface IReadOnlyCollection<KeyValuePair<string, obj>>

Public NotInheritable Class AIFunctionArguments
Implements ICollection(Of KeyValuePair(Of String, Object)), IDictionary(Of String, Object), IEnumerable(Of KeyValuePair(Of String, Object)), IReadOnlyCollection(Of KeyValuePair(Of String, Object)), IReadOnlyDictionary(Of String, Object)

Inheritance: Object
AIFunctionArguments

Implements: ICollection<KeyValuePair<String,Object>> ICollection<KeyValuePair<TKey,TValue>> IDictionary<String,Object> IEnumerable<KeyValuePair<String,Object>> IEnumerable<KeyValuePair<TKey,TValue>> IEnumerable<T> IReadOnlyCollection<KeyValuePair<String,Object>> IReadOnlyCollection<KeyValuePair<TKey,TValue>> IReadOnlyDictionary<String,Object> IEnumerable

Remarks

AIFunctionArguments is a dictionary of name/value pairs that are used as inputs to an AIFunction. However, an instance carries additional non-nominal information, such as an optional IServiceProvider that can be used by an AIFunction if it needs to resolve any services from a dependency injection container.

Constructors

AIFunctionArguments()	Initializes a new instance of the AIFunctionArguments class.
AIFunctionArguments(IDictionary<String,Object>)	Initializes a new instance of the AIFunctionArguments class containing the specified `arguments`.

Properties

Context	Gets or sets additional context associated with these arguments.
Count	Gets the number of elements contained in the ICollection<T>.
Item[String]	Gets or sets the element with the specified key.
Keys	Gets an ICollection<T> containing the keys of the IDictionary<TKey,TValue>.
Services	Gets or sets services optionally associated with these arguments.
Values	Gets an ICollection<T> containing the values in the IDictionary<TKey,TValue>.

Methods

Add(String, Object)	Adds an element with the provided key and value to the IDictionary<TKey,TValue>.
Clear()	Removes all items from the ICollection<T>.
ContainsKey(String)	Determines whether the IDictionary<TKey,TValue> contains an element with the specified key.
CopyTo(KeyValuePair<String,Object>[], Int32)	Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
GetEnumerator()	Returns an enumerator that iterates through the collection.
Remove(String)	Removes the element with the specified key from the IDictionary<TKey,TValue>.
TryGetValue(String, Object)

Explicit Interface Implementations

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)	Adds an item to the ICollection<T>.
ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)	Determines whether the ICollection<T> contains a specific value.
ICollection<KeyValuePair<String,Object>>.IsReadOnly	Gets a value indicating whether the ICollection<T> is read-only.
ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)	Removes the first occurrence of a specific object from the ICollection<T>.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IReadOnlyDictionary<String,Object>.Keys	Gets an enumerable collection that contains the keys in the read-only dictionary.
IReadOnlyDictionary<String,Object>.Values	Gets an enumerable collection that contains the values in the read-only dictionary.

Extension Methods

ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector function.
ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector and element selector functions.
ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>)	Creates a FrozenSet<T> with the specified values.
ToImmutableArray<TSource>(IEnumerable<TSource>)	Creates an immutable array from the specified collection.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Constructs an immutable dictionary based on some transformation of a sequence.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents.
ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>)	Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type.
ToImmutableHashSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable hash set of its contents.
ToImmutableList<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable list of its contents.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>)	Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable sorted set of its contents.
CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler)	Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter `T` is DataRow.
CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption)	Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter `T` is DataRow.
CopyToDataTable<T>(IEnumerable<T>)	Returns a DataTable that contains copies of the DataRow objects, given an input IEnumerable<T> object where the generic parameter `T` is DataRow.
ToAsyncEnumerable<TSource>(IEnumerable<TSource>)	Creates a new IAsyncEnumerable<T> that iterates through `source`.

Applies to

Share via