Class LlmTask

Interacts with a Large Language Model (LLM) to generate a text response based on a user-provided prompt.

Input: None

Returns: Text generated by the LLM based on the provided prompt and configuration.

Example: Using OpenAI's GPT-4 model to generate a joke.

{
"llmTask": {
"providerConfig": {
"openai": {
"model": "gpt-4",
"userPrompt": "Tell me a joke.",
"temperature": 0.7,
"secretNameApiKey": "${OPENAI_API_KEY}"
}
}
}

Implements

Constructors

constructor

Properties

grokxai? groq? openai? providerConfig?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

Optionalgrokxai

grokxai?: null | IGrokXAIConfig

LlmTask grokxai.

Optionalgroq

groq?: null | IGroqConfig

LlmTask groq.

Optionalopenai

openai?: null | IOpenAIConfig

LlmTask openai.

OptionalproviderConfig

providerConfig?: "openai" | "groq" | "grokxai"

LlmTask providerConfig.

Methods

toJSON

  • toJSON(): { [k: string]: any }

    Converts this LlmTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: ILlmTask): OracleJob.LlmTask

    Creates a new LlmTask instance using the specified properties.

    Parameters

    • Optionalproperties: ILlmTask

      Properties to set

    Returns OracleJob.LlmTask

    LlmTask instance

Staticdecode

  • decode(
        reader: Uint8Array<ArrayBufferLike> | Reader,
        length?: number,
    ): OracleJob.LlmTask

    Decodes a LlmTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    • Optionallength: number

      Message length if known beforehand

    Returns OracleJob.LlmTask

    LlmTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(reader: Uint8Array<ArrayBufferLike> | Reader): OracleJob.LlmTask

    Decodes a LlmTask message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.LlmTask

    LlmTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

  • encode(message: ILlmTask, writer?: Writer): Writer

    Encodes the specified LlmTask message. Does not implicitly {@apilink oracle_job.OracleJob.LlmTask.verify|verify} messages.

    Parameters

    • message: ILlmTask

      LlmTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

  • encodeDelimited(message: ILlmTask, writer?: Writer): Writer

    Encodes the specified LlmTask message, length delimited. Does not implicitly {@apilink oracle_job.OracleJob.LlmTask.verify|verify} messages.

    Parameters

    • message: ILlmTask

      LlmTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): OracleJob.LlmTask

    Creates a LlmTask message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: { [k: string]: any }

      Plain object

    Returns OracleJob.LlmTask

    LlmTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for LlmTask

    Parameters

    Returns string

    The default type url

StatictoObject

  • toObject(
        message: OracleJob.LlmTask,
        options?: IConversionOptions,
    ): { [k: string]: any }

    Creates a plain object from a LlmTask message. Also converts values to other types if specified.

    Parameters

    • message: OracleJob.LlmTask

      LlmTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

  • verify(message: { [k: string]: any }): null | string

    Verifies a LlmTask message.

    Parameters

    • message: { [k: string]: any }

      Plain object to verify

    Returns null | string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods