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

dify_oapi/api/knowledge_base/v1/model/dataset/dataset_info.py

@@ -1,150 +0,0 @@
-from __future__ import annotations
-
-from typing import Literal
-
-from pydantic import BaseModel
-
-from ..metadata.metadata_info import MetadataInfo
-from ..tag.tag_info import TagInfo
-from .external_knowledge_info import ExternalKnowledgeInfo
-from .retrieval_model import RetrievalModel
-
-
-class DatasetInfo(BaseModel):
-    id: str | None = None
-    name: str | None = None
-    description: str | None = None
-    provider: str | None = None
-    permission: str | None = None
-    data_source_type: str | None = None
-    indexing_technique: str | None = None
-    app_count: int | None = None
-    document_count: int | None = None
-    word_count: int | None = None
-    created_by: str | None = None
-    created_at: int | None = None
-    updated_by: str | None = None
-    updated_at: int | None = None
-    embedding_model: str | None = None
-    embedding_model_provider: str | None = None
-    embedding_available: bool | None = None
-    retrieval_model_dict: RetrievalModel | None = None
-    tags: list[TagInfo] | None = None
-    doc_form: str | None = None
-    external_knowledge_info: ExternalKnowledgeInfo | None = None
-    external_retrieval_model: RetrievalModel | None = None
-    partial_member_list: list[str] | None = None
-    doc_metadata: list[MetadataInfo] | None = None
-    built_in_field_enabled: bool | None = None
-
-    @staticmethod
-    def builder() -> DatasetInfoBuilder:
-        return DatasetInfoBuilder()
-
-
-class DatasetInfoBuilder:
-    def __init__(self):
-        self._dataset_info = DatasetInfo()
-
-    def build(self) -> DatasetInfo:
-        return self._dataset_info
-
-    def id(self, id: str) -> DatasetInfoBuilder:
-        self._dataset_info.id = id
-        return self
-
-    def name(self, name: str) -> DatasetInfoBuilder:
-        self._dataset_info.name = name
-        return self
-
-    def description(self, description: str) -> DatasetInfoBuilder:
-        self._dataset_info.description = description
-        return self
-
-    def provider(self, provider: str) -> DatasetInfoBuilder:
-        self._dataset_info.provider = provider
-        return self
-
-    def permission(self, permission: str) -> DatasetInfoBuilder:
-        self._dataset_info.permission = permission
-        return self
-
-    def data_source_type(self, data_source_type: str) -> DatasetInfoBuilder:
-        self._dataset_info.data_source_type = data_source_type
-        return self
-
-    def indexing_technique(self, indexing_technique: Literal["high_quality", "economy"]) -> DatasetInfoBuilder:
-        self._dataset_info.indexing_technique = indexing_technique
-        return self
-
-    def app_count(self, app_count: int) -> DatasetInfoBuilder:
-        self._dataset_info.app_count = app_count
-        return self
-
-    def document_count(self, document_count: int) -> DatasetInfoBuilder:
-        self._dataset_info.document_count = document_count
-        return self
-
-    def word_count(self, word_count: int) -> DatasetInfoBuilder:
-        self._dataset_info.word_count = word_count
-        return self
-
-    def created_by(self, created_by: str) -> DatasetInfoBuilder:
-        self._dataset_info.created_by = created_by
-        return self
-
-    def created_at(self, created_at: int) -> DatasetInfoBuilder:
-        self._dataset_info.created_at = created_at
-        return self
-
-    def updated_by(self, updated_by: str) -> DatasetInfoBuilder:
-        self._dataset_info.updated_by = updated_by
-        return self
-
-    def updated_at(self, updated_at: int) -> DatasetInfoBuilder:
-        self._dataset_info.updated_at = updated_at
-        return self
-
-    def embedding_model(self, embedding_model: str) -> DatasetInfoBuilder:
-        self._dataset_info.embedding_model = embedding_model
-        return self
-
-    def embedding_model_provider(self, embedding_model_provider: str) -> DatasetInfoBuilder:
-        self._dataset_info.embedding_model_provider = embedding_model_provider
-        return self
-
-    def embedding_available(self, embedding_available: bool) -> DatasetInfoBuilder:
-        self._dataset_info.embedding_available = embedding_available
-        return self
-
-    def retrieval_model_dict(self, retrieval_model_dict: RetrievalModel) -> DatasetInfoBuilder:
-        self._dataset_info.retrieval_model_dict = retrieval_model_dict
-        return self
-
-    def tags(self, tags: list[TagInfo]) -> DatasetInfoBuilder:
-        self._dataset_info.tags = tags
-        return self
-
-    def doc_form(self, doc_form: Literal["text_model", "hierarchical_model", "qa_model"]) -> DatasetInfoBuilder:
-        self._dataset_info.doc_form = doc_form
-        return self
-
-    def external_knowledge_info(self, external_knowledge_info: ExternalKnowledgeInfo) -> DatasetInfoBuilder:
-        self._dataset_info.external_knowledge_info = external_knowledge_info
-        return self
-
-    def external_retrieval_model(self, external_retrieval_model: RetrievalModel) -> DatasetInfoBuilder:
-        self._dataset_info.external_retrieval_model = external_retrieval_model
-        return self
-
-    def partial_member_list(self, partial_member_list: list[str]) -> DatasetInfoBuilder:
-        self._dataset_info.partial_member_list = partial_member_list
-        return self
-
-    def doc_metadata(self, doc_metadata: list[MetadataInfo]) -> DatasetInfoBuilder:
-        self._dataset_info.doc_metadata = doc_metadata
-        return self
-
-    def built_in_field_enabled(self, built_in_field_enabled: bool) -> DatasetInfoBuilder:
-        self._dataset_info.built_in_field_enabled = built_in_field_enabled
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/dataset_types.py

@@ -1,36 +0,0 @@
-from __future__ import annotations
-
-from typing import Literal
-
-# Indexing technique types
-IndexingTechnique = Literal["high_quality", "economy"]
-
-# Search method types
-SearchMethod = Literal["keyword_search", "semantic_search", "full_text_search", "hybrid_search"]
-
-# Reranking model types
-RerankingModelType = Literal["rerank-model"]
-
-# Processing rule mode types
-ProcessingRuleMode = Literal["automatic", "custom"]
-
-# Data source types
-DataSourceType = Literal["upload_file", "notion_import", "website_crawl"]
-
-# Document status types
-DocumentStatus = Literal["indexing", "completed", "error", "paused"]
-
-# Metadata field types
-MetadataFieldType = Literal["text", "number", "select"]
-
-# Tag types
-TagType = Literal["knowledge", "custom"]
-
-# Built-in metadata actions
-BuiltinMetadataAction = Literal["enable", "disable"]
-
-# Filter operator types
-FilterOperator = Literal["contains", "not_contains", "is", "is_not", "is_empty", "is_not_empty"]
-
-# Reranking enable types
-RerankingEnable = Literal[True, False]

dify_oapi/api/knowledge_base/v1/model/dataset/delete_request.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-from dify_oapi.core.enum import HttpMethod
-from dify_oapi.core.model.base_request import BaseRequest
-
-
-class DeleteRequest(BaseRequest):
-    def __init__(self):
-        super().__init__()
-        self.dataset_id: str | None = None
-
-    @staticmethod
-    def builder() -> DeleteRequestBuilder:
-        return DeleteRequestBuilder()
-
-
-class DeleteRequestBuilder:
-    def __init__(self):
-        delete_request = DeleteRequest()
-        delete_request.http_method = HttpMethod.DELETE
-        delete_request.uri = "/v1/datasets/:dataset_id"
-        self._delete_request = delete_request
-
-    def build(self) -> DeleteRequest:
-        return self._delete_request
-
-    def dataset_id(self, dataset_id: str) -> DeleteRequestBuilder:
-        self._delete_request.dataset_id = dataset_id
-        self._delete_request.paths["dataset_id"] = dataset_id
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/delete_response.py

@@ -1,9 +0,0 @@
-from __future__ import annotations
-
-from dify_oapi.core.model.base_response import BaseResponse
-
-
-class DeleteResponse(BaseResponse):
-    """Response model for delete dataset API (204 No Content)"""
-
-    pass

dify_oapi/api/knowledge_base/v1/model/dataset/external_knowledge_info.py

@@ -1,38 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-
-class ExternalKnowledgeInfo(BaseModel):
-    external_knowledge_id: str | None = None
-    external_knowledge_api_id: str | None = None
-    external_knowledge_api_name: str | None = None
-    external_knowledge_api_endpoint: str | None = None
-
-    @staticmethod
-    def builder() -> ExternalKnowledgeInfoBuilder:
-        return ExternalKnowledgeInfoBuilder()
-
-
-class ExternalKnowledgeInfoBuilder:
-    def __init__(self):
-        self._external_knowledge_info = ExternalKnowledgeInfo()
-
-    def build(self) -> ExternalKnowledgeInfo:
-        return self._external_knowledge_info
-
-    def external_knowledge_id(self, external_knowledge_id: str) -> ExternalKnowledgeInfoBuilder:
-        self._external_knowledge_info.external_knowledge_id = external_knowledge_id
-        return self
-
-    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_api_name(self, external_knowledge_api_name: str) -> ExternalKnowledgeInfoBuilder:
-        self._external_knowledge_info.external_knowledge_api_name = external_knowledge_api_name
-        return self
-
-    def external_knowledge_api_endpoint(self, external_knowledge_api_endpoint: str) -> ExternalKnowledgeInfoBuilder:
-        self._external_knowledge_info.external_knowledge_api_endpoint = external_knowledge_api_endpoint
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/filter_condition.py

@@ -1,72 +0,0 @@
-from __future__ import annotations
-
-from typing import Literal
-
-from pydantic import BaseModel
-
-
-class FilterCondition(BaseModel):
-    name: str
-    comparison_operator: Literal[
-        "contains",
-        "not contains",
-        "start with",
-        "end with",
-        "is",
-        "is not",
-        "empty",
-        "not empty",
-        "=",
-        "≠",
-        ">",
-        "<",
-        "≥",
-        "≤",
-        "before",
-        "after",
-    ]
-    value: str | int | float | None = None
-
-    @staticmethod
-    def builder() -> FilterConditionBuilder:
-        return FilterConditionBuilder()
-
-
-class FilterConditionBuilder:
-    def __init__(self):
-        self._filter_condition = FilterCondition(name="", comparison_operator="contains")
-
-    def build(self) -> FilterCondition:
-        return self._filter_condition
-
-    def name(self, name: str) -> FilterConditionBuilder:
-        self._filter_condition.name = name
-        return self
-
-    def comparison_operator(
-        self,
-        comparison_operator: Literal[
-            "contains",
-            "not contains",
-            "start with",
-            "end with",
-            "is",
-            "is not",
-            "empty",
-            "not empty",
-            "=",
-            "≠",
-            ">",
-            "<",
-            "≥",
-            "≤",
-            "before",
-            "after",
-        ],
-    ) -> FilterConditionBuilder:
-        self._filter_condition.comparison_operator = comparison_operator
-        return self
-
-    def value(self, value: str | int | float | None) -> FilterConditionBuilder:
-        self._filter_condition.value = value
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/get_request.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-from dify_oapi.core.enum import HttpMethod
-from dify_oapi.core.model.base_request import BaseRequest
-
-
-class GetRequest(BaseRequest):
-    def __init__(self):
-        super().__init__()
-        self.dataset_id: str | None = None
-
-    @staticmethod
-    def builder() -> GetRequestBuilder:
-        return GetRequestBuilder()
-
-
-class GetRequestBuilder:
-    def __init__(self):
-        get_request = GetRequest()
-        get_request.http_method = HttpMethod.GET
-        get_request.uri = "/v1/datasets/:dataset_id"
-        self._get_request = get_request
-
-    def build(self) -> GetRequest:
-        return self._get_request
-
-    def dataset_id(self, dataset_id: str) -> GetRequestBuilder:
-        self._get_request.dataset_id = dataset_id
-        self._get_request.paths["dataset_id"] = dataset_id
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/get_response.py

@@ -1,11 +0,0 @@
-from __future__ import annotations
-
-from dify_oapi.core.model.base_response import BaseResponse
-
-from .dataset_info import DatasetInfo
-
-
-class GetResponse(DatasetInfo, BaseResponse):
-    """Response model for get dataset details API"""
-
-    pass

dify_oapi/api/knowledge_base/v1/model/dataset/list_request.py

@@ -1,45 +0,0 @@
-from __future__ import annotations
-
-from dify_oapi.core.enum import HttpMethod
-from dify_oapi.core.model.base_request import BaseRequest
-
-
-class ListRequest(BaseRequest):
-    def __init__(self):
-        super().__init__()
-
-    @staticmethod
-    def builder() -> ListRequestBuilder:
-        return ListRequestBuilder()
-
-
-class ListRequestBuilder:
-    def __init__(self):
-        list_request = ListRequest()
-        list_request.http_method = HttpMethod.GET
-        list_request.uri = "/v1/datasets"
-        self._list_request = list_request
-
-    def build(self) -> ListRequest:
-        return self._list_request
-
-    def keyword(self, keyword: str) -> ListRequestBuilder:
-        self._list_request.add_query("keyword", keyword)
-        return self
-
-    def tag_ids(self, tag_ids: list[str]) -> ListRequestBuilder:
-        for tag_id in tag_ids:
-            self._list_request.add_query("tag_ids", tag_id)
-        return self
-
-    def page(self, page: int) -> ListRequestBuilder:
-        self._list_request.add_query("page", page)
-        return self
-
-    def limit(self, limit: str) -> ListRequestBuilder:
-        self._list_request.add_query("limit", limit)
-        return self
-
-    def include_all(self, include_all: bool) -> ListRequestBuilder:
-        self._list_request.add_query("include_all", include_all)
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/metadata_filtering_conditions.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-from .filter_condition import FilterCondition
-
-
-class MetadataFilteringConditions(BaseModel):
-    logical_operator: str
-    conditions: list[FilterCondition]
-
-    @staticmethod
-    def builder() -> MetadataFilteringConditionsBuilder:
-        return MetadataFilteringConditionsBuilder()
-
-
-class MetadataFilteringConditionsBuilder:
-    def __init__(self):
-        self._metadata_filtering_conditions = MetadataFilteringConditions(logical_operator="", conditions=[])
-
-    def build(self) -> MetadataFilteringConditions:
-        return self._metadata_filtering_conditions
-
-    def logical_operator(self, logical_operator: str) -> MetadataFilteringConditionsBuilder:
-        self._metadata_filtering_conditions.logical_operator = logical_operator
-        return self
-
-    def conditions(self, conditions: list[FilterCondition]) -> MetadataFilteringConditionsBuilder:
-        self._metadata_filtering_conditions.conditions = conditions
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/reranking_model.py

@@ -1,28 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-
-class RerankingModel(BaseModel):
-    reranking_provider_name: str | None = None
-    reranking_model_name: str | None = None
-
-    @staticmethod
-    def builder() -> RerankingModelBuilder:
-        return RerankingModelBuilder()
-
-
-class RerankingModelBuilder:
-    def __init__(self):
-        self._reranking_model = RerankingModel()
-
-    def build(self) -> RerankingModel:
-        return self._reranking_model
-
-    def reranking_provider_name(self, reranking_provider_name: str) -> RerankingModelBuilder:
-        self._reranking_model.reranking_provider_name = reranking_provider_name
-        return self
-
-    def reranking_model_name(self, reranking_model_name: str) -> RerankingModelBuilder:
-        self._reranking_model.reranking_model_name = reranking_model_name
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/retrieval_model.py

@@ -1,144 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-from .dataset_types import SearchMethod
-from .metadata_filtering_conditions import MetadataFilteringConditions
-from .reranking_model import RerankingModel
-
-
-class KeywordSetting(BaseModel):
-    keyword_weight: float | None = None
-
-    @staticmethod
-    def builder() -> KeywordSettingBuilder:
-        return KeywordSettingBuilder()
-
-
-class KeywordSettingBuilder:
-    def __init__(self):
-        self._keyword_setting = KeywordSetting()
-
-    def build(self) -> KeywordSetting:
-        return self._keyword_setting
-
-    def keyword_weight(self, keyword_weight: float) -> KeywordSettingBuilder:
-        self._keyword_setting.keyword_weight = keyword_weight
-        return self
-
-
-class VectorSetting(BaseModel):
-    vector_weight: float | None = None
-    embedding_model_name: str | None = None
-    embedding_provider_name: str | None = None
-
-    @staticmethod
-    def builder() -> VectorSettingBuilder:
-        return VectorSettingBuilder()
-
-
-class VectorSettingBuilder:
-    def __init__(self):
-        self._vector_setting = VectorSetting()
-
-    def build(self) -> VectorSetting:
-        return self._vector_setting
-
-    def vector_weight(self, vector_weight: float) -> VectorSettingBuilder:
-        self._vector_setting.vector_weight = vector_weight
-        return self
-
-    def embedding_model_name(self, embedding_model_name: str) -> VectorSettingBuilder:
-        self._vector_setting.embedding_model_name = embedding_model_name
-        return self
-
-    def embedding_provider_name(self, embedding_provider_name: str) -> VectorSettingBuilder:
-        self._vector_setting.embedding_provider_name = embedding_provider_name
-        return self
-
-
-class Weights(BaseModel):
-    keyword_setting: KeywordSetting | None = None
-    vector_setting: VectorSetting | None = None
-
-    @staticmethod
-    def builder() -> WeightsBuilder:
-        return WeightsBuilder()
-
-
-class WeightsBuilder:
-    def __init__(self):
-        self._weights = Weights()
-
-    def build(self) -> Weights:
-        return self._weights
-
-    def keyword_setting(self, keyword_setting: KeywordSetting) -> WeightsBuilder:
-        self._weights.keyword_setting = keyword_setting
-        return self
-
-    def vector_setting(self, vector_setting: VectorSetting) -> WeightsBuilder:
-        self._weights.vector_setting = vector_setting
-        return self
-
-
-class RetrievalModel(BaseModel):
-    search_method: SearchMethod | None = None
-    reranking_enable: bool | None = None
-    reranking_mode: str | None = None
-    reranking_model: RerankingModel | None = None
-    weights: Weights | None = None
-    top_k: int | None = None
-    score_threshold_enabled: bool | None = None
-    score_threshold: float | None = None
-    metadata_filtering_conditions: MetadataFilteringConditions | None = None
-
-    @staticmethod
-    def builder() -> RetrievalModelBuilder:
-        return RetrievalModelBuilder()
-
-
-class RetrievalModelBuilder:
-    def __init__(self):
-        self._retrieval_model = RetrievalModel()
-
-    def build(self) -> RetrievalModel:
-        return self._retrieval_model
-
-    def search_method(self, search_method: SearchMethod) -> RetrievalModelBuilder:
-        self._retrieval_model.search_method = search_method
-        return self
-
-    def reranking_enable(self, reranking_enable: bool) -> RetrievalModelBuilder:
-        self._retrieval_model.reranking_enable = reranking_enable
-        return self
-
-    def reranking_mode(self, reranking_mode: str) -> RetrievalModelBuilder:
-        self._retrieval_model.reranking_mode = reranking_mode
-        return self
-
-    def reranking_model(self, reranking_model: RerankingModel) -> RetrievalModelBuilder:
-        self._retrieval_model.reranking_model = reranking_model
-        return self
-
-    def weights(self, weights: Weights) -> RetrievalModelBuilder:
-        self._retrieval_model.weights = weights
-        return self
-
-    def top_k(self, top_k: int) -> RetrievalModelBuilder:
-        self._retrieval_model.top_k = top_k
-        return self
-
-    def score_threshold_enabled(self, score_threshold_enabled: bool) -> RetrievalModelBuilder:
-        self._retrieval_model.score_threshold_enabled = score_threshold_enabled
-        return self
-
-    def score_threshold(self, score_threshold: float) -> RetrievalModelBuilder:
-        self._retrieval_model.score_threshold = score_threshold
-        return self
-
-    def metadata_filtering_conditions(
-        self, metadata_filtering_conditions: MetadataFilteringConditions
-    ) -> RetrievalModelBuilder:
-        self._retrieval_model.metadata_filtering_conditions = metadata_filtering_conditions
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/retrieve_request.py

@@ -1,38 +0,0 @@
-from __future__ import annotations
-
-from dify_oapi.core.enum import HttpMethod
-from dify_oapi.core.model.base_request import BaseRequest
-
-from .retrieve_request_body import RetrieveRequestBody
-
-
-class RetrieveRequest(BaseRequest):
-    def __init__(self):
-        super().__init__()
-        self.dataset_id: str | None = None
-        self.request_body: RetrieveRequestBody | None = None
-
-    @staticmethod
-    def builder() -> RetrieveRequestBuilder:
-        return RetrieveRequestBuilder()
-
-
-class RetrieveRequestBuilder:
-    def __init__(self):
-        retrieve_request = RetrieveRequest()
-        retrieve_request.http_method = HttpMethod.POST
-        retrieve_request.uri = "/v1/datasets/:dataset_id/retrieve"
-        self._retrieve_request = retrieve_request
-
-    def build(self) -> RetrieveRequest:
-        return self._retrieve_request
-
-    def dataset_id(self, dataset_id: str) -> RetrieveRequestBuilder:
-        self._retrieve_request.dataset_id = dataset_id
-        self._retrieve_request.paths["dataset_id"] = dataset_id
-        return self
-
-    def request_body(self, request_body: RetrieveRequestBody) -> RetrieveRequestBuilder:
-        self._retrieve_request.request_body = request_body
-        self._retrieve_request.body = request_body.model_dump(exclude_none=True, mode="json")
-        return self