Logo
Classes

FaithfulnessEvaluator

Defined in: llamaindex/src/evaluation/Faithfulness.ts:20

Extends

  • PromptMixin

Implements

  • BaseEvaluator

Constructors

new FaithfulnessEvaluator()

new FaithfulnessEvaluator(params?): FaithfulnessEvaluator

Defined in: llamaindex/src/evaluation/Faithfulness.ts:28

Parameters

params?
raiseError?

boolean

faithfulnessSystemPrompt?

FaithfulnessTextQAPrompt

faithFulnessRefinePrompt?

FaithfulnessRefinePrompt

Returns

FaithfulnessEvaluator

Overrides

PromptMixin.constructor

Methods

_getPromptModules()

protected _getPromptModules(): ModuleRecord

Defined in: llamaindex/src/evaluation/Faithfulness.ts:42

Return a dictionary of sub-modules within the current module that also implement PromptMixin (so that their prompts can also be get/set).

Can be blank if no sub-modules.

Returns

ModuleRecord

Overrides

PromptMixin._getPromptModules


_getPrompts()

protected _getPrompts(): object

Defined in: llamaindex/src/evaluation/Faithfulness.ts:47

Returns

object

Overrides

PromptMixin._getPrompts


_updatePrompts()

protected _updatePrompts(promptsDict): void

Defined in: llamaindex/src/evaluation/Faithfulness.ts:54

Parameters

promptsDict
faithfulnessSystemPrompt

FaithfulnessTextQAPrompt

faithFulnessRefinePrompt

FaithfulnessRefinePrompt

Returns

void

Overrides

PromptMixin._updatePrompts


evaluate()

evaluate(__namedParameters): Promise<EvaluationResult>

Defined in: llamaindex/src/evaluation/Faithfulness.ts:74

Parameters

__namedParameters

EvaluatorParams

Returns

Promise<EvaluationResult>

Implementation of

BaseEvaluator.evaluate


evaluateResponse()

evaluateResponse(__namedParameters): Promise<EvaluationResult>

Defined in: llamaindex/src/evaluation/Faithfulness.ts:132

Parameters

__namedParameters

EvaluatorResponseParams

Returns

Promise<EvaluationResult>

Implementation of

BaseEvaluator.evaluateResponse