Class PairwiseEmbeddingDistanceEvalChain

Use embedding distances to score semantic difference between two predictions.

Hierarchy

  • PairwiseStringEvaluator
    • PairwiseEmbeddingDistanceEvalChain

Implements

Constructors

Properties

distanceMetric: EmbeddingDistanceType = "cosine"

The distance metric to use for comparing the embeddings.

outputKey: string = "score"
requiresInput: boolean = false
requiresReference: boolean = false
verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
embedding?: Embeddings

The embedding objects to vectorize the outputs.

evaluationName?: string = ...

The name of the evaluation.

memory?: BaseMemory
metadata?: Record<string, unknown>
skipInputWarning?: string = ...
skipReferenceWarning?: string = ...
tags?: string[]

Accessors

Methods

  • 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.

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

    Parameters

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<ChainValues, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<ChainValues, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<ChainValues, any, unknown>

Generated using TypeDoc