Skip to content

Commit 2732575

Browse files
docs: add scope sections to README (#13)
1 parent 8df0428 commit 2732575

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,29 @@ This library solves my challenges in building production-ready AI Agents such as
2121

2222
This library aims to solve the same challenges for you by providing a resilient layer that intelligently manages failures and rate limits, enabling you (developers) to integrate LLMs confidently and effortlessly at scale.
2323

24+
## Scope
25+
26+
### What's in scope
27+
28+
- **Unified LLM Interface**: Simple, consistent API across multiple LLM providers (OpenAI, Anthropic, Google Gemini, Ollama)
29+
- **Resilience Features**: Circuit breakers, adaptive retries with exponential backoff, and intelligent failure recovery
30+
- **Rate Limiting**: Token bucket rate limiting with automatic token estimation and enforcement
31+
- **Production Readiness**: Handling of network issues, API rate limits, timeouts, and server overload scenarios
32+
- **Basic Chat Functionality**: Support for conversational chat interfaces and message history
33+
- **Request Control**: AbortController support for on-demand request cancellation and timeouts
34+
- **Error Recovery**: Dynamic response to API signals like retry-after headers and provider-specific error codes
35+
36+
### What's not in scope
37+
38+
- **Complex LLM Orchestration**: Advanced workflows, chains, or multi-step LLM interactions (use LangChain or similar for complex use cases)
39+
- **Multi-modal Support**: Image, audio, or video processing capabilities
40+
- **Tool/Function Calling**: Advanced function calling or tool integration features
41+
- **Streaming Responses**: Real-time streaming of LLM responses
42+
- **Vector Databases**: Embedding storage, similarity search, or RAG (Retrieval-Augmented Generation) capabilities
43+
- **Fine-tuning or Training**: Model training, fine-tuning, or custom model deployment
44+
- **UI Components**: Frontend widgets, chat interfaces, or user interface elements
45+
- **Data Processing Pipelines**: ETL processes, data transformation, or batch processing workflows
46+
2447
## Quickstart
2548

2649
```javascript

0 commit comments

Comments
 (0)