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

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

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

@@ -1,38 +0,0 @@
-from __future__ import annotations
-
-from typing import Any
-
-from pydantic import BaseModel
-
-from .retrieval_model import RetrievalModel
-
-
-class RetrieveRequestBody(BaseModel):
-    query: str | None = None
-    retrieval_model: RetrievalModel | None = None
-    external_retrieval_model: dict[str, Any] | None = None
-
-    @staticmethod
-    def builder() -> RetrieveRequestBodyBuilder:
-        return RetrieveRequestBodyBuilder()
-
-
-class RetrieveRequestBodyBuilder:
-    def __init__(self):
-        retrieve_request_body = RetrieveRequestBody()
-        self._retrieve_request_body = retrieve_request_body
-
-    def build(self) -> RetrieveRequestBody:
-        return self._retrieve_request_body
-
-    def query(self, query: str) -> RetrieveRequestBodyBuilder:
-        self._retrieve_request_body.query = query
-        return self
-
-    def retrieval_model(self, retrieval_model: RetrievalModel) -> RetrieveRequestBodyBuilder:
-        self._retrieve_request_body.retrieval_model = retrieval_model
-        return self
-
-    def external_retrieval_model(self, external_retrieval_model: dict[str, Any]) -> RetrieveRequestBodyBuilder:
-        self._retrieve_request_body.external_retrieval_model = external_retrieval_model
-        return self

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

@@ -1,53 +0,0 @@
-from __future__ import annotations
-
-from typing import Any
-
-from pydantic import BaseModel
-
-from dify_oapi.core.model.base_response import BaseResponse
-
-
-class RetrieveResponse(BaseResponse):
-    query: QueryInfo | None = None
-    records: list[RetrievalRecord] | None = None
-
-
-class QueryInfo(BaseModel):
-    content: str | None = None
-
-
-class RetrievalRecord(BaseModel):
-    segment: SegmentInfo | None = None
-    score: float | None = None
-    tsne_position: dict[str, Any] | None = None
-
-
-class SegmentInfo(BaseModel):
-    id: str | None = None
-    position: int | None = None
-    document_id: str | None = None
-    content: str | None = None
-    answer: str | None = None
-    word_count: int | None = None
-    tokens: int | None = None
-    keywords: list[str] | None = None
-    index_node_id: str | None = None
-    index_node_hash: str | None = None
-    hit_count: int | None = None
-    enabled: bool | None = None
-    disabled_at: int | None = None
-    disabled_by: str | None = None
-    status: str | None = None
-    created_by: str | None = None
-    created_at: int | None = None
-    indexing_at: int | None = None
-    completed_at: int | None = None
-    error: str | None = None
-    stopped_at: int | None = None
-    document: DocumentInfo | None = None
-
-
-class DocumentInfo(BaseModel):
-    id: str | None = None
-    data_source_type: str | None = None
-    name: str | None = None

dify_oapi/api/knowledge_base/v1/model/dataset/update_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 .update_request_body import UpdateRequestBody
-
-
-class UpdateRequest(BaseRequest):
-    def __init__(self):
-        super().__init__()
-        self.dataset_id: str | None = None
-        self.request_body: UpdateRequestBody | None = None
-
-    @staticmethod
-    def builder() -> UpdateRequestBuilder:
-        return UpdateRequestBuilder()
-
-
-class UpdateRequestBuilder:
-    def __init__(self):
-        update_request = UpdateRequest()
-        update_request.http_method = HttpMethod.PATCH
-        update_request.uri = "/v1/datasets/:dataset_id"
-        self._update_request = update_request
-
-    def build(self) -> UpdateRequest:
-        return self._update_request
-
-    def dataset_id(self, dataset_id: str) -> UpdateRequestBuilder:
-        self._update_request.dataset_id = dataset_id
-        self._update_request.paths["dataset_id"] = dataset_id
-        return self
-
-    def request_body(self, request_body: UpdateRequestBody) -> UpdateRequestBuilder:
-        self._update_request.request_body = request_body
-        self._update_request.body = request_body.model_dump(exclude_none=True, mode="json")
-        return self

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

@@ -1,58 +0,0 @@
-from __future__ import annotations
-
-from typing import Literal
-
-from pydantic import BaseModel
-
-from .retrieval_model import RetrievalModel
-
-
-class UpdateRequestBody(BaseModel):
-    name: str | None = None
-    indexing_technique: str | None = None
-    permission: str | None = None
-    embedding_model_provider: str | None = None
-    embedding_model: str | None = None
-    retrieval_model: RetrievalModel | None = None
-    partial_member_list: list[str] | None = None
-
-    @staticmethod
-    def builder() -> UpdateRequestBodyBuilder:
-        return UpdateRequestBodyBuilder()
-
-
-class UpdateRequestBodyBuilder:
-    def __init__(self):
-        update_request_body = UpdateRequestBody()
-        self._update_request_body = update_request_body
-
-    def build(self) -> UpdateRequestBody:
-        return self._update_request_body
-
-    def name(self, name: str) -> UpdateRequestBodyBuilder:
-        self._update_request_body.name = name
-        return self
-
-    def indexing_technique(self, indexing_technique: Literal["high_quality", "economy"]) -> UpdateRequestBodyBuilder:
-        self._update_request_body.indexing_technique = indexing_technique
-        return self
-
-    def permission(self, permission: str) -> UpdateRequestBodyBuilder:
-        self._update_request_body.permission = permission
-        return self
-
-    def embedding_model_provider(self, embedding_model_provider: str) -> UpdateRequestBodyBuilder:
-        self._update_request_body.embedding_model_provider = embedding_model_provider
-        return self
-
-    def embedding_model(self, embedding_model: str) -> UpdateRequestBodyBuilder:
-        self._update_request_body.embedding_model = embedding_model
-        return self
-
-    def retrieval_model(self, retrieval_model: RetrievalModel) -> UpdateRequestBodyBuilder:
-        self._update_request_body.retrieval_model = retrieval_model
-        return self
-
-    def partial_member_list(self, partial_member_list: list[str]) -> UpdateRequestBodyBuilder:
-        self._update_request_body.partial_member_list = partial_member_list
-        return self

dify_oapi/api/knowledge_base/v1/model/dataset/update_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 UpdateResponse(DatasetInfo, BaseResponse):
-    """Response model for update dataset API"""
-
-    pass

dify_oapi/api/knowledge_base/v1/model/document/create_by_file_request.py

@@ -1,53 +0,0 @@
-"""Create document by file request model."""
-
-from __future__ import annotations
-
-from io import BytesIO
-
-from dify_oapi.core.enum import HttpMethod
-from dify_oapi.core.model.base_request import BaseRequest
-
-from .create_by_file_request_body import CreateByFileRequestBody
-
-
-class CreateByFileRequest(BaseRequest):
-    """Request model for create document by file API."""
-
-    def __init__(self) -> None:
-        super().__init__()
-        self.dataset_id: str | None = None
-        self.request_body: CreateByFileRequestBody | None = None
-        self.file: BytesIO | None = None
-
-    @staticmethod
-    def builder() -> CreateByFileRequestBuilder:
-        return CreateByFileRequestBuilder()
-
-
-class CreateByFileRequestBuilder:
-    """Builder for CreateByFileRequest."""
-
-    def __init__(self) -> None:
-        create_by_file_request = CreateByFileRequest()
-        create_by_file_request.http_method = HttpMethod.POST
-        create_by_file_request.uri = "/v1/datasets/:dataset_id/document/create-by-file"
-        self._create_by_file_request = create_by_file_request
-
-    def build(self) -> CreateByFileRequest:
-        return self._create_by_file_request
-
-    def dataset_id(self, dataset_id: str) -> CreateByFileRequestBuilder:
-        self._create_by_file_request.dataset_id = dataset_id
-        self._create_by_file_request.paths["dataset_id"] = dataset_id
-        return self
-
-    def request_body(self, request_body: CreateByFileRequestBody) -> CreateByFileRequestBuilder:
-        self._create_by_file_request.request_body = request_body
-        self._create_by_file_request.body = request_body.model_dump(exclude_none=True, mode="json")
-        return self
-
-    def file(self, file: BytesIO, file_name: str | None = None) -> CreateByFileRequestBuilder:
-        self._create_by_file_request.file = file
-        file_name = file_name or "upload"
-        self._create_by_file_request.files = {"file": (file_name, file)}
-        return self

dify_oapi/api/knowledge_base/v1/model/document/create_by_file_request_body.py

@@ -1,31 +0,0 @@
-"""Create document by file request body model."""
-
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-from .create_by_file_request_body_data import CreateByFileRequestBodyData
-
-
-class CreateByFileRequestBody(BaseModel):
-    """Request body model for create document by file API."""
-
-    data: str | None = None
-
-    @staticmethod
-    def builder() -> CreateByFileRequestBodyBuilder:
-        return CreateByFileRequestBodyBuilder()
-
-
-class CreateByFileRequestBodyBuilder:
-    """Builder for CreateByFileRequestBody."""
-
-    def __init__(self) -> None:
-        self._create_by_file_request_body = CreateByFileRequestBody()
-
-    def build(self) -> CreateByFileRequestBody:
-        return self._create_by_file_request_body
-
-    def data(self, data: CreateByFileRequestBodyData) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body.data = data.model_dump_json(exclude_none=True)
-        return self

dify_oapi/api/knowledge_base/v1/model/document/create_by_file_request_body_data.py

@@ -1,78 +0,0 @@
-"""Create document by file request body model."""
-
-from __future__ import annotations
-
-from typing import Literal
-
-from pydantic import BaseModel
-
-from .process_rule import ProcessRule
-from .retrieval_model import RetrievalModel
-
-
-class CreateByFileRequestBodyData(BaseModel):
-    """Request body model for create document by file API."""
-
-    file: str | None = None
-    original_document_id: str | None = None
-    indexing_technique: str | None = None
-    doc_form: str | None = None
-    doc_language: str | None = None
-    process_rule: ProcessRule | None = None
-    retrieval_model: RetrievalModel | None = None
-    embedding_model: str | None = None
-    embedding_model_provider: str | None = None
-
-    @staticmethod
-    def builder() -> CreateByFileRequestBodyBuilder:
-        return CreateByFileRequestBodyBuilder()
-
-
-class CreateByFileRequestBodyBuilder:
-    """Builder for CreateByFileRequestBody."""
-
-    def __init__(self) -> None:
-        self._create_by_file_request_body_data = CreateByFileRequestBodyData()
-
-    def build(self) -> CreateByFileRequestBodyData:
-        return self._create_by_file_request_body_data
-
-    def file(self, file: str) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.file = file
-        return self
-
-    def original_document_id(self, original_document_id: str) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.original_document_id = original_document_id
-        return self
-
-    def indexing_technique(
-        self, indexing_technique: Literal["high_quality", "economy"]
-    ) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.indexing_technique = indexing_technique
-        return self
-
-    def doc_form(
-        self, doc_form: Literal["text_model", "hierarchical_model", "qa_model"]
-    ) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.doc_form = doc_form
-        return self
-
-    def doc_language(self, doc_language: str) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.doc_language = doc_language
-        return self
-
-    def process_rule(self, process_rule: ProcessRule) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.process_rule = process_rule
-        return self
-
-    def retrieval_model(self, retrieval_model: RetrievalModel) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.retrieval_model = retrieval_model
-        return self
-
-    def embedding_model(self, embedding_model: str) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.embedding_model = embedding_model
-        return self
-
-    def embedding_model_provider(self, embedding_model_provider: str) -> CreateByFileRequestBodyBuilder:
-        self._create_by_file_request_body_data.embedding_model_provider = embedding_model_provider
-        return self

dify_oapi/api/knowledge_base/v1/model/document/create_by_text_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 .create_by_text_request_body import CreateByTextRequestBody
-
-
-class CreateByTextRequest(BaseRequest):
-    def __init__(self):
-        super().__init__()
-        self.dataset_id: str | None = None
-        self.request_body: CreateByTextRequestBody | None = None
-
-    @staticmethod
-    def builder() -> CreateByTextRequestBuilder:
-        return CreateByTextRequestBuilder()
-
-
-class CreateByTextRequestBuilder:
-    def __init__(self):
-        create_by_text_request = CreateByTextRequest()
-        create_by_text_request.http_method = HttpMethod.POST
-        create_by_text_request.uri = "/v1/datasets/:dataset_id/document/create-by-text"
-        self._create_by_text_request = create_by_text_request
-
-    def build(self) -> CreateByTextRequest:
-        return self._create_by_text_request
-
-    def dataset_id(self, dataset_id: str) -> CreateByTextRequestBuilder:
-        self._create_by_text_request.dataset_id = dataset_id
-        self._create_by_text_request.paths["dataset_id"] = dataset_id
-        return self
-
-    def request_body(self, request_body: CreateByTextRequestBody) -> CreateByTextRequestBuilder:
-        self._create_by_text_request.request_body = request_body
-        self._create_by_text_request.body = request_body.model_dump(exclude_none=True, mode="json")
-        return self

dify_oapi/api/knowledge_base/v1/model/document/create_by_text_request_body.py

@@ -1,75 +0,0 @@
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-from .document_types import DocumentForm, DocumentLanguage, IndexingTechnique
-from .process_rule import ProcessRule
-from .retrieval_model import RetrievalModel
-
-
-class CreateByTextRequestBody(BaseModel):
-    """Request body model for create document by text API"""
-
-    name: str | None = None
-    text: str | None = None
-    indexing_technique: IndexingTechnique | None = None
-    doc_form: DocumentForm | None = None
-    doc_language: DocumentLanguage | None = None
-    process_rule: ProcessRule | None = None
-    retrieval_model: RetrievalModel | None = None
-    embedding_model: str | None = None
-    embedding_model_provider: str | None = None
-
-    @staticmethod
-    def builder() -> CreateByTextRequestBodyBuilder:
-        return CreateByTextRequestBodyBuilder()
-
-
-class CreateByTextRequestBodyBuilder:
-    def __init__(self):
-        self._create_by_text_request_body = CreateByTextRequestBody()
-
-    def build(self) -> CreateByTextRequestBody:
-        if not self._create_by_text_request_body.name:
-            raise ValueError("Name must be provided")
-
-        if not self._create_by_text_request_body.text:
-            raise ValueError("Text must be provided")
-
-        return self._create_by_text_request_body
-
-    def name(self, name: str) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.name = name
-        return self
-
-    def text(self, text: str) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.text = text
-        return self
-
-    def indexing_technique(self, indexing_technique: IndexingTechnique) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.indexing_technique = indexing_technique
-        return self
-
-    def doc_form(self, doc_form: DocumentForm) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.doc_form = doc_form
-        return self
-
-    def doc_language(self, doc_language: DocumentLanguage) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.doc_language = doc_language
-        return self
-
-    def process_rule(self, process_rule: ProcessRule) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.process_rule = process_rule
-        return self
-
-    def retrieval_model(self, retrieval_model: RetrievalModel) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.retrieval_model = retrieval_model
-        return self
-
-    def embedding_model(self, embedding_model: str) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.embedding_model = embedding_model
-        return self
-
-    def embedding_model_provider(self, embedding_model_provider: str) -> CreateByTextRequestBodyBuilder:
-        self._create_by_text_request_body.embedding_model_provider = embedding_model_provider
-        return self