Files
dify-plugin-sdks/python/dify_plugin/entities/__init__.py
2025-09-26 22:51:43 +08:00

68 lines
1.7 KiB
Python

from enum import StrEnum
from pydantic import BaseModel, Field, field_validator
from dify_plugin.core.documentation.schema_doc import docs
@docs(
description="Common i18n object",
)
class I18nObject(BaseModel):
"""
Model class for i18n object.
"""
zh_Hans: str | None = None
pt_BR: str | None = None
ja_JP: str | None = None
en_US: str
def __init__(self, **data):
super().__init__(**data)
if not self.zh_Hans:
self.zh_Hans = self.en_US
if not self.pt_BR:
self.pt_BR = self.en_US
if not self.ja_JP:
self.ja_JP = self.en_US
def to_dict(self) -> dict:
return {"zh_Hans": self.zh_Hans, "en_US": self.en_US, "pt_BR": self.pt_BR, "ja_JP": self.ja_JP}
@docs(
description="The option of the parameter",
)
class ParameterOption(BaseModel):
value: str = Field(..., description="The value of the option")
label: I18nObject = Field(..., description="The label of the option")
icon: str | None = Field(
default=None, description="The icon of the option, can be a URL or a base64 encoded string"
)
@field_validator("value", mode="before")
@classmethod
def transform_id_to_str(cls, value) -> str:
if not isinstance(value, str):
return str(value)
else:
return value
@docs(
description="The auto generate of the parameter",
)
class ParameterAutoGenerate(BaseModel):
class Type(StrEnum):
PROMPT_INSTRUCTION = "prompt_instruction"
type: Type
@docs(
description="The template of the parameter",
)
class ParameterTemplate(BaseModel):
enabled: bool = Field(..., description="Whether the parameter is jinja enabled")