]j d dl Z ddlmZmZ ddlmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
d d
lmZmZ e j" e j$ d Z G d d
Z G d d Zy) N )AsyncClientWrapperSyncClientWrapper)RequestOptions)InferenceRunCostEstimate) ProviderEnum)RefinedPromptResponse)ThirdPartyModelVersion )AsyncRawVersionsClientRawVersionsClient.c e Zd ZdefdZedefd Zdddede j e ddfd Z ddd
d ed e j e
de j e de j e fd
Zeeeeddd ede
de
de
de j e de j e de j e de j e de j e defdZddd edede j e defdZddd edede j e ddfdZeeeeeeeddd edede j e de j e de j e de j e
de j e de j e
de j e
de j e defdZddd edede j e defd Zddd d eded e j e
de j e def
d Zddd d eded!ed"e
d#ed$e j e de j e defd%Z y)&VersionsClientclient_wrapperc & t | | _ y N)r )r
_raw_clientselfr s R/root/env/lib/python3.12/site-packages/label_studio_sdk/prompts/versions/client.py__init__zVersionsClient.__init__ s ,NK returnc | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawVersionsClient
r r s r with_raw_responsez VersionsClient.with_raw_response r Nrequest_optionsidr c T | j j || }|j S )a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get default prompt version name
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.get_default_version_name(
id=1,
)
r r get_default_version_namedatar r! r _responses r r$ z'VersionsClient.get_default_version_name s+ @ $$==bRa=b ~~ r orderingr prompt_idr) c V | j j ||| }|j S )am
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all versions of a prompt.
Parameters
----------
prompt_id : int
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[ThirdPartyModelVersion]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.list(
prompt_id=1,
)
r( r listr% r r* r) r r' s r r- zVersionsClient.listC s- T $$)))hXg)h ~~ r model_provider_connection organization parent_modelproviderr promptprovider_model_idtitler0 r1 r2 r3 c b | j j ||||||||| }
|
j S )aY
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new version of a prompt.
Parameters
----------
prompt_id : int
prompt : str
Prompt to execute
provider_model_id : str
The model ID to use within the given provider, e.g. gpt-3.5
title : str
Model name
model_provider_connection : typing.Optional[int]
organization : typing.Optional[int]
parent_model : typing.Optional[int]
Parent model interface ID
provider : typing.Optional[ProviderEnum]
The model provider to use e.g. OpenAI
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ThirdPartyModelVersion
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.create(
prompt_id=1,
prompt="prompt",
provider_model_id="provider_model_id",
title="title",
)
r4 r5 r6 r0 r1 r2 r3 r r creater% r r* r4 r5 r6 r0 r1 r2 r3 r r' s r r: zVersionsClient.createp sG V $$++ /&?%% + ,
~~ r
version_idc V | j j ||| }|j S )a8
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific prompt of a model.
Parameters
----------
prompt_id : int
version_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ThirdPartyModelVersion
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.get(
prompt_id=1,
version_id=1,
)
r r getr% r r* r< r r' s r r? zVersionsClient.get s- L $$((JP_(` ~~ r c V | j j ||| }|j S )a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a prompt version by ID
Parameters
----------
prompt_id : int
version_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.delete(
prompt_id=1,
version_id=1,
)
r r deleter% r@ s r rC zVersionsClient.delete s- J $$++IzSb+c ~~ r r0 r1 r2 r4 r3 r5 r6 r c d | j j ||||||||| |
} | j S )a[
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific prompt version by ID.
Parameters
----------
prompt_id : int
version_id : int
model_provider_connection : typing.Optional[int]
organization : typing.Optional[int]
parent_model : typing.Optional[int]
Parent model interface ID
prompt : typing.Optional[str]
Prompt to execute
provider : typing.Optional[ProviderEnum]
The model provider to use e.g. OpenAI
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
provider_model_id : typing.Optional[str]
The model ID to use within the given provider, e.g. gpt-3.5
title : typing.Optional[str]
Model name
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ThirdPartyModelVersion
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.update(
prompt_id=1,
version_id=1,
)
rD r updater% r r* r< r0 r1 r2 r4 r3 r5 r6 r r' s r rG zVersionsClient.update sJ X $$++ &?%% / + ,
~~ r c V | j j ||| }|j S )a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset
Parameters
----------
prompt_id : int
version_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
InferenceRunCostEstimate
Cost estimate response
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.cost_estimate(
prompt_id=1,
version_id=1,
)
r r
cost_estimater% r@ s r rK z VersionsClient.cost_estimates s- L $$229jZi2j ~~ r refinement_job_idr rM c X | j j |||| }|j S )a#
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get the refined prompt based on the `refinement_job_id`.
Parameters
----------
prompt_id : int
version_id : int
refinement_job_id : typing.Optional[str]
Refinement Job ID acquired from the `POST /api/prompts/{prompt_id}/versions/{version_id}/refine` endpoint
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
RefinedPromptResponse
Refined prompt response
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.get_refined_prompt(
prompt_id=1,
version_id=1,
)
rL r get_refined_promptr% r r* r< rM r r' s r rP z!VersionsClient.get_refined_prompt s7 \ $$77 z5FXg 8
~~ r async_r
project_idteacher_model_name$teacher_model_provider_connection_idrS c ^ | j j ||||||| }|j S )a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Refine a prompt version using a teacher model and save the refined prompt as a new version.
Parameters
----------
prompt_id : int
version_id : int
project_id : int
Project ID to target the refined prompt for
teacher_model_name : str
Name of the model to use to refine the prompt
teacher_model_provider_connection_id : int
Model Provider Connection ID to use to refine the prompt
async_ : typing.Optional[bool]
Whether to run the refinement asynchronously
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
RefinedPromptResponse
Refined prompt response
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.versions.refine_prompt(
prompt_id=1,
version_id=1,
project_id=1,
teacher_model_name="teacher_model_name",
teacher_model_provider_connection_id=1,
)
rT rU rV rS r r
refine_promptr% r r* r< rT rU rV rS r r' s r rZ z VersionsClient.refine_prompt sA z $$22 ! 11U + 3
~~ r ) __name__
__module__ __qualname__r r propertyr
r inttypingOptionalr r$ strListr
r- OMITr r: r? rC rG r rK r rP boolrZ r r r r s L*; L #4 gk ! 3 ! FOOTbDc ! os ! N *.;? + + //#& +
8 +
+ ,
+ h ;?-1-126;?V V V
V
V $*??3#7V ooc*V ooc*V //,/V 8V
V r fj' ' *-' CI??SaCb' ' T fj& & *-& CI??SaCb&
& Z ;?-1-1'+2626&*;?X X X
$*??3#7 X ooc*
X ooc*X $X //,/X "??3/X s#X 8X
X v fj' ' *-' CI??SaCb' !' \ 37;?
1 1 1
"??3/ 1 8
1
1 v )-;?F F F
F
F /2F %F 8F
F r r c e Zd ZdefdZedefd Zdddede j e ddfd Z ddd
d ed e j e
de j e de j e fd
Zeeeeddd ede
de
de
de j e de j e de j e de j e de j e defdZddd edede j e defdZddd edede j e ddfdZeeeeeeeddd edede j e de j e de j e de j e
de j e de j e
de j e
de j e defdZddd edede j e defd Zddd d eded e j e
de j e def
d Zddd d eded!ed"e
d#ed$e j e de j e defd%Z y)&AsyncVersionsClientr c & t | | _ y r )r r r s r r z AsyncVersionsClient.__init__ s 1 Pr r c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawVersionsClient
r r s r r z%AsyncVersionsClient.with_raw_response r r Nr r! r c p K | j j || d{ }|j S 7 w)ag
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get default prompt version name
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.get_default_version_name(
id=1,
)
asyncio.run(main())
r Nr# r& s r r$ z,AsyncVersionsClient.get_default_version_name' s8 T **CCBXgChh ~~ is !646r( r* r) c r K | j j ||| d{ }|j S 7 w)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all versions of a prompt.
Parameters
----------
prompt_id : int
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[ThirdPartyModelVersion]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.list(
prompt_id=1,
)
asyncio.run(main())
r( Nr, r. s r r- zAsyncVersionsClient.listT s: d **// H^m/nn ~~ o "757r/ r4 r5 r6 r0 r1 r2 r3 c ~ K | j j ||||||||| d{ }
|
j S 7 w)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new version of a prompt.
Parameters
----------
prompt_id : int
prompt : str
Prompt to execute
provider_model_id : str
The model ID to use within the given provider, e.g. gpt-3.5
title : str
Model name
model_provider_connection : typing.Optional[int]
organization : typing.Optional[int]
parent_model : typing.Optional[int]
Parent model interface ID
provider : typing.Optional[ProviderEnum]
The model provider to use e.g. OpenAI
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ThirdPartyModelVersion
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.create(
prompt_id=1,
prompt="prompt",
provider_model_id="provider_model_id",
title="title",
)
asyncio.run(main())
r8 Nr9 r; s r r: zAsyncVersionsClient.create sU f **11 /&?%% + 2
~~
s (=;=r< c r K | j j ||| d{ }|j S 7 w)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific prompt of a model.
Parameters
----------
prompt_id : int
version_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ThirdPartyModelVersion
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.get(
prompt_id=1,
version_id=1,
)
asyncio.run(main())
r Nr> r@ s r r? zAsyncVersionsClient.get s: \ **..y*Ve.ff ~~ grn c r K | j j ||| d{ }|j S 7 w)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a prompt version by ID
Parameters
----------
prompt_id : int
version_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.delete(
prompt_id=1,
version_id=1,
)
asyncio.run(main())
r NrB r@ s r rC zAsyncVersionsClient.delete s: Z **11)ZYh1ii ~~ jrn rD c K | j j ||||||||| |
d{ } | j S 7 w)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific prompt version by ID.
Parameters
----------
prompt_id : int
version_id : int
model_provider_connection : typing.Optional[int]
organization : typing.Optional[int]
parent_model : typing.Optional[int]
Parent model interface ID
prompt : typing.Optional[str]
Prompt to execute
provider : typing.Optional[ProviderEnum]
The model provider to use e.g. OpenAI
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
provider_model_id : typing.Optional[str]
The model ID to use within the given provider, e.g. gpt-3.5
title : typing.Optional[str]
Model name
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ThirdPartyModelVersion
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.update(
prompt_id=1,
version_id=1,
)
asyncio.run(main())
rD NrF rH s r rG zAsyncVersionsClient.updateJ sX h **11 &?%% / + 2
~~
s )><>c r K | j j ||| d{ }|j S 7 w)a*
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset
Parameters
----------
prompt_id : int
version_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
InferenceRunCostEstimate
Cost estimate response
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.cost_estimate(
prompt_id=1,
version_id=1,
)
asyncio.run(main())
r NrJ r@ s r rK z!AsyncVersionsClient.cost_estimate s: \ **88J`o8pp ~~ qrn rL rM c t K | j j |||| d{ }|j S 7 w)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get the refined prompt based on the `refinement_job_id`.
Parameters
----------
prompt_id : int
version_id : int
refinement_job_id : typing.Optional[str]
Refinement Job ID acquired from the `POST /api/prompts/{prompt_id}/versions/{version_id}/refine` endpoint
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
RefinedPromptResponse
Refined prompt response
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.get_refined_prompt(
prompt_id=1,
version_id=1,
)
asyncio.run(main())
rL NrO rQ s r rP z&AsyncVersionsClient.get_refined_prompt sE l **== z5FXg >
~~
s #868rR rT rU rV rS c z K | j j ||||||| d{ }|j S 7 w)a*
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Refine a prompt version using a teacher model and save the refined prompt as a new version.
Parameters
----------
prompt_id : int
version_id : int
project_id : int
Project ID to target the refined prompt for
teacher_model_name : str
Name of the model to use to refine the prompt
teacher_model_provider_connection_id : int
Model Provider Connection ID to use to refine the prompt
async_ : typing.Optional[bool]
Whether to run the refinement asynchronously
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
RefinedPromptResponse
Refined prompt response
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.versions.refine_prompt(
prompt_id=1,
version_id=1,
project_id=1,
teacher_model_name="teacher_model_name",
teacher_model_provider_connection_id=1,
)
asyncio.run(main())
rX NrY r[ s r rZ z!AsyncVersionsClient.refine_prompt sO J **88 ! 11U + 9
~~
s &;9;) r\ r] r^ r r r_ r r r` ra rb r r$ rc rd r
r- re r r: r? rC rG r rK r rP rf rZ rg r r ri ri s Q*< Q #9 NR+ + +1??>+J+
+ b *.;? 3 3 //#& 3
8 3
+ ,
3 x ;?-1-126;?^ ^ ^
^
^ $*??3#7^ ooc*^ ooc*^ //,/^ 8^
^ B fj/ / *-/ CI??SaCb/ / d fj. . *-. CI??SaCb.
. j ;?-1-1'+2626&*;?` ` `
$*??3#7 ` ooc*
` ooc*` $` //,/` "??3/` s#` 8`
` F fj/ / *-/ CI??SaCb/ !/ l 37;?
9 9 9
"??3/ 9 8
9
9 F )-;?N N N
N
N /2N %N 8N
N r ri )ra core.client_wrapperr r core.request_optionsr !types.inference_run_cost_estimater types.provider_enumr types.refined_prompt_responser types.third_party_model_versionr
raw_clientr r
castAnyre r ri rg r r r sP H 2 I / B E A v{{6::s#D D NN N r