label-studio-sdk 1.0.20__py3-none-any.whl → 2.0.1__py3-none-any.whl

label_studio_sdk/projects/types/projects_update_response.py

@@ -1,96 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from ...core.pydantic_utilities import UniversalBaseModel
-import typing
-import pydantic
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
-
-
-class ProjectsUpdateResponse(UniversalBaseModel):
-    """
-    Project
-    """
-
-    title: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Project title
-    """
-
-    description: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Project description
-    """
-
-    label_config: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Label config in XML format
-    """
-
-    expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Labeling instructions to show to the user
-    """
-
-    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Show labeling instructions
-    """
-
-    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Show skip button
-    """
-
-    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Allow empty annotations
-    """
-
-    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Show annotation history
-    """
-
-    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Reveal preannotations interactively. If set to True, predictions will be shown to the user only after selecting the area of interest
-    """
-
-    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Show predictions to annotators
-    """
-
-    maximum_annotations: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Maximum annotations per task
-    """
-
-    annotation_limit_count: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Maximum number of annotations per annotator
-    """
-
-    annotation_limit_percent: typing.Optional[float] = pydantic.Field(default=None)
-    """
-    Maximum percentage of annotations per annotator
-    """
-
-    color: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Project color in HEX format
-    """
-
-    control_weights: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
-    """
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

label_studio_sdk/prompts/types/prompts_batch_failed_predictions_request_failed_predictions_item.py

@@ -1,32 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from ...core.pydantic_utilities import UniversalBaseModel
-import typing
-import pydantic
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
-
-
-class PromptsBatchFailedPredictionsRequestFailedPredictionsItem(UniversalBaseModel):
-    task_id: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Task ID to associate the prediction with
-    """
-
-    error_type: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Type of error (e.g. "Timeout", "Rate Limit", etc)
-    """
-
-    message: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Error message details
-    """
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

label_studio_sdk/prompts/types/prompts_batch_predictions_request_results_item.py

@@ -1,59 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from ...core.pydantic_utilities import UniversalBaseModel
-import typing
-import pydantic
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
-
-
-class PromptsBatchPredictionsRequestResultsItem(UniversalBaseModel):
-    task_id: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Task ID to associate the prediction with
-    """
-
-    output: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Prediction output that contains keys from labeling config. Each key must be a valid control tag name from the labeling config. For example, given the output: ```json {"sentiment": "positive"} ``` it will be converted to the internal LS annotation format: ```json {
-      "value": {
-        "choices": ["positive"]
-      },
-      "from_name": "label",
-      "to_name": "",
-      ...
-    } ```
-    """
-
-    prompt_tokens: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Number of tokens in the prompt
-    """
-
-    completion_tokens: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Number of tokens in the completion
-    """
-
-    prompt_cost_usd: typing.Optional[float] = pydantic.Field(default=None)
-    """
-    Cost of the prompt (in USD)
-    """
-
-    completion_cost_usd: typing.Optional[float] = pydantic.Field(default=None)
-    """
-    Cost of the completion (in USD)
-    """
-
-    total_cost_usd: typing.Optional[float] = pydantic.Field(default=None)
-    """
-    Total cost of the inference (in USD)
-    """
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

label_studio_sdk/tasks/types/tasks_list_response.py

@@ -1,38 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from ...core.pydantic_utilities import UniversalBaseModel
-import typing
-from ...types.task import Task
-import pydantic
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
-
-
-class TasksListResponse(UniversalBaseModel):
-    tasks: typing.Optional[typing.List[Task]] = pydantic.Field(default=None)
-    """
-    List of tasks, each task contains predictions and annotations if `fields` query parameter is set to `all`
-    """
-
-    total: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Total number of tasks
-    """
-
-    total_annotations: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Total number of annotations
-    """
-
-    total_predictions: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Total number of predictions
-    """
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

label_studio_sdk/types/annotation_completed_by.py

@@ -1,6 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-from .user_simple import UserSimple
-
-AnnotationCompletedBy = typing.Union[UserSimple, int]

label_studio_sdk/types/azure_blob_export_storage_status.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-AzureBlobExportStorageStatus = typing.Union[
-    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
-]

label_studio_sdk/types/base_task_updated_by.py

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

label_studio_sdk/types/comment_created_by.py

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

label_studio_sdk/types/converted_format_status.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ConvertedFormatStatus = typing.Union[typing.Literal["created", "in_progress", "failed", "completed"], typing.Any]

label_studio_sdk/types/data_manager_task_serializer.py

@@ -1,118 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing
-from .data_manager_task_serializer_predictions_item import DataManagerTaskSerializerPredictionsItem
-import pydantic
-from .annotations_dm_field import AnnotationsDmField
-from .data_manager_task_serializer_drafts_item import DataManagerTaskSerializerDraftsItem
-from .data_manager_task_serializer_annotators_item import DataManagerTaskSerializerAnnotatorsItem
-import datetime as dt
-from .data_manager_task_serializer_comment_authors_item import DataManagerTaskSerializerCommentAuthorsItem
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-
-
-class DataManagerTaskSerializer(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    predictions: typing.Optional[typing.List[DataManagerTaskSerializerPredictionsItem]] = pydantic.Field(default=None)
-    """
-    Predictions for this task
-    """
-
-    annotations: typing.Optional[typing.List[AnnotationsDmField]] = None
-    drafts: typing.Optional[typing.List[DataManagerTaskSerializerDraftsItem]] = pydantic.Field(default=None)
-    """
-    Drafts for this task
-    """
-
-    annotators: typing.Optional[typing.List[DataManagerTaskSerializerAnnotatorsItem]] = pydantic.Field(default=None)
-    """
-    Annotators who annotated this task
-    """
-
-    inner_id: typing.Optional[int] = None
-    cancelled_annotations: typing.Optional[int] = None
-    total_annotations: typing.Optional[int] = None
-    total_predictions: typing.Optional[int] = None
-    completed_at: typing.Optional[dt.datetime] = None
-    annotations_results: typing.Optional[str] = None
-    predictions_results: typing.Optional[str] = None
-    predictions_score: typing.Optional[float] = None
-    file_upload: typing.Optional[str] = None
-    storage_filename: typing.Optional[str] = None
-    annotations_ids: typing.Optional[str] = None
-    predictions_model_versions: typing.Optional[str] = None
-    avg_lead_time: typing.Optional[float] = None
-    draft_exists: typing.Optional[bool] = None
-    updated_by: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(
-        default=None
-    )
-    """
-    User IDs who updated this task
-    """
-
-    data: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
-    """
-    User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
-    """
-
-    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
-    """
-
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
-    """
-    Time a task was created
-    """
-
-    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
-    """
-    Last time a task was updated
-    """
-
-    is_labeled: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
-    """
-
-    overlap: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Number of distinct annotators that processed the current task
-    """
-
-    comment_count: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Number of comments in the task including all annotations
-    """
-
-    unresolved_comment_count: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Number of unresolved comments in the task including all annotations
-    """
-
-    last_comment_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
-    """
-    When the last comment was updated
-    """
-
-    project: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Project ID for this task
-    """
-
-    comment_authors: typing.Optional[typing.List[DataManagerTaskSerializerCommentAuthorsItem]] = pydantic.Field(
-        default=None
-    )
-    """
-    Users who wrote comments
-    """
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

label_studio_sdk/types/data_manager_task_serializer_annotators_item.py

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

label_studio_sdk/types/data_manager_task_serializer_comment_authors_item.py

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

label_studio_sdk/types/data_manager_task_serializer_predictions_item_model_run.py

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

label_studio_sdk/types/export_format.py

@@ -1,25 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ExportFormat = typing.Union[
-    typing.Literal[
-        "JSON",
-        "JSON_MIN",
-        "CSV",
-        "TSV",
-        "CONLL2003",
-        "COCO",
-        "VOC",
-        "BRUSH_TO_NUMPY",
-        "BRUSH_TO_PNG",
-        "ASR_MANIFEST",
-        "YOLO",
-        "YOLO_OBB",
-        "CSV_OLD",
-        "YOLO_WITH_IMAGES",
-        "COCO_WITH_IMAGES",
-        "YOLO_OBB_WITH_IMAGES",
-    ],
-    typing.Any,
-]

label_studio_sdk/types/export_snapshot_status.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ExportSnapshotStatus = typing.Union[typing.Literal["created", "in_progress", "failed", "completed"], typing.Any]

label_studio_sdk/types/export_status.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ExportStatus = typing.Union[typing.Literal["created", "in_progress", "failed", "completed"], typing.Any]

label_studio_sdk/types/gcs_export_storage_status.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-GcsExportStorageStatus = typing.Union[
-    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
-]

label_studio_sdk/types/gcs_import_storage_status.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-GcsImportStorageStatus = typing.Union[
-    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
-]

label_studio_sdk/types/inference_run.py

@@ -1,34 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing
-from .inference_run_organization import InferenceRunOrganization
-from .inference_run_created_by import InferenceRunCreatedBy
-from .inference_run_project_subset import InferenceRunProjectSubset
-from .inference_run_status import InferenceRunStatus
-import datetime as dt
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import pydantic
-
-
-class InferenceRun(UniversalBaseModel):
-    organization: typing.Optional[InferenceRunOrganization] = None
-    project: int
-    model_version: typing.Optional[int] = None
-    created_by: typing.Optional[InferenceRunCreatedBy] = None
-    project_subset: InferenceRunProjectSubset
-    status: typing.Optional[InferenceRunStatus] = None
-    job_id: typing.Optional[str] = None
-    created_at: typing.Optional[dt.datetime] = None
-    triggered_at: typing.Optional[dt.datetime] = None
-    predictions_updated_at: typing.Optional[dt.datetime] = None
-    completed_at: typing.Optional[dt.datetime] = None
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

label_studio_sdk/types/inference_run_created_by.py

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

label_studio_sdk/types/inference_run_organization.py

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

label_studio_sdk/types/inference_run_project_subset.py

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

label_studio_sdk/types/key_indicators.py

@@ -1,6 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-from .key_indicators_item import KeyIndicatorsItem
-
-KeyIndicators = typing.List[KeyIndicatorsItem]

label_studio_sdk/types/key_indicators_item.py

@@ -1,41 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from ..core.pydantic_utilities import UniversalBaseModel
-import pydantic
-import typing
-from .key_indicators_item_additional_kpis_item import KeyIndicatorsItemAdditionalKpisItem
-from .key_indicators_item_extra_kpis_item import KeyIndicatorsItemExtraKpisItem
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-
-
-class KeyIndicatorsItem(UniversalBaseModel):
-    key: str = pydantic.Field()
-    """
-    The key for this KPI, where you can find the value from inside main_kpi
-    """
-
-    title: str = pydantic.Field()
-    """
-    The title for this metric, to be displayed to the user
-    """
-
-    main_kpi: str
-    secondary_kpi: typing.Optional[str] = None
-    additional_kpis: typing.Optional[typing.List[KeyIndicatorsItemAdditionalKpisItem]] = pydantic.Field(default=None)
-    """
-    Additional KPIs to be displayed at the bottom of the box
-    """
-
-    extra_kpis: typing.Optional[typing.List[KeyIndicatorsItemExtraKpisItem]] = pydantic.Field(default=None)
-    """
-    Extra KPIs to be displayed in the hover-tootip for that indicator
-    """
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

label_studio_sdk/types/local_files_export_storage_status.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-LocalFilesExportStorageStatus = typing.Union[
-    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
-]

label_studio_sdk/types/local_files_import_storage_status.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-LocalFilesImportStorageStatus = typing.Union[
-    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
-]

label_studio_sdk/types/ml_backend_auth_method.py

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

label_studio_sdk/types/ml_backend_state.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-MlBackendState = typing.Union[typing.Literal["CO", "DI", "ER", "TR", "PR"], typing.Any]

label_studio_sdk/types/model_provider_connection_created_by.py

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

label_studio_sdk/types/model_provider_connection_organization.py

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

label_studio_sdk/types/model_provider_connection_provider.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ModelProviderConnectionProvider = typing.Union[
-    typing.Literal["OpenAI", "AzureOpenAI", "AzureAIFoundry", "VertexAI", "Gemini", "Anthropic", "Custom"], typing.Any
-]

label_studio_sdk/types/model_provider_connection_scope.py

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

label_studio_sdk/types/pause_paused_by.py

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

label_studio_sdk/types/project_import_status.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ProjectImportStatus = typing.Union[typing.Literal["created", "in_progress", "failed", "completed"], typing.Any]