Merge branch 'develop' into sdubinin/model-1489

Author: dubininsergey

docs/conf.py

@@ -16,7 +16,7 @@
 project = 'Python SDK reference'
 copyright = '2024, Labelbox'
 author = 'Labelbox'
-release = '3.75.1'
+release = '3.76.0'
 
 # -- General configuration ---------------------------------------------------
 

docs/labelbox/labeling-service.rst

@@ -0,0 +1,6 @@
+Project Labeling Service
+===============================================================================================
+
+.. automodule:: labelbox.schema.labeling_service
+   :members:
+   :show-inheritance:

libs/labelbox/CHANGELOG.md

@@ -1,4 +1,21 @@
 # Changelog
+#  Version 3.76.0 (2024-07-29)
+# Added
+* Added Project get_labeling_service(), request_labeling_service() and get_labeling_service_status()
+* Added project and ontology creation for prompt response projects: Client create_prompt_response_generation_project(), create_response_creation_project() in https://github.com/Labelbox/labelbox-python/pull/1726
+* Added is_benchmark_enabled, is_consensus_enabled to Project in https://github.com/Labelbox/labelbox-python/pull/1745
+
+## Updated
+* Made Project quality modes a list to allow combining more than 1 quality mode per project in https://github.com/Labelbox/labelbox-python/pull/1683
+
+## Notebooks
+* Added back in export migration guide in https://github.com/Labelbox/labelbox-python/pull/1736
+* Added correct data param to video notebookin https://github.com/Labelbox/labelbox-python/pull/1732
+NOTE: the notebooks will be removed and moved to this repo https://github.com/Labelbox/labelbox-notebooks soon
+
+## Other
+* Use connection pool for all http and graphql requests in https://github.com/Labelbox/labelbox-python/pull/1733
+
 # Version 3.75.1 (2024-07-16)
 ## Removed
 * Project MEDIA_TYPE JSON https://github.com/Labelbox/labelbox-python/pull/1728

libs/labelbox/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "labelbox"
-version = "3.75.1"
+version = "3.76.0"
 description = "Labelbox Python API"
 authors = [{ name = "Labelbox", email = "engineering@labelbox.com" }]
 dependencies = [

libs/labelbox/src/labelbox/__init__.py

@@ -1,6 +1,6 @@
 name = "labelbox"
 
-__version__ = "3.75.1"
+__version__ = "3.76.0"
 
 from labelbox.client import Client
 from labelbox.schema.project import Project
@@ -43,3 +43,4 @@
 from labelbox.schema.identifiable import UniqueId, GlobalKey
 from labelbox.schema.ontology_kind import OntologyKind
 from labelbox.schema.project_overview import ProjectOverview, ProjectOverviewDetailed
+from labelbox.schema.labeling_service import LabelingService, LabelingServiceStatus

libs/labelbox/src/labelbox/client.py

@@ -895,17 +895,17 @@ def create_prompt_response_generation_project(self,
         NOTE: Only a dataset_name or dataset_id should be included
 
         Examples:
-            >>> client.create_prompt_response_generation_project(name=project_name, dataset_name="new data set", project_kind=MediaType.LLMPromptResponseCreation)
-            >>>     This creates a new dataset with a default number of rows (100), creates new project and assigns a batch of the newly created datarows to the project.
+            >>> client.create_prompt_response_generation_project(name=project_name, dataset_name="new data set", media_type=MediaType.LLMPromptResponseCreation)
+            >>>     This creates a new dataset with a default number of rows (100), creates new prompt and response creation project and assigns a batch of the newly created data rows to the project.
 
-            >>> client.create_prompt_response_generation_project(name=project_name, dataset_name="new data set", data_row_count=10, project_kind=MediaType.LLMPromptCreation)
-            >>>     This creates a new dataset with 10 data rows, creates new project and assigns a batch of the newly created datarows to the project.
+            >>> client.create_prompt_response_generation_project(name=project_name, dataset_name="new data set", data_row_count=10, media_type=MediaType.LLMPromptCreation)
+            >>>     This creates a new dataset with 10 data rows, creates new prompt creation project and assigns a batch of the newly created datarows to the project.
 
-            >>> client.create_prompt_response_generation_project(name=project_name, dataset_id="clr00u8j0j0j0", project_kind=MediaType.LLMPromptCreation)
-            >>>     This creates a new project, and adds 100 datarows to the dataset with id "clr00u8j0j0j0" and assigns a batch of the newly created data rows to the project.
+            >>> client.create_prompt_response_generation_project(name=project_name, dataset_id="clr00u8j0j0j0", media_type=MediaType.LLMPromptCreation)
+            >>>     This creates a new prompt creation project, and adds 100 datarows to the dataset with id "clr00u8j0j0j0" and assigns a batch of the newly created data rows to the project.
 
-            >>> client.create_prompt_response_generation_project(name=project_name, dataset_id="clr00u8j0j0j0", data_row_count=10, project_kind=MediaType.LLMPromptResponseCreation)
-            >>>     This creates a new project, and adds 100 datarows to the dataset with id "clr00u8j0j0j0" and assigns a batch of the newly created 10 data rows to the project.
+            >>> client.create_prompt_response_generation_project(name=project_name, dataset_id="clr00u8j0j0j0", data_row_count=10, media_type=MediaType.LLMPromptResponseCreation)
+            >>>     This creates a new prompt and response creation project, and adds 100 datarows to the dataset with id "clr00u8j0j0j0" and assigns a batch of the newly created 10 data rows to the project.
 
         """
         if not dataset_id and not dataset_name:
@@ -1501,8 +1501,8 @@ def create_ontology(self,
             name (str): Name of the ontology
             normalized (dict): A normalized ontology payload. See above for details.
             media_type (MediaType or None): Media type of a new ontology
-            ontology_kind (OntologyKind or None): set to OntologyKind.ModelEvaluation if the ontology is for chat evaluation,
-                leave as None otherwise.
+            ontology_kind (OntologyKind or None): set to OntologyKind.ModelEvaluation if the ontology is for chat evaluation or 
+                OntologyKind.ResponseCreation if ontology is for response creation, leave as None otherwise.
 
         Returns:
             The created Ontology

libs/labelbox/src/labelbox/schema/labeling_service.py

@@ -0,0 +1,87 @@
+from datetime import datetime
+from enum import Enum
+from typing import Any
+from typing_extensions import Annotated
+
+from labelbox.exceptions import ResourceNotFoundError
+
+from labelbox.pydantic_compat import BaseModel, Field
+from labelbox.utils import _CamelCaseMixin
+
+Cuid = Annotated[str, Field(min_length=25, max_length=25)]
+
+class LabelingServiceStatus(Enum):
+    Accepted = 'ACCEPTED',
+    Calibration = 'CALIBRATION',
+    Complete = 'COMPLETE',
+    Production = 'PRODUCTION',
+    Requested = 'REQUESTED',
+    SetUp = 'SET_UP'
+
+
+class LabelingService(BaseModel):
+    id: Cuid
+    project_id: Cuid
+    created_at: datetime
+    updated_at: datetime
+    created_by_id: Cuid
+    status: LabelingServiceStatus
+    client: Any  # type Any to avoid circular import from client
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        if not self.client.enable_experimental:
+            raise RuntimeError(
+                "Please enable experimental in client to use LabelingService")
+
+    class Config(_CamelCaseMixin.Config):
+        ...
+
+    @classmethod
+    def start(cls, client, project_id: Cuid) -> 'LabelingService':
+        """
+        Starts the labeling service for the project. This is equivalent to a UI acction to Request Specialized Labelers
+
+        Returns:
+            LabelingService: The labeling service for the project.
+        Raises:
+            Exception: If the service fails to start.
+        """
+        query_str = """mutation CreateProjectBoostWorkforcePyApi($projectId: ID!) {
+          upsertProjectBoostWorkforce(data: { projectId: $projectId }) {
+            success
+          }
+        }"""
+        result = client.execute(query_str, {"projectId": project_id})
+        success = result["upsertProjectBoostWorkforce"]["success"]
+        if not success:
+            raise Exception("Failed to start labeling service")
+        return cls.get(client, project_id)
+
+    @classmethod
+    def get(cls, client, project_id: Cuid) -> 'LabelingService':
+        """
+        Returns the labeling service associated with the project.
+
+        Raises:
+            ResourceNotFoundError: If the project does not have a labeling service.
+        """
+        query = """
+            query GetProjectBoostWorkforcePyApi($projectId: ID!) {
+            projectBoostWorkforce(data: { projectId: $projectId }) {
+                    id
+                    projectId
+                    createdAt
+                    updatedAt
+                    createdById
+                    status
+                }
+            }
+        """
+        result = client.execute(query, {"projectId": project_id})
+        if result["projectBoostWorkforce"] is None:
+            raise ResourceNotFoundError(
+                message="The project does not have a labeling service.")
+        data = result["projectBoostWorkforce"]
+        data["client"] = client
+        return LabelingService(**data)

libs/labelbox/src/labelbox/schema/project.py

@@ -9,6 +9,7 @@
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple, TypeVar, Union, overload
 from urllib.parse import urlparse
 
+from labelbox.schema.labeling_service import LabelingService, LabelingServiceStatus
 import requests
 
 from labelbox import parser
@@ -149,7 +150,7 @@ def is_chat_evaluation(self) -> bool:
             True if this project is a live chat evaluation project, False otherwise
         """
         return self.media_type == MediaType.Conversational and self.editor_task_type == EditorTaskType.ModelChatEvaluation
-    
+
     def is_prompt_response(self) -> bool:
         """
         Returns:
@@ -1915,6 +1916,39 @@ def clone(self) -> "Project":
         result = self.client.execute(mutation, {"projectId": self.uid})
         return self.client.get_project(result["cloneProject"]["id"])
 
+    @experimental
+    def get_labeling_service(self) -> LabelingService:
+        """Get the labeling service for this project.
+
+        Raises:
+            ResourceNotFoundError if the project does not have a labeling service.
+
+        Returns:
+            LabelingService: The labeling service for this project.
+        """
+        return LabelingService.get(self.client, self.uid)
+
+    @experimental
+    def get_labeling_service_status(self) -> LabelingServiceStatus:
+        """Get the labeling service status for this project.
+
+        Raises:
+            ResourceNotFoundError if the project does not have a labeling service.
+
+        Returns:
+            LabelingServiceStatus: The labeling service status for this project.
+        """
+        return self.get_labeling_service().status
+
+    @experimental
+    def request_labeling_service(self) -> LabelingService:
+        """Get the labeling service for this project.
+
+        Returns:
+            LabelingService: The labeling service for this project.
+        """
+        return LabelingService.start(self.client, self.uid)  # type: ignore
+
 
 class ProjectMember(DbObject):
     user = Relationship.ToOne("User", cache=True)

libs/labelbox/tests/integration/test_labeling_service.py

@@ -0,0 +1,25 @@
+import pytest
+
+from labelbox.exceptions import ResourceNotFoundError
+from labelbox.schema.labeling_service import LabelingServiceStatus
+
+
+def test_get_labeling_service_throws_exception(project):
+    with pytest.raises(ResourceNotFoundError):  # No labeling service by default
+        project.get_labeling_service()
+    with pytest.raises(ResourceNotFoundError):  # No labeling service by default
+        project.get_labeling_service_status()
+
+
+def test_start_labeling_service(project):
+    labeling_service = project.request_labeling_service()
+    assert labeling_service.status == LabelingServiceStatus.SetUp
+    assert labeling_service.project_id == project.uid
+
+    # Check that the labeling service is now available
+    labeling_service = project.get_labeling_service()
+    assert labeling_service.status == LabelingServiceStatus.SetUp
+    assert labeling_service.project_id == project.uid
+
+    labeling_service_status = project.get_labeling_service_status()
+    assert labeling_service_status == LabelingServiceStatus.SetUp