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

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

@@ -0,0 +1,11 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .chat_types import JobStatus
+
+
+class GetAnnotationReplyStatusResponse(BaseResponse):
+    """Response for getting annotation reply settings status."""
+
+    job_id: str | None = None
+    job_status: JobStatus | None = None
+    error_msg: str | None = None

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

@@ -1,48 +1,49 @@
 from __future__ import annotations
 
+from dify_oapi.api.chat.v1.model.chat_types import SortBy
 from dify_oapi.core.enum import HttpMethod
 from dify_oapi.core.model.base_request import BaseRequest
 
 
-class GetConversationListRequest(BaseRequest):
+class GetConversationsRequest(BaseRequest):
     def __init__(self):
         super().__init__()
         self.user: str | None = None
         self.last_id: str | None = None
         self.limit: int | None = None
-        self.pinned: bool | None = None
+        self.sort_by: SortBy | None = None
 
     @staticmethod
-    def builder() -> GetConversationListRequestBuilder:
-        return GetConversationListRequestBuilder()
+    def builder() -> GetConversationsRequestBuilder:
+        return GetConversationsRequestBuilder()
 
 
-class GetConversationListRequestBuilder:
+class GetConversationsRequestBuilder:
     def __init__(self):
-        get_conversation_list_request = GetConversationListRequest()
-        get_conversation_list_request.http_method = HttpMethod.GET
-        get_conversation_list_request.uri = "/v1/conversations"
-        self._get_conversation_list_request = get_conversation_list_request
-
-    def user(self, user: str) -> GetConversationListRequestBuilder:
-        self._get_conversation_list_request.user = user
-        self._get_conversation_list_request.add_query("user", user)
+        get_conversations_request = GetConversationsRequest()
+        get_conversations_request.http_method = HttpMethod.GET
+        get_conversations_request.uri = "/v1/conversations"
+        self._get_conversations_request = get_conversations_request
+
+    def user(self, user: str) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.user = user
+        self._get_conversations_request.add_query("user", user)
         return self
 
-    def last_id(self, last_id: str) -> GetConversationListRequestBuilder:
-        self._get_conversation_list_request.last_id = last_id
-        self._get_conversation_list_request.add_query("last_id", last_id)
+    def last_id(self, last_id: str) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.last_id = last_id
+        self._get_conversations_request.add_query("last_id", last_id)
         return self
 
-    def limit(self, limit: int) -> GetConversationListRequestBuilder:
-        self._get_conversation_list_request.limit = limit
-        self._get_conversation_list_request.add_query("limit", limit)
+    def limit(self, limit: int) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.limit = limit
+        self._get_conversations_request.add_query("limit", limit)
         return self
 
-    def pinned(self, pinned: bool) -> GetConversationListRequestBuilder:
-        self._get_conversation_list_request.pinned = pinned
-        self._get_conversation_list_request.add_query("pinned", str(pinned).lower())
+    def sort_by(self, sort_by: SortBy) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.sort_by = sort_by
+        self._get_conversations_request.add_query("sort_by", sort_by)
         return self
 
-    def build(self) -> GetConversationListRequest:
-        return self._get_conversation_list_request
+    def build(self) -> GetConversationsRequest:
+        return self._get_conversations_request

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

@@ -1,21 +1,10 @@
 from __future__ import annotations
 
-from pydantic import BaseModel
-
+from dify_oapi.api.chat.v1.model.conversation_info import ConversationInfo
 from dify_oapi.core.model.base_response import BaseResponse
 
 
-class GetConversationListResponse(BaseResponse):
-    data: list[GetConversationListData] | None = None
-    has_more: bool | None = None
+class GetConversationsResponse(BaseResponse):
     limit: int | None = None
-
-
-class GetConversationListData(BaseModel):
-    id: str | None = None
-    name: str | None = None
-    inputs: dict | None = None
-    status: str | None = None
-    introduction: str | None = None
-    created_at: int | None = None
-    updated_at: int | None = None
+    has_more: bool | None = None
+    data: list[ConversationInfo] | None = None

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

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetConversationVariablesRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+        self.conversation_id: str | None = None
+        self.user: str | None = None
+        self.last_id: str | None = None
+        self.limit: int | None = None
+        self.variable_name: str | None = None
+
+    @staticmethod
+    def builder() -> GetConversationVariablesRequestBuilder:
+        return GetConversationVariablesRequestBuilder()
+
+
+class GetConversationVariablesRequestBuilder:
+    def __init__(self):
+        get_conversation_variables_request = GetConversationVariablesRequest()
+        get_conversation_variables_request.http_method = HttpMethod.GET
+        get_conversation_variables_request.uri = "/v1/conversations/:conversation_id/variables"
+        self._get_conversation_variables_request = get_conversation_variables_request
+
+    def conversation_id(self, conversation_id: str) -> GetConversationVariablesRequestBuilder:
+        self._get_conversation_variables_request.conversation_id = conversation_id
+        self._get_conversation_variables_request.paths["conversation_id"] = conversation_id
+        return self
+
+    def user(self, user: str) -> GetConversationVariablesRequestBuilder:
+        self._get_conversation_variables_request.user = user
+        self._get_conversation_variables_request.add_query("user", user)
+        return self
+
+    def last_id(self, last_id: str) -> GetConversationVariablesRequestBuilder:
+        self._get_conversation_variables_request.last_id = last_id
+        self._get_conversation_variables_request.add_query("last_id", last_id)
+        return self
+
+    def limit(self, limit: int) -> GetConversationVariablesRequestBuilder:
+        self._get_conversation_variables_request.limit = limit
+        self._get_conversation_variables_request.add_query("limit", limit)
+        return self
+
+    def variable_name(self, variable_name: str) -> GetConversationVariablesRequestBuilder:
+        self._get_conversation_variables_request.variable_name = variable_name
+        self._get_conversation_variables_request.add_query("variable_name", variable_name)
+        return self
+
+    def build(self) -> GetConversationVariablesRequest:
+        return self._get_conversation_variables_request

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

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from dify_oapi.api.chat.v1.model.conversation_variable import ConversationVariable
+from dify_oapi.core.model.base_response import BaseResponse
+
+
+class GetConversationVariablesResponse(BaseResponse):
+    limit: int | None = None
+    has_more: bool | None = None
+    data: list[ConversationVariable] | None = None

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

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from dify_oapi.api.chat.v1.model.chat_types import SortBy
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetConversationsRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+        self.user: str | None = None
+        self.last_id: str | None = None
+        self.limit: int | None = None
+        self.sort_by: SortBy | None = None
+
+    @staticmethod
+    def builder() -> GetConversationsRequestBuilder:
+        return GetConversationsRequestBuilder()
+
+
+class GetConversationsRequestBuilder:
+    def __init__(self):
+        get_conversations_request = GetConversationsRequest()
+        get_conversations_request.http_method = HttpMethod.GET
+        get_conversations_request.uri = "/v1/conversations"
+        self._get_conversations_request = get_conversations_request
+
+    def user(self, user: str) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.user = user
+        self._get_conversations_request.add_query("user", user)
+        return self
+
+    def last_id(self, last_id: str) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.last_id = last_id
+        self._get_conversations_request.add_query("last_id", last_id)
+        return self
+
+    def limit(self, limit: int) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.limit = limit
+        self._get_conversations_request.add_query("limit", limit)
+        return self
+
+    def sort_by(self, sort_by: SortBy) -> GetConversationsRequestBuilder:
+        self._get_conversations_request.sort_by = sort_by
+        self._get_conversations_request.add_query("sort_by", sort_by)
+        return self
+
+    def build(self) -> GetConversationsRequest:
+        return self._get_conversations_request

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

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetSuggestedQuestionsRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+        self.message_id: str | None = None
+        self.user: str | None = None
+
+    @staticmethod
+    def builder() -> GetSuggestedQuestionsRequestBuilder:
+        return GetSuggestedQuestionsRequestBuilder()
+
+
+class GetSuggestedQuestionsRequestBuilder:
+    def __init__(self) -> None:
+        get_suggested_questions_request = GetSuggestedQuestionsRequest()
+        get_suggested_questions_request.http_method = HttpMethod.GET
+        get_suggested_questions_request.uri = "/v1/messages/:message_id/suggested"
+        self._get_suggested_questions_request = get_suggested_questions_request
+
+    def message_id(self, message_id: str) -> GetSuggestedQuestionsRequestBuilder:
+        self._get_suggested_questions_request.message_id = message_id
+        self._get_suggested_questions_request.paths["message_id"] = message_id
+        return self
+
+    def user(self, user: str) -> GetSuggestedQuestionsRequestBuilder:
+        self._get_suggested_questions_request.user = user
+        self._get_suggested_questions_request.add_query("user", user)
+        return self
+
+    def build(self) -> GetSuggestedQuestionsRequest:
+        return self._get_suggested_questions_request

dify_oapi/api/chat/v1/model/{message_suggested_response.py → get_suggested_questions_response.py}

@@ -1,6 +1,6 @@
 from dify_oapi.core.model.base_response import BaseResponse
 
 
-class MessageSuggestedResponse(BaseResponse):
+class GetSuggestedQuestionsResponse(BaseResponse):
     result: str | None = None
     data: list[str] | None = None

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

@@ -0,0 +1,32 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class ListAnnotationsRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+
+    @staticmethod
+    def builder() -> "ListAnnotationsRequestBuilder":
+        return ListAnnotationsRequestBuilder()
+
+
+class ListAnnotationsRequestBuilder:
+    def __init__(self) -> None:
+        list_annotations_request = ListAnnotationsRequest()
+        list_annotations_request.http_method = HttpMethod.GET
+        list_annotations_request.uri = "/v1/apps/annotations"
+        self._list_annotations_request = list_annotations_request
+
+    def page(self, page: int | None) -> "ListAnnotationsRequestBuilder":
+        if page is not None:
+            self._list_annotations_request.add_query("page", str(page))
+        return self
+
+    def limit(self, limit: int | None) -> "ListAnnotationsRequestBuilder":
+        if limit is not None:
+            self._list_annotations_request.add_query("limit", str(limit))
+        return self
+
+    def build(self) -> ListAnnotationsRequest:
+        return self._list_annotations_request

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

@@ -0,0 +1,11 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .annotation_info import AnnotationInfo
+
+
+class ListAnnotationsResponse(BaseResponse):
+    data: list[AnnotationInfo] = []
+    has_more: bool = False
+    limit: int = 20
+    total: int = 0
+    page: int = 1

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

@@ -0,0 +1,46 @@
+"""Message file model for Chat API."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .chat_types import MessageBelongsTo
+
+
+class MessageFile(BaseModel):
+    """Message file model."""
+
+    id: str | None = None
+    type: str | None = None
+    url: str | None = None
+    belongs_to: MessageBelongsTo | None = None
+
+    @staticmethod
+    def builder() -> MessageFileBuilder:
+        return MessageFileBuilder()
+
+
+class MessageFileBuilder:
+    """Builder for MessageFile."""
+
+    def __init__(self):
+        self._message_file = MessageFile()
+
+    def build(self) -> MessageFile:
+        return self._message_file
+
+    def id(self, id: str) -> MessageFileBuilder:
+        self._message_file.id = id
+        return self
+
+    def type(self, type: str) -> MessageFileBuilder:
+        self._message_file.type = type
+        return self
+
+    def url(self, url: str) -> MessageFileBuilder:
+        self._message_file.url = url
+        return self
+
+    def belongs_to(self, belongs_to: MessageBelongsTo) -> MessageFileBuilder:
+        self._message_file.belongs_to = belongs_to
+        return self

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

@@ -4,7 +4,7 @@ from dify_oapi.core.enum import HttpMethod
 from dify_oapi.core.model.base_request import BaseRequest
 
 
-class MessageHistoryRequest(BaseRequest):
+class GetMessageHistoryRequest(BaseRequest):
     def __init__(self):
         super().__init__()
         self.conversation_id: str | None = None
@@ -13,36 +13,36 @@ class MessageHistoryRequest(BaseRequest):
         self.limit: int | None = None
 
     @staticmethod
-    def builder() -> MessageHistoryRequestBuilder:
-        return MessageHistoryRequestBuilder()
+    def builder() -> GetMessageHistoryRequestBuilder:
+        return GetMessageHistoryRequestBuilder()
 
 
-class MessageHistoryRequestBuilder:
+class GetMessageHistoryRequestBuilder:
     def __init__(self):
-        message_history_request = MessageHistoryRequest()
-        message_history_request.http_method = HttpMethod.GET
-        message_history_request.uri = "/v1/messages"
-        self._message_history_request = message_history_request
-
-    def build(self) -> MessageHistoryRequest:
-        return self._message_history_request
-
-    def conversation_id(self, conversation_id: str):
-        self._message_history_request.conversation_id = conversation_id
-        self._message_history_request.add_query("conversation_id", conversation_id)
+        get_message_history_request = GetMessageHistoryRequest()
+        get_message_history_request.http_method = HttpMethod.GET
+        get_message_history_request.uri = "/v1/messages"
+        self._get_message_history_request = get_message_history_request
+
+    def conversation_id(self, conversation_id: str) -> GetMessageHistoryRequestBuilder:
+        self._get_message_history_request.conversation_id = conversation_id
+        self._get_message_history_request.add_query("conversation_id", conversation_id)
         return self
 
-    def user(self, user: str):
-        self._message_history_request.user = user
-        self._message_history_request.add_query("user", user)
+    def user(self, user: str) -> GetMessageHistoryRequestBuilder:
+        self._get_message_history_request.user = user
+        self._get_message_history_request.add_query("user", user)
         return self
 
-    def first_id(self, first_id: str):
-        self._message_history_request.first_id = first_id
-        self._message_history_request.add_query("first_id", first_id)
+    def first_id(self, first_id: str) -> GetMessageHistoryRequestBuilder:
+        self._get_message_history_request.first_id = first_id
+        self._get_message_history_request.add_query("first_id", first_id)
         return self
 
-    def limit(self, limit: int):
-        self._message_history_request.limit = limit
-        self._message_history_request.add_query("limit", limit)
+    def limit(self, limit: int) -> GetMessageHistoryRequestBuilder:
+        self._get_message_history_request.limit = limit
+        self._get_message_history_request.add_query("limit", limit)
         return self
+
+    def build(self) -> GetMessageHistoryRequest:
+        return self._get_message_history_request

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

@@ -1,49 +1,10 @@
 from __future__ import annotations
 
-from pydantic import BaseModel
-
+from dify_oapi.api.chat.v1.model.message_info import MessageInfo
 from dify_oapi.core.model.base_response import BaseResponse
 
 
-class MessageHistoryResponse(BaseResponse):
-    data: list[dict] | None = None
-    id: str | None = None
-    conversation_id: str | None = None
-    inputs: list[dict] | None = None
-    query: str | None = None
-    message_files: list[MessageHistoryResponseFile] | None = None
-    answer: str | None = None
-    created_at: int | None = None
-    feedback: MessageHistoryResponseFeedback | None = None
-    retriever_resources: list[dict] | None = None
-    has_more: bool | None = None
+class GetMessageHistoryResponse(BaseResponse):
     limit: int | None = None
-
-
-class MessageHistoryResponseFeedback(BaseModel):
-    rating: str | None = None
-
-
-class MessageHistoryResponseFile(BaseModel):
-    id: str | None = None
-    type: str | None = None
-    url: str | None = None
-    belongs_to: str | None = None
-    agent_thoughts: list[MessageHistoryResponseFileAgentThought] | None = None
-
-
-class MessageHistoryResponseFileAgentThought(BaseResponse):
-    id: str | None = None
-    message_id: str | None = None
-    position: int | None = None
-    thought: str | None = None
-    observation: str | None = None
-    tool: str | None = None
-    tool_input: str | None = None
-    created_at: int | None = None
-    message_files: list[MessageHistoryResponseFileAgentThoughtFile] | None = None
-    conversation_id: str | None = None
-
-
-class MessageHistoryResponseFileAgentThoughtFile(BaseModel):
-    file_id: str | None = None
+    has_more: bool | None = None
+    data: list[MessageInfo] | None = None

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: