Skip to content

update demo code in readme #114

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

Merged
merged 2 commits into from
Oct 15, 2025
Merged

update demo code in readme #114

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4591177
update demo code in readme
axl1313 Oct 9, 2025
860733f
Merge branch 'main' into axl1313-patch-4
axl1313 Oct 15, 2025
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ pip install cleanlab-codex
Integrating Codex into your RAG application is as simple as:

```python
from cleanlab_codex import Validator
validator = Validator(codex_access_key=...) # optional configurations can improve accuracy/latency
from cleanlab_codex import Project
project = Project.from_access_key(...)

# Your existing RAG code:
context = rag_retrieve_context(user_query)
prompt = rag_form_prompt(user_query, retrieved_context)
response = rag_generate_response(prompt)

# Detect bad responses and remediate with Cleanlab
results = validator.validate(query=query, context=context, response=response,
form_prompt=rag_form_prompt)
results = project.validate(query=query, context=context, response=response,
messages=[..., prompt])

final_response = (
results["expert_answer"] # Codex's answer
if results["is_bad_response"] and results["expert_answer"]
if results["expert_answer"] is not None
else response # Your RAG system's initial response
)
```
Expand Down