feat: DIA-1402: V1-Submit Prompt auto-refinement job (#322)

Co-authored-by: Matt Bernstein <matt@humansignal.com> Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
HumanSignal · Oct 1, 2024 · 763a804 · 763a804
1 parent 34b9124
commit 763a804
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 19 deletions.
diff --git a/.mock/definition/prompts/versions.yml b/.mock/definition/prompts/versions.yml
@@ -163,14 +163,14 @@ service:
       audiences:
         - public
     refine_prompt:
-      path: /api/prompts/{id}/versions/{version_id}/refine-prompt
+      path: /api/prompts/{prompt_id}/versions/{version_id}/refine
       method: POST
       auth: true
       docs: >
         Refine a prompt version using a teacher model and save the refined
         prompt as a new version.
       path-parameters:
-        id:
+        prompt_id:
           type: integer
           docs: Prompt ID
         version_id:
@@ -195,7 +195,7 @@ service:
         type: root.PromptVersion
       examples:
         - path-parameters:
-            id: 1
+            prompt_id: 1
             version_id: 1
           request: {}
           response:

diff --git a/poetry.lock b/poetry.lock
diff --git a/reference.md b/reference.md
@@ -15198,7 +15198,7 @@ client = LabelStudio(
     api_key="YOUR_API_KEY",
 )
 client.prompts.versions.refine_prompt(
-    id=1,
+    prompt_id=1,
     version_id=1,
 )
 
@@ -15216,7 +15216,7 @@ client.prompts.versions.refine_prompt(
 <dl>
 <dd>
 
-**id:** `int` — Prompt ID
+**prompt_id:** `int` — Prompt ID
 
 </dd>
 </dl>

diff --git a/src/label_studio_sdk/prompts/versions/client.py b/src/label_studio_sdk/prompts/versions/client.py
@@ -337,7 +337,7 @@ def update(
 
     def refine_prompt(
         self,
-        id: int,
+        prompt_id: int,
         version_id: int,
         *,
         teacher_model_provider_connection_id: typing.Optional[int] = OMIT,
@@ -350,7 +350,7 @@ def refine_prompt(
 
         Parameters
         ----------
-        id : int
+        prompt_id : int
             Prompt ID
 
         version_id : int
@@ -381,12 +381,12 @@ def refine_prompt(
             api_key="YOUR_API_KEY",
         )
         client.prompts.versions.refine_prompt(
-            id=1,
+            prompt_id=1,
             version_id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}/refine-prompt",
+            f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/refine",
             method="POST",
             json={
                 "teacher_model_provider_connection_id": teacher_model_provider_connection_id,
@@ -728,7 +728,7 @@ async def update(
 
     async def refine_prompt(
         self,
-        id: int,
+        prompt_id: int,
         version_id: int,
         *,
         teacher_model_provider_connection_id: typing.Optional[int] = OMIT,
@@ -741,7 +741,7 @@ async def refine_prompt(
 
         Parameters
         ----------
-        id : int
+        prompt_id : int
             Prompt ID
 
         version_id : int
@@ -772,12 +772,12 @@ async def refine_prompt(
             api_key="YOUR_API_KEY",
         )
         await client.prompts.versions.refine_prompt(
-            id=1,
+            prompt_id=1,
             version_id=1,
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}/refine-prompt",
+            f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/refine",
             method="POST",
             json={
                 "teacher_model_provider_connection_id": teacher_model_provider_connection_id,

diff --git a/tests/prompts/test_versions.py b/tests/prompts/test_versions.py
@@ -174,8 +174,8 @@ async def test_refine_prompt(client: LabelStudio, async_client: AsyncLabelStudio
         "updated_at": "datetime",
         "organization": "integer",
     }
-    response = client.prompts.versions.refine_prompt(id=1, version_id=1)
+    response = client.prompts.versions.refine_prompt(prompt_id=1, version_id=1)
     validate_response(response, expected_response, expected_types)
 
-    async_response = await async_client.prompts.versions.refine_prompt(id=1, version_id=1)
+    async_response = await async_client.prompts.versions.refine_prompt(prompt_id=1, version_id=1)
     validate_response(async_response, expected_response, expected_types)