AIFunction Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Abstractions.dll

Package:

Microsoft.Extensions.AI.Abstractions v9.3.0-preview.1.25114.11

Source:

AIFunction.cs

Represents a function that can be described to an AI service and invoked.

C#

public abstract class AIFunction : Microsoft.Extensions.AI.AITool

Inheritance

Object

AITool

AIFunction

Constructors

AIFunction()

Properties

AdditionalProperties	Gets any additional properties associated with the tool. (Inherited from AITool)
Description	Gets a description of the tool, suitable for use in describing the purpose to a model. (Inherited from AITool)
JsonSchema	Gets a JSON Schema describing the function and its input parameters.
JsonSerializerOptions	Gets a JsonSerializerOptions that can be used to marshal function parameters.
Name	Gets the name of the tool. (Inherited from AITool)
UnderlyingMethod	Gets the underlying MethodInfo that this AIFunction might be wrapping.

Methods

InvokeAsync(IEnumerable<KeyValuePair<String,Object>>, CancellationToken)	Invokes the AIFunction and returns its result.
InvokeCoreAsync(IEnumerable<KeyValuePair<String,Object>>, CancellationToken)	Invokes the AIFunction and returns its result.
ToString()	Returns a string that represents the current object. (Inherited from AITool)

Extension Methods

ToConversationFunctionTool(AIFunction)

Converts a AIFunction into a ConversationFunctionTool so that it can be used with RealtimeConversationClient.

Applies to