Class QAEvalChain

Deprecated

This class will be removed in 0.3.0. Use the LangChain Expression Language (LCEL) instead. See the example below for how to use LCEL with the LLMChain class:

Chain to run queries against LLMs.

Example

import { ChatPromptTemplate } from "@langchain/core/prompts";
import { ChatOpenAI } from "@langchain/openai";

const prompt = ChatPromptTemplate.fromTemplate("Tell me a {adjective} joke");
const llm = new ChatOpenAI();
const chain = prompt.pipe(llm);

const response = await chain.invoke({ adjective: "funny" });

Hierarchy (view full)

Constructors

constructor

Properties

llm outputKey prompt llmKwargs? memory? outputParser?

Accessors

inputKeys outputKeys

Methods

apply call evaluate 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>

evaluate

  • evaluate(examples, predictions, args?): Promise<ChainValues>

  • Parameters

    • examples: ChainValues
    • predictions: ChainValues
    • args: EvaluateArgs = ...

    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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc