Skip to main content

Classes

ReflectionAction

Action to take based on evaluation.

Values

ValueDescription
ACCEPTAccept the current response
REVISERevise the response based on feedback
RETRYRetry with different approach
CLARIFYNeed clarification from user

EvaluationCriteria

Criteria for evaluating responses.

Parameters

ParameterTypeDefaultDescription
accuracyfloat-Accuracy of the information (0-1)
completenessfloat-Completeness of the response (0-1)
relevancefloat-Relevance to the task (0-1)
clarityfloat-Clarity and readability (0-1)

Functions

overall_score
Calculate overall evaluation score. Returns:
  • float: The overall evaluation score

EvaluationResult

Result of response evaluation.

Parameters

ParameterTypeDefaultDescription
criteriaEvaluationCriteria-Criteria for evaluating responses
overall_scorefloat-Overall evaluation score (0-1)
feedbackstr-Detailed feedback for improvement
suggested_improvementsList[str]-Specific improvement suggestions
actionReflectionAction-Recommended action
confidencefloat-Confidence in evaluation (0-1)

Functions

__post_init__
Calculate overall score after initialization.

ReflectionConfig

Configuration for reflection process.

Parameters

ParameterTypeDefaultDescription
max_iterationsint3Maximum reflection iterations
acceptance_thresholdfloat0.8Minimum score to accept response
evaluator_modelOptional[str]NoneModel for evaluation
enable_self_critiqueboolTrueEnable self-critique
enable_improvement_suggestionsboolTrueEnable improvement suggestions

ReflectionState

State tracking for reflection process.

Parameters

ParameterTypeDefaultDescription
iterationint0Current iteration number
evaluationsList[EvaluationResult][]History of evaluations
responsesList[str][]History of responses
final_responseOptional[str]NoneFinal accepted response
terminated_reasonOptional[str]NoneReason for termination

Functions

add_evaluation
Add an evaluation result to the state. Parameters:
  • response (str): The response text
  • evaluation (EvaluationResult): The evaluation result
get_latest_evaluation
Get the most recent evaluation. Returns:
  • Optional[EvaluationResult]: The most recent evaluation result
should_continue
Check if reflection should continue. Parameters:
  • config (ReflectionConfig): The reflection configuration
Returns:
  • bool: True if reflection should continue

ReflectionPrompts

Prompt templates for reflection process.

Parameters

ParameterTypeDefaultDescription
EVALUATION_PROMPTstr-Template for evaluation prompts
IMPROVEMENT_PROMPTstr-Template for improvement prompts
SELF_CRITIQUE_PROMPTstr-Template for self-critique prompts
I