refactor: use kili-formats for common code

Author: baptiste-olivier

src/kili/adapters/kili_api_gateway/label/annotation_to_json_response.py

@@ -4,6 +4,8 @@
 from dataclasses import dataclass
 from typing import Dict, Generator, List, Optional, Tuple, TypeVar, Union, cast, overload
 
+from kili_formats.types import JobTool
+
 from kili.domain.annotation import (
     ClassicAnnotation,
     ClassificationAnnotation,
@@ -18,7 +20,7 @@
     VideoTranscriptionAnnotation,
     VideoTranscriptionKeyAnnotation,
 )
-from kili.domain.ontology import JobName, JobTool
+from kili.domain.ontology import JobName
 
 ASSET_LEVEL_KEY = "assetLevel"
 

src/kili/adapters/kili_api_gateway/llm/mappers.py

@@ -2,10 +2,10 @@
 
 from typing import Dict, List, Optional
 
+from kili_formats.types import ChatItemRole, Conversation
+
 from kili.domain.llm import (
     AzureOpenAICredentials,
-    ChatItemRole,
-    Conversation,
     ModelToCreateInput,
     ModelToUpdateInput,
     ModelType,

src/kili/adapters/kili_api_gateway/llm/operations_mixin.py

@@ -2,6 +2,8 @@
 
 from typing import Dict, List, Optional, cast
 
+from kili_formats.types import ChatItem, ChatItemRole, Conversation
+
 from kili.adapters.kili_api_gateway.base import BaseOperationMixin
 from kili.adapters.kili_api_gateway.helpers.queries import (
     PaginatedGraphQLQuery,
@@ -39,9 +41,6 @@
     get_update_project_model_mutation,
 )
 from kili.domain.llm import (
-    ChatItem,
-    ChatItemRole,
-    Conversation,
     ModelDict,
     ModelToCreateInput,
     ModelToUpdateInput,

src/kili/domain/llm.py

@@ -2,7 +2,7 @@
 
 from dataclasses import dataclass
 from enum import Enum
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, Optional, Union
 
 from typing_extensions import TypedDict
 
@@ -95,14 +95,6 @@ class ProjectModelFilters:
     model_id: Optional[str] = None
 
 
-class ChatItemRole(str, Enum):
-    """Enumeration of the supported chat item role."""
-
-    ASSISTANT = "ASSISTANT"
-    USER = "USER"
-    SYSTEM = "SYSTEM"
-
-
 class OpenAISDKCredentialsDict(TypedDict):
     """Dict that represents model.Credentials for OpenAI SDK."""
 
@@ -133,33 +125,3 @@ class ProjectModelDict(TypedDict):
     id: str
     configuration: Dict[str, Any]
     model: ModelDict
-
-
-class ChatItem(TypedDict):
-    """Dict that represents a ChatItem."""
-
-    id: str
-    content: str
-    createdAt: Optional[str]
-    externalId: str
-    modelId: Optional[str]
-    modelName: Optional[str]
-    role: ChatItemRole
-
-
-class ConversationLabel(TypedDict):
-    """Dict that represents a ConversationLabel."""
-
-    completion: Optional[Dict]
-    conversation: Optional[Dict]
-    round: Optional[Dict]
-
-
-class Conversation(TypedDict):
-    """Dict that represents a Conversation."""
-
-    chatItems: List[ChatItem]
-    externalId: Optional[str]
-    label: Optional[ConversationLabel]
-    labeler: Optional[str]
-    metadata: Optional[dict]

src/kili/domain/ontology.py

@@ -21,16 +21,3 @@ class JobMLTask(str, Enum):
     RANKING = "RANKING"
     SPEECH_TO_TEXT = "SPEECH_TO_TEXT"
     TRANSCRIPTION = "TRANSCRIPTION"
-
-
-class JobTool(str, Enum):
-    """List of tools."""
-
-    MARKER = "marker"
-    POLYGON = "polygon"
-    POLYLINE = "polyline"
-    POSE = "pose"
-    RANGE = "range"
-    RECTANGLE = "rectangle"
-    SEMANTIC = "semantic"
-    VECTOR = "vector"

src/kili/llm/presentation/client/llm.py

@@ -10,14 +10,13 @@
     cast,
 )
 
+from kili_formats.types import ChatItem, ChatItemRole, Conversation
+
 from kili.adapters.kili_api_gateway.kili_api_gateway import KiliAPIGateway
 from kili.domain.asset import AssetExternalId, AssetFilters, AssetId, AssetStatus
 from kili.domain.label import LabelType
 from kili.domain.llm import (
     AzureOpenAICredentials,
-    ChatItem,
-    ChatItemRole,
-    Conversation,
     ModelDict,
     ModelToCreateInput,
     ModelToUpdateInput,

src/kili/llm/services/export/__init__.py

@@ -2,11 +2,12 @@
 
 from typing import Dict, List, Optional, Union
 
+from kili_formats.types import Conversation
+
 from kili.adapters.kili_api_gateway.helpers.queries import QueryOptions
 from kili.adapters.kili_api_gateway.kili_api_gateway import KiliAPIGateway
 from kili.domain.asset.asset import AssetFilters
 from kili.domain.label import LabelType
-from kili.domain.llm import Conversation
 from kili.domain.project import ProjectId
 
 from .export_llm_rlhf import LLMRLHFExporter

src/kili/llm/services/export/export_llm_static_or_dynamic.py

@@ -1,9 +1,9 @@
 from typing import Dict, List, Optional, cast
 
 from kili_formats import convert_from_kili_to_llm_static_or_dynamic_format
+from kili_formats.types import ChatItem, Conversation, JobLevel
 
 from kili.adapters.kili_api_gateway.kili_api_gateway import KiliAPIGateway
-from kili.domain.llm import ChatItem, Conversation
 
 CHAT_ITEMS_NEEDED_FIELDS = [
     "id",
@@ -29,12 +29,6 @@
 ]
 
 
-class JobLevel:
-    ROUND = "round"
-    CONVERSATION = "conversation"
-    COMPLETION = "completion"
-
-
 DEFAULT_JOB_LEVEL = JobLevel.ROUND
 
 

src/kili/services/export/format/base.py

@@ -7,7 +7,9 @@
 from abc import ABC, abstractmethod
 from datetime import datetime
 from pathlib import Path
-from typing import TYPE_CHECKING, Dict, List, Literal, NamedTuple, Optional, Tuple, TypedDict, Union
+from typing import TYPE_CHECKING, Dict, List, Literal, NamedTuple, Optional, Tuple, Union
+
+from kili_formats.types import Job
 
 from kili.domain.asset import AssetId
 from kili.domain.project import ProjectId
@@ -25,7 +27,6 @@
     LabelFormat,
     SplitOption,
 )
-from kili.services.types import Job
 from kili.utils.tempfile import TemporaryDirectory
 
 if TYPE_CHECKING:
@@ -34,17 +35,6 @@
 InputType = Literal["IMAGE", "LLM_INSTR_FOLLOWING", "LLM_RLHF", "PDF", "TEXT", "VIDEO"]
 
 
-class ProjectDict(TypedDict):
-    """Project dictionary."""
-
-    description: str
-    id: str
-    inputType: InputType
-    jsonInterface: Optional[Dict]
-    organizationId: str
-    title: str
-
-
 class ExportParams(NamedTuple):
     """Contains all parameters that change the result of the export."""
 

src/kili/services/export/format/coco/__init__.py

@@ -4,16 +4,16 @@
 from typing import Dict, List, Optional
 
 from kili_formats import convert_from_kili_to_coco_format
+from kili_formats.types import Job, JobTool
 
-from kili.domain.ontology import JobMLTask, JobTool
+from kili.domain.ontology import JobMLTask
 from kili.services.export.exceptions import (
     NoCompatibleJobError,
     NotCompatibleInputType,
     NotCompatibleOptions,
 )
 from kili.services.export.format.base import AbstractExporter
 from kili.services.export.types import CocoAnnotationModifier
-from kili.services.types import Job
 
 DATA_SUBDIR = "data"