AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class GENResponseTask

    Task for generating text using an LLM model. Supports instructions and role-based prompts.

    Inheritance
    object
    GENTask<GENResponseTask, string, ChatCompletion>
    GENCompletionTask<GENResponseTask, ChatCompletion>
    GENResponseTask
    Implements
    IGENTask
    Inherited Members
    GENCompletionTask<GENResponseTask, ChatCompletion>.Attach(params string[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.Attach(params FileInfo[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.Attach(params Texture2D[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.Attach(params AudioClip[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.Attach(params IFile[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetInstruction(string)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetStartingMessage(string)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetModelSettings(ModelSettings)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetReasoning(ReasoningEffort)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetReasoning(ReasoningOptions)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetSpeechOutput(SpeechOutputOptions)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetWebSearchOptions(WebSearchOptions)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetModeration(ModerationOptions)
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetTools(params ToolCall[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.AddTools(params ToolCall[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetFunctions(params FunctionCall[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.AddFunctions(params FunctionCall[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.SetMessages(params ChatMessage[])
    GENCompletionTask<GENResponseTask, ChatCompletion>.AddMessages(params ChatMessage[])
    GENTask<GENResponseTask, string, ChatCompletion>.token
    GENTask<GENResponseTask, string, ChatCompletion>.enableHistory
    GENTask<GENResponseTask, string, ChatCompletion>.isCanceled
    GENTask<GENResponseTask, string, ChatCompletion>.outputMimeType
    GENTask<GENResponseTask, string, ChatCompletion>.Cancel()
    GENTask<GENResponseTask, string, ChatCompletion>.SetOption(string, object)
    GENTask<GENResponseTask, string, ChatCompletion>.TryGetOption<T>(string, out T)
    GENTask<GENResponseTask, string, ChatCompletion>.SetModel(Model)
    GENTask<GENResponseTask, string, ChatCompletion>.SetCount(int)
    GENTask<GENResponseTask, string, ChatCompletion>.SetOutputPath(string)
    GENTask<GENResponseTask, string, ChatCompletion>.SetSender(string)
    GENTask<GENResponseTask, string, ChatCompletion>.SetIgnoreLogs(bool)
    GENTask<GENResponseTask, string, ChatCompletion>.EnablePromptHistory(bool)
    GENTask<GENResponseTask, string, ChatCompletion>.SetCancellationToken(CancellationToken)
    GENTask<GENResponseTask, string, ChatCompletion>.ExecuteAsyncINTERNAL()
    GENTask<GENResponseTask, string, ChatCompletion>.ExecuteAsync()
    GENTask<GENResponseTask, string, ChatCompletion>.ExecuteAsync<T>()
    Namespace: Glitch9.AIDevKit
    Assembly: .dll
    Syntax
    public class GENResponseTask : GENCompletionTask<GENResponseTask, ChatCompletion>, IGENTask

    Constructors

    GENResponseTask(string)

    Declaration
    public GENResponseTask(string prompt)
    Parameters
    Type Name Description
    string prompt

    Methods

    ExecuteAsyncINTERNAL()

    Executes the text generation and returns the full response as a string.

    Declaration
    protected override UniTask<ChatCompletion> ExecuteAsyncINTERNAL()
    Returns
    Type Description
    UniTask<ChatCompletion>
    Overrides
    GENTask<GENResponseTask, string, ChatCompletion>.ExecuteAsyncINTERNAL()

    OnStreamDeltaChunk(Action<ChatDelta[]>)

    Declaration
    public GENResponseTask OnStreamDeltaChunk(Action<ChatDelta[]> onDeltaChunk)
    Parameters
    Type Name Description
    Action<ChatDelta[]> onDeltaChunk
    Returns
    Type Description
    GENResponseTask

    OnStreamDone(Action<ChatCompletion>)

    Declaration
    public GENResponseTask OnStreamDone(Action<ChatCompletion> onDone)
    Parameters
    Type Name Description
    Action<ChatCompletion> onDone
    Returns
    Type Description
    GENResponseTask

    OnStreamError(Action<string>)

    Declaration
    public GENResponseTask OnStreamError(Action<string> onError)
    Parameters
    Type Name Description
    Action<string> onError
    Returns
    Type Description
    GENResponseTask

    OnStreamText(Action<string>, Action<string>)

    Declaration
    public GENResponseTask OnStreamText(Action<string> onReceiveText, Action<string> onReceiveRefusal = null)
    Parameters
    Type Name Description
    Action<string> onReceiveText
    Action<string> onReceiveRefusal
    Returns
    Type Description
    GENResponseTask

    OnStreamToolCalls(Action<ToolCall[]>)

    Declaration
    public GENResponseTask OnStreamToolCalls(Action<ToolCall[]> onToolCalls)
    Parameters
    Type Name Description
    Action<ToolCall[]> onToolCalls
    Returns
    Type Description
    GENResponseTask

    ResolveStreamHandler(IChatCompletionStreamHandler)

    Declaration
    protected IChatCompletionStreamHandler ResolveStreamHandler(IChatCompletionStreamHandler streamHandler)
    Parameters
    Type Name Description
    IChatCompletionStreamHandler streamHandler
    Returns
    Type Description
    IChatCompletionStreamHandler

    StreamAsync(IChatCompletionStreamHandler)

    Streams text generation output in real time as it's received from the model.

    Declaration
    public UniTask StreamAsync(IChatCompletionStreamHandler streamHandler = null)
    Parameters
    Type Name Description
    IChatCompletionStreamHandler streamHandler
    Returns
    Type Description
    UniTask

    Implements

    IGENTask

    Extension Methods

    FluentAPIExtensions.SetAspectRatio<TTask>(TTask, AspectRatio)
    FluentAPIExtensions.SetPersonGeneration<TTask>(TTask, PersonGeneration)
    FluentAPIExtensions.SetSize<T>(T, ImageSize)
    In this article
    Back to top Generated by DocFX