Search Results for

    Show / Hide Table of Contents

    Class FunctionOutput

    The output of a function tool call.

    Inheritance
    object
    ConversationItem
    ToolOutput
    FunctionOutput
    Implements
    IPrompt
    IValidatable
    IHasId<string>
    IToolCallOutput
    Inherited Members
    ToolOutput.Index
    ToolOutput.CallId
    ToolOutput.Status
    ConversationItem.Id
    ConversationItem.Type
    ConversationItem.GetPromptText()
    ConversationItem.IsValid()
    ConversationItem.Validate()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Glitch9.AIDevKit
    Assembly: Glitch9.AIDevKit.dll
    Syntax
    public class FunctionOutput : ToolOutput, IPrompt, IValidatable, IHasId<string>, IToolCallOutput

    Constructors

    | Edit this page View Source

    FunctionOutput()

    Declaration
    public FunctionOutput()

    Properties

    | Edit this page View Source

    Output

    Required. A JSON string of the output of the function tool call.

    Declaration
    [JsonProperty("output")]
    public string Output { get; set; }
    Property Value
    Type Description
    string

    Methods

    | Edit this page View Source

    Error(FunctionCall, string)

    Creates an error FunctionOutput with the specified error message.

    Declaration
    public static FunctionOutput Error(FunctionCall call, string message)
    Parameters
    Type Name Description
    FunctionCall call

    The function call that triggered the error.

    string message

    The error message to include in the output.

    Returns
    Type Description
    FunctionOutput

    A FunctionOutput with error payload and Completed status.

    | Edit this page View Source

    Success(FunctionCall, object)

    Creates a success FunctionOutput with the serialized result object.

    Declaration
    public static FunctionOutput Success(FunctionCall call, object result)
    Parameters
    Type Name Description
    FunctionCall call

    The function call that produced the result.

    object result

    The result object to serialize and include in the output.

    Returns
    Type Description
    FunctionOutput

    A FunctionOutput with serialized result and specified status.

    Implements

    IPrompt
    IValidatable
    IHasId<TId>
    IToolCallOutput

    Extension Methods

    UnifiedApiCallerExtensions.GENResponse(ConversationItem)
    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    ResponseCastingExtensions.GetResult<T>(T)
    CoreLibTypeExtensions.GetIdOrNull(IHasId<string>)
    CoreLibTypeExtensions.IsNullOrEmptyId(IHasId<string>)
    SystemExtensions.GetName(object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation