label-studio-sdk 1.0.5__py3-none-any.whl → 1.0.8__py3-none-any.whl

label_studio_sdk/types/prompt_organization.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptOrganization = typing.Union[int, typing.Dict[str, typing.Any]]

label_studio_sdk/types/prompt_version.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .prompt_version_created_by import PromptVersionCreatedBy
+from .prompt_version_organization import PromptVersionOrganization
+from .prompt_version_provider import PromptVersionProvider
+
+
+class PromptVersion(pydantic_v1.BaseModel):
+    title: typing.Optional[str] = None
+    parent_model: typing.Optional[int] = None
+    model_provider_connection: typing.Optional[int] = None
+    prompt: typing.Optional[str] = None
+    provider: typing.Optional[PromptVersionProvider] = None
+    provider_model_id: typing.Optional[str] = None
+    created_by: typing.Optional[PromptVersionCreatedBy] = None
+    created_at: typing.Optional[dt.datetime] = None
+    updated_at: typing.Optional[dt.datetime] = None
+    organization: typing.Optional[PromptVersionOrganization] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/prompt_version_created_by.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptVersionCreatedBy = typing.Union[int, typing.Dict[str, typing.Any]]

label_studio_sdk/types/prompt_version_organization.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptVersionOrganization = typing.Union[int, typing.Dict[str, typing.Any]]

label_studio_sdk/types/prompt_version_provider.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptVersionProvider = typing.Union[typing.Literal["OpenAI", "AzureOpenAI"], typing.Any]

label_studio_sdk/types/refined_prompt_response.py

@@ -0,0 +1,64 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .prompt_version import PromptVersion
+from .refined_prompt_response_refinement_status import RefinedPromptResponseRefinementStatus
+
+
+class RefinedPromptResponse(pydantic_v1.BaseModel):
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Title of the refined prompt
+    """
+
+    reasoning: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Reasoning behind the refinement
+    """
+
+    prompt: str = pydantic_v1.Field()
+    """
+    The refined prompt text
+    """
+
+    refinement_job_id: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Unique identifier for the refinement job
+    """
+
+    refinement_status: typing.Optional[RefinedPromptResponseRefinementStatus] = pydantic_v1.Field(default=None)
+    """
+    Status of the refinement job
+    """
+
+    total_cost: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Total cost of the refinement job (in USD)
+    """
+
+    previous_version: typing.Optional[PromptVersion] = pydantic_v1.Field(default=None)
+    """
+    Previous version of the prompt
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/refined_prompt_response_refinement_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RefinedPromptResponseRefinementStatus = typing.Union[
+    typing.Literal["Pending", "InProgress", "Completed", "Failed"], typing.Any
+]

label_studio_sdk/types/task.py

@@ -6,6 +6,7 @@ import typing
 from ..core.datetime_utils import serialize_datetime
 from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 from .task_annotators_item import TaskAnnotatorsItem
+from .task_comment_authors_item import TaskCommentAuthorsItem
 
 
 class Task(pydantic_v1.BaseModel):
@@ -134,9 +135,9 @@ class Task(pydantic_v1.BaseModel):
     Project ID for this task
     """
 
-    comment_authors: typing.Optional[typing.List[int]] = pydantic_v1.Field(default=None)
+    comment_authors: typing.Optional[typing.List[TaskCommentAuthorsItem]] = pydantic_v1.Field(default=None)
     """
-    List of comment authors' IDs for this task
+    List of comment authors for this task
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/types/task_comment_authors_item.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TaskCommentAuthorsItem = typing.Union[int, typing.Dict[str, typing.Any]]

label_studio_sdk/webhooks/client.py

@@ -1,5 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 from json.decoder import JSONDecodeError
 
@@ -9,7 +10,9 @@ from ..core.jsonable_encoder import jsonable_encoder
 from ..core.pydantic_utilities import pydantic_v1
 from ..core.request_options import RequestOptions
 from ..types.webhook import Webhook
+from ..types.webhook_actions_item import WebhookActionsItem
 from ..types.webhook_serializer_for_update import WebhookSerializerForUpdate
+from ..types.webhook_serializer_for_update_actions_item import WebhookSerializerForUpdateActionsItem
 from .types.webhooks_update_request_actions_item import WebhooksUpdateRequestActionsItem
 
 # this is used as the default value for optional parameters
@@ -63,7 +66,22 @@ class WebhooksClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def create(self, *, request: Webhook, request_options: typing.Optional[RequestOptions] = None) -> Webhook:
+    def create(
+        self,
+        *,
+        url: str,
+        id: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        send_payload: typing.Optional[bool] = OMIT,
+        send_for_all_actions: typing.Optional[bool] = OMIT,
+        headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        is_active: typing.Optional[bool] = OMIT,
+        actions: typing.Optional[typing.Sequence[WebhookActionsItem]] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        updated_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Webhook:
         """
         Create a webhook.
         Label Studio provides several out-of-the box webhook events, which you can find listed here: [Available Label Studio webhooks](https://labelstud.io/guide/webhooks#Available-Label-Studio-webhooks).
@@ -74,7 +92,34 @@ class WebhooksClient:
 
         Parameters
         ----------
-        request : Webhook
+        url : str
+            URL of webhook
+
+        id : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
+        project : typing.Optional[int]
+
+        send_payload : typing.Optional[bool]
+            If value is False send only action
+
+        send_for_all_actions : typing.Optional[bool]
+            If value is False - used only for actions from WebhookAction
+
+        headers : typing.Optional[typing.Dict[str, typing.Any]]
+            Key Value Json of headers
+
+        is_active : typing.Optional[bool]
+            If value is False the webhook is disabled
+
+        actions : typing.Optional[typing.Sequence[WebhookActionsItem]]
+
+        created_at : typing.Optional[dt.datetime]
+            Creation time
+
+        updated_at : typing.Optional[dt.datetime]
+            Last update time
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -86,20 +131,33 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk import Webhook
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.webhooks.create(
-            request=Webhook(
-                url="url",
-            ),
+            url="url",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/webhooks/", method="POST", json=request, request_options=request_options, omit=OMIT
+            "api/webhooks/",
+            method="POST",
+            json={
+                "id": id,
+                "organization": organization,
+                "project": project,
+                "url": url,
+                "send_payload": send_payload,
+                "send_for_all_actions": send_for_all_actions,
+                "headers": headers,
+                "is_active": is_active,
+                "actions": actions,
+                "created_at": created_at,
+                "updated_at": updated_at,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -236,10 +294,10 @@ class WebhooksClient:
 
     def update(
         self,
-        id: int,
+        id_: int,
         *,
         url: str,
-        request: WebhookSerializerForUpdate,
+        webhook_serializer_for_update_url: str,
         send_payload: typing.Optional[bool] = None,
         send_for_all_actions: typing.Optional[bool] = None,
         headers: typing.Optional[str] = None,
@@ -247,6 +305,18 @@ class WebhooksClient:
         actions: typing.Optional[
             typing.Union[WebhooksUpdateRequestActionsItem, typing.Sequence[WebhooksUpdateRequestActionsItem]]
         ] = None,
+        id: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        webhook_serializer_for_update_send_payload: typing.Optional[bool] = OMIT,
+        webhook_serializer_for_update_send_for_all_actions: typing.Optional[bool] = OMIT,
+        webhook_serializer_for_update_headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        webhook_serializer_for_update_is_active: typing.Optional[bool] = OMIT,
+        webhook_serializer_for_update_actions: typing.Optional[
+            typing.Sequence[WebhookSerializerForUpdateActionsItem]
+        ] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        updated_at: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WebhookSerializerForUpdate:
         """
@@ -256,13 +326,14 @@ class WebhooksClient:
 
         Parameters
         ----------
-        id : int
+        id_ : int
             A unique integer value identifying this webhook.
 
         url : str
             URL of webhook
 
-        request : WebhookSerializerForUpdate
+        webhook_serializer_for_update_url : str
+            URL of webhook
 
         send_payload : typing.Optional[bool]
             If value is False send only action
@@ -278,6 +349,32 @@ class WebhooksClient:
 
         actions : typing.Optional[typing.Union[WebhooksUpdateRequestActionsItem, typing.Sequence[WebhooksUpdateRequestActionsItem]]]
 
+        id : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
+        project : typing.Optional[int]
+
+        webhook_serializer_for_update_send_payload : typing.Optional[bool]
+            If value is False send only action
+
+        webhook_serializer_for_update_send_for_all_actions : typing.Optional[bool]
+            If value is False - used only for actions from WebhookAction
+
+        webhook_serializer_for_update_headers : typing.Optional[typing.Dict[str, typing.Any]]
+            Key Value Json of headers
+
+        webhook_serializer_for_update_is_active : typing.Optional[bool]
+            If value is False the webhook is disabled
+
+        webhook_serializer_for_update_actions : typing.Optional[typing.Sequence[WebhookSerializerForUpdateActionsItem]]
+
+        created_at : typing.Optional[dt.datetime]
+            Creation time
+
+        updated_at : typing.Optional[dt.datetime]
+            Last update time
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -288,22 +385,19 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk import WebhookSerializerForUpdate
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.webhooks.update(
-            id=1,
+            id_=1,
             url="url",
-            request=WebhookSerializerForUpdate(
-                url="url",
-            ),
+            webhook_serializer_for_update_url="url",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/webhooks/{jsonable_encoder(id)}/",
+            f"api/webhooks/{jsonable_encoder(id_)}/",
             method="PATCH",
             params={
                 "url": url,
@@ -313,7 +407,19 @@ class WebhooksClient:
                 "is_active": is_active,
                 "actions": actions,
             },
-            json=request,
+            json={
+                "id": id,
+                "organization": organization,
+                "project": project,
+                "url": url,
+                "send_payload": send_payload,
+                "send_for_all_actions": send_for_all_actions,
+                "headers": headers,
+                "is_active": is_active,
+                "actions": actions,
+                "created_at": created_at,
+                "updated_at": updated_at,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -373,7 +479,22 @@ class AsyncWebhooksClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def create(self, *, request: Webhook, request_options: typing.Optional[RequestOptions] = None) -> Webhook:
+    async def create(
+        self,
+        *,
+        url: str,
+        id: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        send_payload: typing.Optional[bool] = OMIT,
+        send_for_all_actions: typing.Optional[bool] = OMIT,
+        headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        is_active: typing.Optional[bool] = OMIT,
+        actions: typing.Optional[typing.Sequence[WebhookActionsItem]] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        updated_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Webhook:
         """
         Create a webhook.
         Label Studio provides several out-of-the box webhook events, which you can find listed here: [Available Label Studio webhooks](https://labelstud.io/guide/webhooks#Available-Label-Studio-webhooks).
@@ -384,7 +505,34 @@ class AsyncWebhooksClient:
 
         Parameters
         ----------
-        request : Webhook
+        url : str
+            URL of webhook
+
+        id : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
+        project : typing.Optional[int]
+
+        send_payload : typing.Optional[bool]
+            If value is False send only action
+
+        send_for_all_actions : typing.Optional[bool]
+            If value is False - used only for actions from WebhookAction
+
+        headers : typing.Optional[typing.Dict[str, typing.Any]]
+            Key Value Json of headers
+
+        is_active : typing.Optional[bool]
+            If value is False the webhook is disabled
+
+        actions : typing.Optional[typing.Sequence[WebhookActionsItem]]
+
+        created_at : typing.Optional[dt.datetime]
+            Creation time
+
+        updated_at : typing.Optional[dt.datetime]
+            Last update time
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -396,20 +544,33 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk import Webhook
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
         await client.webhooks.create(
-            request=Webhook(
-                url="url",
-            ),
+            url="url",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/webhooks/", method="POST", json=request, request_options=request_options, omit=OMIT
+            "api/webhooks/",
+            method="POST",
+            json={
+                "id": id,
+                "organization": organization,
+                "project": project,
+                "url": url,
+                "send_payload": send_payload,
+                "send_for_all_actions": send_for_all_actions,
+                "headers": headers,
+                "is_active": is_active,
+                "actions": actions,
+                "created_at": created_at,
+                "updated_at": updated_at,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -546,10 +707,10 @@ class AsyncWebhooksClient:
 
     async def update(
         self,
-        id: int,
+        id_: int,
         *,
         url: str,
-        request: WebhookSerializerForUpdate,
+        webhook_serializer_for_update_url: str,
         send_payload: typing.Optional[bool] = None,
         send_for_all_actions: typing.Optional[bool] = None,
         headers: typing.Optional[str] = None,
@@ -557,6 +718,18 @@ class AsyncWebhooksClient:
         actions: typing.Optional[
             typing.Union[WebhooksUpdateRequestActionsItem, typing.Sequence[WebhooksUpdateRequestActionsItem]]
         ] = None,
+        id: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        webhook_serializer_for_update_send_payload: typing.Optional[bool] = OMIT,
+        webhook_serializer_for_update_send_for_all_actions: typing.Optional[bool] = OMIT,
+        webhook_serializer_for_update_headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        webhook_serializer_for_update_is_active: typing.Optional[bool] = OMIT,
+        webhook_serializer_for_update_actions: typing.Optional[
+            typing.Sequence[WebhookSerializerForUpdateActionsItem]
+        ] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        updated_at: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WebhookSerializerForUpdate:
         """
@@ -566,13 +739,14 @@ class AsyncWebhooksClient:
 
         Parameters
         ----------
-        id : int
+        id_ : int
             A unique integer value identifying this webhook.
 
         url : str
             URL of webhook
 
-        request : WebhookSerializerForUpdate
+        webhook_serializer_for_update_url : str
+            URL of webhook
 
         send_payload : typing.Optional[bool]
             If value is False send only action
@@ -588,6 +762,32 @@ class AsyncWebhooksClient:
 
         actions : typing.Optional[typing.Union[WebhooksUpdateRequestActionsItem, typing.Sequence[WebhooksUpdateRequestActionsItem]]]
 
+        id : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
+        project : typing.Optional[int]
+
+        webhook_serializer_for_update_send_payload : typing.Optional[bool]
+            If value is False send only action
+
+        webhook_serializer_for_update_send_for_all_actions : typing.Optional[bool]
+            If value is False - used only for actions from WebhookAction
+
+        webhook_serializer_for_update_headers : typing.Optional[typing.Dict[str, typing.Any]]
+            Key Value Json of headers
+
+        webhook_serializer_for_update_is_active : typing.Optional[bool]
+            If value is False the webhook is disabled
+
+        webhook_serializer_for_update_actions : typing.Optional[typing.Sequence[WebhookSerializerForUpdateActionsItem]]
+
+        created_at : typing.Optional[dt.datetime]
+            Creation time
+
+        updated_at : typing.Optional[dt.datetime]
+            Last update time
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -598,22 +798,19 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk import WebhookSerializerForUpdate
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
         await client.webhooks.update(
-            id=1,
+            id_=1,
             url="url",
-            request=WebhookSerializerForUpdate(
-                url="url",
-            ),
+            webhook_serializer_for_update_url="url",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/webhooks/{jsonable_encoder(id)}/",
+            f"api/webhooks/{jsonable_encoder(id_)}/",
             method="PATCH",
             params={
                 "url": url,
@@ -623,7 +820,19 @@ class AsyncWebhooksClient:
                 "is_active": is_active,
                 "actions": actions,
             },
-            json=request,
+            json={
+                "id": id,
+                "organization": organization,
+                "project": project,
+                "url": url,
+                "send_payload": send_payload,
+                "send_for_all_actions": send_for_all_actions,
+                "headers": headers,
+                "is_active": is_active,
+                "actions": actions,
+                "created_at": created_at,
+                "updated_at": updated_at,
+            },
             request_options=request_options,
             omit=OMIT,
         )