Class EmbeddingDistanceEvalChain

Optional evaluationName

Optional memory

Optional skipInputWarning

Optional skipReferenceWarning

apply

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

• Parameters

  • inputs: ChainValues[]

  • Optional config: any[]

  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?, tags?): Promise<ChainValues>

• Parameters

  • values: any

  • Optional config: any

  • Optional tags: string[]

    Deprecated

  Returns Promise<ChainValues>

  Deprecated

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

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

  Wraps _call and handles memory.

checkEvaluationArgs

• checkEvaluationArgs(reference?, input?): void

• Check if the evaluation arguments are valid.

  Parameters

  • Optional reference: string

    The reference label.

  • Optional input: string

    The input string.

  Returns void

  Throws

  If the evaluator requires an input string but none is provided, or if the evaluator requires a reference label but none is provided.

evaluateStrings

• evaluateStrings(args, config?): Promise<ChainValues>

• Evaluate Chain or LLM output, based on optional input and label.

  Parameters

  • args: StringEvaluatorArgs

  • Optional config: any

  Returns Promise<ChainValues>

  The evaluation results containing the score or value. It is recommended that the dictionary contain the following keys:

  • score: the score of the evaluation, if applicable.
  • value: the string value of the evaluation, if applicable.
  • reasoning: the reasoning for the evaluation, if applicable.

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: any

  Returns Promise<ChainValues>

  Promise that resolves with the output of the chain run.

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: any

  Returns Promise<string>

  Deprecated

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

serialize

• serialize(): SerializedBaseChain

• Return a json-like object representing this chain.

  Returns SerializedBaseChain

Static deserialize

• deserialize(data, values?): Promise<BaseChain<ChainValues, ChainValues>>

• Load a chain from a json-like object describing it.

  Parameters

  • data: SerializedBaseChain

  • values: LoadValues = {}

  Returns Promise<BaseChain<ChainValues, ChainValues>>