Class TaskCreationChain

Chain to generate tasks.

Hierarchy (view full)

Constructors

constructor

Properties

llm outputKey prompt llmKwargs? memory? outputParser?

Accessors

inputKeys outputKeys

Methods

apply call invoke predict prepOutputs run serialize deserialize fromLLM

Constructors

constructor

Properties

llm

llm: LLMType

LLM Wrapper to use

outputKey

outputKey: string = "text"

Key to use for output, defaults to text

prompt

prompt: BasePromptTemplate<any, BasePromptValueInterface, any>

Prompt object to use

Optional llmKwargs

llmKwargs?: any

Kwargs to pass to LLM

Optional memory

memory?: BaseMemory

Optional outputParser

outputParser?: BaseLLMOutputParser<string>

OutputParser to use

Accessors

inputKeys

outputKeys

Methods

apply

  • apply(inputs, config?): Promise<ChainValues[]>

  • Parameters

    • inputs: ChainValues[]
    • Optional config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]

    Returns Promise<ChainValues[]>

    ⚠️ Deprecated ⚠️

    Use .batch() instead. Will be removed in 0.2.0.

    This feature is deprecated and will be removed in the future.

    It is not recommended for use.

    Call the chain on all inputs in the list

call

  • call(values, config?): Promise<ChainValues>

  • Run the core logic of this chain and add to output if desired.

    Wraps _call and handles memory.

    Parameters

    • values: any
    • Optional config: BaseCallbackConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

    Returns Promise<ChainValues>

invoke

  • invoke(input, options?): Promise<ChainValues>

  • Invoke the chain with the provided input and returns the output.

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional options: RunnableConfig

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

predict

  • predict(values, callbackManager?): Promise<string>

  • Format prompt with values and pass to LLM

    Parameters

    • values: any

      keys to pass to prompt template

    • Optional callbackManager: CallbackManager

      CallbackManager to use

    Returns Promise<string>

    Completion from LLM.

    Example

    llm.predict({ adjective: "funny" })

prepOutputs

  • prepOutputs(inputs, outputs, returnOnlyOutputs?): Promise<Record<string, unknown>>

  • Parameters

    • inputs: Record<string, unknown>
    • outputs: Record<string, unknown>
    • returnOnlyOutputs: boolean = false

    Returns Promise<Record<string, unknown>>

run

  • run(input, config?): Promise<string>

  • Parameters

    • input: any
    • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

    Returns Promise<string>

    Deprecated

    Use .invoke() instead. Will be removed in 0.2.0.

serialize

Static deserialize

Static fromLLM

  • fromLLM(fields): LLMChain<string, LLMType>

  • Creates a new TaskCreationChain instance. It takes an object of type LLMChainInput as input, omitting the 'prompt' field. It uses the PromptTemplate class to create a new prompt based on the task creation template and the input variables. The new TaskCreationChain instance is then created with this prompt and the remaining fields from the input object.

    Parameters

    • fields: Omit<LLMChainInput<string, LLMType>, "prompt">

      An object of type LLMChainInput, omitting the 'prompt' field.

    Returns LLMChain<string, LLMType>

    A new instance of TaskCreationChain.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc