AI DevKit
Search Results for

    Show / Hide Table of Contents

    Class GENChatTask

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

    Inheritance
    object
    TaskBase<GENResponseTask, ChatCompletion>
    GENTask<GENResponseTask, ICompletionOptions, TextPrompt, ChatCompletion>
    GENTextGenerationTask<GENResponseTask, ChatCompletion>
    GENResponseTask
    GENChatTask
    Implements
    IGENTextTask
    IStreamingChatTask<GENResponseTask>
    IGENTask
    Inherited Members
    GENResponseTask.StreamHandlerBuilder
    GENResponseTask.OnStreamText(Action<string>)
    GENResponseTask.OnStreamUsage(Action<Usage>)
    GENResponseTask.OnStreamSpeechAudio(Action<float[]>)
    GENResponseTask.OnStreamToolCalls(Action<ToolCall[]>)
    GENResponseTask.OnStreamDeltaChunk(Action<ChatDelta[]>)
    GENResponseTask.OnStreamError(Action<string>)
    GENResponseTask.OnStreamDone(Action<ChatCompletion>)
    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()
    Namespace: Glitch9.AIDevKit.Advanced.Chat
    Assembly: .dll
    Syntax
    public class GENChatTask : GENResponseTask, IGENTextTask, IStreamingChatTask<GENResponseTask>, IGENTask

    Constructors

    GENChatTask(ChatSession, ChatMessage)

    Declaration
    public GENChatTask(ChatSession chatSession, ChatMessage chatMessage)
    Parameters
    Type Name Description
    ChatSession chatSession
    ChatMessage chatMessage

    Properties

    IsWrapperTask

    Declaration
    public override bool IsWrapperTask { get; }
    Property Value
    Type Description
    bool
    Overrides
    TaskBase<GENResponseTask, ChatCompletion>.IsWrapperTask

    Method

    Declaration
    public override string Method { get; }
    Property Value
    Type Description
    string
    Overrides
    GENResponseTask.Method

    Methods

    CreateEditTask(ChatSession, int, string)

    Declaration
    public static GENChatTask CreateEditTask(ChatSession chatSession, int index, string editedContent)
    Parameters
    Type Name Description
    ChatSession chatSession
    int index
    string editedContent
    Returns
    Type Description
    GENChatTask

    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
    GENResponseTask.ExecuteAsyncINTERNAL()

    SetChatbotProfile(LocalChatbotProfileInstruct)

    Declaration
    public GENChatTask SetChatbotProfile(LocalChatbotProfileInstruct profile)
    Parameters
    Type Name Description
    LocalChatbotProfileInstruct profile
    Returns
    Type Description
    GENChatTask

    StreamAsync(ChatStreamHandler)

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

    Declaration
    public override UniTask StreamAsync(ChatStreamHandler streamHandler = null)
    Parameters
    Type Name Description
    ChatStreamHandler streamHandler
    Returns
    Type Description
    UniTask
    Overrides
    GENResponseTask.StreamAsync(ChatStreamHandler)

    Implements

    IGENTextTask
    IStreamingChatTask<T>
    IGENTask

    Extension Methods

    ConverterExtensions.ToAnthropicMessageRequest(GENResponseTask, IJsonSchema, bool)
    In this article
    Back to top Generated by DocFX