AI DevKit
Search Results for

    Show / Hide Table of Contents

    Class GENTextGenerationTask<TSelf, TResult>

    Base class for GENTasks which utilize a CompletionRequest or a ChatCompletionRequest.

    Inheritance
    object
    TaskBase<TSelf, TResult>
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>
    GENTextGenerationTask<TSelf, TResult>
    GENCodeTask
    GENResponseTask
    GENStructTask<T>
    Implements
    IGENTextTask
    IGENTask
    Inherited Members
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.Api
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.Prompt
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.ModelId
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.OutputFilePath
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.OutputFileNote
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.RecordHistory
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SaveGeneratedContents
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.N
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.MaxN
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.Options
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SetModel(Api, string)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SetModel(Model)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SetCount(int)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SaveContentsTo(string, string)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.EnablePromptHistory(bool)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SetRequestMimeType(MIMEType)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SetResponseMimeType(MIMEType)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.SetOptions(ICompletionOptions)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.ExecuteAsync()
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.YieldAsync()
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.ResolveOutputPath(Api?, string)
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.GetPrompt()
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.YieldAsyncINTERNAL()
    GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>.CreateMergedHistoryRecordINTERNAL(List<TResult>)
    TaskBase<TSelf, TResult>.Method
    TaskBase<TSelf, TResult>.Cts
    TaskBase<TSelf, TResult>.Token
    TaskBase<TSelf, TResult>.Api
    TaskBase<TSelf, TResult>.Sender
    TaskBase<TSelf, TResult>.IgnoreLogs
    TaskBase<TSelf, TResult>.IsCanceled
    TaskBase<TSelf, TResult>.RequestMimeType
    TaskBase<TSelf, TResult>.ResponseMimeType
    TaskBase<TSelf, TResult>.IsWrapperTask
    TaskBase<TSelf, TResult>.SetSender(string)
    TaskBase<TSelf, TResult>.SetIgnoreLogs(bool)
    TaskBase<TSelf, TResult>.SetCancellationToken(CancellationToken)
    TaskBase<TSelf, TResult>.ExecuteAsync()
    TaskBase<TSelf, TResult>.ExecuteAsyncINTERNAL()
    TaskBase<TSelf, TResult>.ExecuteAsync<T>()
    TaskBase<TSelf, TResult>.CancelTask()
    Namespace: Glitch9.AIDevKit
    Assembly: .dll
    Syntax
    public abstract class GENTextGenerationTask<TSelf, TResult> : GENTask<TSelf, ICompletionOptions, TextPrompt, TResult>, IGENTextTask, IGENTask where TSelf : GENTextGenerationTask<TSelf, TResult> where TResult : IGeneratedResult
    Type Parameters
    Name Description
    TSelf
    TResult

    Constructors

    GENTextGenerationTask(TextPrompt)

    Declaration
    protected GENTextGenerationTask(TextPrompt prompt)
    Parameters
    Type Name Description
    TextPrompt prompt

    Properties

    AttachedFiles

    Declaration
    public List<IFile> AttachedFiles { get; set; }
    Property Value
    Type Description
    List<IFile>

    Instructions

    Declaration
    public string Instructions { get; set; }
    Property Value
    Type Description
    string

    JsonSchema

    Declaration
    public IJsonSchema JsonSchema { get; set; }
    Property Value
    Type Description
    IJsonSchema

    MaxTokens

    Declaration
    public int? MaxTokens { get; set; }
    Property Value
    Type Description
    int?

    Messages

    Declaration
    public List<ChatMessage> Messages { get; set; }
    Property Value
    Type Description
    List<ChatMessage>

    ModerationOptions

    Declaration
    public ModerationOptions ModerationOptions { get; set; }
    Property Value
    Type Description
    ModerationOptions

    Seed

    Declaration
    public uint? Seed { get; set; }
    Property Value
    Type Description
    uint?

    StartingMessage

    Declaration
    public string StartingMessage { get; set; }
    Property Value
    Type Description
    string

    StopSequences

    Declaration
    public List<string> StopSequences { get; set; }
    Property Value
    Type Description
    List<string>

    Temperature

    Declaration
    public float? Temperature { get; set; }
    Property Value
    Type Description
    float?

    TextProcessor

    Declaration
    public TextProcessor TextProcessor { get; set; }
    Property Value
    Type Description
    TextProcessor

    Tools

    Declaration
    public List<ToolCall> Tools { get; set; }
    Property Value
    Type Description
    List<ToolCall>

    Methods

    AddFunctions(params FunctionCall[])

    Declaration
    public TSelf AddFunctions(params FunctionCall[] functions)
    Parameters
    Type Name Description
    FunctionCall[] functions
    Returns
    Type Description
    TSelf

    AddMessages(params ChatMessage[])

    Declaration
    public TSelf AddMessages(params ChatMessage[] messages)
    Parameters
    Type Name Description
    ChatMessage[] messages
    Returns
    Type Description
    TSelf

    AddTools(params ToolCall[])

    Declaration
    public TSelf AddTools(params ToolCall[] tools)
    Parameters
    Type Name Description
    ToolCall[] tools
    Returns
    Type Description
    TSelf

    Attach(params AudioClip[])

    Declaration
    public TSelf Attach(params AudioClip[] audioClips)
    Parameters
    Type Name Description
    AudioClip[] audioClips
    Returns
    Type Description
    TSelf

    Attach(params IFile[])

    Declaration
    public TSelf Attach(params IFile[] files)
    Parameters
    Type Name Description
    IFile[] files
    Returns
    Type Description
    TSelf

    Attach(params FileInfo[])

    Declaration
    public TSelf Attach(params FileInfo[] fileInfos)
    Parameters
    Type Name Description
    FileInfo[] fileInfos
    Returns
    Type Description
    TSelf

    Attach(params string[])

    Declaration
    public TSelf Attach(params string[] filePaths)
    Parameters
    Type Name Description
    string[] filePaths
    Returns
    Type Description
    TSelf

    Attach(params Texture2D[])

    Declaration
    public TSelf Attach(params Texture2D[] textures)
    Parameters
    Type Name Description
    Texture2D[] textures
    Returns
    Type Description
    TSelf

    SetFunctions(params FunctionCall[])

    Declaration
    public TSelf SetFunctions(params FunctionCall[] functions)
    Parameters
    Type Name Description
    FunctionCall[] functions
    Returns
    Type Description
    TSelf

    SetInstructions(string)

    Sets the instruction for the task. This is a specific command or request for the model to follow.

    Declaration
    public TSelf SetInstructions(string instructions)
    Parameters
    Type Name Description
    string instructions
    Returns
    Type Description
    TSelf

    SetJsonSchema(IJsonSchema)

    Declaration
    public TSelf SetJsonSchema(IJsonSchema jsonSchema)
    Parameters
    Type Name Description
    IJsonSchema jsonSchema
    Returns
    Type Description
    TSelf

    SetJsonSchema(Type)

    Declaration
    public TSelf SetJsonSchema(Type type)
    Parameters
    Type Name Description
    Type type
    Returns
    Type Description
    TSelf

    SetMaxTokens(int)

    Declaration
    public TSelf SetMaxTokens(int maxTokens)
    Parameters
    Type Name Description
    int maxTokens
    Returns
    Type Description
    TSelf

    SetMessages(params ChatMessage[])

    Declaration
    public TSelf SetMessages(params ChatMessage[] messages)
    Parameters
    Type Name Description
    ChatMessage[] messages
    Returns
    Type Description
    TSelf

    SetModeration(ModerationOptions)

    Declaration
    public TSelf SetModeration(ModerationOptions options)
    Parameters
    Type Name Description
    ModerationOptions options
    Returns
    Type Description
    TSelf

    SetSeed(uint)

    Declaration
    public TSelf SetSeed(uint seed)
    Parameters
    Type Name Description
    uint seed
    Returns
    Type Description
    TSelf

    SetStartingMessage(string)

    Declaration
    public TSelf SetStartingMessage(string startingMessage)
    Parameters
    Type Name Description
    string startingMessage
    Returns
    Type Description
    TSelf

    SetStopSequences(params string[])

    Declaration
    public TSelf SetStopSequences(params string[] stopSequences)
    Parameters
    Type Name Description
    string[] stopSequences
    Returns
    Type Description
    TSelf

    SetSystemInstructions(string)

    Redirects to SetInstructions(string) for setting system instructions.

    Declaration
    public TSelf SetSystemInstructions(string systemInstructions)
    Parameters
    Type Name Description
    string systemInstructions
    Returns
    Type Description
    TSelf

    SetTemperature(float)

    Declaration
    public TSelf SetTemperature(float temperature)
    Parameters
    Type Name Description
    float temperature
    Returns
    Type Description
    TSelf

    SetTools(params ToolCall[])

    Declaration
    public TSelf SetTools(params ToolCall[] tools)
    Parameters
    Type Name Description
    ToolCall[] tools
    Returns
    Type Description
    TSelf

    Implements

    IGENTextTask
    IGENTask
    In this article
    Back to top Generated by DocFX