Skip to content

Update docstring for Project.validate, for the query argument #98

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

Closed
wants to merge 1 commit into from
Closed

Update docstring for Project.validate, for the query argument #98

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 src/cleanlab_codex/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ def validate(
This must include the final user message that triggered the AI response. All other arguments—`query`, `context`, and `response`—
must correspond specifically to this final user message.
response (ChatCompletion | str): Your AI-response that was generated based on the given `messages`. This is the response being evaluated, and should not appear in the `messages`.
query (str): The user query that the `response` is answering. This query should be the latest user message in `messages`.
query (str): The user query that the `response` is answering. This query should be in the latest user message in `messages`.
context (str): The retrieved context (e.g., from your RAG system) that was supplied to the AI when generating the `response` to the final user query in `messages`.
rewritten_query (str, optional): An optional reformulation of `query` (e.g. made self-contained w.r.t multi-turn conversations) to improve retrieval quality.
metadata (object, optional): Arbitrary metadata to associate with this validation for logging or analysis inside the Codex project.
Expand Down