Class: RelevancyEvaluator
Hierarchy
-
↳
RelevancyEvaluator
Implements
BaseEvaluator
Constructors
constructor
• new RelevancyEvaluator(params?
): RelevancyEvaluator
Parameters
Name | Type |
---|---|
params? | RelevancyParams |
Returns
Overrides
Defined in
packages/core/src/evaluation/Relevancy.ts:31
Properties
evalTemplate
• Private
evalTemplate: (__namedParameters
: { context
: string
; query
: string
}) => string
Type declaration
▸ («destructured»
): string
Parameters
Name | Type |
---|---|
«destructured» | Object |
› context | string |
› query | string |
Returns
string
Defined in
packages/core/src/evaluation/Relevancy.ts:28
raiseError
• Private
raiseError: boolean
Defined in
packages/core/src/evaluation/Relevancy.ts:26
refineTemplate
• Private
refineTemplate: (__namedParameters
: { contextMsg
: string
; existingAnswer
: string
; query
: string
}) => string
Type declaration
▸ («destructured»
): string
Parameters
Name | Type |
---|---|
«destructured» | Object |
› contextMsg | string |
› existingAnswer | string |
› query | string |
Returns
string
Defined in
packages/core/src/evaluation/Relevancy.ts:29
serviceContext
• Private
Optional
serviceContext: ServiceContext
Defined in
packages/core/src/evaluation/Relevancy.ts:25
Methods
_getPromptModules
▸ _getPromptModules(): Record
<string
, any
>
Returns
Record
<string
, any
>
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:82
_getPrompts
▸ _getPrompts(): Object
Returns
Object
Name | Type |
---|---|
evalTemplate | (__namedParameters : { context : string ; query : string }) => string |
refineTemplate | (__namedParameters : { contextMsg : string ; existingAnswer : string ; query : string }) => string |
Overrides
Defined in
packages/core/src/evaluation/Relevancy.ts:41
_updatePrompts
▸ _updatePrompts(prompts
): void
Parameters
Name | Type |
---|---|
prompts | Object |
prompts.evalTemplate | (__namedParameters : { context : string ; query : string }) => string |
prompts.refineTemplate | (__namedParameters : { contextMsg : string ; existingAnswer : string ; query : string }) => string |
Returns
void
Overrides
Defined in
packages/core/src/evaluation/Relevancy.ts:48
evaluate
▸ evaluate(«destructured»
): Promise
<EvaluationResult
>
Parameters
Name | Type |
---|---|
«destructured» | EvaluatorParams |
Returns
Promise
<EvaluationResult
>
Implementation of
BaseEvaluator.evaluate
Defined in
packages/core/src/evaluation/Relevancy.ts:60
evaluateResponse
▸ evaluateResponse(«destructured»
): Promise
<EvaluationResult
>
Parameters
Name | Type |
---|---|
«destructured» | EvaluatorResponseParams |
Returns
Promise
<EvaluationResult
>
Implementation of
BaseEvaluator.evaluateResponse
Defined in
packages/core/src/evaluation/Relevancy.ts:120
getPrompts
▸ getPrompts(): PromptsDict
Returns all prompts from the mixin and its modules
Returns
PromptsDict
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:27
updatePrompts
▸ updatePrompts(promptsDict
): void
Updates the prompts in the mixin and its modules
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
Returns
void
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:48
validatePrompts
▸ validatePrompts(promptsDict
, moduleDict
): void
Validates the prompt keys and module keys
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
moduleDict | ModuleDict |
Returns
void