Skip to main content

Class: FaithfulnessEvaluator

Hierarchy

Implements

  • BaseEvaluator

Constructors

constructor

new FaithfulnessEvaluator(params): FaithfulnessEvaluator

Parameters

NameType
paramsObject
params.faithFulnessRefinePrompt?(__namedParameters: { context: string ; existingAnswer: string ; query: string }) => string
params.faithfulnessSystemPrompt?(__namedParameters: { context: string ; query: string }) => string
params.raiseError?boolean
params.serviceContext?ServiceContext

Returns

FaithfulnessEvaluator

Overrides

PromptMixin.constructor

Defined in

packages/core/src/evaluation/Faithfulness.ts:30

Properties

evalTemplate

Private evalTemplate: (__namedParameters: { context: string ; query: string }) => string

Type declaration

▸ («destructured»): string

Parameters
NameType
«destructured»Object
› contextstring
› querystring
Returns

string

Defined in

packages/core/src/evaluation/Faithfulness.ts:27


raiseError

Private raiseError: boolean

Defined in

packages/core/src/evaluation/Faithfulness.ts:26


refineTemplate

Private refineTemplate: (__namedParameters: { context: string ; existingAnswer: string ; query: string }) => string

Type declaration

▸ («destructured»): string

Parameters
NameType
«destructured»Object
› contextstring
› existingAnswerstring
› querystring
Returns

string

Defined in

packages/core/src/evaluation/Faithfulness.ts:28


serviceContext

Private serviceContext: ServiceContext

Defined in

packages/core/src/evaluation/Faithfulness.ts:25

Methods

_getPromptModules

_getPromptModules(): Record<string, any>

Returns

Record<string, any>

Inherited from

PromptMixin._getPromptModules

Defined in

packages/core/src/prompts/Mixin.ts:82


_getPrompts

_getPrompts(): Object

Returns

Object

Overrides

PromptMixin._getPrompts

Defined in

packages/core/src/evaluation/Faithfulness.ts:46


_updatePrompts

_updatePrompts(promptsDict): void

Parameters

NameType
promptsDictObject
promptsDict.faithFulnessRefinePrompt(__namedParameters: { context: string ; existingAnswer: string ; query: string }) => string
promptsDict.faithfulnessSystemPrompt(__namedParameters: { context: string ; query: string }) => string

Returns

void

Overrides

PromptMixin._updatePrompts

Defined in

packages/core/src/evaluation/Faithfulness.ts:53


evaluate

evaluate(«destructured»): Promise<EvaluationResult>

Parameters

NameType
«destructured»EvaluatorParams

Returns

Promise<EvaluationResult>

Implementation of

BaseEvaluator.evaluate

Defined in

packages/core/src/evaluation/Faithfulness.ts:73


evaluateResponse

evaluateResponse(«destructured»): Promise<EvaluationResult>

Parameters

NameType
«destructured»EvaluatorResponseParams

Returns

Promise<EvaluationResult>

Implementation of

BaseEvaluator.evaluateResponse

Defined in

packages/core/src/evaluation/Faithfulness.ts:132


getPrompts

getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

PromptMixin.getPrompts

Defined in

packages/core/src/prompts/Mixin.ts:27


updatePrompts

updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

NameType
promptsDictPromptsDict

Returns

void

Inherited from

PromptMixin.updatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:48


validatePrompts

validatePrompts(promptsDict, moduleDict): void

Validates the prompt keys and module keys

Parameters

NameType
promptsDictPromptsDict
moduleDictModuleDict

Returns

void

Inherited from

PromptMixin.validatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:10