Skip to main content

Python client library for developers to integrate Cleanlab Codex into RAG systems

Project description

Cleanlab Codex - Closing the AI Knowledge Gap

Build Status PyPI - Version PyPI - Python Version Docs

Codex enables you to seamlessly leverage knowledge from Subject Matter Experts (SMEs) to improve your RAG/Agentic applications.

The cleanlab-codex library provides a simple interface to integrate Codex's capabilities into your RAG application. See immediate impact with just a few lines of code!

Demo

Install the package:

pip install cleanlab-codex

Integrating Codex into your RAG application as a tool is as simple as:

from cleanlab_codex import CodexTool

def rag(question, system_prompt, tools) -> str:
    """Your RAG/Agentic code here"""
    ...

# Initialize the Codex tool
codex_tool = CodexTool.from_access_key("your-access-key")

# Update your system prompt to include information on how to use the Codex tool
system_prompt = f"""Answer the user's Question based on the following Context. If the Context doesn't adequately address the Question, use the {codex_tool.tool_name} tool to ask an outside expert."""

# Convert the Codex tool to a framework-specific tool
framework_specific_codex_tool = codex_tool.to_<framework_name>_tool() # i.e. codex_tool.to_llamaindex_tool(), codex_tool.to_openai_tool(), etc.

# Pass the Codex tool to your RAG/Agentic framework
response = rag(question, system_prompt, [framework_specific_codex_tool])

(Note: Exact code will depend on the RAG/Agentic framework you are using. Other integrations are available if you prefer to avoid Tool Calls.)

Why Codex?

  • Detect Knowledge Gaps and Hallucinations: Codex identifies knowledge gaps and incorrect/untrustworthy responses in your AI application, to help you know which questions require expert input.
  • Save SME time: Codex ensures that SMEs see the most critical knowledge gaps first.
  • Easy Integration: Integrate Codex into any RAG/Agentic application with just a few lines of code.
  • Immediate Impact: SME answers instantly improve your AI, without any additional Engineering/technical work.

Documentation

Comprehensive documentation along with tutorials and examples can be found here.

License

cleanlab-codex is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cleanlab_codex-1.0.11.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cleanlab_codex-1.0.11-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file cleanlab_codex-1.0.11.tar.gz.

File metadata

  • Download URL: cleanlab_codex-1.0.11.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cleanlab_codex-1.0.11.tar.gz
Algorithm Hash digest
SHA256 397a765d83ead16e9145ad1e32e60d408f26e61521a63fcfa01dcf73348807a1
MD5 9ad35e52b58326079f7bb8fc6c68f429
BLAKE2b-256 109b40ea9e933237d8960563e4bdc5579dc4b5c058ec2846d979db3c9edbd9e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanlab_codex-1.0.11.tar.gz:

Publisher: release.yml on cleanlab/cleanlab-codex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cleanlab_codex-1.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for cleanlab_codex-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 a6cf64f6513517040c56052b221c12f95a7452bdf5d63a161a90bb25161234d4
MD5 92bdb838af20c2e5b924925075fb0ef7
BLAKE2b-256 9dcd73db81148dcab3a1469304058e5f5465c0ed7fb881d8a3902f363d2cdb4e

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanlab_codex-1.0.11-py3-none-any.whl:

Publisher: release.yml on cleanlab/cleanlab-codex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page