Get refined prompt | API Reference

1 from label_studio_sdk import LabelStudio 2 3 client = LabelStudio( 4 api_key="YOUR_API_KEY", 5 ) 6 client.prompts.versions.get_refined_prompt( 7 prompt_id=1, 8 version_id=1, 9 refinement_job_id="refinement_job_id", 10 )

1 { 2 "prompt": "prompt", 3 "title": "title", 4 "reasoning": "reasoning", 5 "refinement_job_id": "refinement_job_id", 6 "refinement_status": "Pending", 7 "total_cost": "total_cost", 8 "previous_version": { 9 "title": "title", 10 "parent_model": 1, 11 "model_provider_connection": 1, 12 "prompt": "prompt", 13 "provider": "OpenAI", 14 "provider_model_id": "provider_model_id", 15 "created_by": 1, 16 "created_at": "2024-01-15T09:30:00Z", 17 "updated_at": "2024-01-15T09:30:00Z", 18 "organization": 1 19 } 20 }

Get the refined prompt based on the refinement_job_id.

Path parameters

prompt_idintegerRequired

Prompt ID

version_idintegerRequired

Prompt Version ID

Query parameters

refinement_job_idstringRequired

Refinement Job ID acquired from the POST /api/prompts/{prompt_id}/versions/{version_id}/refine endpoint

Response

promptstring

The refined prompt text

titlestring or null

Title of the refined prompt

reasoningstring or null

Reasoning behind the refinement

refinement_job_idstring or null

Unique identifier for the refinement job

refinement_statusenum or nullDefaults to Pending

Status of the refinement job

Allowed values:

total_coststring or null

Total cost of the refinement job (in USD)

previous_versionobject or null

Previous version of the prompt

Path parameters

Headers

Query parameters

Response