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

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)

Why Codex?

  • Identify Knowledge Gaps: Codex captures knowledge gaps in your application so that you can easily identify which questions require expert input.
  • Efficiently Leverage SMEs: Codex ensures the SMEs see the most critical knowledge gaps first.
  • Easy Integration: Integrate Codex into your RAG/Agentic application with just a few lines of code.
  • Immediate Impact: SME responses instantly enhance your AI applications.

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-0.0.1a3.tar.gz (19.4 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-0.0.1a3-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file cleanlab_codex-0.0.1a3.tar.gz.

File metadata

  • Download URL: cleanlab_codex-0.0.1a3.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for cleanlab_codex-0.0.1a3.tar.gz
Algorithm Hash digest
SHA256 21e4f416119aed252400540e8ad92ebb123cc4dd1781fea9903eacb3c137e077
MD5 477a6643e66ac4b2df19f09eb559219f
BLAKE2b-256 7a5dde021d65c5c5a09c328cdf401a2c8185450a681c0ee4a22083137ff48384

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanlab_codex-0.0.1a3.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-0.0.1a3-py3-none-any.whl.

File metadata

File hashes

Hashes for cleanlab_codex-0.0.1a3-py3-none-any.whl
Algorithm Hash digest
SHA256 c28521139bc7c3b061af2366ee2557d0307ffa02a62b9d43f2dddf627937060a
MD5 abd5d789aafa920e630cb372c1c732c7
BLAKE2b-256 db053110ff2fefc512999f64a8dd23951d9817e8dad2b62fe0a7c2f5956d4474

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanlab_codex-0.0.1a3-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