📖 References

Reference documents for the ragas package.

• Evaluation
  • evaluate()
  • Result
• Metrics
  • AnswerCorrectness
    • AnswerCorrectness.name
    • AnswerCorrectness.weights
    • AnswerCorrectness.answer_similarity
    • AnswerCorrectness.adapt()
    • AnswerCorrectness.init()
    • AnswerCorrectness.save()
  • AnswerRelevancy
    • AnswerRelevancy.name
    • AnswerRelevancy.strictness
    • AnswerRelevancy.embeddings
    • AnswerRelevancy.adapt()
    • AnswerRelevancy.save()
  • AnswerSimilarity
    • AnswerSimilarity.name
    • AnswerSimilarity.model_name
    • AnswerSimilarity.threshold
  • AspectCritique
    • AspectCritique.name
    • AspectCritique.definition
    • AspectCritique.strictness
    • AspectCritique.llm
    • AspectCritique.adapt()
    • AspectCritique.save()
  • ContextEntityRecall
    • ContextEntityRecall.name
    • ContextEntityRecall.batch_size
    • ContextEntityRecall.save()
  • ContextPrecision
    • ContextPrecision.name
    • ContextPrecision.evaluation_mode
    • ContextPrecision.context_precision_prompt
    • ContextPrecision.adapt()
    • ContextPrecision.save()
  • ContextRecall
    • ContextRecall.name
    • ContextRecall.adapt()
    • ContextRecall.save()
  • ContextUtilization
  • Faithfulness
    • Faithfulness.adapt()
    • Faithfulness.save()
  • FaithulnesswithHHEM
  • LabelledRubricsScore
    • LabelledRubricsScore.adapt()
    • LabelledRubricsScore.save()
  • NoiseSensitivity
    • NoiseSensitivity.adapt()
    • NoiseSensitivity.save()
  • ReferenceFreeRubricsScore
  • SummarizationScore
    • SummarizationScore.adapt()
• RunConfig
  • rng
• Integrations