Skip to content

docs: sync README files with latest repo state #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yyiilluu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: sync README files with latest repo state #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion reflexio/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ client (Python SDK)
- **`api_endpoints/`**: Request handling, `RequestContext` (bundles storage/config/prompts), auth
- **`routes/`**: Domain route modules (`system.py`, `interactions.py`, `profiles.py`, `playbooks.py`, `search.py`, `provenance.py`, `evaluation.py`, `braintrust.py`, `config.py`) included into `api.py`'s `core_router`
- **`db/`**: Auth & config storage only (SQLite) - NOT for profiles/interactions
- **`llm/`**: Unified LiteLLM client, provider adapters, local rerank helpers, structured-output repair, and fail-open per-provider concurrency caps
- **`llm/`**: Unified LiteLLM client, provider adapters, local/internal embedding service routing, cross-encoder rerank service support, structured-output repair, and fail-open per-provider concurrency caps
- **`prompt/`**: Versioned prompt templates in `prompt_bank/`
- **`services/`**: Core business logic
- `generation_service.py` - Orchestrator (runs profile/playbook/success services)
Expand Down
5 changes: 4 additions & 1 deletion reflexio/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,10 @@ Key files:
- `litellm_client.py`: Stable import surface, client config/credential resolution, and `LiteLLMClient` facade
- `_litellm_text_generation.py`, `_litellm_embedding.py`, `_litellm_structured_output.py`: Completion/tool-call, embedding, and structured-output mixins
- `_litellm_json_extraction.py`, `_litellm_subprocess.py`, `_provider_concurrency.py`, `_litellm_types.py`: JSON parsing, hard-timeout subprocess snapshots/workers, per-provider fail-open concurrency caps, and shared public types/errors
- `providers/`: Optional local/provider adapters (`claude-code/`, OpenClaw, local embedding, Nomic embedding); registration is opt-in via environment/config
- `embedding_service.py`: OpenAI-compatible local/internal embedding daemon with `/v1/embeddings`, `/v1/rerank`, `/health`, micro-batching, and single-active-model warmup
- `providers/embedding_service_provider.py`: Routing boundary for `REFLEXIO_EMBEDDING_PROVIDER` (`cloud`, `local_service`, `internal_service`, `inprocess`, `off`), service URL/timeouts, local daemon probing, and request splitting
- `rerank/cross_encoder_reranker.py`: Cross-encoder rerank helper; uses in-process scoring by default or delegates to `REFLEXIO_RERANK_SERVICE_URL`
- `providers/`: Optional local/provider adapters (`claude-code/`, OpenClaw, local embedding, Nomic embedding, embedding service); registration is opt-in via environment/config
- `openai_client.py`: OpenAI implementation (legacy, do not use directly)
- `claude_client.py`: Claude implementation (legacy, do not use directly)
- `llm_utils.py`: Helper functions for Pydantic model conversion
Expand Down