Class PairwiseEmbeddingDistanceEvalChain

Use embedding distances to score semantic difference between two predictions.

Hierarchy

PairwiseStringEvaluator
- PairwiseEmbeddingDistanceEvalChain

Implements

EmbeddingDistanceEvalChainInput

Constructors

constructor

new PairwiseEmbeddingDistanceEvalChain(
fields: EmbeddingDistanceEvalChainInput,
): PairwiseEmbeddingDistanceEvalChain
Parameters
- fields: EmbeddingDistanceEvalChainInput
Returns PairwiseEmbeddingDistanceEvalChain
Overrides PairwiseStringEvaluator.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/embedding_distance/base.ts:166

Properties

distanceMetric

distanceMetric: EmbeddingDistanceType = "cosine"

The distance metric to use for comparing the embeddings.

`Optional`embedding

embedding?: any

The embedding objects to vectorize the outputs.

`Optional`evaluationName

evaluationName?: string = ...

The name of the evaluation.

`Optional`memory

memory?: any

outputKey

outputKey: string = "score"

requiresInput

requiresInput: boolean = false

requiresReference

requiresReference: boolean = false

`Optional`skipInputWarning

skipInputWarning?: string = ...

`Optional`skipReferenceWarning

skipReferenceWarning?: string = ...

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides PairwiseStringEvaluator.inputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/embedding_distance/base.ts:185

lc_namespace

get lc_namespace(): string[]
Returns string[]
Inherited from QAEvalChain.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:41

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides PairwiseStringEvaluator.outputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/embedding_distance/base.ts:189

Methods

_call

_call(values: ChainValues, _runManager: any): Promise<ChainValues>
Run the core logic of this chain and return the output
Parameters
- values: ChainValues
- _runManager: any
Returns Promise<ChainValues>
Overrides PairwiseStringEvaluator._call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/embedding_distance/base.ts:193

_chainType

_chainType(): | "pairwise_embedding_cosine_distance"
| "pairwise_embedding_euclidean_distance"
| "pairwise_embedding_manhattan_distance"
| "pairwise_embedding_chebyshev_distance"
Return the string type key uniquely identifying this class of chain.

Returns
    | "pairwise_embedding_cosine_distance"
    | "pairwise_embedding_euclidean_distance"
    | "pairwise_embedding_manhattan_distance"
    | "pairwise_embedding_chebyshev_distance"
Overrides PairwiseStringEvaluator._chainType
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/embedding_distance/base.ts:172

_evaluateStringPairs

_evaluateStringPairs(
args: PairwiseStringEvaluatorArgs,
config?: any,
): Promise<ChainValues>
Evaluate the output string pairs.
Parameters
- args: PairwiseStringEvaluatorArgs
- Optionalconfig: any
Returns Promise<ChainValues>
A dictionary containing the preference, scores, and/or other information.
Overrides PairwiseStringEvaluator._evaluateStringPairs
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/embedding_distance/base.ts:176

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from PairwiseStringEvaluator._formatValues
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:217

apply

apply(inputs: ChainValues[], config?: any[]): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optionalconfig: any[]
Returns Promise<ChainValues[]>
Deprecated
Use .batch() instead. Will be removed in 0.2.0.

Call the chain on all inputs in the list
Inherited from PairwiseStringEvaluator.apply
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:258

call

call(values: any, config?: any, tags?: string[]): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: 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.
Inherited from PairwiseStringEvaluator.call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:243

checkEvaluationArgs

checkEvaluationArgs(reference?: string, input?: string): void
Check if the evaluation arguments are valid.
Parameters
- Optionalreference: string
  The reference label.
- Optionalinput: 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.
Inherited from PairwiseStringEvaluator.checkEvaluationArgs
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/base.ts:97

evaluateStringPairs

evaluateStringPairs(
args: PairwiseStringEvaluatorArgs,
config?: any,
): Promise<ChainValues>
Evaluate the output string pairs.
Parameters
- args: PairwiseStringEvaluatorArgs
- Optionalconfig: any
Returns Promise<ChainValues>
A dictionary containing the preference, scores, and/or other information.
Inherited from PairwiseStringEvaluator.evaluateStringPairs
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/evaluation/base.ts:273

invoke

invoke(input: ChainValues, options?: any): Promise<ChainValues>
Invoke the chain with the provided input and returns the output.
Parameters
- input: ChainValues
  Input values for the chain run.
- Optionaloptions: any
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from PairwiseStringEvaluator.invoke
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:86

prepOutputs

prepOutputs(
    inputs: Record<string, unknown>,
    outputs: Record<string, unknown>,
    returnOnlyOutputs?: boolean,
): Promise<Record<string, unknown>>
Parameters
- inputs: Record<string, unknown>
- outputs: Record<string, unknown>
- returnOnlyOutputs: boolean = false
Returns Promise<Record<string, unknown>>
Inherited from PairwiseStringEvaluator.prepOutputs
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:149

run

run(input: any, config?: any): Promise<string>
Parameters
- input: any
- Optionalconfig: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from PairwiseStringEvaluator.run
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:190

serialize

serialize(): SerializedBaseChain
Return a json-like object representing this chain.

Returns SerializedBaseChain
Inherited from PairwiseStringEvaluator.serialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:181

`Static`deserialize

deserialize(
data: SerializedBaseChain,
values?: LoadValues,
): Promise<BaseChain<ChainValues, ChainValues>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedBaseChain
- values: LoadValues = {}
Returns Promise<BaseChain<ChainValues, ChainValues>>
Inherited from PairwiseStringEvaluator.deserialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:270

Class PairwiseEmbeddingDistanceEvalChain

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PairwiseEmbeddingDistanceEvalChain

Properties

distanceMetric

Optionalembedding

OptionalevaluationName

Optionalmemory

outputKey

requiresInput

requiresReference

OptionalskipInputWarning

OptionalskipReferenceWarning

Accessors

inputKeys

Returns string[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_call

Parameters

Returns Promise<ChainValues>

_chainType

Returns | "pairwise_embedding_cosine_distance" | "pairwise_embedding_euclidean_distance" | "pairwise_embedding_manhattan_distance" | "pairwise_embedding_chebyshev_distance"

_evaluateStringPairs

Parameters

Returns Promise<ChainValues>

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

checkEvaluationArgs

Parameters

Returns void

Throws

evaluateStringPairs

Parameters

Returns Promise<ChainValues>

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Staticdeserialize

Parameters

Returns Promise<BaseChain<ChainValues, ChainValues>>

Settings

On This Page

`Optional`embedding

`Optional`evaluationName

`Optional`memory

`Optional`skipInputWarning

`Optional`skipReferenceWarning

Returns
| "pairwise_embedding_cosine_distance"
| "pairwise_embedding_euclidean_distance"
| "pairwise_embedding_manhattan_distance"
| "pairwise_embedding_chebyshev_distance"

`Protected`_formatValues

`Static`deserialize