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

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

@@ -0,0 +1,132 @@
+"""Document information model for Knowledge Base API."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+from .data_source_info import DataSourceInfo
+from .knowledge_types import DataSourceType, DocumentDisplayStatus, DocumentForm, IndexingStatus
+
+
+class DocumentInfo(BaseModel):
+    """Document information model with builder pattern."""
+
+    id: Optional[str] = None
+    position: Optional[int] = None
+    data_source_type: Optional[DataSourceType] = None
+    data_source_info: Optional["DataSourceInfo"] = None
+    dataset_process_rule_id: Optional[str] = None
+    name: Optional[str] = None
+    created_from: Optional[str] = None
+    created_by: Optional[str] = None
+    created_at: Optional[float] = None
+    tokens: Optional[int] = None
+    indexing_status: Optional[IndexingStatus] = None
+    error: Optional[str] = None
+    enabled: Optional[bool] = None
+    disabled_at: Optional[float] = None
+    disabled_by: Optional[str] = None
+    archived: Optional[bool] = None
+    display_status: Optional[DocumentDisplayStatus] = None
+    word_count: Optional[int] = None
+    hit_count: Optional[int] = None
+    doc_form: Optional[DocumentForm] = None
+    updated_at: Optional[float] = None
+
+    @staticmethod
+    def builder() -> "DocumentInfoBuilder":
+        return DocumentInfoBuilder()
+
+
+class DocumentInfoBuilder:
+    """Builder for DocumentInfo."""
+
+    def __init__(self):
+        self._document_info = DocumentInfo()
+
+    def build(self) -> DocumentInfo:
+        return self._document_info
+
+    def id(self, id: str) -> "DocumentInfoBuilder":
+        self._document_info.id = id
+        return self
+
+    def position(self, position: int) -> "DocumentInfoBuilder":
+        self._document_info.position = position
+        return self
+
+    def data_source_type(self, data_source_type: DataSourceType) -> "DocumentInfoBuilder":
+        self._document_info.data_source_type = data_source_type
+        return self
+
+    def data_source_info(self, data_source_info: DataSourceInfo) -> "DocumentInfoBuilder":
+        self._document_info.data_source_info = data_source_info
+        return self
+
+    def dataset_process_rule_id(self, dataset_process_rule_id: str) -> "DocumentInfoBuilder":
+        self._document_info.dataset_process_rule_id = dataset_process_rule_id
+        return self
+
+    def name(self, name: str) -> "DocumentInfoBuilder":
+        self._document_info.name = name
+        return self
+
+    def created_from(self, created_from: str) -> "DocumentInfoBuilder":
+        self._document_info.created_from = created_from
+        return self
+
+    def created_by(self, created_by: str) -> "DocumentInfoBuilder":
+        self._document_info.created_by = created_by
+        return self
+
+    def created_at(self, created_at: float) -> "DocumentInfoBuilder":
+        self._document_info.created_at = created_at
+        return self
+
+    def tokens(self, tokens: int) -> "DocumentInfoBuilder":
+        self._document_info.tokens = tokens
+        return self
+
+    def indexing_status(self, indexing_status: IndexingStatus) -> "DocumentInfoBuilder":
+        self._document_info.indexing_status = indexing_status
+        return self
+
+    def error(self, error: str) -> "DocumentInfoBuilder":
+        self._document_info.error = error
+        return self
+
+    def enabled(self, enabled: bool) -> "DocumentInfoBuilder":
+        self._document_info.enabled = enabled
+        return self
+
+    def disabled_at(self, disabled_at: float) -> "DocumentInfoBuilder":
+        self._document_info.disabled_at = disabled_at
+        return self
+
+    def disabled_by(self, disabled_by: str) -> "DocumentInfoBuilder":
+        self._document_info.disabled_by = disabled_by
+        return self
+
+    def archived(self, archived: bool) -> "DocumentInfoBuilder":
+        self._document_info.archived = archived
+        return self
+
+    def display_status(self, display_status: DocumentDisplayStatus) -> "DocumentInfoBuilder":
+        self._document_info.display_status = display_status
+        return self
+
+    def word_count(self, word_count: int) -> "DocumentInfoBuilder":
+        self._document_info.word_count = word_count
+        return self
+
+    def hit_count(self, hit_count: int) -> "DocumentInfoBuilder":
+        self._document_info.hit_count = hit_count
+        return self
+
+    def doc_form(self, doc_form: DocumentForm) -> "DocumentInfoBuilder":
+        self._document_info.doc_form = doc_form
+        return self
+
+    def updated_at(self, updated_at: float) -> "DocumentInfoBuilder":
+        self._document_info.updated_at = updated_at
+        return self

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

@@ -0,0 +1,39 @@
+"""Document metadata model for Knowledge Base API."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class DocumentMetadata(BaseModel):
+    """Document metadata model with builder pattern."""
+
+    id: Optional[str] = None
+    name: Optional[str] = None
+    type: Optional[str] = None
+
+    @staticmethod
+    def builder() -> "DocumentMetadataBuilder":
+        return DocumentMetadataBuilder()
+
+
+class DocumentMetadataBuilder:
+    """Builder for DocumentMetadata."""
+
+    def __init__(self):
+        self._document_metadata = DocumentMetadata()
+
+    def build(self) -> DocumentMetadata:
+        return self._document_metadata
+
+    def id(self, id: str) -> "DocumentMetadataBuilder":
+        self._document_metadata.id = id
+        return self
+
+    def name(self, name: str) -> "DocumentMetadataBuilder":
+        self._document_metadata.name = name
+        return self
+
+    def type(self, type: str) -> "DocumentMetadataBuilder":
+        self._document_metadata.type = type
+        return self

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

@@ -0,0 +1,47 @@
+"""Embedding model parameters for Knowledge Base API."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+from .model_credentials import ModelCredentials
+from .model_parameters import ModelParameters
+
+
+class EmbeddingModelParameters(BaseModel):
+    """Embedding model parameters with builder pattern."""
+
+    model: Optional[str] = None
+    provider: Optional[str] = None
+    credentials: Optional[ModelCredentials] = None
+    model_parameters: Optional[ModelParameters] = None
+
+    @staticmethod
+    def builder() -> "EmbeddingModelParametersBuilder":
+        return EmbeddingModelParametersBuilder()
+
+
+class EmbeddingModelParametersBuilder:
+    """Builder for EmbeddingModelParameters."""
+
+    def __init__(self):
+        self._embedding_model_parameters = EmbeddingModelParameters()
+
+    def build(self) -> EmbeddingModelParameters:
+        return self._embedding_model_parameters
+
+    def model(self, model: str) -> "EmbeddingModelParametersBuilder":
+        self._embedding_model_parameters.model = model
+        return self
+
+    def provider(self, provider: str) -> "EmbeddingModelParametersBuilder":
+        self._embedding_model_parameters.provider = provider
+        return self
+
+    def credentials(self, credentials: ModelCredentials) -> "EmbeddingModelParametersBuilder":
+        self._embedding_model_parameters.credentials = credentials
+        return self
+
+    def model_parameters(self, model_parameters: ModelParameters) -> "EmbeddingModelParametersBuilder":
+        self._embedding_model_parameters.model_parameters = model_parameters
+        return self

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

@@ -0,0 +1,34 @@
+"""External knowledge info model for Knowledge Base API."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ExternalKnowledgeInfo(BaseModel):
+    """External knowledge info model with builder pattern."""
+
+    external_knowledge_api_id: Optional[str] = None
+    external_knowledge_id: Optional[str] = None
+
+    @staticmethod
+    def builder() -> "ExternalKnowledgeInfoBuilder":
+        return ExternalKnowledgeInfoBuilder()
+
+
+class ExternalKnowledgeInfoBuilder:
+    """Builder for ExternalKnowledgeInfo."""
+
+    def __init__(self):
+        self._external_knowledge_info = ExternalKnowledgeInfo()
+
+    def build(self) -> ExternalKnowledgeInfo:
+        return self._external_knowledge_info
+
+    def external_knowledge_api_id(self, external_knowledge_api_id: str) -> "ExternalKnowledgeInfoBuilder":
+        self._external_knowledge_info.external_knowledge_api_id = external_knowledge_api_id
+        return self
+
+    def external_knowledge_id(self, external_knowledge_id: str) -> "ExternalKnowledgeInfoBuilder":
+        self._external_knowledge_info.external_knowledge_id = external_knowledge_id
+        return self

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

@@ -0,0 +1,71 @@
+"""File information model for Knowledge Base API."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+from .knowledge_types import FileType
+
+
+class FileInfo(BaseModel):
+    """File information model with builder pattern."""
+
+    id: Optional[str] = None
+    name: Optional[str] = None
+    size: Optional[int] = None
+    extension: Optional[str] = None
+    mime_type: Optional[str] = None
+    type: Optional[FileType] = None
+    created_by: Optional[str] = None
+    created_at: Optional[float] = None
+    upload_file_id: Optional[str] = None
+
+    @staticmethod
+    def builder() -> "FileInfoBuilder":
+        return FileInfoBuilder()
+
+
+class FileInfoBuilder:
+    """Builder for FileInfo."""
+
+    def __init__(self):
+        self._file_info = FileInfo()
+
+    def build(self) -> FileInfo:
+        return self._file_info
+
+    def id(self, id: str) -> "FileInfoBuilder":
+        self._file_info.id = id
+        return self
+
+    def name(self, name: str) -> "FileInfoBuilder":
+        self._file_info.name = name
+        return self
+
+    def size(self, size: int) -> "FileInfoBuilder":
+        self._file_info.size = size
+        return self
+
+    def extension(self, extension: str) -> "FileInfoBuilder":
+        self._file_info.extension = extension
+        return self
+
+    def mime_type(self, mime_type: str) -> "FileInfoBuilder":
+        self._file_info.mime_type = mime_type
+        return self
+
+    def type(self, type: FileType) -> "FileInfoBuilder":
+        self._file_info.type = type
+        return self
+
+    def created_by(self, created_by: str) -> "FileInfoBuilder":
+        self._file_info.created_by = created_by
+        return self
+
+    def created_at(self, created_at: float) -> "FileInfoBuilder":
+        self._file_info.created_at = created_at
+        return self
+
+    def upload_file_id(self, upload_file_id: str) -> "FileInfoBuilder":
+        self._file_info.upload_file_id = upload_file_id
+        return self

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

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

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

@@ -0,0 +1,22 @@
+"""Get batch indexing status response model."""
+
+from typing import Optional
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+
+class GetBatchIndexingStatusResponse(BaseResponse):
+    """Response model for get batch indexing status API."""
+
+    id: Optional[str] = None
+    indexing_status: Optional[str] = None
+    processing_started_at: Optional[float] = None
+    parsing_completed_at: Optional[float] = None
+    cleaning_completed_at: Optional[float] = None
+    splitting_completed_at: Optional[float] = None
+    completed_at: Optional[float] = None
+    paused_at: Optional[float] = None
+    error: Optional[str] = None
+    stopped_at: Optional[float] = None
+    completed_segments: Optional[int] = None
+    total_segments: Optional[int] = None

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