API References
This section contains detailed API documentation for all core components of Ragas. The documentation is organized into the following sections:
Core Components
- Prompt - Core prompt management and templating
- LLMs - Language model interfaces and configurations
- Embeddings - Embedding model interfaces and utilities
- Tokenizers - Tokenizer interfaces for text splitting
- RunConfig - Evaluation runtime configuration
- RateLimit - Requests and tokens per minute for LLM calls
- Executor - Execution engine for concurrent jobs
- Cache - Caching mechanisms for LLM calls
Evaluation
- Schemas - Samples, messages, datasets and experiments
- Metrics - Available metrics and their implementations
- metrics_experiment() - Score metrics over a dataset;
summarize()andcheck() - Sync and async runs -
run()andarun()
Testset Generation
- Schemas - Data structures for test data
- Graph - Knowledge graph creation and management
- Transforms - Data transformation utilities
- Synthesizers - Test data generation components
- Generation - Test data generation API
Integrations
- Integrations - APIs for external tool integrations