dify client SDK hopes to add asynchronous functionality #15235

New Issue

Closed

opened 2026-02-21 19:20:48 -05:00 by yindo · 6 comments

yindo commented 2026-02-21 19:20:48 -05:00

Owner

Copy Link

Copy Source

Originally created by @InfernalAzazel on GitHub (Jul 10, 2025).

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:)
• Please do not modify this template :) and fill in all the required fields.

1. Is this request related to a challenge you're experiencing? Tell me about your story.

Code

import json
import anyio
import httpx


def in_async_context() -> bool:
    try:
        anyio.get_current_task()
        return True
    except RuntimeError:
        return False

class DifyClient:
    def __init__(self, api_key, base_url = "https://api.dify.ai/v1"):
        self.api_key = api_key
        self.base_url = base_url

    async def _request_async(
            self, method: str,
            endpoint: str,
            json= None,
            params=None,
            stream: bool = False,
    ) -> httpx.Response:
        async with httpx.AsyncClient() as client:
            headers = {
                "Authorization": f"Bearer {self.api_key}",
                "Content-Type": "application/json",
            }
            url = f"{self.base_url}{endpoint}"
            request = httpx.Request(method, url, json=json, params=params, headers=headers)
            return await client.send(request, stream=stream)

    def _send_request(self, method, endpoint, json=None, params=None, stream=False):
        coro = self._request_async(method, endpoint, json, params, stream)
        if in_async_context():
            return coro  # Return coroutine, external await
        else:
            return anyio.run(lambda: coro)  # Synchronize the environment and run automatically

    def _send_request_with_files(self, method, endpoint, data,files):
        headers = {"Authorization": f"Bearer {self.api_key}"}

        url = f"{self.base_url}{endpoint}"
        response = httpx.request(
            method, url, data=data, headers=headers, files=files
        )

        return response

    def message_feedback(self, message_id, rating, user):
        data = {"rating": rating, "user": user}
        return self._send_request("POST", f"/messages/{message_id}/feedbacks", data)

    def get_application_parameters(self, user):
        params = {"user": user}
        return self._send_request("GET", "/parameters", params=params)

    def file_upload(self, user, files):
        data = {"user": user}
        return self._send_request_with_files(
            "POST", "/files/upload", data=data, files=files
        )

    def text_to_audio(self, text: str, user: str, streaming: bool = False):
        data = {"text": text, "user": user, "streaming": streaming}
        return self._send_request("POST", "/text-to-audio", json=data)

    def get_meta(self, user):
        params = {"user": user}
        return self._send_request("GET", "/meta", params=params)


class CompletionClient(DifyClient):
    def create_completion_message(self, inputs, response_mode, user, files=None):
        data = {
            "inputs": inputs,
            "response_mode": response_mode,
            "user": user,
            "files": files,
        }
        return self._send_request(
            "POST",
            "/completion-messages",
            data,
            stream=True if response_mode == "streaming" else False,
        )


class ChatClient(DifyClient):
    def create_chat_message(
        self,
        inputs,
        query,
        user,
        response_mode="blocking",
        conversation_id=None,
        files=None,
    ):
        data = {
            "inputs": inputs,
            "query": query,
            "user": user,
            "response_mode": response_mode,
            "files": files,
        }
        if conversation_id:
            data["conversation_id"] = conversation_id

        return self._send_request(
            "POST",
            "/chat-messages",
            data,
            stream=True if response_mode == "streaming" else False,
        )

    def get_suggested(self, message_id, user: str):
        params = {"user": user}
        return self._send_request(
            "GET", f"/messages/{message_id}/suggested", params=params
        )

    def stop_message(self, task_id, user):
        data = {"user": user}
        return self._send_request("POST", f"/chat-messages/{task_id}/stop", data)

    def get_conversations(self, user, last_id=None, limit=None, pinned=None):
        params = {"user": user, "last_id": last_id, "limit": limit, "pinned": pinned}
        return self._send_request("GET", "/conversations", params=params)

    def get_conversation_messages(
        self, user, conversation_id=None, first_id=None, limit=None
    ):
        params = {"user": user}

        if conversation_id:
            params["conversation_id"] = conversation_id
        if first_id:
            params["first_id"] = first_id
        if limit:
            params["limit"] = limit

        return self._send_request("GET", "/messages", params=params)

    def rename_conversation(
        self, conversation_id, name, auto_generate: bool, user: str
    ):
        data = {"name": name, "auto_generate": auto_generate, "user": user}
        return self._send_request(
            "POST", f"/conversations/{conversation_id}/name", data
        )

    def delete_conversation(self, conversation_id, user):
        data = {"user": user}
        return self._send_request("DELETE", f"/conversations/{conversation_id}", data)

    def audio_to_text(self, audio_file, user):
        data = {"user": user}
        files = {"audio_file": audio_file}
        return self._send_request_with_files("POST", "/audio-to-text", data, files)


class WorkflowClient(DifyClient):
    def run(
        self, inputs: dict, response_mode: str = "streaming", user: str = "abc-123"
    ):
        data = {"inputs": inputs, "response_mode": response_mode, "user": user}
        return self._send_request("POST", "/workflows/run", data)

    def stop(self, task_id, user):
        data = {"user": user}
        return self._send_request("POST", f"/workflows/tasks/{task_id}/stop", data)

    def get_result(self, workflow_run_id):
        return self._send_request("GET", f"/workflows/run/{workflow_run_id}")


class KnowledgeBaseClient(DifyClient):
    def __init__(
        self,
        api_key,
        base_url: str = "https://api.dify.ai/v1",
        dataset_id: str | None = None,
    ):
        """
        Construct a KnowledgeBaseClient object.

        Args:
            api_key (str): API key of Dify.
            base_url (str, optional): Base URL of Dify API. Defaults to 'https://api.dify.ai/v1'.
            dataset_id (str, optional): ID of the dataset. Defaults to None. You don't need this if you just want to
                create a new dataset. or list datasets. otherwise you need to set this.
        """
        super().__init__(api_key=api_key, base_url=base_url)
        self.dataset_id = dataset_id

    def _get_dataset_id(self):
        if self.dataset_id is None:
            raise ValueError("dataset_id is not set")
        return self.dataset_id

    def create_dataset(self, name: str, **kwargs):
        return self._send_request("POST", "/datasets", {"name": name}, **kwargs)

    def list_datasets(self, page: int = 1, page_size: int = 20, **kwargs):
        return self._send_request(
            "GET", f"/datasets?page={page}&limit={page_size}", **kwargs
        )

    def create_document_by_text(
        self, name, text, extra_params: dict | None = None, **kwargs
    ):
        """
        Create a document by text.

        :param name: Name of the document
        :param text: Text content of the document
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        data = {
            "indexing_technique": "high_quality",
            "process_rule": {"mode": "automatic"},
            "name": name,
            "text": text,
        }
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = f"/datasets/{self._get_dataset_id()}/document/create_by_text"
        return self._send_request("POST", url, json=data, **kwargs)

    def update_document_by_text(
        self, document_id, name, text, extra_params: dict | None = None, **kwargs
    ):
        """
        Update a document by text.

        :param document_id: ID of the document
        :param name: Name of the document
        :param text: Text content of the document
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        data = {"name": name, "text": text}
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = (
            f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_text"
        )
        return self._send_request("POST", url, json=data, **kwargs)

    def create_document_by_file(
        self, file_path, original_document_id=None, extra_params: dict | None = None
    ):
        """
        Create a document by file.

        :param file_path: Path to the file
        :param original_document_id: pass this ID if you want to replace the original document (optional)
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        files = {"file": open(file_path, "rb")}
        data = {
            "process_rule": {"mode": "automatic"},
            "indexing_technique": "high_quality",
        }
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        if original_document_id is not None:
            data["original_document_id"] = original_document_id
        url = f"/datasets/{self._get_dataset_id()}/document/create_by_file"
        return self._send_request_with_files(
            "POST", url, {"data": json.dumps(data)}, files
        )

    def update_document_by_file(
        self, document_id, file_path, extra_params: dict | None = None
    ):
        """
        Update a document by file.

        :param document_id: ID of the document
        :param file_path: Path to the file
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return:
        """
        files = {"file": open(file_path, "rb")}
        data = {}
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = (
            f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_file"
        )
        return self._send_request_with_files(
            "POST", url, {"data": json.dumps(data)}, files
        )

    def batch_indexing_status(self, batch_id: str, **kwargs):
        """
        Get the status of the batch indexing.

        :param batch_id: ID of the batch uploading
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{batch_id}/indexing-status"
        return self._send_request("GET", url, **kwargs)

    def delete_dataset(self):
        """
        Delete this dataset.

        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}"
        return self._send_request("DELETE", url)

    def delete_document(self, document_id):
        """
        Delete a document.

        :param document_id: ID of the document
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}"
        return self._send_request("DELETE", url)

    def list_documents(
        self,
        page: int | None = None,
        page_size: int | None = None,
        keyword: str | None = None,
        **kwargs,
    ):
        """
        Get a list of documents in this dataset.

        :return: Response from the API
        """
        params = {}
        if page is not None:
            params["page"] = page
        if page_size is not None:
            params["limit"] = page_size
        if keyword is not None:
            params["keyword"] = keyword
        url = f"/datasets/{self._get_dataset_id()}/documents"
        return self._send_request("GET", url, params=params, **kwargs)

    def add_segments(self, document_id, segments, **kwargs):
        """
        Add segments to a document.

        :param document_id: ID of the document
        :param segments: List of segments to add, example: [{"content": "1", "answer": "1", "keyword": ["a"]}]
        :return: Response from the API
        """
        data = {"segments": segments}
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments"
        return self._send_request("POST", url, json=data, **kwargs)

    def query_segments(
        self,
        document_id,
        keyword: str | None = None,
        status: str | None = None,
        **kwargs,
    ):
        """
        Query segments in this document.

        :param document_id: ID of the document
        :param keyword: query keyword, optional
        :param status: status of the segment, optional, e.g. completed
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments"
        params = {}
        if keyword is not None:
            params["keyword"] = keyword
        if status is not None:
            params["status"] = status
        if "params" in kwargs:
            params.update(kwargs["params"])
        return self._send_request("GET", url, params=params, **kwargs)

    def delete_document_segment(self, document_id, segment_id):
        """
        Delete a segment from a document.

        :param document_id: ID of the document
        :param segment_id: ID of the segment
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}"
        return self._send_request("DELETE", url)

    def update_document_segment(self, document_id, segment_id, segment_data, **kwargs):
        """
        Update a segment in a document.

        :param document_id: ID of the document
        :param segment_id: ID of the segment
        :param segment_data: Data of the segment, example: {"content": "1", "answer": "1", "keyword": ["a"], "enabled": True}
        :return: Response from the API
        """
        data = {"segment": segment_data}
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}"
        return self._send_request("POST", url, json=data, **kwargs)



if __name__ == "__main__":
    import asyncio
    async def main():
        client = ChatClient("key", 'http://127.0.0.1/v1')
        res = await client.get_conversations("test", limit=2)
        print(res.json())
        
    client = ChatClient("key", 'http://127.0.0.1/v1')
    res = client.get_conversations("test", limit=1)
    print(res.json())
    asyncio.run(main())

effect：

2. Additional context or comments

No response

3. Can you help us with this feature?

• I am interested in contributing to this feature.

Originally created by @InfernalAzazel on GitHub (Jul 10, 2025). ### Self Checks - [x] I have searched for existing issues [search for existing issues](https://github.com/langgenius/dify/issues), including closed ones. - [x] I confirm that I am using English to submit this report (我已阅读并同意 [Language Policy](https://github.com/langgenius/dify/issues/1542)). - [x] [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:) - [x] Please do not modify this template :) and fill in all the required fields. ### 1. Is this request related to a challenge you're experiencing? Tell me about your story. Code ```python import json import anyio import httpx def in_async_context() -> bool: try: anyio.get_current_task() return True except RuntimeError: return False class DifyClient: def __init__(self, api_key, base_url = "https://api.dify.ai/v1"): self.api_key = api_key self.base_url = base_url async def _request_async( self, method: str, endpoint: str, json= None, params=None, stream: bool = False, ) -> httpx.Response: async with httpx.AsyncClient() as client: headers = { "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json", } url = f"{self.base_url}{endpoint}" request = httpx.Request(method, url, json=json, params=params, headers=headers) return await client.send(request, stream=stream) def _send_request(self, method, endpoint, json=None, params=None, stream=False): coro = self._request_async(method, endpoint, json, params, stream) if in_async_context(): return coro # Return coroutine, external await else: return anyio.run(lambda: coro) # Synchronize the environment and run automatically def _send_request_with_files(self, method, endpoint, data,files): headers = {"Authorization": f"Bearer {self.api_key}"} url = f"{self.base_url}{endpoint}" response = httpx.request( method, url, data=data, headers=headers, files=files ) return response def message_feedback(self, message_id, rating, user): data = {"rating": rating, "user": user} return self._send_request("POST", f"/messages/{message_id}/feedbacks", data) def get_application_parameters(self, user): params = {"user": user} return self._send_request("GET", "/parameters", params=params) def file_upload(self, user, files): data = {"user": user} return self._send_request_with_files( "POST", "/files/upload", data=data, files=files ) def text_to_audio(self, text: str, user: str, streaming: bool = False): data = {"text": text, "user": user, "streaming": streaming} return self._send_request("POST", "/text-to-audio", json=data) def get_meta(self, user): params = {"user": user} return self._send_request("GET", "/meta", params=params) class CompletionClient(DifyClient): def create_completion_message(self, inputs, response_mode, user, files=None): data = { "inputs": inputs, "response_mode": response_mode, "user": user, "files": files, } return self._send_request( "POST", "/completion-messages", data, stream=True if response_mode == "streaming" else False, ) class ChatClient(DifyClient): def create_chat_message( self, inputs, query, user, response_mode="blocking", conversation_id=None, files=None, ): data = { "inputs": inputs, "query": query, "user": user, "response_mode": response_mode, "files": files, } if conversation_id: data["conversation_id"] = conversation_id return self._send_request( "POST", "/chat-messages", data, stream=True if response_mode == "streaming" else False, ) def get_suggested(self, message_id, user: str): params = {"user": user} return self._send_request( "GET", f"/messages/{message_id}/suggested", params=params ) def stop_message(self, task_id, user): data = {"user": user} return self._send_request("POST", f"/chat-messages/{task_id}/stop", data) def get_conversations(self, user, last_id=None, limit=None, pinned=None): params = {"user": user, "last_id": last_id, "limit": limit, "pinned": pinned} return self._send_request("GET", "/conversations", params=params) def get_conversation_messages( self, user, conversation_id=None, first_id=None, limit=None ): params = {"user": user} if conversation_id: params["conversation_id"] = conversation_id if first_id: params["first_id"] = first_id if limit: params["limit"] = limit return self._send_request("GET", "/messages", params=params) def rename_conversation( self, conversation_id, name, auto_generate: bool, user: str ): data = {"name": name, "auto_generate": auto_generate, "user": user} return self._send_request( "POST", f"/conversations/{conversation_id}/name", data ) def delete_conversation(self, conversation_id, user): data = {"user": user} return self._send_request("DELETE", f"/conversations/{conversation_id}", data) def audio_to_text(self, audio_file, user): data = {"user": user} files = {"audio_file": audio_file} return self._send_request_with_files("POST", "/audio-to-text", data, files) class WorkflowClient(DifyClient): def run( self, inputs: dict, response_mode: str = "streaming", user: str = "abc-123" ): data = {"inputs": inputs, "response_mode": response_mode, "user": user} return self._send_request("POST", "/workflows/run", data) def stop(self, task_id, user): data = {"user": user} return self._send_request("POST", f"/workflows/tasks/{task_id}/stop", data) def get_result(self, workflow_run_id): return self._send_request("GET", f"/workflows/run/{workflow_run_id}") class KnowledgeBaseClient(DifyClient): def __init__( self, api_key, base_url: str = "https://api.dify.ai/v1", dataset_id: str | None = None, ): """ Construct a KnowledgeBaseClient object. Args: api_key (str): API key of Dify. base_url (str, optional): Base URL of Dify API. Defaults to 'https://api.dify.ai/v1'. dataset_id (str, optional): ID of the dataset. Defaults to None. You don't need this if you just want to create a new dataset. or list datasets. otherwise you need to set this. """ super().__init__(api_key=api_key, base_url=base_url) self.dataset_id = dataset_id def _get_dataset_id(self): if self.dataset_id is None: raise ValueError("dataset_id is not set") return self.dataset_id def create_dataset(self, name: str, **kwargs): return self._send_request("POST", "/datasets", {"name": name}, **kwargs) def list_datasets(self, page: int = 1, page_size: int = 20, **kwargs): return self._send_request( "GET", f"/datasets?page={page}&limit={page_size}", **kwargs ) def create_document_by_text( self, name, text, extra_params: dict | None = None, **kwargs ): """ Create a document by text. :param name: Name of the document :param text: Text content of the document :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ data = { "indexing_technique": "high_quality", "process_rule": {"mode": "automatic"}, "name": name, "text": text, } if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = f"/datasets/{self._get_dataset_id()}/document/create_by_text" return self._send_request("POST", url, json=data, **kwargs) def update_document_by_text( self, document_id, name, text, extra_params: dict | None = None, **kwargs ): """ Update a document by text. :param document_id: ID of the document :param name: Name of the document :param text: Text content of the document :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ data = {"name": name, "text": text} if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = ( f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_text" ) return self._send_request("POST", url, json=data, **kwargs) def create_document_by_file( self, file_path, original_document_id=None, extra_params: dict | None = None ): """ Create a document by file. :param file_path: Path to the file :param original_document_id: pass this ID if you want to replace the original document (optional) :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ files = {"file": open(file_path, "rb")} data = { "process_rule": {"mode": "automatic"}, "indexing_technique": "high_quality", } if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) if original_document_id is not None: data["original_document_id"] = original_document_id url = f"/datasets/{self._get_dataset_id()}/document/create_by_file" return self._send_request_with_files( "POST", url, {"data": json.dumps(data)}, files ) def update_document_by_file( self, document_id, file_path, extra_params: dict | None = None ): """ Update a document by file. :param document_id: ID of the document :param file_path: Path to the file :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: """ files = {"file": open(file_path, "rb")} data = {} if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = ( f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_file" ) return self._send_request_with_files( "POST", url, {"data": json.dumps(data)}, files ) def batch_indexing_status(self, batch_id: str, **kwargs): """ Get the status of the batch indexing. :param batch_id: ID of the batch uploading :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{batch_id}/indexing-status" return self._send_request("GET", url, **kwargs) def delete_dataset(self): """ Delete this dataset. :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}" return self._send_request("DELETE", url) def delete_document(self, document_id): """ Delete a document. :param document_id: ID of the document :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}" return self._send_request("DELETE", url) def list_documents( self, page: int | None = None, page_size: int | None = None, keyword: str | None = None, **kwargs, ): """ Get a list of documents in this dataset. :return: Response from the API """ params = {} if page is not None: params["page"] = page if page_size is not None: params["limit"] = page_size if keyword is not None: params["keyword"] = keyword url = f"/datasets/{self._get_dataset_id()}/documents" return self._send_request("GET", url, params=params, **kwargs) def add_segments(self, document_id, segments, **kwargs): """ Add segments to a document. :param document_id: ID of the document :param segments: List of segments to add, example: [{"content": "1", "answer": "1", "keyword": ["a"]}] :return: Response from the API """ data = {"segments": segments} url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments" return self._send_request("POST", url, json=data, **kwargs) def query_segments( self, document_id, keyword: str | None = None, status: str | None = None, **kwargs, ): """ Query segments in this document. :param document_id: ID of the document :param keyword: query keyword, optional :param status: status of the segment, optional, e.g. completed """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments" params = {} if keyword is not None: params["keyword"] = keyword if status is not None: params["status"] = status if "params" in kwargs: params.update(kwargs["params"]) return self._send_request("GET", url, params=params, **kwargs) def delete_document_segment(self, document_id, segment_id): """ Delete a segment from a document. :param document_id: ID of the document :param segment_id: ID of the segment :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}" return self._send_request("DELETE", url) def update_document_segment(self, document_id, segment_id, segment_data, **kwargs): """ Update a segment in a document. :param document_id: ID of the document :param segment_id: ID of the segment :param segment_data: Data of the segment, example: {"content": "1", "answer": "1", "keyword": ["a"], "enabled": True} :return: Response from the API """ data = {"segment": segment_data} url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}" return self._send_request("POST", url, json=data, **kwargs) if __name__ == "__main__": import asyncio async def main(): client = ChatClient("key", 'http://127.0.0.1/v1') res = await client.get_conversations("test", limit=2) print(res.json()) client = ChatClient("key", 'http://127.0.0.1/v1') res = client.get_conversations("test", limit=1) print(res.json()) asyncio.run(main()) ``` effect：  ### 2. Additional context or comments _No response_ ### 3. Can you help us with this feature? - [ ] I am interested in contributing to this feature.

yindo added the 💪 enhancement label 2026-02-21 19:20:48 -05:00

yindo closed this issue 2026-02-21 19:20:48 -05:00

yindo commented 2026-02-21 19:20:48 -05:00

Author

Owner

Copy Link

Copy Source

@crazywoola commented on GitHub (Jul 10, 2025):

Feel free to open a PR for this.

@crazywoola commented on GitHub (Jul 10, 2025): Feel free to open a PR for this.

yindo commented 2026-02-21 19:20:48 -05:00

Author

Owner

Copy Link

Copy Source

@InfernalAzazel commented on GitHub (Jul 10, 2025):

Feel free to open a PR for this.
Currently under research, there are some issues with the stream

    async def _request_async(
            self, method: str,
            endpoint: str,
            json= None,
            params=None,
            stream: bool = False,
    ) -> httpx.Response:
        async with httpx.AsyncClient() as client:
            headers = {
                "Authorization": f"Bearer {self.api_key}",
                "Content-Type": "application/json",
            }
            url = f"{self.base_url}{endpoint}"
            request = httpx.Request(method, url, json=json, params=params, headers=headers)
            return await client.send(request, stream=stream)

test:

if __name__ == "__main__":
    import asyncio
    async def main():
        client = ChatClient("app-key", 'http://127.0.0.1/v1')
        res = await client.get_conversations("test", limit=2)
        print(res.json())
        response = await client.create_chat_message(
            inputs={},
            query='你好',
            user='test',
            response_mode='streaming',
        )
        async for line in response.aiter_lines():
            print("line:", line)
        # async for line in response.aiter_lines():
        #     if line:
        #         # Dify 的流式响应使用 SSE 格式，每行以 'data:' 开头
        #         if line.startswith("data:"):
        #             data = line.lstrip("data:").strip()
        #             if data:
        #                 try:
        #                     parsed = json.loads(data)
        #                     print(parsed.get("answer", ""))
        #                 except json.JSONDecodeError:
        #                     continue

    client = ChatClient("app-D5kYcBLTyv06Uft3e33ufLYT", 'http://127.0.0.1/v1')
    res = client.get_conversations("test", limit=1)
    print(res.json())
    asyncio.run(main())

error:

{'limit': 1, 'has_more': True, 'data': [{'id': '654067e2-f53f-4058-97e1-485fb088a9ca', 'name': '问候自己☺️', 'inputs': {}, 'status': 'normal', 'introduction': '', 'created_at': 1752140795, 'updated_at': 1752140795}]}
{'limit': 2, 'has_more': True, 'data': [{'id': '654067e2-f53f-4058-97e1-485fb088a9ca', 'name': '问候自己☺️', 'inputs': {}, 'status': 'normal', 'introduction': '', 'created_at': 1752140795, 'updated_at': 1752140795}, {'id': '4088c2de-f8a9-41e2-80f1-e00fa8038f04', 'name': '问候我☺️', 'inputs': {}, 'status': 'normal', 'introduction': '', 'created_at': 1752140773, 'updated_at': 1752140773}]}
line: data: {"event": "workflow_started", "conversation_id": "1db49b2a-4203-4117-ab82-de914b020e9f", "message_id": "21ea0deb-0b89-4b16-bcbd-c2192d873937", "created_at": 1752145439, "task_id": "41394676-e8ce-440e-a99d-409b566f65ed", "workflow_run_id": "fe3c83e5-b46c-4de6-a322-8b7b5dcb9fc2", "data": {"id": "fe3c83e5-b46c-4de6-a322-8b7b5dcb9fc2", "workflow_id": "5f0633e3-65c2-4b7a-bb6b-a87329eb03b7", "sequence_number": 66, "inputs": {"sys.query": "\u4f60\u597d", "sys.files": [], "sys.conversation_id": "1db49b2a-4203-4117-ab82-de914b020e9f", "sys.user_id": "test", "sys.dialogue_count": 0, "sys.app_id": "b71c94bc-8405-4a9e-884a-29e4996b4d04", "sys.workflow_id": "5f0633e3-65c2-4b7a-bb6b-a87329eb03b7", "sys.workflow_run_id": "fe3c83e5-b46c-4de6-a322-8b7b5dcb9fc2"}, "created_at": 1752145439}}
line: 
Traceback (most recent call last):
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 101, in map_httpcore_exceptions
    yield
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 271, in __aiter__
    async for part in self._httpcore_stream:
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/connection_pool.py", line 407, in __aiter__
    raise exc from None
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/connection_pool.py", line 403, in __aiter__
    async for part in self._stream:
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 342, in __aiter__
    raise exc
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 334, in __aiter__
    async for chunk in self._connection._receive_response_body(**kwargs):
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 203, in _receive_response_body
    event = await self._receive_event(timeout=timeout)
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 217, in _receive_event
    data = await self._network_stream.read(
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_backends/anyio.py", line 32, in read
    with map_exceptions(exc_map):
  File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/contextlib.py", line 153, in __exit__
    self.gen.throw(typ, value, traceback)
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_exceptions.py", line 14, in map_exceptions
    raise to_exc(exc) from exc
httpcore.ReadError

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/Users/kylin/work/code/github/test/dify_client.py", line 512, in <module>
    asyncio.run(main())
  File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/asyncio/base_events.py", line 649, in run_until_complete
    return future.result()
  File "/Users/kylin/work/code/github/test/dify_client.py", line 495, in main
    async for line in response.aiter_lines():
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 1031, in aiter_lines
    async for text in self.aiter_text():
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 1018, in aiter_text
    async for byte_content in self.aiter_bytes():
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 997, in aiter_bytes
    async for raw_bytes in self.aiter_raw():
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 1055, in aiter_raw
    async for raw_stream_bytes in self.stream:
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_client.py", line 176, in __aiter__
    async for chunk in self._stream:
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 270, in __aiter__
    with map_httpcore_exceptions():
  File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/contextlib.py", line 153, in __exit__
    self.gen.throw(typ, value, traceback)
  File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 118, in map_httpcore_exceptions
    raise mapped_exc(message) from exc
httpx.ReadError

I also encountered problems when integrating FastAPI

import json
from typing import Optional, Literal, Dict, List, Annotated
from fastapi import APIRouter, Depends, File
from fastapi_utils.cbv import cbv
from pydantic import BaseModel, Field
from starlette.responses import StreamingResponse
from dependencies.dify_client import ChatClient

router = APIRouter(prefix='/api/v1/dify')


class ChatMessageFile(BaseModel):
    type: Literal['document', 'image', 'audio', 'video', 'custom'] = Field(..., description='支持类型')
    transfer_method: Literal['remote_url', 'local_file'] = Field(..., description='支持类型')
    url: Optional[str] = Field(None, description='图片地址（仅当传递方式为 remote_url 时）')
    upload_file_id: Optional[str] = Field(None, description='上传文件 ID（仅当传递方式为 local_file 时）')


class ChatMessage(BaseModel):
    inputs: Optional[Dict] = None
    query: str
    user: str
    response_mode: Literal['blocking', 'streaming'] = "blocking"
    conversation_id: Optional[str] = None
    files: Optional[List[ChatMessageFile]] = None


@cbv(router)
class CBV:
    @router.post("/chat-message")
    async def chat_message(
            self,
            chat_message: ChatMessage,
            chat_client: Annotated[ChatClient, Depends()]
    ):
        """发送对话消息"""
        response = await chat_client.create_chat_message(
            inputs=chat_message.inputs,
            query=chat_message.query,
            user=chat_message.user,
            response_mode=chat_message.response_mode,
            conversation_id=chat_message.conversation_id,
            files=chat_message.files,
        )

        def event_generator():
            for line in response.iter_lines(decode_unicode=True):
                if line:
                    # Dify 的流式响应使用 SSE 格式，每行以 'data:' 开头
                    if line.startswith("data:"):
                        data = line.lstrip("data:").strip()
                        if data:
                            try:
                                parsed = json.loads(data)
                                yield parsed.get("answer", "")
                            except json.JSONDecodeError:
                                continue

        if chat_message.response_mode == "streaming":
            return StreamingResponse(event_generator(), media_type="text/plain")
        print(response.json())
        return response.json()

    @router.post("/chat-messages/{task_id}/stop")
    async def stop(self, task_id: str, user: str, chat_client: Annotated[ChatClient, Depends()]):
        """停止响应,仅支持流式模式"""
        return await chat_client.stop_message(task_id, user)

    # @router.post('/files/upload')
    # async def upload_file(self, user: str, file: File, chat_client: Annotated[ChatClient, Depends()]):
    #     """上传文件"""
    #     response = await chat_client.file_upload(user, file)
    #     return response.json()

    # @router.get('/messages')
    # async def messages(
    #         self,
    #         conversation_id: str,
    #         user: str,
    #         first_id: str,
    #         limit: int = 20,
    #         chat_client: Annotated[ChatClient, Depends()] = Depends()):
    #     """获取会话历史消息"""
    #     response = await chat_client.get_conversation_messages(
    #         user, conversation_id, first_id, limit
    #     )
    #     return response.json()

    # @router.post('/messages/{message_id}/feedbacks')
    # async def message_feedback(self,
    #               user: str,
    #               message_id: str,
    #               rating: Optional[Literal['like', 'dislike']] = None,
    #               chat_client: Annotated[ChatClient, Depends()] = Depends()):
    #     response = await chat_client.message_feedback(message_id, rating, user)
    #     return response.json()

    # @router.get("/conversations")
    # async def get_conversations(
    #         self,
    #         user: str,
    #         last_id: Optional[str] = None,
    #         limit: Optional[int] = 20,
    #         pinned: Optional[bool] = None,
    #         chat_client: Annotated[ChatClient, Depends()] = Depends()
    # ):
    #     response = await chat_client.get_conversations(
    #         user=user,
    #         last_id=last_id,
    #         limit=limit,
    #         pinned=pinned,
    #     )
    #     return response.json()

@InfernalAzazel commented on GitHub (Jul 10, 2025): > Feel free to open a PR for this. Currently under research, there are some issues with the stream ```python async def _request_async( self, method: str, endpoint: str, json= None, params=None, stream: bool = False, ) -> httpx.Response: async with httpx.AsyncClient() as client: headers = { "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json", } url = f"{self.base_url}{endpoint}" request = httpx.Request(method, url, json=json, params=params, headers=headers) return await client.send(request, stream=stream) ``` test: ```python if __name__ == "__main__": import asyncio async def main(): client = ChatClient("app-key", 'http://127.0.0.1/v1') res = await client.get_conversations("test", limit=2) print(res.json()) response = await client.create_chat_message( inputs={}, query='你好', user='test', response_mode='streaming', ) async for line in response.aiter_lines(): print("line:", line) # async for line in response.aiter_lines(): # if line: # # Dify 的流式响应使用 SSE 格式，每行以 'data:' 开头 # if line.startswith("data:"): # data = line.lstrip("data:").strip() # if data: # try: # parsed = json.loads(data) # print(parsed.get("answer", "")) # except json.JSONDecodeError: # continue client = ChatClient("app-D5kYcBLTyv06Uft3e33ufLYT", 'http://127.0.0.1/v1') res = client.get_conversations("test", limit=1) print(res.json()) asyncio.run(main()) ``` error: ```shell {'limit': 1, 'has_more': True, 'data': [{'id': '654067e2-f53f-4058-97e1-485fb088a9ca', 'name': '问候自己☺️', 'inputs': {}, 'status': 'normal', 'introduction': '', 'created_at': 1752140795, 'updated_at': 1752140795}]} {'limit': 2, 'has_more': True, 'data': [{'id': '654067e2-f53f-4058-97e1-485fb088a9ca', 'name': '问候自己☺️', 'inputs': {}, 'status': 'normal', 'introduction': '', 'created_at': 1752140795, 'updated_at': 1752140795}, {'id': '4088c2de-f8a9-41e2-80f1-e00fa8038f04', 'name': '问候我☺️', 'inputs': {}, 'status': 'normal', 'introduction': '', 'created_at': 1752140773, 'updated_at': 1752140773}]} line: data: {"event": "workflow_started", "conversation_id": "1db49b2a-4203-4117-ab82-de914b020e9f", "message_id": "21ea0deb-0b89-4b16-bcbd-c2192d873937", "created_at": 1752145439, "task_id": "41394676-e8ce-440e-a99d-409b566f65ed", "workflow_run_id": "fe3c83e5-b46c-4de6-a322-8b7b5dcb9fc2", "data": {"id": "fe3c83e5-b46c-4de6-a322-8b7b5dcb9fc2", "workflow_id": "5f0633e3-65c2-4b7a-bb6b-a87329eb03b7", "sequence_number": 66, "inputs": {"sys.query": "\u4f60\u597d", "sys.files": [], "sys.conversation_id": "1db49b2a-4203-4117-ab82-de914b020e9f", "sys.user_id": "test", "sys.dialogue_count": 0, "sys.app_id": "b71c94bc-8405-4a9e-884a-29e4996b4d04", "sys.workflow_id": "5f0633e3-65c2-4b7a-bb6b-a87329eb03b7", "sys.workflow_run_id": "fe3c83e5-b46c-4de6-a322-8b7b5dcb9fc2"}, "created_at": 1752145439}} line: Traceback (most recent call last): File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 101, in map_httpcore_exceptions yield File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 271, in __aiter__ async for part in self._httpcore_stream: File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/connection_pool.py", line 407, in __aiter__ raise exc from None File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/connection_pool.py", line 403, in __aiter__ async for part in self._stream: File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 342, in __aiter__ raise exc File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 334, in __aiter__ async for chunk in self._connection._receive_response_body(**kwargs): File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 203, in _receive_response_body event = await self._receive_event(timeout=timeout) File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_async/http11.py", line 217, in _receive_event data = await self._network_stream.read( File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_backends/anyio.py", line 32, in read with map_exceptions(exc_map): File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/contextlib.py", line 153, in __exit__ self.gen.throw(typ, value, traceback) File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpcore/_exceptions.py", line 14, in map_exceptions raise to_exc(exc) from exc httpcore.ReadError The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/Users/kylin/work/code/github/test/dify_client.py", line 512, in <module> asyncio.run(main()) File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/asyncio/runners.py", line 44, in run return loop.run_until_complete(main) File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/asyncio/base_events.py", line 649, in run_until_complete return future.result() File "/Users/kylin/work/code/github/test/dify_client.py", line 495, in main async for line in response.aiter_lines(): File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 1031, in aiter_lines async for text in self.aiter_text(): File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 1018, in aiter_text async for byte_content in self.aiter_bytes(): File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 997, in aiter_bytes async for raw_bytes in self.aiter_raw(): File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_models.py", line 1055, in aiter_raw async for raw_stream_bytes in self.stream: File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_client.py", line 176, in __aiter__ async for chunk in self._stream: File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 270, in __aiter__ with map_httpcore_exceptions(): File "/Users/kylin/.pyenv/versions/3.10.12/lib/python3.10/contextlib.py", line 153, in __exit__ self.gen.throw(typ, value, traceback) File "/Users/kylin/work/code/github/test/.venv/lib/python3.10/site-packages/httpx/_transports/default.py", line 118, in map_httpcore_exceptions raise mapped_exc(message) from exc httpx.ReadError ``` I also encountered problems when integrating FastAPI ```python import json from typing import Optional, Literal, Dict, List, Annotated from fastapi import APIRouter, Depends, File from fastapi_utils.cbv import cbv from pydantic import BaseModel, Field from starlette.responses import StreamingResponse from dependencies.dify_client import ChatClient router = APIRouter(prefix='/api/v1/dify') class ChatMessageFile(BaseModel): type: Literal['document', 'image', 'audio', 'video', 'custom'] = Field(..., description='支持类型') transfer_method: Literal['remote_url', 'local_file'] = Field(..., description='支持类型') url: Optional[str] = Field(None, description='图片地址（仅当传递方式为 remote_url 时）') upload_file_id: Optional[str] = Field(None, description='上传文件 ID（仅当传递方式为 local_file 时）') class ChatMessage(BaseModel): inputs: Optional[Dict] = None query: str user: str response_mode: Literal['blocking', 'streaming'] = "blocking" conversation_id: Optional[str] = None files: Optional[List[ChatMessageFile]] = None @cbv(router) class CBV: @router.post("/chat-message") async def chat_message( self, chat_message: ChatMessage, chat_client: Annotated[ChatClient, Depends()] ): """发送对话消息""" response = await chat_client.create_chat_message( inputs=chat_message.inputs, query=chat_message.query, user=chat_message.user, response_mode=chat_message.response_mode, conversation_id=chat_message.conversation_id, files=chat_message.files, ) def event_generator(): for line in response.iter_lines(decode_unicode=True): if line: # Dify 的流式响应使用 SSE 格式，每行以 'data:' 开头 if line.startswith("data:"): data = line.lstrip("data:").strip() if data: try: parsed = json.loads(data) yield parsed.get("answer", "") except json.JSONDecodeError: continue if chat_message.response_mode == "streaming": return StreamingResponse(event_generator(), media_type="text/plain") print(response.json()) return response.json() @router.post("/chat-messages/{task_id}/stop") async def stop(self, task_id: str, user: str, chat_client: Annotated[ChatClient, Depends()]): """停止响应,仅支持流式模式""" return await chat_client.stop_message(task_id, user) # @router.post('/files/upload') # async def upload_file(self, user: str, file: File, chat_client: Annotated[ChatClient, Depends()]): # """上传文件""" # response = await chat_client.file_upload(user, file) # return response.json() # @router.get('/messages') # async def messages( # self, # conversation_id: str, # user: str, # first_id: str, # limit: int = 20, # chat_client: Annotated[ChatClient, Depends()] = Depends()): # """获取会话历史消息""" # response = await chat_client.get_conversation_messages( # user, conversation_id, first_id, limit # ) # return response.json() # @router.post('/messages/{message_id}/feedbacks') # async def message_feedback(self, # user: str, # message_id: str, # rating: Optional[Literal['like', 'dislike']] = None, # chat_client: Annotated[ChatClient, Depends()] = Depends()): # response = await chat_client.message_feedback(message_id, rating, user) # return response.json() # @router.get("/conversations") # async def get_conversations( # self, # user: str, # last_id: Optional[str] = None, # limit: Optional[int] = 20, # pinned: Optional[bool] = None, # chat_client: Annotated[ChatClient, Depends()] = Depends() # ): # response = await chat_client.get_conversations( # user=user, # last_id=last_id, # limit=limit, # pinned=pinned, # ) # return response.json() ```

yindo commented 2026-02-21 19:20:48 -05:00

Author

Owner

Copy Link

Copy Source

@InfernalAzazel commented on GitHub (Jul 10, 2025):

In addition, I also found that the dify ui docs and SDK function parameters are inconsistent, and I am not sure which one should prevail.

e.g:

@InfernalAzazel commented on GitHub (Jul 10, 2025): In addition, I also found that the dify ui docs and SDK function parameters are inconsistent, and I am not sure which one should prevail. e.g: <img width="1007" height="751" alt="Image" src="https://github.com/user-attachments/assets/68bfc5ab-8069-4573-b844-5ac90497603a" /> <img width="1068" height="800" alt="Image" src="https://github.com/user-attachments/assets/b5e78064-3d92-4ba2-87da-b5c41bf9a591" />

yindo commented 2026-02-21 19:20:49 -05:00

Author

Owner

Copy Link

Copy Source

@InfernalAzazel commented on GitHub (Jul 10, 2025):

It should be a problem with the library https://github.com/encode/httpx/issues/3348

@InfernalAzazel commented on GitHub (Jul 10, 2025): It should be a problem with the library https://github.com/encode/httpx/issues/3348

yindo commented 2026-02-21 19:20:49 -05:00

Author

Owner

Copy Link

Copy Source

@InfernalAzazel commented on GitHub (Jul 11, 2025):

I didn't understand the materials being tested

After research, only one code can be written synchronously and one code can be written asynchronously

dify_async_client.py

import asyncio
import json
import httpx


class AsyncDifyClient:
    def __init__(self, api_key, base_url: str = "https://api.dify.ai/v1", timeout=60):
        self.api_key = api_key
        self.base_url = base_url
        self.client = httpx.AsyncClient()
        self.timeout = timeout
        self.headers = {"Authorization": f"Bearer {self.api_key}"}

    async def _send_request(self, method, endpoint, json=None, params=None, stream=False):
        url = f"{self.base_url}{endpoint}"
        request = self.client.build_request(method, url, json=json, params=params, headers=self.headers,
                                            timeout=self.timeout)
        return await self.client.send(request, stream=stream)

    async def _send_request_with_files(self, method, endpoint, data, files):
        url = f"{self.base_url}{endpoint}"
        return await self.client.request(method, url, data=data, headers=self.headers, files=files)

    async def message_feedback(self, message_id, rating, user):
        data = {"rating": rating, "user": user}
        return await self._send_request("POST", f"/messages/{message_id}/feedbacks", data)

    async def get_application_parameters(self, user):
        params = {"user": user}
        return await self._send_request("GET", "/parameters", params=params)

    async def file_upload(self, user, files):
        data = {"user": user}
        return await self._send_request_with_files(
            "POST", "/files/upload", data=data, files=files
        )

    async def text_to_audio(self, text: str, user: str, streaming: bool = False):
        data = {"text": text, "user": user, "streaming": streaming}
        return await self._send_request("POST", "/text-to-audio", json=data)

    async def get_meta(self, user):
        params = {"user": user}
        return await self._send_request("GET", "/meta", params=params)


class AsyncCompletionClient(AsyncDifyClient):
    async def create_completion_message(self, inputs, response_mode, user, files=None):
        data = {
            "inputs": inputs,
            "response_mode": response_mode,
            "user": user,
            "files": files,
        }
        return await self._send_request(
            "POST",
            "/completion-messages",
            data,
            stream=(response_mode == "streaming"),
        )


class AsyncChatClient(AsyncDifyClient):
    async def create_chat_message(
            self,
            inputs,
            query,
            user,
            response_mode="blocking",
            conversation_id=None,
            files=None,
    ):
        data = {
            "inputs": inputs,
            "query": query,
            "user": user,
            "response_mode": response_mode,
            "files": files,
        }
        if conversation_id:
            data["conversation_id"] = conversation_id

        return await self._send_request(
            "POST",
            "/chat-messages",
            data,
            stream=True if response_mode == "streaming" else False,
        )

    async def get_suggested(self, message_id, user: str):
        params = {"user": user}
        return await self._send_request(
            "GET", f"/messages/{message_id}/suggested", params=params
        )

    async def stop_message(self, task_id, user):
        data = {"user": user}
        return await self._send_request("POST", f"/chat-messages/{task_id}/stop", data)

    async def get_conversations(self, user, last_id=None, limit=None, sort_by=None):
        params = {"user": user, "last_id": last_id, "limit": limit, "sort_by": sort_by}
        return await self._send_request("GET", "/conversations", params=params)

    async def get_conversation_messages(
            self, user, conversation_id=None, first_id=None, limit=None
    ):
        params = {"user": user}

        if conversation_id:
            params["conversation_id"] = conversation_id
        if first_id:
            params["first_id"] = first_id
        if limit:
            params["limit"] = limit

        return await self._send_request("GET", "/messages", params=params)

    async def rename_conversation(
            self, conversation_id: str, name: str, user: str, auto_generate: bool = False,
    ):
        data = {"name": name, "auto_generate": auto_generate, "user": user}
        return await self._send_request(
            "POST", f"/conversations/{conversation_id}/name", data
        )

    async def delete_conversation(self, conversation_id, user):
        data = {"user": user}
        return await self._send_request("DELETE", f"/conversations/{conversation_id}", data)

    async def audio_to_text(self, audio_file, user):
        data = {"user": user}
        files = {"audio_file": audio_file}
        return await self._send_request_with_files("POST", "/audio-to-text", data, files)


class AsyncWorkflowClient(AsyncDifyClient):
    async def run(
            self, inputs: dict, response_mode: str = "streaming", user: str = "abc-123"
    ):
        data = {"inputs": inputs, "response_mode": response_mode, "user": user}
        return await self._send_request("POST", "/workflows/run", data)

    async def stop(self, task_id, user):
        data = {"user": user}
        return await self._send_request("POST", f"/workflows/tasks/{task_id}/stop", data)

    async def get_result(self, workflow_run_id):
        return await self._send_request("GET", f"/workflows/run/{workflow_run_id}")


class AsyncKnowledgeBaseClient(AsyncDifyClient):
    def __init__(
            self,
            api_key,
            base_url: str = "https://api.dify.ai/v1",
            dataset_id: str | None = None,
    ):
        """
        Construct a KnowledgeBaseClient object.

        Args:
            api_key (str): API key of Dify.
            base_url (str, optional): Base URL of Dify API. Defaults to 'https://api.dify.ai/v1'.
            dataset_id (str, optional): ID of the dataset. Defaults to None. You don't need this if you just want to
                create a new dataset. or list datasets. otherwise you need to set this.
        """
        super().__init__(api_key=api_key, base_url=base_url)
        self.dataset_id = dataset_id

    def _get_dataset_id(self):
        if self.dataset_id is None:
            raise ValueError("dataset_id is not set")
        return self.dataset_id

    async def create_dataset(self, name: str, **kwargs):
        return await self._send_request("POST", "/datasets", {"name": name}, **kwargs)

    async def list_datasets(self, page: int = 1, page_size: int = 20, **kwargs):
        return await self._send_request(
            "GET", f"/datasets?page={page}&limit={page_size}", **kwargs
        )

    async def create_document_by_text(
            self, name, text, extra_params: dict | None = None, **kwargs
    ):
        """
        Create a document by text.

        :param name: Name of the document
        :param text: Text content of the document
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        data = {
            "indexing_technique": "high_quality",
            "process_rule": {"mode": "automatic"},
            "name": name,
            "text": text,
        }
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = f"/datasets/{self._get_dataset_id()}/document/create_by_text"
        return await self._send_request("POST", url, json=data, **kwargs)

    async def update_document_by_text(
            self, document_id, name, text, extra_params: dict | None = None, **kwargs
    ):
        """
        Update a document by text.

        :param document_id: ID of the document
        :param name: Name of the document
        :param text: Text content of the document
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        data = {"name": name, "text": text}
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = (
            f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_text"
        )
        return await self._send_request("POST", url, json=data, **kwargs)

    async def create_document_by_file(
            self, file_path, original_document_id=None, extra_params: dict | None = None
    ):
        """
        Create a document by file.

        :param file_path: Path to the file
        :param original_document_id: pass this ID if you want to replace the original document (optional)
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        files = {"file": open(file_path, "rb")}
        data = {
            "process_rule": {"mode": "automatic"},
            "indexing_technique": "high_quality",
        }
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        if original_document_id is not None:
            data["original_document_id"] = original_document_id
        url = f"/datasets/{self._get_dataset_id()}/document/create_by_file"
        return await self._send_request_with_files(
            "POST", url, {"data": json.dumps(data)}, files
        )

    async def update_document_by_file(
            self, document_id, file_path, extra_params: dict | None = None
    ):
        """
        Update a document by file.

        :param document_id: ID of the document
        :param file_path: Path to the file
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return:
        """
        files = {"file": open(file_path, "rb")}
        data = {}
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = (
            f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_file"
        )
        return await self._send_request_with_files(
            "POST", url, {"data": json.dumps(data)}, files
        )

    async def batch_indexing_status(self, batch_id: str, **kwargs):
        """
        Get the status of the batch indexing.

        :param batch_id: ID of the batch uploading
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{batch_id}/indexing-status"
        return await self._send_request("GET", url, **kwargs)

    async def delete_dataset(self):
        """
        Delete this dataset.

        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}"
        return await self._send_request("DELETE", url)

    async def delete_document(self, document_id):
        """
        Delete a document.

        :param document_id: ID of the document
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}"
        return await self._send_request("DELETE", url)

    async def list_documents(
            self,
            page: int | None = None,
            page_size: int | None = None,
            keyword: str | None = None,
            **kwargs,
    ):
        """
        Get a list of documents in this dataset.

        :return: Response from the API
        """
        params = {}
        if page is not None:
            params["page"] = page
        if page_size is not None:
            params["limit"] = page_size
        if keyword is not None:
            params["keyword"] = keyword
        url = f"/datasets/{self._get_dataset_id()}/documents"
        return await self._send_request("GET", url, params=params, **kwargs)

    async def add_segments(self, document_id, segments, **kwargs):
        """
        Add segments to a document.

        :param document_id: ID of the document
        :param segments: List of segments to add, example: [{"content": "1", "answer": "1", "keyword": ["a"]}]
        :return: Response from the API
        """
        data = {"segments": segments}
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments"
        return await self._send_request("POST", url, json=data, **kwargs)

    async def query_segments(
            self,
            document_id,
            keyword: str | None = None,
            status: str | None = None,
            **kwargs,
    ):
        """
        Query segments in this document.

        :param document_id: ID of the document
        :param keyword: query keyword, optional
        :param status: status of the segment, optional, e.g. completed
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments"
        params = {}
        if keyword is not None:
            params["keyword"] = keyword
        if status is not None:
            params["status"] = status
        if "params" in kwargs:
            params.update(kwargs["params"])
        return await self._send_request("GET", url, params=params, **kwargs)

    async def delete_document_segment(self, document_id, segment_id):
        """
        Delete a segment from a document.

        :param document_id: ID of the document
        :param segment_id: ID of the segment
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}"
        return await self._send_request("DELETE", url)

    async def update_document_segment(self, document_id, segment_id, segment_data, **kwargs):
        """
        Update a segment in a document.

        :param document_id: ID of the document
        :param segment_id: ID of the segment
        :param segment_data: Data of the segment, example: {"content": "1", "answer": "1", "keyword": ["a"], "enabled": True}
        :return: Response from the API
        """
        data = {"segment": segment_data}
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}"
        return await self._send_request("POST", url, json=data, **kwargs)


if __name__ == "__main__":
    async def main():
        chat_client = AsyncChatClient('app-sJPF4xwHdRid4Ch8gjDGBahe')
        response = await chat_client.create_chat_message({}, '"what is it?', 'test', 'blocking', files=[{
            "type": "image",
            "transfer_method": "remote_url",
            "url": "https://cloud.dify.ai/logo/logo-site.png"
        }])
        data = response.json()
        print('test1', data)

        response = await chat_client.create_chat_message({}, '"what is it?', 'test', 'streaming', files=[{
            "type": "image",
            "transfer_method": "remote_url",
            "url": "https://cloud.dify.ai/logo/logo-site.png"
        }])
        rdata =  await response.aread()
        print('test2', rdata.decode('utf-8'))

    asyncio.run(main())

The above issue has been resolved

synchronous

import json
import httpx


class DifyClient:
    def __init__(self, api_key: str, base_url: str = "https://api.dify.ai/v1", timeout=60):
        self.api_key = api_key
        self.base_url = base_url
        self.timeout= timeout
        self.client = httpx.Client()
        self.headers = {"Authorization": f"Bearer {self.api_key}"}

    def _send_request(self, method: str, endpoint: str, json=None, params=None, stream=False):
       
        url = f"{self.base_url}{endpoint}"
        client = httpx.Client()
        request = client.build_request(method, url, json=json, params=params, headers=self.headers, timeout=self.timeout)
        response = client.send(request, stream=stream)

        return response

    def _send_request_with_files(self, method: str, endpoint: str, data, files):
        url = f"{self.base_url}{endpoint}"
        response = httpx.request(
            method, url, data=data, headers=self.headers, files=files
        )

        return response

    def message_feedback(self, message_id, rating, user):
        data = {"rating": rating, "user": user}
        return self._send_request("POST", f"/messages/{message_id}/feedbacks", data)

    def get_application_parameters(self, user):
        params = {"user": user}
        return self._send_request("GET", "/parameters", params=params)

    def file_upload(self, user, files):
        data = {"user": user}
        return self._send_request_with_files(
            "POST", "/files/upload", data=data, files=files
        )

    def text_to_audio(self, text: str, user: str, streaming: bool = False):
        data = {"text": text, "user": user, "streaming": streaming}
        return self._send_request("POST", "/text-to-audio", json=data)

    def get_meta(self, user):
        params = {"user": user}
        return self._send_request("GET", "/meta", params=params)


class CompletionClient(DifyClient):
    def create_completion_message(self, inputs, response_mode, user, files=None):
        data = {
            "inputs": inputs,
            "response_mode": response_mode,
            "user": user,
            "files": files,
        }
        return self._send_request(
            "POST",
            "/completion-messages",
            data,
            stream=True if response_mode == "streaming" else False,
        )


class ChatClient(DifyClient):
    def create_chat_message(
        self,
        inputs,
        query,
        user,
        response_mode="blocking",
        conversation_id=None,
        files=None,
    ):
        data = {
            "inputs": inputs,
            "query": query,
            "user": user,
            "response_mode": response_mode,
            "files": files,
        }
        if conversation_id:
            data["conversation_id"] = conversation_id

        return self._send_request(
            "POST",
            "/chat-messages",
            data,
            stream=True if response_mode == "streaming" else False,
        )

    def get_suggested(self, message_id, user: str):
        params = {"user": user}
        return self._send_request(
            "GET", f"/messages/{message_id}/suggested", params=params
        )

    def stop_message(self, task_id, user):
        data = {"user": user}
        return self._send_request("POST", f"/chat-messages/{task_id}/stop", data)

    def get_conversations(self, user, last_id=None, limit=None, pinned=None):
        params = {"user": user, "last_id": last_id, "limit": limit, "pinned": pinned}
        return self._send_request("GET", "/conversations", params=params)

    def get_conversation_messages(
        self, user, conversation_id=None, first_id=None, limit=None
    ):
        params = {"user": user}

        if conversation_id:
            params["conversation_id"] = conversation_id
        if first_id:
            params["first_id"] = first_id
        if limit:
            params["limit"] = limit

        return self._send_request("GET", "/messages", params=params)

    def rename_conversation(
        self, conversation_id, name, auto_generate: bool, user: str
    ):
        data = {"name": name, "auto_generate": auto_generate, "user": user}
        return self._send_request(
            "POST", f"/conversations/{conversation_id}/name", data
        )

    def delete_conversation(self, conversation_id, user):
        data = {"user": user}
        return self._send_request("DELETE", f"/conversations/{conversation_id}", data)

    def audio_to_text(self, audio_file, user):
        data = {"user": user}
        files = {"audio_file": audio_file}
        return self._send_request_with_files("POST", "/audio-to-text", data, files)


class WorkflowClient(DifyClient):
    def run(
        self, inputs: dict, response_mode: str = "streaming", user: str = "abc-123"
    ):
        data = {"inputs": inputs, "response_mode": response_mode, "user": user}
        return self._send_request("POST", "/workflows/run", data)

    def stop(self, task_id, user):
        data = {"user": user}
        return self._send_request("POST", f"/workflows/tasks/{task_id}/stop", data)

    def get_result(self, workflow_run_id):
        return self._send_request("GET", f"/workflows/run/{workflow_run_id}")


class KnowledgeBaseClient(DifyClient):
    def __init__(
        self,
        api_key,
        base_url: str = "https://api.dify.ai/v1",
        dataset_id: str | None = None,
    ):
        """
        Construct a KnowledgeBaseClient object.

        Args:
            api_key (str): API key of Dify.
            base_url (str, optional): Base URL of Dify API. Defaults to 'https://api.dify.ai/v1'.
            dataset_id (str, optional): ID of the dataset. Defaults to None. You don't need this if you just want to
                create a new dataset. or list datasets. otherwise you need to set this.
        """
        super().__init__(api_key=api_key, base_url=base_url)
        self.dataset_id = dataset_id

    def _get_dataset_id(self):
        if self.dataset_id is None:
            raise ValueError("dataset_id is not set")
        return self.dataset_id

    def create_dataset(self, name: str, **kwargs):
        return self._send_request("POST", "/datasets", {"name": name}, **kwargs)

    def list_datasets(self, page: int = 1, page_size: int = 20, **kwargs):
        return self._send_request(
            "GET", f"/datasets?page={page}&limit={page_size}", **kwargs
        )

    def create_document_by_text(
        self, name, text, extra_params: dict | None = None, **kwargs
    ):
        """
        Create a document by text.

        :param name: Name of the document
        :param text: Text content of the document
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        data = {
            "indexing_technique": "high_quality",
            "process_rule": {"mode": "automatic"},
            "name": name,
            "text": text,
        }
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = f"/datasets/{self._get_dataset_id()}/document/create_by_text"
        return self._send_request("POST", url, json=data, **kwargs)

    def update_document_by_text(
        self, document_id, name, text, extra_params: dict | None = None, **kwargs
    ):
        """
        Update a document by text.

        :param document_id: ID of the document
        :param name: Name of the document
        :param text: Text content of the document
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        data = {"name": name, "text": text}
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = (
            f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_text"
        )
        return self._send_request("POST", url, json=data, **kwargs)

    def create_document_by_file(
        self, file_path, original_document_id=None, extra_params: dict | None = None
    ):
        """
        Create a document by file.

        :param file_path: Path to the file
        :param original_document_id: pass this ID if you want to replace the original document (optional)
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return: Response from the API
        """
        files = {"file": open(file_path, "rb")}
        data = {
            "process_rule": {"mode": "automatic"},
            "indexing_technique": "high_quality",
        }
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        if original_document_id is not None:
            data["original_document_id"] = original_document_id
        url = f"/datasets/{self._get_dataset_id()}/document/create_by_file"
        return self._send_request_with_files(
            "POST", url, {"data": json.dumps(data)}, files
        )

    def update_document_by_file(
        self, document_id, file_path, extra_params: dict | None = None
    ):
        """
        Update a document by file.

        :param document_id: ID of the document
        :param file_path: Path to the file
        :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional)
            e.g.
            {
            'indexing_technique': 'high_quality',
            'process_rule': {
                'rules': {
                    'pre_processing_rules': [
                        {'id': 'remove_extra_spaces', 'enabled': True},
                        {'id': 'remove_urls_emails', 'enabled': True}
                    ],
                    'segmentation': {
                        'separator': '\n',
                        'max_tokens': 500
                    }
                },
                'mode': 'custom'
            }
        }
        :return:
        """
        files = {"file": open(file_path, "rb")}
        data = {}
        if extra_params is not None and isinstance(extra_params, dict):
            data.update(extra_params)
        url = (
            f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_file"
        )
        return self._send_request_with_files(
            "POST", url, {"data": json.dumps(data)}, files
        )

    def batch_indexing_status(self, batch_id: str, **kwargs):
        """
        Get the status of the batch indexing.

        :param batch_id: ID of the batch uploading
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{batch_id}/indexing-status"
        return self._send_request("GET", url, **kwargs)

    def delete_dataset(self):
        """
        Delete this dataset.

        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}"
        return self._send_request("DELETE", url)

    def delete_document(self, document_id):
        """
        Delete a document.

        :param document_id: ID of the document
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}"
        return self._send_request("DELETE", url)

    def list_documents(
        self,
        page: int | None = None,
        page_size: int | None = None,
        keyword: str | None = None,
        **kwargs,
    ):
        """
        Get a list of documents in this dataset.

        :return: Response from the API
        """
        params = {}
        if page is not None:
            params["page"] = page
        if page_size is not None:
            params["limit"] = page_size
        if keyword is not None:
            params["keyword"] = keyword
        url = f"/datasets/{self._get_dataset_id()}/documents"
        return self._send_request("GET", url, params=params, **kwargs)

    def add_segments(self, document_id, segments, **kwargs):
        """
        Add segments to a document.

        :param document_id: ID of the document
        :param segments: List of segments to add, example: [{"content": "1", "answer": "1", "keyword": ["a"]}]
        :return: Response from the API
        """
        data = {"segments": segments}
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments"
        return self._send_request("POST", url, json=data, **kwargs)

    def query_segments(
        self,
        document_id,
        keyword: str | None = None,
        status: str | None = None,
        **kwargs,
    ):
        """
        Query segments in this document.

        :param document_id: ID of the document
        :param keyword: query keyword, optional
        :param status: status of the segment, optional, e.g. completed
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments"
        params = {}
        if keyword is not None:
            params["keyword"] = keyword
        if status is not None:
            params["status"] = status
        if "params" in kwargs:
            params.update(kwargs["params"])
        return self._send_request("GET", url, params=params, **kwargs)

    def delete_document_segment(self, document_id, segment_id):
        """
        Delete a segment from a document.

        :param document_id: ID of the document
        :param segment_id: ID of the segment
        :return: Response from the API
        """
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}"
        return self._send_request("DELETE", url)

    def update_document_segment(self, document_id, segment_id, segment_data, **kwargs):
        """
        Update a segment in a document.

        :param document_id: ID of the document
        :param segment_id: ID of the segment
        :param segment_data: Data of the segment, example: {"content": "1", "answer": "1", "keyword": ["a"], "enabled": True}
        :return: Response from the API
        """
        data = {"segment": segment_data}
        url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}"
        return self._send_request("POST", url, json=data, **kwargs)

I didn't understand the test cases and materials, and this part of the work needs someone who is more clear to complete.

@InfernalAzazel commented on GitHub (Jul 11, 2025): I didn't understand the materials being tested <img width="1400" height="949" alt="Image" src="https://github.com/user-attachments/assets/3c0bd6b8-0917-4f29-908c-7a3bfb39cf54" /> After research, only one code can be written synchronously and one code can be written asynchronously dify_async_client.py ```python import asyncio import json import httpx class AsyncDifyClient: def __init__(self, api_key, base_url: str = "https://api.dify.ai/v1", timeout=60): self.api_key = api_key self.base_url = base_url self.client = httpx.AsyncClient() self.timeout = timeout self.headers = {"Authorization": f"Bearer {self.api_key}"} async def _send_request(self, method, endpoint, json=None, params=None, stream=False): url = f"{self.base_url}{endpoint}" request = self.client.build_request(method, url, json=json, params=params, headers=self.headers, timeout=self.timeout) return await self.client.send(request, stream=stream) async def _send_request_with_files(self, method, endpoint, data, files): url = f"{self.base_url}{endpoint}" return await self.client.request(method, url, data=data, headers=self.headers, files=files) async def message_feedback(self, message_id, rating, user): data = {"rating": rating, "user": user} return await self._send_request("POST", f"/messages/{message_id}/feedbacks", data) async def get_application_parameters(self, user): params = {"user": user} return await self._send_request("GET", "/parameters", params=params) async def file_upload(self, user, files): data = {"user": user} return await self._send_request_with_files( "POST", "/files/upload", data=data, files=files ) async def text_to_audio(self, text: str, user: str, streaming: bool = False): data = {"text": text, "user": user, "streaming": streaming} return await self._send_request("POST", "/text-to-audio", json=data) async def get_meta(self, user): params = {"user": user} return await self._send_request("GET", "/meta", params=params) class AsyncCompletionClient(AsyncDifyClient): async def create_completion_message(self, inputs, response_mode, user, files=None): data = { "inputs": inputs, "response_mode": response_mode, "user": user, "files": files, } return await self._send_request( "POST", "/completion-messages", data, stream=(response_mode == "streaming"), ) class AsyncChatClient(AsyncDifyClient): async def create_chat_message( self, inputs, query, user, response_mode="blocking", conversation_id=None, files=None, ): data = { "inputs": inputs, "query": query, "user": user, "response_mode": response_mode, "files": files, } if conversation_id: data["conversation_id"] = conversation_id return await self._send_request( "POST", "/chat-messages", data, stream=True if response_mode == "streaming" else False, ) async def get_suggested(self, message_id, user: str): params = {"user": user} return await self._send_request( "GET", f"/messages/{message_id}/suggested", params=params ) async def stop_message(self, task_id, user): data = {"user": user} return await self._send_request("POST", f"/chat-messages/{task_id}/stop", data) async def get_conversations(self, user, last_id=None, limit=None, sort_by=None): params = {"user": user, "last_id": last_id, "limit": limit, "sort_by": sort_by} return await self._send_request("GET", "/conversations", params=params) async def get_conversation_messages( self, user, conversation_id=None, first_id=None, limit=None ): params = {"user": user} if conversation_id: params["conversation_id"] = conversation_id if first_id: params["first_id"] = first_id if limit: params["limit"] = limit return await self._send_request("GET", "/messages", params=params) async def rename_conversation( self, conversation_id: str, name: str, user: str, auto_generate: bool = False, ): data = {"name": name, "auto_generate": auto_generate, "user": user} return await self._send_request( "POST", f"/conversations/{conversation_id}/name", data ) async def delete_conversation(self, conversation_id, user): data = {"user": user} return await self._send_request("DELETE", f"/conversations/{conversation_id}", data) async def audio_to_text(self, audio_file, user): data = {"user": user} files = {"audio_file": audio_file} return await self._send_request_with_files("POST", "/audio-to-text", data, files) class AsyncWorkflowClient(AsyncDifyClient): async def run( self, inputs: dict, response_mode: str = "streaming", user: str = "abc-123" ): data = {"inputs": inputs, "response_mode": response_mode, "user": user} return await self._send_request("POST", "/workflows/run", data) async def stop(self, task_id, user): data = {"user": user} return await self._send_request("POST", f"/workflows/tasks/{task_id}/stop", data) async def get_result(self, workflow_run_id): return await self._send_request("GET", f"/workflows/run/{workflow_run_id}") class AsyncKnowledgeBaseClient(AsyncDifyClient): def __init__( self, api_key, base_url: str = "https://api.dify.ai/v1", dataset_id: str | None = None, ): """ Construct a KnowledgeBaseClient object. Args: api_key (str): API key of Dify. base_url (str, optional): Base URL of Dify API. Defaults to 'https://api.dify.ai/v1'. dataset_id (str, optional): ID of the dataset. Defaults to None. You don't need this if you just want to create a new dataset. or list datasets. otherwise you need to set this. """ super().__init__(api_key=api_key, base_url=base_url) self.dataset_id = dataset_id def _get_dataset_id(self): if self.dataset_id is None: raise ValueError("dataset_id is not set") return self.dataset_id async def create_dataset(self, name: str, **kwargs): return await self._send_request("POST", "/datasets", {"name": name}, **kwargs) async def list_datasets(self, page: int = 1, page_size: int = 20, **kwargs): return await self._send_request( "GET", f"/datasets?page={page}&limit={page_size}", **kwargs ) async def create_document_by_text( self, name, text, extra_params: dict | None = None, **kwargs ): """ Create a document by text. :param name: Name of the document :param text: Text content of the document :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ data = { "indexing_technique": "high_quality", "process_rule": {"mode": "automatic"}, "name": name, "text": text, } if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = f"/datasets/{self._get_dataset_id()}/document/create_by_text" return await self._send_request("POST", url, json=data, **kwargs) async def update_document_by_text( self, document_id, name, text, extra_params: dict | None = None, **kwargs ): """ Update a document by text. :param document_id: ID of the document :param name: Name of the document :param text: Text content of the document :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ data = {"name": name, "text": text} if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = ( f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_text" ) return await self._send_request("POST", url, json=data, **kwargs) async def create_document_by_file( self, file_path, original_document_id=None, extra_params: dict | None = None ): """ Create a document by file. :param file_path: Path to the file :param original_document_id: pass this ID if you want to replace the original document (optional) :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ files = {"file": open(file_path, "rb")} data = { "process_rule": {"mode": "automatic"}, "indexing_technique": "high_quality", } if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) if original_document_id is not None: data["original_document_id"] = original_document_id url = f"/datasets/{self._get_dataset_id()}/document/create_by_file" return await self._send_request_with_files( "POST", url, {"data": json.dumps(data)}, files ) async def update_document_by_file( self, document_id, file_path, extra_params: dict | None = None ): """ Update a document by file. :param document_id: ID of the document :param file_path: Path to the file :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: """ files = {"file": open(file_path, "rb")} data = {} if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = ( f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_file" ) return await self._send_request_with_files( "POST", url, {"data": json.dumps(data)}, files ) async def batch_indexing_status(self, batch_id: str, **kwargs): """ Get the status of the batch indexing. :param batch_id: ID of the batch uploading :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{batch_id}/indexing-status" return await self._send_request("GET", url, **kwargs) async def delete_dataset(self): """ Delete this dataset. :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}" return await self._send_request("DELETE", url) async def delete_document(self, document_id): """ Delete a document. :param document_id: ID of the document :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}" return await self._send_request("DELETE", url) async def list_documents( self, page: int | None = None, page_size: int | None = None, keyword: str | None = None, **kwargs, ): """ Get a list of documents in this dataset. :return: Response from the API """ params = {} if page is not None: params["page"] = page if page_size is not None: params["limit"] = page_size if keyword is not None: params["keyword"] = keyword url = f"/datasets/{self._get_dataset_id()}/documents" return await self._send_request("GET", url, params=params, **kwargs) async def add_segments(self, document_id, segments, **kwargs): """ Add segments to a document. :param document_id: ID of the document :param segments: List of segments to add, example: [{"content": "1", "answer": "1", "keyword": ["a"]}] :return: Response from the API """ data = {"segments": segments} url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments" return await self._send_request("POST", url, json=data, **kwargs) async def query_segments( self, document_id, keyword: str | None = None, status: str | None = None, **kwargs, ): """ Query segments in this document. :param document_id: ID of the document :param keyword: query keyword, optional :param status: status of the segment, optional, e.g. completed """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments" params = {} if keyword is not None: params["keyword"] = keyword if status is not None: params["status"] = status if "params" in kwargs: params.update(kwargs["params"]) return await self._send_request("GET", url, params=params, **kwargs) async def delete_document_segment(self, document_id, segment_id): """ Delete a segment from a document. :param document_id: ID of the document :param segment_id: ID of the segment :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}" return await self._send_request("DELETE", url) async def update_document_segment(self, document_id, segment_id, segment_data, **kwargs): """ Update a segment in a document. :param document_id: ID of the document :param segment_id: ID of the segment :param segment_data: Data of the segment, example: {"content": "1", "answer": "1", "keyword": ["a"], "enabled": True} :return: Response from the API """ data = {"segment": segment_data} url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}" return await self._send_request("POST", url, json=data, **kwargs) if __name__ == "__main__": async def main(): chat_client = AsyncChatClient('app-sJPF4xwHdRid4Ch8gjDGBahe') response = await chat_client.create_chat_message({}, '"what is it?', 'test', 'blocking', files=[{ "type": "image", "transfer_method": "remote_url", "url": "https://cloud.dify.ai/logo/logo-site.png" }]) data = response.json() print('test1', data) response = await chat_client.create_chat_message({}, '"what is it?', 'test', 'streaming', files=[{ "type": "image", "transfer_method": "remote_url", "url": "https://cloud.dify.ai/logo/logo-site.png" }]) rdata = await response.aread() print('test2', rdata.decode('utf-8')) asyncio.run(main()) ``` The above issue has been resolved <img width="1570" height="502" alt="Image" src="https://github.com/user-attachments/assets/4f0141c6-4e71-4a1a-9aad-8ae250c4f761" /> synchronous ```python import json import httpx class DifyClient: def __init__(self, api_key: str, base_url: str = "https://api.dify.ai/v1", timeout=60): self.api_key = api_key self.base_url = base_url self.timeout= timeout self.client = httpx.Client() self.headers = {"Authorization": f"Bearer {self.api_key}"} def _send_request(self, method: str, endpoint: str, json=None, params=None, stream=False): url = f"{self.base_url}{endpoint}" client = httpx.Client() request = client.build_request(method, url, json=json, params=params, headers=self.headers, timeout=self.timeout) response = client.send(request, stream=stream) return response def _send_request_with_files(self, method: str, endpoint: str, data, files): url = f"{self.base_url}{endpoint}" response = httpx.request( method, url, data=data, headers=self.headers, files=files ) return response def message_feedback(self, message_id, rating, user): data = {"rating": rating, "user": user} return self._send_request("POST", f"/messages/{message_id}/feedbacks", data) def get_application_parameters(self, user): params = {"user": user} return self._send_request("GET", "/parameters", params=params) def file_upload(self, user, files): data = {"user": user} return self._send_request_with_files( "POST", "/files/upload", data=data, files=files ) def text_to_audio(self, text: str, user: str, streaming: bool = False): data = {"text": text, "user": user, "streaming": streaming} return self._send_request("POST", "/text-to-audio", json=data) def get_meta(self, user): params = {"user": user} return self._send_request("GET", "/meta", params=params) class CompletionClient(DifyClient): def create_completion_message(self, inputs, response_mode, user, files=None): data = { "inputs": inputs, "response_mode": response_mode, "user": user, "files": files, } return self._send_request( "POST", "/completion-messages", data, stream=True if response_mode == "streaming" else False, ) class ChatClient(DifyClient): def create_chat_message( self, inputs, query, user, response_mode="blocking", conversation_id=None, files=None, ): data = { "inputs": inputs, "query": query, "user": user, "response_mode": response_mode, "files": files, } if conversation_id: data["conversation_id"] = conversation_id return self._send_request( "POST", "/chat-messages", data, stream=True if response_mode == "streaming" else False, ) def get_suggested(self, message_id, user: str): params = {"user": user} return self._send_request( "GET", f"/messages/{message_id}/suggested", params=params ) def stop_message(self, task_id, user): data = {"user": user} return self._send_request("POST", f"/chat-messages/{task_id}/stop", data) def get_conversations(self, user, last_id=None, limit=None, pinned=None): params = {"user": user, "last_id": last_id, "limit": limit, "pinned": pinned} return self._send_request("GET", "/conversations", params=params) def get_conversation_messages( self, user, conversation_id=None, first_id=None, limit=None ): params = {"user": user} if conversation_id: params["conversation_id"] = conversation_id if first_id: params["first_id"] = first_id if limit: params["limit"] = limit return self._send_request("GET", "/messages", params=params) def rename_conversation( self, conversation_id, name, auto_generate: bool, user: str ): data = {"name": name, "auto_generate": auto_generate, "user": user} return self._send_request( "POST", f"/conversations/{conversation_id}/name", data ) def delete_conversation(self, conversation_id, user): data = {"user": user} return self._send_request("DELETE", f"/conversations/{conversation_id}", data) def audio_to_text(self, audio_file, user): data = {"user": user} files = {"audio_file": audio_file} return self._send_request_with_files("POST", "/audio-to-text", data, files) class WorkflowClient(DifyClient): def run( self, inputs: dict, response_mode: str = "streaming", user: str = "abc-123" ): data = {"inputs": inputs, "response_mode": response_mode, "user": user} return self._send_request("POST", "/workflows/run", data) def stop(self, task_id, user): data = {"user": user} return self._send_request("POST", f"/workflows/tasks/{task_id}/stop", data) def get_result(self, workflow_run_id): return self._send_request("GET", f"/workflows/run/{workflow_run_id}") class KnowledgeBaseClient(DifyClient): def __init__( self, api_key, base_url: str = "https://api.dify.ai/v1", dataset_id: str | None = None, ): """ Construct a KnowledgeBaseClient object. Args: api_key (str): API key of Dify. base_url (str, optional): Base URL of Dify API. Defaults to 'https://api.dify.ai/v1'. dataset_id (str, optional): ID of the dataset. Defaults to None. You don't need this if you just want to create a new dataset. or list datasets. otherwise you need to set this. """ super().__init__(api_key=api_key, base_url=base_url) self.dataset_id = dataset_id def _get_dataset_id(self): if self.dataset_id is None: raise ValueError("dataset_id is not set") return self.dataset_id def create_dataset(self, name: str, **kwargs): return self._send_request("POST", "/datasets", {"name": name}, **kwargs) def list_datasets(self, page: int = 1, page_size: int = 20, **kwargs): return self._send_request( "GET", f"/datasets?page={page}&limit={page_size}", **kwargs ) def create_document_by_text( self, name, text, extra_params: dict | None = None, **kwargs ): """ Create a document by text. :param name: Name of the document :param text: Text content of the document :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ data = { "indexing_technique": "high_quality", "process_rule": {"mode": "automatic"}, "name": name, "text": text, } if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = f"/datasets/{self._get_dataset_id()}/document/create_by_text" return self._send_request("POST", url, json=data, **kwargs) def update_document_by_text( self, document_id, name, text, extra_params: dict | None = None, **kwargs ): """ Update a document by text. :param document_id: ID of the document :param name: Name of the document :param text: Text content of the document :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ data = {"name": name, "text": text} if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = ( f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_text" ) return self._send_request("POST", url, json=data, **kwargs) def create_document_by_file( self, file_path, original_document_id=None, extra_params: dict | None = None ): """ Create a document by file. :param file_path: Path to the file :param original_document_id: pass this ID if you want to replace the original document (optional) :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: Response from the API """ files = {"file": open(file_path, "rb")} data = { "process_rule": {"mode": "automatic"}, "indexing_technique": "high_quality", } if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) if original_document_id is not None: data["original_document_id"] = original_document_id url = f"/datasets/{self._get_dataset_id()}/document/create_by_file" return self._send_request_with_files( "POST", url, {"data": json.dumps(data)}, files ) def update_document_by_file( self, document_id, file_path, extra_params: dict | None = None ): """ Update a document by file. :param document_id: ID of the document :param file_path: Path to the file :param extra_params: extra parameters pass to the API, such as indexing_technique, process_rule. (optional) e.g. { 'indexing_technique': 'high_quality', 'process_rule': { 'rules': { 'pre_processing_rules': [ {'id': 'remove_extra_spaces', 'enabled': True}, {'id': 'remove_urls_emails', 'enabled': True} ], 'segmentation': { 'separator': '\n', 'max_tokens': 500 } }, 'mode': 'custom' } } :return: """ files = {"file": open(file_path, "rb")} data = {} if extra_params is not None and isinstance(extra_params, dict): data.update(extra_params) url = ( f"/datasets/{self._get_dataset_id()}/documents/{document_id}/update_by_file" ) return self._send_request_with_files( "POST", url, {"data": json.dumps(data)}, files ) def batch_indexing_status(self, batch_id: str, **kwargs): """ Get the status of the batch indexing. :param batch_id: ID of the batch uploading :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{batch_id}/indexing-status" return self._send_request("GET", url, **kwargs) def delete_dataset(self): """ Delete this dataset. :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}" return self._send_request("DELETE", url) def delete_document(self, document_id): """ Delete a document. :param document_id: ID of the document :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}" return self._send_request("DELETE", url) def list_documents( self, page: int | None = None, page_size: int | None = None, keyword: str | None = None, **kwargs, ): """ Get a list of documents in this dataset. :return: Response from the API """ params = {} if page is not None: params["page"] = page if page_size is not None: params["limit"] = page_size if keyword is not None: params["keyword"] = keyword url = f"/datasets/{self._get_dataset_id()}/documents" return self._send_request("GET", url, params=params, **kwargs) def add_segments(self, document_id, segments, **kwargs): """ Add segments to a document. :param document_id: ID of the document :param segments: List of segments to add, example: [{"content": "1", "answer": "1", "keyword": ["a"]}] :return: Response from the API """ data = {"segments": segments} url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments" return self._send_request("POST", url, json=data, **kwargs) def query_segments( self, document_id, keyword: str | None = None, status: str | None = None, **kwargs, ): """ Query segments in this document. :param document_id: ID of the document :param keyword: query keyword, optional :param status: status of the segment, optional, e.g. completed """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments" params = {} if keyword is not None: params["keyword"] = keyword if status is not None: params["status"] = status if "params" in kwargs: params.update(kwargs["params"]) return self._send_request("GET", url, params=params, **kwargs) def delete_document_segment(self, document_id, segment_id): """ Delete a segment from a document. :param document_id: ID of the document :param segment_id: ID of the segment :return: Response from the API """ url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}" return self._send_request("DELETE", url) def update_document_segment(self, document_id, segment_id, segment_data, **kwargs): """ Update a segment in a document. :param document_id: ID of the document :param segment_id: ID of the segment :param segment_data: Data of the segment, example: {"content": "1", "answer": "1", "keyword": ["a"], "enabled": True} :return: Response from the API """ data = {"segment": segment_data} url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}/segments/{segment_id}" return self._send_request("POST", url, json=data, **kwargs) ``` I didn't understand the test cases and materials, and this part of the work needs someone who is more clear to complete.

yindo commented 2026-02-21 19:20:49 -05:00

Author

Owner

Copy Link

Copy Source

@dosubot[bot] commented on GitHub (Aug 30, 2025):

Hi, @InfernalAzazel. I'm Dosu, and I'm helping the Dify team manage their backlog and am marking this issue as stale.

Issue Summary:

• You requested asynchronous support for the Dify client SDK and shared example code.
• Encountered httpx ReadError issues during streaming responses.
• Noted inconsistencies between Dify UI docs and SDK parameters.
• Provided separate fully asynchronous and synchronous client implementations that resolved streaming errors.
• The maintainer encouraged submitting a PR for the async feature.

Next Steps:

• Please confirm if asynchronous support is still relevant to the latest version of Dify.
• If so, you can keep the discussion open by commenting; otherwise, I will automatically close this issue in 15 days.

Thanks for your understanding and contribution!

@dosubot[bot] commented on GitHub (Aug 30, 2025): Hi, @InfernalAzazel. I'm [Dosu](https://dosu.dev), and I'm helping the Dify team manage their backlog and am marking this issue as stale. **Issue Summary:** - You requested asynchronous support for the Dify client SDK and shared example code. - Encountered httpx ReadError issues during streaming responses. - Noted inconsistencies between Dify UI docs and SDK parameters. - Provided separate fully asynchronous and synchronous client implementations that resolved streaming errors. - The maintainer encouraged submitting a PR for the async feature. **Next Steps:** - Please confirm if asynchronous support is still relevant to the latest version of Dify. - If so, you can keep the discussion open by commenting; otherwise, I will automatically close this issue in 15 days. Thanks for your understanding and contribution!

yindo referenced this issue 2026-02-21 20:43:09 -05:00

[PR #15235] Fix: reranker OFF logic to preserve user setting #28284

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

0720-new-rag-contracts

deploy/konwledge

deploy/agent

chore/support-preview-mode-fe

codex/migrate-knowledge-fs

0721-happy-path-smoke

0721-document-detail

0720-documents-tasks

0720-crawl-selection

feat/cloud-analytics-consent

0720-crawl-preview

0720-source-connections

0720-create-knowledge

deploy/dev

build/cus-1418-annotation-probe

feat/hitl-im-dev

deploy/saas

lts/1.13.x

perf/optimize-markdown-renderer

deploy/enterprise

gareth/esq1-170-rbac-for-agent

yanli/refactor-sandbox-and-e2b

copilot/fix-security-issue

feat/ce-telemetry-dev

release/e-1.11.4

hotfix/cus-1422-enterprise-api-timeout

feat/fix-undefined-answer-preview

hotfix/1.15.0-fix.15

laipz8200/human-input-loop-iteration

hotfix/1.15.0-fix.14

deploy/workflow-archive-catalog-discovery

dependabot/uv/api/pydantic-09001a97e5

laipz8200/completion-workflow-entry

dependabot/uv/api/lts/1.13.x/python-packages-6c2bf7110c

dependabot/uv/api/storage-4219cfbece

dependabot/uv/api/lts/1.13.x/dev-6fc4f8b90c

dependabot/uv/api/llm-46e0cee538

dependabot/uv/api/lts/1.13.x/vdb-72526f7860

dependabot/uv/api/opentelemetry-b8005594e1

dependabot/uv/api/lts/1.13.x/storage-4310e8b8d8

dependabot/uv/api/lts/1.13.x/database-c0fba9b420

dependabot/uv/api/lts/1.13.x/llm-5ce1d68736

dependabot/uv/api/lts/1.13.x/pydantic-09001a97e5

dependabot/uv/api/lts/1.13.x/opentelemetry-b8005594e1

dependabot/uv/api/google-68de7a6be5

dependabot/github_actions/lts/1.13.x/github-actions-dependencies-1a36b91cf1

dependabot/uv/api/lts/1.13.x/google-c93828e58f

dependabot/uv/api/lts/1.13.x/flask-1086fc46af

0717-knowledge-fs-contract

feat/secret-scrub-persistence

feat/llm-ft-timeout

feat/appdeploy-selected-workflow-dsl

0715-new-rag

laipz8200/llm-environment-variables

release/ee-1.15.0-hotfix

laipz8200/chore-remove-feature-preview-root-env

dependabot/go_modules/dify-agent-runtime/golang.org/x/net-0.55.0

hotfix/1.15.0-fix.12

hotfix/1.15.0-fix.12-cherrypick

hotfix/1.15.0-fix.13

build/invite-seats-precheck

hotfix/1.15.0-fix.11

laipz8200/workflow-persistence-mixed-mode

hotfix/1.15.0-fix.10

zhangxin/eng-558-licensed-seats-1.15

fix/wta-1307-effect-suspense-read

feat/cli-skills-agents

0713-vp-lint

fix/agent-roster-answer-completion-main

feat/pay-by-invoice

codex/run-external-e2e-main-ci

agent/remove-sandbox-bind-mounts

feat/agent-v2-e2e-test

hotfix/1.15.0-fix.9

hotfix/1.15.0-fix.8

build/test-archive-export

linw/restore-agent-message-delta-feat

hotfix/1.15.0-fix.7

hotfix/1.15.0-fix.6

codex/pr-38227-session-types

codex/pr-38227-session-scope-split

fix/ui-fix

hotfix/1.15.0-fix.4

codex/review-pr-38480

hotfix/1.15.0-fix.2

copilot/fix-web-full-stack-e2e-job

fix/dify-2738-agent-node-dsl-export

hotfix/1.15.0-fix.3

fix/scope-segment-batch-delete

laipz8200/scope-segment-route-lookup

chore/i18n-sync-7b7956f3e7ca-e901a65a

codex/upgrade-orpc-v2-beta

hotfix/1.15.0-fix.1

codex/upgrade-openapi-ts-autofix

codex/upgrade-next-16-3-preview

hotfix/1.15.0-fix.0

hotfix/web-detail-adjustment-before-release

release/e-1.15.0

codex/replace-lamejs-with-mediabunny

copilot/add-more-tests

deploy/archive-db-resilience

fix/studio-nav-home-button

hotfix/1.14.2-fix.13

worktree-token-expired-error-code

hotfix-1.14.2-fix.12

codex/agent-v2-state-graph

codex/refactor-deployment-detail-components

hotfix/1.14.2-fix.12

build/fix/workflow-error-hanging

work/dify-2585-agent-drafts-pr

fix/dify-2574-soul-files-kv

fix/dify-2554-debug-conversation-per-user

hotfix/1.14.2-fix.11

feat/openapi-rbac

test/cli-e2e-error-body-contract

build/optimize-clean-messages-eligible-apps

zhaohao1004/optimize-clean-messages-cursor

gh-readonly-queue/main/pr-37592-c71f03f5902031b7c02e61af3aff5c2dee6f7d85

build/optimize-clean-messages-cursor

feat/country

codex/vp-fmt-migration

hotfix/1.14.2-fix.10

hotfix/1.14.2-fix.9

hotfix/1.14.2-fix.8

hotfix/1.14.2-fix.7

hotfix/1.14.2-fix.6

codex/page-title-updates

feat/agent-mention-stable-ids

fix/guard-workspace-with-defualt-roles

build/pr-37227-free-plan-workflow-run-cleanup

feat/cli-e2e-test-suite

feat/ui-start-node

feat/hitl-file-in-body

copilot/dify-team-question-agent-node

fix/wta-438-device-sso-redirect-origin

hotfix/1.14.2-fix.5

feat/dev-snippet-fronted

feat/mcp-token-transfer

chore/keep-info-icon-the-same-postion

codex/local-app-list-tag-filter

feat/snippet-new

hotfix/1.14.2-fix.4

codex/migrate-var-reference-combobox

hotfix/1.14.2-fix.3

feat/marketplace-template

chore/deploy-saas-workflow

hotfix/1.14.2-fix.2

build/cli

codex/snp-406-pointer-position-ref

hotfix/1.14.1-fix.3

build/feat/model-type-migration-script

fix/webapp-disabled-not-jump-to-webapp-login

fix/lb-model-type-dedup

song/eng-379-file-output-check-executor

chore/bump-authlib-1.6.12

fix/tag-trigger-preserve-case

chore/bump-sendgrid-lts-1.13.x

fix/model-type-enum-construction

refactor/add-missing-override-decorator

work/web-mcp-1.14.1

copilot/check-runtime-limits

laipz8200/workflow-response-stream-filter

copilot/query-issues-pr-images

laipz8200/fix-autofix-contract-generation

copilot/fix-autofix-job-failure

codex/deprecate-sys-files-compat

codex/fix-scrolling-issue-with-overflow-visible

copilot/research-retrieval-attachment-consumption

copilot/research-agent-node-implementation

chore/upgrade-xyflow-v12

hotfix/1.14.1-fix.1

build/1.14.1-fix.1-langfuse

hotfix/1.14.1-fix.2

feat/lts-lazy-dialogue-count

fix/can-not-create-knowledge

codex/fix-marketplace-hero-shake

codex/tag-name-url-filter

upgrade-graphon-to-0-3-0

codex/app-delete-enter-confirm

build/sample-tidb

codex/revert-pr-35708

chore/remove-dify-deploy-script

chore/simpler-deploy

lts/1.13.x-fix-35910

feat/storage-path-prefix

hotfix/1.13.3-fix10

hotfix/1.13.3-fix9

hotfix/1.14.0-fix.4

hotfix/1.14.0-fix.3

hotfix/1.14.0-fix.2

revert-35748-4-30-open-api

feat/upgrade-graphon

copilot/research-celery-task-ttl

hotfix/1.14.0-fix.1

copilot/fix-css-issue

feat/s3-public-base-url

hotfix/1.13.3-fix8

build/depot-speed-benchmark-20260426

build/depot-speed-benchmark-20260426-warm

hotfix/1.13.3-fix7

feat/evaluation

fix/workflow-line

chore/dependency-upgrade

deploy/zhaohao

feat/replayable-stream

feat/show-the-hierarchy-in-phonenix-trace

p363-reviewed

build/billing-v3

copilot/list-contributions-to-dify

cursor/migrate-tooltip-to-popover-infotips

refactor/quota-service

feat/new-biliing-quota

hotfix/1.13.3-fix6

cursor/dify-ui-infra

p363-hjlarry

cursor/refactor-select-trigger-api

chore/lts-13x-bump-deps

codex/tighten-button-tone-types

locate-queue-autocreate-deps

hotfix/1.13.3-fix5

feat/new-agent-node

hotfix/1.13.3-fix4

feat/per-db-credential

chore/i18n-sync-208604a3a819-9220dd74

chore/i18n-sync-1b369cede4b4-0e13ce3f

chore/i18n-sync-c93e40212e4c-0e13ce3f

codex/fix-vite-audit-in-sdk-test

copilot/fix-agent-dialogue-input-limit

codex/dify-ui-package-migration

4-2-no-global-loading

fix/ps-not-send

3-18-no-global-loading

feat/support-agent-sandbox

hotfix/1.13.3-fix3

hotfix/1.13.3-fix2

4-1-unocss

build/feat/saas-quota-v4

feat/remove-unused-is-deleted-from-conversation

codex-add-podman-compose-dev-scripts

fix-partnerstack-cookie-sync

hotfix/1.13.3-fix1

3-31-vite-task-cache

test/add-test-case-for-prompt-editor

build/feat/saas-quota

build/feat/saas-quota-v2

deploy/agent-dev

yanli/fix-iter-log

review-myscale-sqli

codex/force-node24-for-actions

ci/docker-build-narrowing

chore/dependabot-alert-to-bot

verify-email-reset-flow

3-26-cache-lint-for-autofix

gh-readonly-queue/main/pr-34120-2cbcf9518e40104286a3034f3c3c688cd4ff9fbf

gh-readonly-queue/main/pr-34123-1c72b8d9db03b93b3fc7f86bc522e53806f5a8f0

gh-readonly-queue/main/pr-33960-38285aa1ac6de98614456f49b4d834fe503f4e58

p383

yanli/phase3-code-scope

test/workflow-app

codex/migrate-old-toast-calls-and-update-translations

hotfix/1.13.2-fix2

focal-quokka

codex/fix-issue-33422-in-repository

hotfix/1.13.2-fix1

copilot/refactor-test-config-leak-fix

build/release-1.13.2

fix-kpa-issue

build/release-1.13.1-rc.3

3-18-dev-with-http2

build/release-1.13.1-rc.2

3-16-revert-changes

3-16-add-csp

build/release-1.13.1-rc.1

feat/source-for-plugin-tasks

3-16-next-lib

revert-33484-dependabot/pip/api/python-packages-2eba66ec58

move-trigger-nodes

copilot/refactor-test-config-leak-detection

fix/enterprise-api-error-handling

release/e-1.12.1

fix/vinext-deps

yanli/docx-image-render

copilot/analyze-dify-code

deploy/clean-task-trace

copilot/sub-pr-33044

3-6-type-check

feat/model-provider-refactor

copilot/refactor-unnecessary-cast-call

build/export-app-messages

1.12.1-otel-ee

hotfix/1.13.0-fix.4

update-checker

test/ui-primitive-wrapper-tests-pr

hotfix/1.13.0-fix.3

refactor/base-comp

deploy/memory-usage

hotfix/1.13.0-fix.2

hotfix/1.13.0-fix.1

build/sandbox-clean-job-260302-1

build/sandbox-clean-job

fix/otel-upgrade-e-1.12.1

build/optimize-workflow-run-cleanup

move-core-prompt-runtime

hotfix/1.12.1-fix.6

copilot/remove-pm2-from-docker

move-token-buffer-memory

32589-main-repo

fix/access-mode-sso-verified

refactor/remove-workspace-mutate-from-context

2-11-fix-lint

feat/plugins-marketplace-ssr-prefetch-loading

build/message-clean-performance-log

refactor/template-transform-node

hotfix/1.12.1-fix.5

2-9-stable-test-2

pre-align-hitl-frontend

fix/preserve-UNC-paths-in-conversation-opner

hotfix/1.12.1-fix.4

hotfix/1.12.1-fix.3

feat/add-update-all-plugin-button

refactor/share

hotfix/1.12.1-fix.2

test/inprove-quality

feat/add_templates

hotfix/1.12.1-fix.1

fix/ee-1511-set-default-provider-user-id-bug

copilot/fix-pnpm-test

hotfix/1.12.1-fix.0

feat/vibe-wf

fix/fix-test

fix/console_ns_import

release/1.12.1

fix/workflow-sync-draft

refactor/ssr-prefetch-zustand-removal

1-24-kubb-generate

refactor/migrate-react-window-to-tanstack-virtual

fix/input-ime-onpressenter

1-30-fix-failed-test

feat/structured-output-with-sandbox

yanli/init-ty

hotfix/1.11.4-fix.4

fix/trigger-plugin-output

fix/parallel-generation-render

refactor/configuration

yanli/add-opaque-body

build/billing-refactor-test-2026012701

refactor/debug-and-preview-store

refactor/tools-workflow

build/debug-billing-refactor

build/billing-service

build-billing-service

feat/add-agentation

refactor/app-components

build/collaboration

copilot/sub-pr-31424

refactor/local-storage

refactor/skill-bundler

hotfix/1.11.4-fix.3

build/archive-workflow-run

feat/pull-a-variable

hotfix/1.11.4-fix.2

copilot/sub-pr-30849

hotfix/1.11.4-fix.1

1-21-test-window-is-not-defined

revert-30727-feat/model-total-credits

copilot/sub-pr-31283

zhsama/multi-turn-popup

zhsama/panel-var-popup

12-19-demo-for-app-store

refactor/migrate-app-detail-to-tanstack-query

build/clear-message

feat/credential-sync-fix-ee

feat/llm-first-token-timeout

zhsama/assemble-var-input

release/e-1.11.2

feature/task-quadrant-view

zhsama/llm-warning-ui

build/clear-workflow-run

zhsama/agent-at-nodes

build/1.11.4

release/e-1.6.0-fix.1

release/e-0.15.8-fix.1

1-14-remove-web-app-access-token

refactor/plugins-detail

fix/reset-dev

feat/llm-support-tools

feat/knowledge-summary-index

fix/preact-security-vulnerability

copilot/fix-clear-query-params-test

refactor/query-params-nuqs

chore/upgrade-pnpm-10.28.0

8c92-update-api-core

detached

chore/i18n-sync-20260107-104636

chore/i18n-sync-20260107-102654

feat/grouping-branching

feat/agent-node-v2

hotfix/1.11.2-fix.3

feat/llm-node-support-tools

refactor/remove-axios-dependency

refactor/web-service-hooks

fix/pwa-plugin-migration

chore/refactor-text-generation

hotfix/1.11.2-fix.2

release/e-1.11.1

release/e-1.9.2

release/e-1.8.2

hotfix/1.11.2-hotfix-1

refactor/chat-messages-service-api

fix/knowledge-retrieval-node-affected-by-past-version

fix/esbuild-dependabot-145

chore/automated-i18n-updates-02e0fadef78f0c888b79e7a52ae6714ac73effdc

chore/automated-i18n-updates-eb73f9a9b9fc9eee6be786d2bf5f41fc77e240c4

hotfix/1.11.1-2

refactor-text-generate-item

feat/end-user-oauth

feat/add-qdrant-to-tidb-migration

codex/run-pnpm-lint-fix-and-commit-changes

feat/document-test

feat/e2e-testing

deploy/trigger-dev

hotfix/1.11.1-1

e-260

refactor/use-log-react-query

feat/fallback-interface-for-unauthorized-datasource-node

hotfix/1.10.1-fix.4

refactor/app/components/app/text-generate/item/index.tsx-and-add-test

release/e-1.6.0

hotfix/1.10.1-fix.3

hotfix/1.10.1-fix.2

feat/tracking-1203

deploy/end-user-oauth

hotfix/1.10.1-fix.1

refactor/marketplace-react-query

feat/detect-cognitive-complexity

fix/codeowners

fix/httpx_timeout_parameters

feat/end-user-auth-dummy-apis

chore/re-point-doc-urls

fix/share-markdown-xss

feat/data-tracking

feat/memory-orchestration-be

build/trigger-billing

chore/remove-docker-legacy-dir

copilot/reverse-engineer-dify-application

feat/amplitude

feat/trigger-saas

mysql-adapt

test/build-diff-edition

feat/no-root-image

feat/trigger

feat/ga-tracking

feat/collaboration

mysql-adaptation

feat/sqlalchemy-type-annotations

build/trigger-1

build/self-tenant-queue

mcp-conditional-capability

fix/mcp-capability

hotfix/1.9.2-fix.3

hotfix/1.9.2-fix.2

feat/iteration-node

hotfix/1.9.2-fix.1

hotfix/1.9.1-fix.1

e1ca7a9bdb0443b9f027b6de16

fix/login-status

feat/gtag-1016

test/monaco-editor-and-remix-icon-upgrade

copilot/fix-ce7a9189-f70c-4ea9-81ba-3f49303104d6

feat/memory-orchestration-be-dev-env

build/trigger

feat/add-knowledge-pipeline-template-command

chore/workflow-performance

copilot/fix-fc039c44-aa24-4844-82b2-e9ac237a13e9

test/log-refactor

chore/ssrf-config

feat/pinecone-vdb

copilot/fix-d8c5989d-5a30-418f-8dc4-099cf1f37218

deploy/rag-dev

hotfix/1.9.0-fix.2

pinecone

fix/document-query

feat/trigger_backup

feat/playwright-integration

feat/trigger_merging

feat/chunk-deduplication

feat/crendential-policy-default-check

feat/credential-policy

release/e-1.8.1

fix/template-list

feat/end_user

feat/trigger-fe

revert-25628-refactor-24421-app-datasets-part1

fix/plugin-tag-fallback

fix/unselect-credential

feat/limit-conv-var-desc-length

feat/rag-pipeline-service-api

fix/empty-plugin-list

feat/plugin-readme

feat/plugin-readme-fe

feat/container-node-extract-mapping

bug1

fix/model-credential

feat/big-var-value-show-fe

build/1.7.2-fix.2

release/e-1.7.2

build/boolean-type

feat/oauth-provider-fe

build/0.7.2-fix.1

feat/model-credentials

feat/model-auth

feat/rag-2-preview

release/e-1.7.1

fix/hotfix-tool-provider-deadlock

feat/knowledge-pipeline-access-control

config-tool-file-size

13604-when-using-redis-cluster-for-caching-add-global_prefix-to-all-keys-cached-by-redis

feat/model-credentils

build/oauth

feat/oauth

feat/human-input

build/plugin-auto-upgrade

test/performance

feat/tool-plugin-oauth

feat/tool-oauth

temp-feat-owner-transfer-enterprise-frontend

release/e-3.0.2

feat/plugin-auto-upgrade-fe

chore/offline-the-sys-files

feat/rag-pipeline

feat/r2

release/e-3.2.0

wtw/rag-pipeline

feat/add-retrival-field-in-dataset

feat/webapp-verified-sso-main

fix/app-not-published-error

feat/webapp-verified-sso-260

v141-hotfix

fix/20326-tool-invoke-error-instance-account

fix/19933-account-object-has-no-attribute-_current_tenant-when-workflow-uses-workflow-as-tool-node

hotfix/0519

fix/e-legacy-clean-up

fix/admin-permission

fix/e-admin-permission

feat/model-memory

feat/webapp-auth-api

1.0.0-fix

revert-17133-fix/i16990-text-to-language-settings

e-0156

hotfix/translation-fix

fix/slider-style-error

e-0154

release/0.15.6-alpha-1

cohere/cleanup-free-tenants-logs

chore/auto-dify

fix/rag-infinity-spaces-loop

fix/dataset-admin

fix/expose-debugging-port

fix/tool-info

fix/aws-s3-r2-compatible

feat/knowledge-metabase

fix/fail-branch-stream-output-error

release/0.15.3-fix1

feat/14009-feature-request-support-for-retrieving-historical-conversations-without-from-enduser-id

feat/upgrade-unstructured-version-10.2

feat/classnames-sort

feat/upgrade-unstructured-version

fix/version-check

fix/handle-agent-none-value

fix/agent-params-pasring

fix/agent-parallel

feat/knowledge-dark-mode

feat/custom-tool-input

release/0.15.2-fix1

0.15.1-admin-apis

feat/support-docx-image-view

feat/agent-stream-output

feat/workflow-node-dark-mode

fix/switch-strategy-clean-param

fix/chore-fix

opik-monitoring

provider-gpustack

feat/mecab-japanese-keywords

feat/retry-single-step-debug

revert-12086-feat/parent-child-retrieval

fix/remove-the-retry-index-field

fix/11839

feat/node-execution-retry

feat/support-extractor-tools-update-wip

feat/update-tidb-batchget-endpoint

fix/iteration-thread-pool-error

feat/support-multi-token-count

feat/parent-child-retrieval-api

fix/app-icon-is-missing

feat/support-extractor-tools-update

test/disable_site

build/add-dependabot

feat/support-extractor-tools

fix/docx-extract-image-ssrf

fix/redis-slow-in-gevent

fix/9772-internal-server-error-when-custom-disclaimer-longer-than-64-characters

alert-autofix-89

build/eslint-react-refresh-plugin

build/switch-to-pnpm

revert-9424-feat/update-dataset-clean-rule

fix/external-knowledge-retrieval-issues

feat/login-type-coontrol

feat/external-knowledge-api

feat/rag-external-knowledge-with-api

feat/external-knowledge

fix/notion-table-extract

fix/tooltip

feat/workflow-add-block-shortcut

feat/update-docs

fix/note-node-zoom-issue

fix/model-runtime-quato-issue

fix/db-lock-timeout

feat/new-tooltip

feat/web-app-sso

chore/optimize-app-workflow-deletion-slow-sql

fix/trace_app_config_app_id_idx

fix/extra-table-tracing-app-config

feat/update-beat-job-time-to-env

fix/index-estimate-error

chore/enterprise-license-status

fix/remove-tsne_position

feat/2p

feat/aws-iam-auth-check

feat/add-flashrank

feat/support-milvus-2.4

feat/add-resource-from-tools

bai

1.16.0

1.16.0-rc1

1.15.0

1.14.2

1.14.1

1.14.0

1.13.3

1.13.2

1.13.1

1.14.0-rc1

1.13.0

1.12.1

1.12.0

1.11.4

1.11.3

1.11.2

1.11.1

1.11.0

1.10.1-fix.1

1.10.1

1.10.0

1.10.0-rc1

1.9.2

1.9.1

1.9.0

2.0.0-beta.2

2.0.0-beta.1

1.8.1

1.8.0

1.7.2

1.7.1

1.7.0

1.6.0

1.5.1

1.5.0

1.4.3

1.4.2

0.15.8

1.4.1

1.4.0

1.3.1

0.15.7

1.3.0

0.15.6

1.2.0

0.15.6-alpha.1

1.1.3

0.15.5

1.1.2

0.15.4

1.1.1

1.1.0

1.0.1

1.0.0

0.15.3

0.15.2

0.15.1

1.0.0-beta.1

0.15.0

0.14.2

v0.8.3-fix1

0.14.1

0.14.0

0.13.2

0.13.1

0.13.0

0.12.1

0.12.0

0.11.2

0.11.1

0.10.2-fix1

0.11.0

0.10.2

0.10.1

0.10.0

0.10.0-beta3

0.9.2

0.9.1-fix1

0.10.0-beta2

0.10.0-beta1

0.9.1

0.9.0

0.8.3

0.8.2

0.8.1

0.8.0

0.8.0-beta1

0.7.3

0.7.2

0.7.1

0.7.0

0.6.16

0.6.15

0.6.14

0.6.13

0.6.12-fix1

0.6.12

0.6.11

0.6.10

0.6.9

0.6.8

0.6.7

0.6.6

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0-fix1

0.6.0

0.6.0-preview-workflow.2

0.5.11-fix1

0.5.11

0.6.0-preview-workflow.1

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.9

0.4.8

0.4.7

0.4.6

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.3.34

0.3.33

0.3.32

0.3.31-fix3

0.3.31-fix2

0.3.31-fix1

0.3.31

0.3.30

0.3.29

0.3.28

0.3.27

0.3.26

0.3.25

0.3.24

0.3.23

0.3.22

0.3.21

0.3.20

0.3.19

0.3.18

0.3.17

0.3.16

0.3.15

0.3.14

0.3.13

0.3.12

0.3.11

0.3.10

0.3.9

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.2

0.2.1

Labels

Clear labels

Knowledge Pipeline

Proposal

WIP

cloud

dependencies

feat:webapp

good first issue

outdated

performance

pull-request

Mirrored from GitHub Pull Request

python:uv

refactor

size:L

stale

status: accepting prs

status: blocked

status: in discussion

stt & tts

vulnerablity

web

wont-fix

🌊 feat:workflow

🌚 invalid

🐞 bug

👻 feat:rag

💪 enhancement

📚 documentation

🔨 feat:tools

🙋‍♂️ question

🙏 help wanted

🤔 cant-reproduce

🤖 feat:agent

No Label 💪 enhancement

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

yindo

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: langgenius/dify#15235