dify-oapi2 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

dify_oapi/api/chat/v1/model/message_info.py

@@ -0,0 +1,73 @@
+from typing import Any
+
+from pydantic import BaseModel
+
+from .agent_thought import AgentThought
+from .feedback_info import FeedbackInfo
+from .message_file import MessageFile
+from .retriever_resource import RetrieverResource
+
+
+class MessageInfo(BaseModel):
+    id: str | None = None
+    conversation_id: str | None = None
+    inputs: dict[str, Any] | None = None
+    query: str | None = None
+    answer: str | None = None
+    message_files: list[MessageFile] | None = None
+    feedback: FeedbackInfo | None = None
+    retriever_resources: list[RetrieverResource] | None = None
+    agent_thoughts: list[AgentThought] | None = None
+    created_at: int | None = None
+
+    @staticmethod
+    def builder() -> "MessageInfoBuilder":
+        return MessageInfoBuilder()
+
+
+class MessageInfoBuilder:
+    def __init__(self):
+        self._message_info = MessageInfo()
+
+    def id(self, id: str) -> "MessageInfoBuilder":
+        self._message_info.id = id
+        return self
+
+    def conversation_id(self, conversation_id: str) -> "MessageInfoBuilder":
+        self._message_info.conversation_id = conversation_id
+        return self
+
+    def inputs(self, inputs: dict[str, Any]) -> "MessageInfoBuilder":
+        self._message_info.inputs = inputs
+        return self
+
+    def query(self, query: str) -> "MessageInfoBuilder":
+        self._message_info.query = query
+        return self
+
+    def answer(self, answer: str) -> "MessageInfoBuilder":
+        self._message_info.answer = answer
+        return self
+
+    def message_files(self, message_files: list[MessageFile]) -> "MessageInfoBuilder":
+        self._message_info.message_files = message_files
+        return self
+
+    def feedback(self, feedback: FeedbackInfo) -> "MessageInfoBuilder":
+        self._message_info.feedback = feedback
+        return self
+
+    def retriever_resources(self, retriever_resources: list[RetrieverResource]) -> "MessageInfoBuilder":
+        self._message_info.retriever_resources = retriever_resources
+        return self
+
+    def agent_thoughts(self, agent_thoughts: list[AgentThought]) -> "MessageInfoBuilder":
+        self._message_info.agent_thoughts = agent_thoughts
+        return self
+
+    def created_at(self, created_at: int) -> "MessageInfoBuilder":
+        self._message_info.created_at = created_at
+        return self
+
+    def build(self) -> MessageInfo:
+        return self._message_info

dify_oapi/api/chat/v1/model/pagination_info.py

@@ -0,0 +1,44 @@
+"""Pagination information model for Chat API."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class PaginationInfo(BaseModel):
+    """Pagination information model."""
+
+    limit: int | None = None
+    has_more: bool | None = None
+    total: int | None = None
+    page: int | None = None
+
+    @staticmethod
+    def builder() -> PaginationInfoBuilder:
+        return PaginationInfoBuilder()
+
+
+class PaginationInfoBuilder:
+    """Builder for PaginationInfo."""
+
+    def __init__(self):
+        self._pagination_info = PaginationInfo()
+
+    def build(self) -> PaginationInfo:
+        return self._pagination_info
+
+    def limit(self, limit: int) -> PaginationInfoBuilder:
+        self._pagination_info.limit = limit
+        return self
+
+    def has_more(self, has_more: bool) -> PaginationInfoBuilder:
+        self._pagination_info.has_more = has_more
+        return self
+
+    def total(self, total: int) -> PaginationInfoBuilder:
+        self._pagination_info.total = total
+        return self
+
+    def page(self, page: int) -> PaginationInfoBuilder:
+        self._pagination_info.page = page
+        return self

dify_oapi/api/chat/v1/model/rename_conversation_request_body.py

@@ -17,7 +17,7 @@ class RenameConversationRequestBodyBuilder:
     def __init__(self):
         self._rename_conversation_request_body = RenameConversationRequestBody()
 
-    def builder(self) -> RenameConversationRequestBody:
+    def build(self) -> RenameConversationRequestBody:
         return self._rename_conversation_request_body
 
     def name(self, name: str) -> RenameConversationRequestBodyBuilder:

dify_oapi/api/chat/v1/model/retriever_resource.py

@@ -0,0 +1,64 @@
+"""Retriever resource model for Chat API."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class RetrieverResource(BaseModel):
+    """Retriever resource model."""
+
+    position: int | None = None
+    dataset_id: str | None = None
+    dataset_name: str | None = None
+    document_id: str | None = None
+    document_name: str | None = None
+    segment_id: str | None = None
+    score: float | None = None
+    content: str | None = None
+
+    @staticmethod
+    def builder() -> RetrieverResourceBuilder:
+        return RetrieverResourceBuilder()
+
+
+class RetrieverResourceBuilder:
+    """Builder for RetrieverResource."""
+
+    def __init__(self):
+        self._retriever_resource = RetrieverResource()
+
+    def build(self) -> RetrieverResource:
+        return self._retriever_resource
+
+    def position(self, position: int) -> RetrieverResourceBuilder:
+        self._retriever_resource.position = position
+        return self
+
+    def dataset_id(self, dataset_id: str) -> RetrieverResourceBuilder:
+        self._retriever_resource.dataset_id = dataset_id
+        return self
+
+    def dataset_name(self, dataset_name: str) -> RetrieverResourceBuilder:
+        self._retriever_resource.dataset_name = dataset_name
+        return self
+
+    def document_id(self, document_id: str) -> RetrieverResourceBuilder:
+        self._retriever_resource.document_id = document_id
+        return self
+
+    def document_name(self, document_name: str) -> RetrieverResourceBuilder:
+        self._retriever_resource.document_name = document_name
+        return self
+
+    def segment_id(self, segment_id: str) -> RetrieverResourceBuilder:
+        self._retriever_resource.segment_id = segment_id
+        return self
+
+    def score(self, score: float) -> RetrieverResourceBuilder:
+        self._retriever_resource.score = score
+        return self
+
+    def content(self, content: str) -> RetrieverResourceBuilder:
+        self._retriever_resource.content = content
+        return self

dify_oapi/api/chat/v1/model/site_settings.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .chat_types import IconType
+
+
+class SiteSettings(BaseModel):
+    """Site settings configuration."""
+
+    title: str | None = None
+    chat_color_theme: str | None = None
+    chat_color_theme_inverted: bool | None = None
+    icon_type: IconType | None = None
+    icon: str | None = None
+    icon_background: str | None = None
+    icon_url: str | None = None
+    description: str | None = None
+    copyright: str | None = None
+    privacy_policy: str | None = None
+    custom_disclaimer: str | None = None
+    default_language: str | None = None
+    show_workflow_steps: bool | None = None
+    use_icon_as_answer_icon: bool | None = None
+
+    @staticmethod
+    def builder() -> SiteSettingsBuilder:
+        return SiteSettingsBuilder()
+
+
+class SiteSettingsBuilder:
+    def __init__(self):
+        self._site_settings = SiteSettings()
+
+    def build(self) -> SiteSettings:
+        return self._site_settings
+
+    def title(self, title: str) -> SiteSettingsBuilder:
+        self._site_settings.title = title
+        return self
+
+    def chat_color_theme(self, chat_color_theme: str) -> SiteSettingsBuilder:
+        self._site_settings.chat_color_theme = chat_color_theme
+        return self
+
+    def chat_color_theme_inverted(self, chat_color_theme_inverted: bool) -> SiteSettingsBuilder:
+        self._site_settings.chat_color_theme_inverted = chat_color_theme_inverted
+        return self
+
+    def icon_type(self, icon_type: IconType) -> SiteSettingsBuilder:
+        self._site_settings.icon_type = icon_type
+        return self
+
+    def icon(self, icon: str) -> SiteSettingsBuilder:
+        self._site_settings.icon = icon
+        return self
+
+    def icon_background(self, icon_background: str) -> SiteSettingsBuilder:
+        self._site_settings.icon_background = icon_background
+        return self
+
+    def icon_url(self, icon_url: str) -> SiteSettingsBuilder:
+        self._site_settings.icon_url = icon_url
+        return self
+
+    def description(self, description: str) -> SiteSettingsBuilder:
+        self._site_settings.description = description
+        return self
+
+    def copyright(self, copyright: str) -> SiteSettingsBuilder:
+        self._site_settings.copyright = copyright
+        return self
+
+    def privacy_policy(self, privacy_policy: str) -> SiteSettingsBuilder:
+        self._site_settings.privacy_policy = privacy_policy
+        return self
+
+    def custom_disclaimer(self, custom_disclaimer: str) -> SiteSettingsBuilder:
+        self._site_settings.custom_disclaimer = custom_disclaimer
+        return self
+
+    def default_language(self, default_language: str) -> SiteSettingsBuilder:
+        self._site_settings.default_language = default_language
+        return self
+
+    def show_workflow_steps(self, show_workflow_steps: bool) -> SiteSettingsBuilder:
+        self._site_settings.show_workflow_steps = show_workflow_steps
+        return self
+
+    def use_icon_as_answer_icon(self, use_icon_as_answer_icon: bool) -> SiteSettingsBuilder:
+        self._site_settings.use_icon_as_answer_icon = use_icon_as_answer_icon
+        return self

dify_oapi/api/chat/v1/model/submit_feedback_request.py

@@ -0,0 +1,34 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+from .submit_feedback_request_body import SubmitFeedbackRequestBody
+
+
+class SubmitFeedbackRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+        self.request_body: SubmitFeedbackRequestBody | None = None
+
+    @staticmethod
+    def builder() -> "SubmitFeedbackRequestBuilder":
+        return SubmitFeedbackRequestBuilder()
+
+
+class SubmitFeedbackRequestBuilder:
+    def __init__(self) -> None:
+        submit_feedback_request = SubmitFeedbackRequest()
+        submit_feedback_request.http_method = HttpMethod.POST
+        submit_feedback_request.uri = "/v1/messages/:message_id/feedbacks"
+        self._submit_feedback_request = submit_feedback_request
+
+    def message_id(self, message_id: str) -> "SubmitFeedbackRequestBuilder":
+        self._submit_feedback_request.paths["message_id"] = message_id
+        return self
+
+    def request_body(self, request_body: SubmitFeedbackRequestBody) -> "SubmitFeedbackRequestBuilder":
+        self._submit_feedback_request.request_body = request_body
+        self._submit_feedback_request.body = request_body.model_dump(exclude_none=True, mode="json")
+        return self
+
+    def build(self) -> SubmitFeedbackRequest:
+        return self._submit_feedback_request

dify_oapi/api/chat/v1/model/submit_feedback_request_body.py

@@ -0,0 +1,33 @@
+from pydantic import BaseModel
+
+from .chat_types import Rating
+
+
+class SubmitFeedbackRequestBody(BaseModel):
+    rating: Rating | None = None
+    user: str
+    content: str | None = None
+
+    @staticmethod
+    def builder() -> "SubmitFeedbackRequestBodyBuilder":
+        return SubmitFeedbackRequestBodyBuilder()
+
+
+class SubmitFeedbackRequestBodyBuilder:
+    def __init__(self) -> None:
+        self._submit_feedback_request_body = SubmitFeedbackRequestBody(user="")
+
+    def rating(self, rating: Rating | None) -> "SubmitFeedbackRequestBodyBuilder":
+        self._submit_feedback_request_body.rating = rating
+        return self
+
+    def user(self, user: str) -> "SubmitFeedbackRequestBodyBuilder":
+        self._submit_feedback_request_body.user = user
+        return self
+
+    def content(self, content: str | None) -> "SubmitFeedbackRequestBodyBuilder":
+        self._submit_feedback_request_body.content = content
+        return self
+
+    def build(self) -> SubmitFeedbackRequestBody:
+        return self._submit_feedback_request_body

dify_oapi/api/chat/v1/model/submit_feedback_response.py

@@ -0,0 +1,5 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+
+class SubmitFeedbackResponse(BaseResponse):
+    result: str = "success"

dify_oapi/api/chat/v1/model/text_to_audio_request.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+from .text_to_audio_request_body import TextToAudioRequestBody
+
+
+class TextToAudioRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+        self.request_body: TextToAudioRequestBody | None = None
+
+    @staticmethod
+    def builder() -> TextToAudioRequestBuilder:
+        return TextToAudioRequestBuilder()
+
+
+class TextToAudioRequestBuilder:
+    def __init__(self):
+        text_to_audio_request = TextToAudioRequest()
+        text_to_audio_request.http_method = HttpMethod.POST
+        text_to_audio_request.uri = "/v1/text-to-audio"
+        self._text_to_audio_request = text_to_audio_request
+
+    def build(self) -> TextToAudioRequest:
+        return self._text_to_audio_request
+
+    def request_body(self, request_body: TextToAudioRequestBody) -> TextToAudioRequestBuilder:
+        self._text_to_audio_request.request_body = request_body
+        self._text_to_audio_request.body = request_body.model_dump(exclude_none=True, mode="json")
+        return self

dify_oapi/api/chat/v1/model/text_to_audio_request_body.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class TextToAudioRequestBody(BaseModel):
+    message_id: str | None = None
+    text: str | None = None
+    user: str
+
+    @staticmethod
+    def builder() -> TextToAudioRequestBodyBuilder:
+        return TextToAudioRequestBodyBuilder()
+
+
+class TextToAudioRequestBodyBuilder:
+    def __init__(self):
+        self._text_to_audio_request_body = TextToAudioRequestBody(user="")
+
+    def build(self) -> TextToAudioRequestBody:
+        return self._text_to_audio_request_body
+
+    def message_id(self, message_id: str) -> TextToAudioRequestBodyBuilder:
+        self._text_to_audio_request_body.message_id = message_id
+        return self
+
+    def text(self, text: str) -> TextToAudioRequestBodyBuilder:
+        self._text_to_audio_request_body.text = text
+        return self
+
+    def user(self, user: str) -> TextToAudioRequestBodyBuilder:
+        self._text_to_audio_request_body.user = user
+        return self

dify_oapi/api/chat/v1/model/text_to_audio_response.py

@@ -0,0 +1,7 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+
+class TextToAudioResponse(BaseResponse):
+    """Response for text-to-audio API that returns binary audio data."""
+
+    pass

dify_oapi/api/chat/v1/model/tool_icon.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class ToolIconDetail(BaseModel):
+    """Tool icon detail configuration."""
+
+    background: str
+    content: str
+
+    @staticmethod
+    def builder() -> ToolIconDetailBuilder:
+        return ToolIconDetailBuilder()
+
+
+class ToolIconDetailBuilder:
+    def __init__(self):
+        self._tool_icon_detail = ToolIconDetail(background="", content="")
+
+    def build(self) -> ToolIconDetail:
+        return self._tool_icon_detail
+
+    def background(self, background: str) -> ToolIconDetailBuilder:
+        self._tool_icon_detail.background = background
+        return self
+
+    def content(self, content: str) -> ToolIconDetailBuilder:
+        self._tool_icon_detail.content = content
+        return self
+
+
+class ToolIcon(BaseModel):
+    """Tool icon configuration."""
+
+    tool_icons: dict[str, str | ToolIconDetail] | None = None
+
+    @staticmethod
+    def builder() -> ToolIconBuilder:
+        return ToolIconBuilder()
+
+
+class ToolIconBuilder:
+    def __init__(self):
+        self._tool_icon = ToolIcon()
+
+    def build(self) -> ToolIcon:
+        return self._tool_icon
+
+    def tool_icons(self, tool_icons: dict[str, str | ToolIconDetail]) -> ToolIconBuilder:
+        self._tool_icon.tool_icons = tool_icons
+        return self

dify_oapi/api/chat/v1/model/update_annotation_request.py

@@ -0,0 +1,33 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+from .update_annotation_request_body import UpdateAnnotationRequestBody
+
+
+class UpdateAnnotationRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+        self.request_body: UpdateAnnotationRequestBody | None = None
+
+    @staticmethod
+    def builder() -> "UpdateAnnotationRequestBuilder":
+        return UpdateAnnotationRequestBuilder()
+
+
+class UpdateAnnotationRequestBuilder:
+    def __init__(self) -> None:
+        update_annotation_request = UpdateAnnotationRequest()
+        update_annotation_request.http_method = HttpMethod.PUT
+        update_annotation_request.uri = "/v1/apps/annotations/:annotation_id"
+        self._update_annotation_request = update_annotation_request
+
+    def annotation_id(self, annotation_id: str) -> "UpdateAnnotationRequestBuilder":
+        self._update_annotation_request.paths["annotation_id"] = annotation_id
+        return self
+
+    def request_body(self, request_body: UpdateAnnotationRequestBody) -> "UpdateAnnotationRequestBuilder":
+        self._update_annotation_request.request_body = request_body
+        return self
+
+    def build(self) -> UpdateAnnotationRequest:
+        return self._update_annotation_request

dify_oapi/api/chat/v1/model/update_annotation_request_body.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class UpdateAnnotationRequestBody(BaseModel):
+    """Request body for updating annotation."""
+
+    question: str = ""
+    answer: str = ""
+
+    @staticmethod
+    def builder() -> UpdateAnnotationRequestBodyBuilder:
+        return UpdateAnnotationRequestBodyBuilder()
+
+
+class UpdateAnnotationRequestBodyBuilder:
+    """Builder for UpdateAnnotationRequestBody."""
+
+    def __init__(self):
+        self._update_annotation_request_body = UpdateAnnotationRequestBody()
+
+    def build(self) -> UpdateAnnotationRequestBody:
+        return self._update_annotation_request_body
+
+    def question(self, question: str) -> UpdateAnnotationRequestBodyBuilder:
+        self._update_annotation_request_body.question = question
+        return self
+
+    def answer(self, answer: str) -> UpdateAnnotationRequestBodyBuilder:
+        self._update_annotation_request_body.answer = answer
+        return self

dify_oapi/api/chat/v1/model/update_annotation_response.py

@@ -0,0 +1,9 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .annotation_info import AnnotationInfo
+
+
+class UpdateAnnotationResponse(AnnotationInfo, BaseResponse):
+    """Response for updating annotation."""
+
+    pass

dify_oapi/api/chat/v1/model/upload_file_request.py

@@ -0,0 +1,54 @@
+"""Upload file request model."""
+
+from __future__ import annotations
+
+from io import BytesIO
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+from .upload_file_request_body import UploadFileRequestBody
+
+
+class UploadFileRequest(BaseRequest):
+    """Request model for upload file API."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.request_body: UploadFileRequestBody | None = None
+        self.file: BytesIO | None = None
+
+    @staticmethod
+    def builder() -> UploadFileRequestBuilder:
+        return UploadFileRequestBuilder()
+
+
+class UploadFileRequestBuilder:
+    """Builder for UploadFileRequest."""
+
+    def __init__(self) -> None:
+        upload_file_request = UploadFileRequest()
+        upload_file_request.http_method = HttpMethod.POST
+        upload_file_request.uri = "/v1/files/upload"
+        self._upload_file_request = upload_file_request
+
+    def build(self) -> UploadFileRequest:
+        return self._upload_file_request
+
+    def file(self, file: BytesIO, file_name: str | None = None) -> UploadFileRequestBuilder:
+        """Set the file to upload."""
+        self._upload_file_request.file = file
+        file_name = file_name or "upload"
+        self._upload_file_request.files = {"file": (file_name, file)}
+        return self
+
+    def request_body(self, request_body: UploadFileRequestBody) -> UploadFileRequestBuilder:
+        """Set the request body."""
+        self._upload_file_request.request_body = request_body
+        if request_body.user:
+            self._upload_file_request.body = {"user": request_body.user}
+        return self
+
+    @staticmethod
+    def builder() -> UploadFileRequestBuilder:
+        return UploadFileRequestBuilder()

dify_oapi/api/chat/v1/model/upload_file_request_body.py

@@ -0,0 +1,29 @@
+"""Upload file request body model."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class UploadFileRequestBody(BaseModel):
+    """Request body for upload file API."""
+
+    user: str
+
+    @staticmethod
+    def builder() -> UploadFileRequestBodyBuilder:
+        return UploadFileRequestBodyBuilder()
+
+
+class UploadFileRequestBodyBuilder:
+    """Builder for UploadFileRequestBody."""
+
+    def __init__(self) -> None:
+        self._upload_file_request_body = UploadFileRequestBody(user="")
+
+    def build(self) -> UploadFileRequestBody:
+        return self._upload_file_request_body
+
+    def user(self, user: str) -> UploadFileRequestBodyBuilder:
+        self._upload_file_request_body.user = user
+        return self

dify_oapi/api/chat/v1/model/upload_file_response.py

@@ -0,0 +1,10 @@
+"""Upload file response model."""
+
+from dify_oapi.api.chat.v1.model.file_info import FileInfo
+from dify_oapi.core.model.base_response import BaseResponse
+
+
+class UploadFileResponse(FileInfo, BaseResponse):
+    """Response model for upload file API."""
+
+    pass