Class GENResponseTask

Namespace

Glitch9.AIDevKit

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

public class GENResponseTask : GENTextGenerationTask<GENResponseTask, ChatCompletion>, IGENTextTask, IStreamingChatTask<GENResponseTask>, IGENTask

Inheritance

object

TaskBase<GENResponseTask, ChatCompletion>

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>

GENTextGenerationTask<GENResponseTask, ChatCompletion>

GENResponseTask

Implements

IGENTextTask

IStreamingChatTask<GENResponseTask>

IGENTask

Derived

GENChatTask

Inherited Members

GENTextGenerationTask<GENResponseTask, ChatCompletion>.AttachedFiles

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Instructions

GENTextGenerationTask<GENResponseTask, ChatCompletion>.StartingMessage

GENTextGenerationTask<GENResponseTask, ChatCompletion>.StopSequences

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Seed

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Temperature

GENTextGenerationTask<GENResponseTask, ChatCompletion>.MaxTokens

GENTextGenerationTask<GENResponseTask, ChatCompletion>.ModerationOptions

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Tools

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Messages

GENTextGenerationTask<GENResponseTask, ChatCompletion>.TextProcessor

GENTextGenerationTask<GENResponseTask, ChatCompletion>.JsonSchema

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Attach(params string[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Attach(params FileInfo[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Attach(params Texture2D[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Attach(params AudioClip[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.Attach(params IFile[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetInstructions(string)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetSystemInstructions(string)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetStartingMessage(string)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetModeration(ModerationOptions)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetTools(params ToolCall[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.AddTools(params ToolCall[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetFunctions(params FunctionCall[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.AddFunctions(params FunctionCall[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetMessages(params ChatMessage[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.AddMessages(params ChatMessage[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetJsonSchema(Type)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetJsonSchema(IJsonSchema)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetTemperature(float)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetSeed(uint)

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetStopSequences(params string[])

GENTextGenerationTask<GENResponseTask, ChatCompletion>.SetMaxTokens(int)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.Api

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.Prompt

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.ModelId

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.OutputFilePath

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.OutputFileNote

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.RecordHistory

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SaveGeneratedContents

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.N

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.MaxN

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.Options

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SetModel(Api, string)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SetModel(Model)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SetCount(int)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SaveContentsTo(string, string)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.EnablePromptHistory(bool)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SetRequestMimeType(MIMEType)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SetResponseMimeType(MIMEType)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.SetOptions(ICompletionOptions)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.ExecuteAsync()

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.YieldAsync()

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.ResolveOutputPath(Api?, string)

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.GetPrompt()

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.YieldAsyncINTERNAL()

GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>.CreateMergedHistoryRecordINTERNAL(List<ChatCompletion>)

TaskBase<GENResponseTask, ChatCompletion>.Method

TaskBase<GENResponseTask, ChatCompletion>.Cts

TaskBase<GENResponseTask, ChatCompletion>.Token

TaskBase<GENResponseTask, ChatCompletion>.Api

TaskBase<GENResponseTask, ChatCompletion>.Sender

TaskBase<GENResponseTask, ChatCompletion>.IgnoreLogs

TaskBase<GENResponseTask, ChatCompletion>.IsCanceled

TaskBase<GENResponseTask, ChatCompletion>.RequestMimeType

TaskBase<GENResponseTask, ChatCompletion>.ResponseMimeType

TaskBase<GENResponseTask, ChatCompletion>.IsWrapperTask

TaskBase<GENResponseTask, ChatCompletion>.SetSender(string)

TaskBase<GENResponseTask, ChatCompletion>.SetIgnoreLogs(bool)

TaskBase<GENResponseTask, ChatCompletion>.SetCancellationToken(CancellationToken)

TaskBase<GENResponseTask, ChatCompletion>.ExecuteAsync()

TaskBase<GENResponseTask, ChatCompletion>.ExecuteAsyncINTERNAL()

TaskBase<GENResponseTask, ChatCompletion>.ExecuteAsync<T>()

TaskBase<GENResponseTask, ChatCompletion>.CancelTask()

Extension Methods

ConverterExtensions.ToAnthropicMessageRequest(GENResponseTask, IJsonSchema, bool)

Constructors

GENResponseTask(TextPrompt)

public GENResponseTask(TextPrompt prompt)

Parameters

prompt TextPrompt

Properties

Method

public override string Method { get; }

Property Value

string

StreamHandlerBuilder

public ChatStreamHandler.Builder StreamHandlerBuilder { get; set; }

Property Value

ChatStreamHandler.Builder

Methods

ExecuteAsyncINTERNAL()

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

protected override UniTask<ChatCompletion> ExecuteAsyncINTERNAL()

Returns

UniTask<ChatCompletion>

OnStreamDeltaChunk(Action<ChatDelta[]>)

public GENResponseTask OnStreamDeltaChunk(Action<ChatDelta[]> onDeltaChunk)

Parameters

onDeltaChunk Action<ChatDelta[]>

Returns

GENResponseTask

OnStreamDone(Action<ChatCompletion>)

public GENResponseTask OnStreamDone(Action<ChatCompletion> onDone)

Parameters

onDone Action<ChatCompletion>

Returns

GENResponseTask

OnStreamError(Action<string>)

public GENResponseTask OnStreamError(Action<string> onError)

Parameters

onError Action<string>

Returns

GENResponseTask

OnStreamSpeechAudio(Action<float[]>)

public GENResponseTask OnStreamSpeechAudio(Action<float[]> onReceiveSpeechAudio)

Parameters

onReceiveSpeechAudio Action<float[]>

Returns

GENResponseTask

OnStreamText(Action<string>)

public GENResponseTask OnStreamText(Action<string> onReceiveText)

Parameters

onReceiveText Action<string>

Returns

GENResponseTask

OnStreamToolCalls(Action<ToolCall[]>)

public GENResponseTask OnStreamToolCalls(Action<ToolCall[]> onToolCalls)

Parameters

onToolCalls Action<ToolCall[]>

Returns

GENResponseTask

OnStreamUsage(Action<Usage>)

public GENResponseTask OnStreamUsage(Action<Usage> onReceiveUsage)

Parameters

onReceiveUsage Action<Usage>

Returns

GENResponseTask

StreamAsync(ChatStreamHandler)

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

public virtual UniTask StreamAsync(ChatStreamHandler streamHandler = null)

Parameters

streamHandler ChatStreamHandler

Returns

UniTask