add ability to create remediations through client (#92)

Author: axl1313

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.21] 2025-06-22
+
+- Support adding remediations to a project
+- Docstring updates
+
 ## [1.0.20] 2025-06-17
 
 - Remove Codex-as-a-tool
@@ -99,8 +104,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release of the `cleanlab-codex` client library.
 
-[Unreleased]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.20...HEAD
-[1.0.19]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.19...v1.0.20
+[Unreleased]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.21...HEAD
+[1.0.21]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.20...v1.0.21
+[1.0.20]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.19...v1.0.20
 [1.0.19]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.18...v1.0.19
 [1.0.18]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.17...v1.0.18
 [1.0.17]: https://github.com/cleanlab/cleanlab-codex/compare/v1.0.16...v1.0.17

pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
 ]
 dependencies = [
   "cleanlab-tlm~=1.1",
-  "codex-sdk==0.1.0a20",
+  "codex-sdk==0.1.0a21",
   "pydantic>=2.0.0, <3",
 ]
 

src/cleanlab_codex/__about__.py

@@ -1,2 +1,2 @@
 # SPDX-License-Identifier: MIT
-__version__ = "1.0.20"
+__version__ = "1.0.21"

src/cleanlab_codex/project.py

@@ -4,7 +4,7 @@
 
 from datetime import datetime
 from typing import TYPE_CHECKING as _TYPE_CHECKING
-from typing import Dict, List, Literal, Optional
+from typing import Dict, Literal, Optional
 
 from codex import AuthenticationError
 
@@ -16,7 +16,6 @@
     from datetime import datetime
 
     from codex import Codex as _Codex
-    from codex.types.project_validate_params import Options as ProjectValidateOptions
     from codex.types.project_validate_response import ProjectValidateResponse
 
 
@@ -151,23 +150,49 @@ def validate(
         query: str,
         response: str,
         *,
-        constrain_outputs: Optional[List[str]] = None,
         custom_metadata: Optional[object] = None,
         eval_scores: Optional[Dict[str, float]] = None,
         eval_thresholds: Optional[Dict[str, float]] = None,
-        options: Optional[ProjectValidateOptions] = None,
         quality_preset: Literal["best", "high", "medium", "low", "base"] = "medium",
     ) -> ProjectValidateResponse:
+        """Run validation on a query to an AI system.
+
+        Args:
+            context (str): The context used by the AI system to generate a response for the query.
+            prompt (str): The full prompt (including system instructions, context, and the original query) used by the AI system to generate a response for the query.
+            query (str): The original user input to the AI system.
+            response (str): The response generated by the AI system for the query.
+            custom_metadata (object, optional): Custom metadata to log in Codex for the query.
+            eval_scores (Dict[str, float], optional): Optional scores to use for the query. When provided, Codex will skip running TrustworthyRAG evaluations on the query and use the provided scores instead.
+            eval_thresholds (Dict[str, float], optional): Optional thresholds to use for evaluating the query. We recommend configuring thresholds on the Project instead and using the same thresholds for all queries.
+            quality_preset (Literal["best", "high", "medium", "low", "base"], optional): The quality preset to use for the query.
+
+        Returns:
+            ProjectValidateResponse: The response from the validation.
+        """
         return self._sdk_client.projects.validate(
             self._id,
             context=context,
             prompt=prompt,
             query=query,
             response=response,
-            constrain_outputs=constrain_outputs,
             custom_eval_thresholds=eval_thresholds,
             custom_metadata=custom_metadata,
             eval_scores=eval_scores,
-            options=options,
             quality_preset=quality_preset,
         )
+
+    def add_remediation(self, question: str, answer: str | None = None) -> None:
+        """Add a remediation to the project. A remediation represents a question and answer pair that is expert verified
+        and should be used to answer future queries to the AI system that are similar to the question.
+
+        Args:
+            question (str): The question to add to the project.
+            answer (str, optional): The expert answer for the question. If not provided, the question will be added to the project without an expert answer.
+        """
+        self._sdk_client.projects.remediations.create(
+            project_id=self.id,
+            question=question,
+            answer=answer,
+            extra_headers=_AnalyticsMetadata().to_headers(),
+        )

src/cleanlab_codex/validator.py

@@ -13,7 +13,6 @@
 from cleanlab_codex.project import Project
 
 if _TYPE_CHECKING:
-    from codex.types.project_validate_params import Options as ProjectValidateOptions
     from codex.types.project_validate_response import ProjectValidateResponse
 
 
@@ -60,7 +59,6 @@ def validate(
         form_prompt: Optional[Callable[[str, str], str]] = None,
         metadata: Optional[dict[str, Any]] = None,
         eval_scores: Optional[dict[str, float]] = None,
-        options: Optional[ProjectValidateOptions] = None,
         quality_preset: Literal["best", "high", "medium", "low", "base"] = "medium",
     ) -> ProjectValidateResponse:
         """Evaluate whether the AI-generated response is bad, and if so, request an alternate expert answer.
@@ -105,6 +103,5 @@ def validate(
             custom_metadata=metadata,
             eval_scores=eval_scores,
             eval_thresholds=self._eval_thresholds,
-            options=options,
             quality_preset=quality_preset,
         )