FaithfulnessEvaluator
Defined in: .build/typescript/packages/llamaindex/src/evaluation/Faithfulness.ts:20
Extends
Section titled “Extends”PromptMixin
Implements
Section titled “Implements”BaseEvaluator
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FaithfulnessEvaluator(
params?):FaithfulnessEvaluator
Defined in: .build/typescript/packages/llamaindex/src/evaluation/Faithfulness.ts:28
Parameters
Section titled “Parameters”params?
Section titled “params?”raiseError?
Section titled “raiseError?”boolean
faithfulnessSystemPrompt?
Section titled “faithfulnessSystemPrompt?”faithFulnessRefinePrompt?
Section titled “faithFulnessRefinePrompt?”Returns
Section titled “Returns”FaithfulnessEvaluator
Overrides
Section titled “Overrides”PromptMixin.constructor
Methods
Section titled “Methods”_getPromptModules()
Section titled “_getPromptModules()”
protected_getPromptModules():ModuleRecord
Defined in: .build/typescript/packages/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
Section titled “Returns”ModuleRecord
Overrides
Section titled “Overrides”PromptMixin._getPromptModules
_getPrompts()
Section titled “_getPrompts()”
protected_getPrompts():object
Defined in: .build/typescript/packages/llamaindex/src/evaluation/Faithfulness.ts:47
Returns
Section titled “Returns”object
Overrides
Section titled “Overrides”PromptMixin._getPrompts
_updatePrompts()
Section titled “_updatePrompts()”
protected_updatePrompts(promptsDict):void
Defined in: .build/typescript/packages/llamaindex/src/evaluation/Faithfulness.ts:54
Parameters
Section titled “Parameters”promptsDict
Section titled “promptsDict”faithfulnessSystemPrompt
Section titled “faithfulnessSystemPrompt”faithFulnessRefinePrompt
Section titled “faithFulnessRefinePrompt”Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”PromptMixin._updatePrompts
evaluate()
Section titled “evaluate()”evaluate(
__namedParameters):Promise<EvaluationResult>
Defined in: .build/typescript/packages/llamaindex/src/evaluation/Faithfulness.ts:74
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”EvaluatorParams
Returns
Section titled “Returns”Promise<EvaluationResult>
Implementation of
Section titled “Implementation of”BaseEvaluator.evaluate
evaluateResponse()
Section titled “evaluateResponse()”evaluateResponse(
__namedParameters):Promise<EvaluationResult>
Defined in: .build/typescript/packages/llamaindex/src/evaluation/Faithfulness.ts:132
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”EvaluatorResponseParams
Returns
Section titled “Returns”Promise<EvaluationResult>
Implementation of
Section titled “Implementation of”BaseEvaluator.evaluateResponse