feat/enhance the multi-modal support (#8818)

api/core/variables/__init__.py

@@ -0,0 +1,61 @@
+from .segment_group import SegmentGroup
+from .segments import (
+    ArrayAnySegment,
+    ArrayFileSegment,
+    ArrayNumberSegment,
+    ArrayObjectSegment,
+    ArraySegment,
+    ArrayStringSegment,
+    FileSegment,
+    FloatSegment,
+    IntegerSegment,
+    NoneSegment,
+    ObjectSegment,
+    Segment,
+    StringSegment,
+)
+from .types import SegmentType
+from .variables import (
+    ArrayAnyVariable,
+    ArrayNumberVariable,
+    ArrayObjectVariable,
+    ArrayStringVariable,
+    FileVariable,
+    FloatVariable,
+    IntegerVariable,
+    NoneVariable,
+    ObjectVariable,
+    SecretVariable,
+    StringVariable,
+    Variable,
+)
+
+__all__ = [
+    "IntegerVariable",
+    "FloatVariable",
+    "ObjectVariable",
+    "SecretVariable",
+    "StringVariable",
+    "ArrayAnyVariable",
+    "Variable",
+    "SegmentType",
+    "SegmentGroup",
+    "Segment",
+    "NoneSegment",
+    "NoneVariable",
+    "IntegerSegment",
+    "FloatSegment",
+    "ObjectSegment",
+    "ArrayAnySegment",
+    "StringSegment",
+    "ArrayStringVariable",
+    "ArrayNumberVariable",
+    "ArrayObjectVariable",
+    "ArraySegment",
+    "ArrayFileSegment",
+    "ArrayNumberSegment",
+    "ArrayObjectSegment",
+    "ArrayStringSegment",
+    "FileSegment",
+    "FileVariable",
+]

api/core/variables/exc.py

@@ -0,0 +1,2 @@
+class VariableError(ValueError):
+    pass

api/core/variables/segment_group.py

@@ -0,0 +1,22 @@
+from .segments import Segment
+from .types import SegmentType
+
+
+class SegmentGroup(Segment):
+    value_type: SegmentType = SegmentType.GROUP
+    value: list[Segment]
+
+    @property
+    def text(self):
+        return "".join([segment.text for segment in self.value])
+
+    @property
+    def log(self):
+        return "".join([segment.log for segment in self.value])
+
+    @property
+    def markdown(self):
+        return "".join([segment.markdown for segment in self.value])
+
+    def to_object(self):
+        return [segment.to_object() for segment in self.value]

api/core/variables/segments.py

@@ -0,0 +1,157 @@
+import json
+import sys
+from collections.abc import Mapping, Sequence
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, field_validator
+
+from core.file import File
+
+from .types import SegmentType
+
+
+class Segment(BaseModel):
+    model_config = ConfigDict(frozen=True)
+
+    value_type: SegmentType
+    value: Any
+
+    @field_validator("value_type")
+    @classmethod
+    def validate_value_type(cls, value):
+        """
+        This validator checks if the provided value is equal to the default value of the 'value_type' field.
+        If the value is different, a ValueError is raised.
+        """
+        if value != cls.model_fields["value_type"].default:
+            raise ValueError("Cannot modify 'value_type'")
+        return value
+
+    @property
+    def text(self) -> str:
+        return str(self.value)
+
+    @property
+    def log(self) -> str:
+        return str(self.value)
+
+    @property
+    def markdown(self) -> str:
+        return str(self.value)
+
+    @property
+    def size(self) -> int:
+        """
+        Return the size of the value in bytes.
+        """
+        return sys.getsizeof(self.value)
+
+    def to_object(self) -> Any:
+        return self.value
+
+
+class NoneSegment(Segment):
+    value_type: SegmentType = SegmentType.NONE
+    value: None = None
+
+    @property
+    def text(self) -> str:
+        return "null"
+
+    @property
+    def log(self) -> str:
+        return "null"
+
+    @property
+    def markdown(self) -> str:
+        return "null"
+
+
+class StringSegment(Segment):
+    value_type: SegmentType = SegmentType.STRING
+    value: str
+
+
+class FloatSegment(Segment):
+    value_type: SegmentType = SegmentType.NUMBER
+    value: float
+
+
+class IntegerSegment(Segment):
+    value_type: SegmentType = SegmentType.NUMBER
+    value: int
+
+
+class ObjectSegment(Segment):
+    value_type: SegmentType = SegmentType.OBJECT
+    value: Mapping[str, Any]
+
+    @property
+    def text(self) -> str:
+        return json.dumps(self.model_dump()["value"], ensure_ascii=False)
+
+    @property
+    def log(self) -> str:
+        return json.dumps(self.model_dump()["value"], ensure_ascii=False, indent=2)
+
+    @property
+    def markdown(self) -> str:
+        return json.dumps(self.model_dump()["value"], ensure_ascii=False, indent=2)
+
+
+class ArraySegment(Segment):
+    @property
+    def markdown(self) -> str:
+        items = []
+        for item in self.value:
+            items.append(str(item))
+        return "\n".join(items)
+
+
+class FileSegment(Segment):
+    value_type: SegmentType = SegmentType.FILE
+    value: File
+
+    @property
+    def markdown(self) -> str:
+        return self.value.markdown
+
+    @property
+    def log(self) -> str:
+        return str(self.value)
+
+    @property
+    def text(self) -> str:
+        return str(self.value)
+
+
+class ArrayAnySegment(ArraySegment):
+    value_type: SegmentType = SegmentType.ARRAY_ANY
+    value: Sequence[Any]
+
+
+class ArrayStringSegment(ArraySegment):
+    value_type: SegmentType = SegmentType.ARRAY_STRING
+    value: Sequence[str]
+
+
+class ArrayNumberSegment(ArraySegment):
+    value_type: SegmentType = SegmentType.ARRAY_NUMBER
+    value: Sequence[float | int]
+
+
+class ArrayObjectSegment(ArraySegment):
+    value_type: SegmentType = SegmentType.ARRAY_OBJECT
+    value: Sequence[Mapping[str, Any]]
+
+
+class ArrayFileSegment(ArraySegment):
+    value_type: SegmentType = SegmentType.ARRAY_FILE
+    value: Sequence[File]
+
+    @property
+    def markdown(self) -> str:
+        items = []
+        for item in self.value:
+            items.append(item.markdown)
+        return "\n".join(items)

api/core/variables/types.py

@@ -0,0 +1,17 @@
+from enum import Enum
+
+
+class SegmentType(str, Enum):
+    NONE = "none"
+    NUMBER = "number"
+    STRING = "string"
+    SECRET = "secret"
+    ARRAY_ANY = "array[any]"
+    ARRAY_STRING = "array[string]"
+    ARRAY_NUMBER = "array[number]"
+    ARRAY_OBJECT = "array[object]"
+    OBJECT = "object"
+    FILE = "file"
+    ARRAY_FILE = "array[file]"
+
+    GROUP = "group"

api/core/variables/variables.py

@@ -0,0 +1,80 @@
+from pydantic import Field
+
+from core.helper import encrypter
+
+from .segments import (
+    ArrayAnySegment,
+    ArrayNumberSegment,
+    ArrayObjectSegment,
+    ArrayStringSegment,
+    FileSegment,
+    FloatSegment,
+    IntegerSegment,
+    NoneSegment,
+    ObjectSegment,
+    Segment,
+    StringSegment,
+)
+from .types import SegmentType
+
+
+class Variable(Segment):
+    """
+    A variable is a segment that has a name.
+    """
+
+    id: str = Field(
+        default="",
+        description="Unique identity for variable. It's only used by environment variables now.",
+    )
+    name: str
+    description: str = Field(default="", description="Description of the variable.")
+
+
+class StringVariable(StringSegment, Variable):
+    pass
+
+
+class FloatVariable(FloatSegment, Variable):
+    pass
+
+
+class IntegerVariable(IntegerSegment, Variable):
+    pass
+
+
+class ObjectVariable(ObjectSegment, Variable):
+    pass
+
+
+class ArrayAnyVariable(ArrayAnySegment, Variable):
+    pass
+
+
+class ArrayStringVariable(ArrayStringSegment, Variable):
+    pass
+
+
+class ArrayNumberVariable(ArrayNumberSegment, Variable):
+    pass
+
+
+class ArrayObjectVariable(ArrayObjectSegment, Variable):
+    pass
+
+
+class SecretVariable(StringVariable):
+    value_type: SegmentType = SegmentType.SECRET
+
+    @property
+    def log(self) -> str:
+        return encrypter.obfuscated_token(self.value)
+
+
+class NoneVariable(NoneSegment, Variable):
+    value_type: SegmentType = SegmentType.NONE
+    value: None = None
+
+
+class FileVariable(FileSegment, Variable):
+    pass