✨ Refine a prompt version | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Refine a prompt version using a teacher model and save the refined prompt as a new version.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Refine a prompt version using a teacher model and save the refined prompt as a new version.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

prompt_idintegerRequired

version_idintegerRequired

Query parameters

asyncbooleanOptional

Whether to run the refinement asynchronously

Request

This endpoint expects an object.

project_idintegerRequired

Project ID to target the refined prompt for

teacher_model_namestringRequired>=1 character

Name of the model to use to refine the prompt

teacher_model_provider_connection_idintegerRequired

Model Provider Connection ID to use to refine the prompt

Response

Refined prompt response

promptstring

The refined prompt text

previous_versionobject or null

Previous version of the prompt

reasoningstring or null

Reasoning behind the refinement

refinement_job_idstring or null

Unique identifier for the refinement job

refinement_statusstring or null

Status of the refinement job

titlestring or null

Title of the refined prompt

total_coststring or null

Total cost of the refinement job (in USD)

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.prompts.versions.refine_prompt(
7	prompt_id=1,
8	version_id=1,
9	project_id=1,
10	teacher_model_name="teacher_model_name",
11	teacher_model_provider_connection_id=1,
12	)

1	{
2	"prompt": "prompt",
3	"previous_version": {
4	"created_at": "2024-01-15T09:30:00Z",
5	"created_by": {
6	"avatar": "avatar",
7	"id": 1,
8	"email": "email",
9	"first_name": "first_name",
10	"last_name": "last_name"
11	},
12	"id": 1,
13	"prompt": "prompt",
14	"provider_model_id": "provider_model_id",
15	"score": "score",
16	"title": "title",
17	"updated_at": "2024-01-15T09:30:00Z",
18	"model_provider_connection": 1,
19	"organization": 1,
20	"parent_model": 1,
21	"provider": "OpenAI"
22	},
23	"reasoning": "reasoning",
24	"refinement_job_id": "refinement_job_id",
25	"refinement_status": "refinement_status",
26	"title": "title",
27	"total_cost": "total_cost"
28	}