Class FunctionContract

Namespace

AutoGen.Core

Assembly

AutoGen.Core.dll

public class FunctionContract

Inheritance

object

FunctionContract

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FunctionContractExtension.ToMistralFunctionDefinition(FunctionContract)

FunctionContractExtension.ToChatTool(FunctionContract)

FunctionContractExtension.ToOpenAIFunctionDefinition(FunctionContract)

Properties

ClassName

The class name of the function.

public string? ClassName { get; set; }

Property Value

string

Description

The description of the function. If a structured comment is available, the description will be extracted from the summary section. Otherwise, the description will be null.

public string? Description { get; set; }

Property Value

string

Name

The name of the function.

public string Name { get; set; }

Property Value

string

Namespace

The namespace of the function.

public string? Namespace { get; set; }

Property Value

string

Parameters

The parameters of the function.

public IEnumerable<FunctionParameterContract>? Parameters { get; set; }

Property Value

IEnumerable<FunctionParameterContract>

ReturnDescription

The description of the return section. If a structured comment is available, the description will be extracted from the return section. Otherwise, the description will be null.

public string? ReturnDescription { get; set; }

Property Value

string

ReturnType

The return type of the function.

public Type? ReturnType { get; set; }

Property Value

Type