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

dify_oapi/api/knowledge/v1/model/get_dataset_request.py

@@ -0,0 +1,28 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetDatasetRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+        self.dataset_id: str | None = None
+
+    @staticmethod
+    def builder() -> "GetDatasetRequestBuilder":
+        return GetDatasetRequestBuilder()
+
+
+class GetDatasetRequestBuilder:
+    def __init__(self) -> None:
+        get_dataset_request = GetDatasetRequest()
+        get_dataset_request.http_method = HttpMethod.GET
+        get_dataset_request.uri = "/v1/datasets/:dataset_id"
+        self._get_dataset_request = get_dataset_request
+
+    def build(self) -> GetDatasetRequest:
+        return self._get_dataset_request
+
+    def dataset_id(self, dataset_id: str) -> "GetDatasetRequestBuilder":
+        self._get_dataset_request.dataset_id = dataset_id
+        self._get_dataset_request.paths["dataset_id"] = dataset_id
+        return self

dify_oapi/api/knowledge/v1/model/get_dataset_response.py

@@ -0,0 +1,7 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .dataset_info import DatasetInfo
+
+
+class GetDatasetResponse(DatasetInfo, BaseResponse):
+    pass

dify_oapi/api/knowledge/v1/model/get_dataset_tags_request.py

@@ -0,0 +1,28 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetDatasetTagsRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+        self.dataset_id: str | None = None
+
+    @staticmethod
+    def builder() -> "GetDatasetTagsRequestBuilder":
+        return GetDatasetTagsRequestBuilder()
+
+
+class GetDatasetTagsRequestBuilder:
+    def __init__(self) -> None:
+        get_dataset_tags_request = GetDatasetTagsRequest()
+        get_dataset_tags_request.http_method = HttpMethod.GET
+        get_dataset_tags_request.uri = "/v1/datasets/:dataset_id/tags"
+        self._get_dataset_tags_request = get_dataset_tags_request
+
+    def build(self) -> GetDatasetTagsRequest:
+        return self._get_dataset_tags_request
+
+    def dataset_id(self, dataset_id: str) -> "GetDatasetTagsRequestBuilder":
+        self._get_dataset_tags_request.dataset_id = dataset_id
+        self._get_dataset_tags_request.paths["dataset_id"] = dataset_id
+        return self

dify_oapi/api/knowledge/v1/model/get_dataset_tags_response.py

@@ -0,0 +1,8 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .tag_info import TagInfo
+
+
+class GetDatasetTagsResponse(BaseResponse):
+    data: list[TagInfo] | None = None
+    total: int | None = None

dify_oapi/api/knowledge/v1/model/get_document_request.py

@@ -0,0 +1,42 @@
+"""Get document request model."""
+
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetDocumentRequest(BaseRequest):
+    """Request model for get document API."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.dataset_id: str | None = None
+        self.document_id: str | None = None
+
+    @staticmethod
+    def builder() -> GetDocumentRequestBuilder:
+        return GetDocumentRequestBuilder()
+
+
+class GetDocumentRequestBuilder:
+    """Builder for GetDocumentRequest."""
+
+    def __init__(self) -> None:
+        get_document_request = GetDocumentRequest()
+        get_document_request.http_method = HttpMethod.GET
+        get_document_request.uri = "/v1/datasets/:dataset_id/documents/:document_id"
+        self._get_document_request = get_document_request
+
+    def build(self) -> GetDocumentRequest:
+        return self._get_document_request
+
+    def dataset_id(self, dataset_id: str) -> GetDocumentRequestBuilder:
+        self._get_document_request.dataset_id = dataset_id
+        self._get_document_request.paths["dataset_id"] = dataset_id
+        return self
+
+    def document_id(self, document_id: str) -> GetDocumentRequestBuilder:
+        self._get_document_request.document_id = document_id
+        self._get_document_request.paths["document_id"] = document_id
+        return self

dify_oapi/api/knowledge/v1/model/get_document_response.py

@@ -0,0 +1,11 @@
+"""Get document response model."""
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .document_info import DocumentInfo
+
+
+class GetDocumentResponse(DocumentInfo, BaseResponse):
+    """Response model for get document API."""
+
+    pass

dify_oapi/api/knowledge/v1/model/get_segment_request.py

@@ -0,0 +1,48 @@
+"""Get segment request model."""
+
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetSegmentRequest(BaseRequest):
+    """Request model for get segment API."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.dataset_id: str | None = None
+        self.document_id: str | None = None
+        self.segment_id: str | None = None
+
+    @staticmethod
+    def builder() -> GetSegmentRequestBuilder:
+        return GetSegmentRequestBuilder()
+
+
+class GetSegmentRequestBuilder:
+    """Builder for GetSegmentRequest."""
+
+    def __init__(self) -> None:
+        get_segment_request = GetSegmentRequest()
+        get_segment_request.http_method = HttpMethod.GET
+        get_segment_request.uri = "/v1/datasets/:dataset_id/documents/:document_id/segments/:segment_id"
+        self._get_segment_request = get_segment_request
+
+    def build(self) -> GetSegmentRequest:
+        return self._get_segment_request
+
+    def dataset_id(self, dataset_id: str) -> GetSegmentRequestBuilder:
+        self._get_segment_request.dataset_id = dataset_id
+        self._get_segment_request.paths["dataset_id"] = dataset_id
+        return self
+
+    def document_id(self, document_id: str) -> GetSegmentRequestBuilder:
+        self._get_segment_request.document_id = document_id
+        self._get_segment_request.paths["document_id"] = document_id
+        return self
+
+    def segment_id(self, segment_id: str) -> GetSegmentRequestBuilder:
+        self._get_segment_request.segment_id = segment_id
+        self._get_segment_request.paths["segment_id"] = segment_id
+        return self

dify_oapi/api/{knowledge_base/v1/model/segment/get_response.py → knowledge/v1/model/get_segment_response.py}

@@ -1,8 +1,12 @@
+"""Get segment response model."""
+
 from dify_oapi.core.model.base_response import BaseResponse
 
 from .segment_info import SegmentInfo
 
 
-class GetResponse(BaseResponse):
+class GetSegmentResponse(BaseResponse):
+    """Response model for get segment API."""
+
     data: SegmentInfo | None = None
     doc_form: str | None = None

dify_oapi/api/knowledge/v1/model/get_text_embedding_models_request.py

@@ -0,0 +1,22 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetTextEmbeddingModelsRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+
+    @staticmethod
+    def builder() -> "GetTextEmbeddingModelsRequestBuilder":
+        return GetTextEmbeddingModelsRequestBuilder()
+
+
+class GetTextEmbeddingModelsRequestBuilder:
+    def __init__(self):
+        get_text_embedding_models_request = GetTextEmbeddingModelsRequest()
+        get_text_embedding_models_request.http_method = HttpMethod.GET
+        get_text_embedding_models_request.uri = "/v1/workspaces/current/models/model-types/text-embedding"
+        self._get_text_embedding_models_request = get_text_embedding_models_request
+
+    def build(self) -> GetTextEmbeddingModelsRequest:
+        return self._get_text_embedding_models_request

dify_oapi/api/knowledge/v1/model/get_text_embedding_models_response.py

@@ -0,0 +1,7 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .model_info import ModelInfo
+
+
+class GetTextEmbeddingModelsResponse(BaseResponse):
+    data: list[ModelInfo] | None = None

dify_oapi/api/knowledge/v1/model/get_upload_file_info_request.py

@@ -0,0 +1,42 @@
+"""Get upload file info request model."""
+
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetUploadFileInfoRequest(BaseRequest):
+    """Request model for get upload file info API."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.dataset_id: str | None = None
+        self.document_id: str | None = None
+
+    @staticmethod
+    def builder() -> GetUploadFileInfoRequestBuilder:
+        return GetUploadFileInfoRequestBuilder()
+
+
+class GetUploadFileInfoRequestBuilder:
+    """Builder for GetUploadFileInfoRequest."""
+
+    def __init__(self) -> None:
+        get_upload_file_info_request = GetUploadFileInfoRequest()
+        get_upload_file_info_request.http_method = HttpMethod.GET
+        get_upload_file_info_request.uri = "/v1/datasets/:dataset_id/documents/:document_id/upload-file"
+        self._get_upload_file_info_request = get_upload_file_info_request
+
+    def build(self) -> GetUploadFileInfoRequest:
+        return self._get_upload_file_info_request
+
+    def dataset_id(self, dataset_id: str) -> GetUploadFileInfoRequestBuilder:
+        self._get_upload_file_info_request.dataset_id = dataset_id
+        self._get_upload_file_info_request.paths["dataset_id"] = dataset_id
+        return self
+
+    def document_id(self, document_id: str) -> GetUploadFileInfoRequestBuilder:
+        self._get_upload_file_info_request.document_id = document_id
+        self._get_upload_file_info_request.paths["document_id"] = document_id
+        return self

dify_oapi/api/knowledge/v1/model/get_upload_file_info_response.py

@@ -0,0 +1,11 @@
+"""Get upload file info response model."""
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .file_info import FileInfo
+
+
+class GetUploadFileInfoResponse(FileInfo, BaseResponse):
+    """Response model for get upload file info API."""
+
+    pass

dify_oapi/api/knowledge/v1/model/knowledge_types.py

@@ -0,0 +1,100 @@
+"""Knowledge Base API type definitions using Literal types for type safety."""
+
+from typing import Literal
+
+# Indexing technique types
+IndexingTechnique = Literal["high_quality", "economy"]
+
+# Permission types
+Permission = Literal["only_me", "all_team_members", "partial_members"]
+
+# Search method types
+SearchMethod = Literal["hybrid_search", "semantic_search", "full_text_search", "keyword_search"]
+
+# Document status types
+DocumentStatus = Literal["indexing", "completed", "error", "paused"]
+
+# Processing mode types
+ProcessingMode = Literal["automatic", "custom", "hierarchical"]
+
+# File types
+FileType = Literal["document", "image", "audio", "video", "custom"]
+
+# Transfer method types
+TransferMethod = Literal["remote_url", "local_file"]
+
+# Tag types
+TagType = Literal["knowledge", "custom"]
+
+# Segment status types
+SegmentStatus = Literal["waiting", "parsing", "cleaning", "splitting", "indexing", "completed", "error", "paused"]
+
+# Document status action types
+DocumentStatusAction = Literal["enable", "disable", "archive", "un_archive"]
+
+# Document form types
+DocumentForm = Literal["text_model", "hierarchical_model", "qa_model"]
+
+# Model types
+ModelType = Literal["text-embedding"]
+
+# Provider types
+ProviderType = Literal["vendor", "external"]
+
+# Data source types
+DataSourceType = Literal["upload_file", "notion_import", "website_crawl"]
+
+# Dataset types
+DatasetType = Literal["knowledge_base", "external_api"]
+
+# Indexing status types
+IndexingStatus = Literal["waiting", "parsing", "cleaning", "splitting", "indexing", "completed", "error", "paused"]
+
+# Reranking model configuration types
+RerankingProviderName = str  # Dynamic provider names
+RerankingModelName = str  # Dynamic model names
+
+# Preprocessing rule types
+PreprocessingRuleId = Literal["remove_extra_spaces", "remove_urls_emails"]
+
+# Parent mode types for hierarchical processing
+ParentMode = Literal["full-doc", "paragraph"]
+
+# Model status types
+ModelStatus = Literal["active", "inactive", "deprecated"]
+
+# Model fetch source types
+ModelFetchFrom = Literal["predefined-model", "customizable-model"]
+
+# Model feature types
+ModelFeature = Literal["embedding", "reranking"]
+
+# Tag binding target types
+TagBindingTarget = Literal["dataset", "document"]
+
+# External knowledge provider types
+ExternalKnowledgeProvider = Literal["external_api", "notion", "web_crawler"]
+
+# Document creation source types
+DocumentCreatedFrom = Literal["api", "web", "upload"]
+
+# Document display status types
+DocumentDisplayStatus = Literal["available", "indexing", "error", "paused", "archived", "queuing"]
+
+# Batch processing status types
+BatchProcessingStatus = Literal["processing", "completed", "failed", "cancelled"]
+
+# File extension types (common ones)
+FileExtension = Literal["pdf", "doc", "docx", "txt", "md", "html", "csv", "xlsx", "ppt", "pptx"]
+
+# MIME type categories
+MimeTypeCategory = Literal["application", "text", "image", "audio", "video"]
+
+# Chunk processing status
+ChunkStatus = Literal["waiting", "processing", "completed", "error"]
+
+# Query content type
+QueryContentType = Literal["text", "structured"]
+
+# Retrieval record score type
+RetrievalScoreType = Literal["cosine", "dot_product", "euclidean"]

dify_oapi/api/{knowledge_base/v1/model/segment → knowledge/v1/model}/list_child_chunks_request.py

@@ -1,3 +1,5 @@
+"""List child chunks request model."""
+
 from __future__ import annotations
 
 from dify_oapi.core.enum import HttpMethod
@@ -5,7 +7,9 @@ from dify_oapi.core.model.base_request import BaseRequest
 
 
 class ListChildChunksRequest(BaseRequest):
-    def __init__(self):
+    """Request model for list child chunks API."""
+
+    def __init__(self) -> None:
         super().__init__()
         self.dataset_id: str | None = None
         self.document_id: str | None = None
@@ -17,7 +21,9 @@ class ListChildChunksRequest(BaseRequest):
 
 
 class ListChildChunksRequestBuilder:
-    def __init__(self):
+    """Builder for ListChildChunksRequest."""
+
+    def __init__(self) -> None:
         list_child_chunks_request = ListChildChunksRequest()
         list_child_chunks_request.http_method = HttpMethod.GET
         list_child_chunks_request.uri = (
@@ -48,9 +54,9 @@ class ListChildChunksRequestBuilder:
         return self
 
     def page(self, page: int) -> ListChildChunksRequestBuilder:
-        self._list_child_chunks_request.add_query("page", page)
+        self._list_child_chunks_request.add_query("page", str(page))
         return self
 
     def limit(self, limit: int) -> ListChildChunksRequestBuilder:
-        self._list_child_chunks_request.add_query("limit", limit)
+        self._list_child_chunks_request.add_query("limit", str(limit))
         return self

dify_oapi/api/{knowledge_base/v1/model/segment → knowledge/v1/model}/list_child_chunks_response.py

@@ -1,9 +1,13 @@
+"""List child chunks response model."""
+
 from dify_oapi.core.model.base_response import BaseResponse
 
 from .child_chunk_info import ChildChunkInfo
 
 
 class ListChildChunksResponse(BaseResponse):
+    """Response model for list child chunks API."""
+
     data: list[ChildChunkInfo] | None = None
     total: int | None = None
     total_pages: int | None = None

dify_oapi/api/knowledge/v1/model/list_datasets_request.py

@@ -0,0 +1,30 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class ListDatasetsRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+
+    @staticmethod
+    def builder() -> "ListDatasetsRequestBuilder":
+        return ListDatasetsRequestBuilder()
+
+
+class ListDatasetsRequestBuilder:
+    def __init__(self) -> None:
+        list_datasets_request = ListDatasetsRequest()
+        list_datasets_request.http_method = HttpMethod.GET
+        list_datasets_request.uri = "/v1/datasets"
+        self._list_datasets_request = list_datasets_request
+
+    def build(self) -> ListDatasetsRequest:
+        return self._list_datasets_request
+
+    def page(self, page: int) -> "ListDatasetsRequestBuilder":
+        self._list_datasets_request.add_query("page", str(page))
+        return self
+
+    def limit(self, limit: int) -> "ListDatasetsRequestBuilder":
+        self._list_datasets_request.add_query("limit", str(limit))
+        return self

dify_oapi/api/{knowledge_base/v1/model/dataset/list_response.py → knowledge/v1/model/list_datasets_response.py}

@@ -1,11 +1,9 @@
-from __future__ import annotations
-
 from dify_oapi.core.model.base_response import BaseResponse
 
 from .dataset_info import DatasetInfo
 
 
-class ListResponse(BaseResponse):
+class ListDatasetsResponse(BaseResponse):
     data: list[DatasetInfo] | None = None
     has_more: bool | None = None
     limit: int | None = None

dify_oapi/api/knowledge/v1/model/list_documents_request.py

@@ -0,0 +1,48 @@
+"""List documents request model."""
+
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class ListDocumentsRequest(BaseRequest):
+    """Request model for list documents API."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.dataset_id: str | None = None
+
+    @staticmethod
+    def builder() -> ListDocumentsRequestBuilder:
+        return ListDocumentsRequestBuilder()
+
+
+class ListDocumentsRequestBuilder:
+    """Builder for ListDocumentsRequest."""
+
+    def __init__(self) -> None:
+        list_documents_request = ListDocumentsRequest()
+        list_documents_request.http_method = HttpMethod.GET
+        list_documents_request.uri = "/v1/datasets/:dataset_id/documents"
+        self._list_documents_request = list_documents_request
+
+    def build(self) -> ListDocumentsRequest:
+        return self._list_documents_request
+
+    def dataset_id(self, dataset_id: str) -> ListDocumentsRequestBuilder:
+        self._list_documents_request.dataset_id = dataset_id
+        self._list_documents_request.paths["dataset_id"] = dataset_id
+        return self
+
+    def keyword(self, keyword: str) -> ListDocumentsRequestBuilder:
+        self._list_documents_request.add_query("keyword", keyword)
+        return self
+
+    def page(self, page: int) -> ListDocumentsRequestBuilder:
+        self._list_documents_request.add_query("page", str(page))
+        return self
+
+    def limit(self, limit: int) -> ListDocumentsRequestBuilder:
+        self._list_documents_request.add_query("limit", str(limit))
+        return self

dify_oapi/api/{knowledge_base/v1/model/document/list_response.py → knowledge/v1/model/list_documents_response.py}

@@ -1,12 +1,12 @@
-from __future__ import annotations
+"""List documents response model."""
 
 from dify_oapi.core.model.base_response import BaseResponse
 
 from .document_info import DocumentInfo
 
 
-class ListResponse(BaseResponse):
-    """Response model for list documents API"""
+class ListDocumentsResponse(BaseResponse):
+    """Response model for list documents API."""
 
     data: list[DocumentInfo] | None = None
     has_more: bool | None = None

dify_oapi/api/knowledge/v1/model/list_segments_request.py

@@ -0,0 +1,60 @@
+"""List segments request model."""
+
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+from .knowledge_types import SegmentStatus
+
+
+class ListSegmentsRequest(BaseRequest):
+    """Request model for list segments API."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.dataset_id: str | None = None
+        self.document_id: str | None = None
+
+    @staticmethod
+    def builder() -> ListSegmentsRequestBuilder:
+        return ListSegmentsRequestBuilder()
+
+
+class ListSegmentsRequestBuilder:
+    """Builder for ListSegmentsRequest."""
+
+    def __init__(self) -> None:
+        list_segments_request = ListSegmentsRequest()
+        list_segments_request.http_method = HttpMethod.GET
+        list_segments_request.uri = "/v1/datasets/:dataset_id/documents/:document_id/segments"
+        self._list_segments_request = list_segments_request
+
+    def build(self) -> ListSegmentsRequest:
+        return self._list_segments_request
+
+    def dataset_id(self, dataset_id: str) -> ListSegmentsRequestBuilder:
+        self._list_segments_request.dataset_id = dataset_id
+        self._list_segments_request.paths["dataset_id"] = dataset_id
+        return self
+
+    def document_id(self, document_id: str) -> ListSegmentsRequestBuilder:
+        self._list_segments_request.document_id = document_id
+        self._list_segments_request.paths["document_id"] = document_id
+        return self
+
+    def keyword(self, keyword: str) -> ListSegmentsRequestBuilder:
+        self._list_segments_request.add_query("keyword", keyword)
+        return self
+
+    def status(self, status: SegmentStatus) -> ListSegmentsRequestBuilder:
+        self._list_segments_request.add_query("status", status)
+        return self
+
+    def page(self, page: int) -> ListSegmentsRequestBuilder:
+        self._list_segments_request.add_query("page", str(page))
+        return self
+
+    def limit(self, limit: int) -> ListSegmentsRequestBuilder:
+        self._list_segments_request.add_query("limit", str(limit))
+        return self

dify_oapi/api/{knowledge_base/v1/model/segment/list_response.py → knowledge/v1/model/list_segments_response.py}

@@ -1,11 +1,14 @@
+"""List segments response model."""
+
 from dify_oapi.core.model.base_response import BaseResponse
 
 from .segment_info import SegmentInfo
 
 
-class ListResponse(BaseResponse):
+class ListSegmentsResponse(BaseResponse):
+    """Response model for list segments API."""
+
     data: list[SegmentInfo] | None = None
-    doc_form: str | None = None
     has_more: bool | None = None
     limit: int | None = None
     total: int | None = None

dify_oapi/api/knowledge/v1/model/list_tags_request.py

@@ -0,0 +1,28 @@
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+from .knowledge_types import TagType
+
+
+class ListTagsRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+
+    @staticmethod
+    def builder() -> "ListTagsRequestBuilder":
+        return ListTagsRequestBuilder()
+
+
+class ListTagsRequestBuilder:
+    def __init__(self):
+        list_tags_request = ListTagsRequest()
+        list_tags_request.http_method = HttpMethod.GET
+        list_tags_request.uri = "/v1/datasets/tags"
+        self._list_tags_request = list_tags_request
+
+    def build(self) -> ListTagsRequest:
+        return self._list_tags_request
+
+    def type(self, type_value: TagType) -> "ListTagsRequestBuilder":
+        self._list_tags_request.add_query("type", type_value)
+        return self

dify_oapi/api/knowledge/v1/model/list_tags_response.py

@@ -0,0 +1,7 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .tag_info import TagInfo
+
+
+class ListTagsResponse(BaseResponse):
+    data: list[TagInfo] | None = None