estel/dify
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix: Azure OpenAI o1 max_completion_token and get_num_token_from_messages error (#9326)

Browse Source 
Co-authored-by: wwwc <wwwc@outlook.com>
This commit is contained in:
Warren Wong
2024-10-15 16:26:44 +08:00
committed by GitHub
parent fb32e5ca9a
commit b597a0d31c
9 changed files with 638 additions and 381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
sdks/python-client/dify_client/__init__.py
View File

@@ -1 +1 @@
from dify_client.client import ChatClient, CompletionClient, DifyClient
from dify_client.client import ChatClient, CompletionClient, DifyClient

128
sdks/python-client/dify_client/client.py
View File

@@ -9,10 +9,15 @@ class DifyClient:
self.base_url = base_url
def _send_request(self, method, endpoint, json=None, params=None, stream=False):
headers = {"Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json"}
headers = {
"Authorization": f"Bearer {self.api_key}",
"Content-Type": "application/json",
}
url = f"{self.base_url}{endpoint}"
response = requests.request(method, url, json=json, params=params, headers=headers, stream=stream)
response = requests.request(
method, url, json=json, params=params, headers=headers, stream=stream
)
return response
@@ -20,7 +25,9 @@ class DifyClient:
headers = {"Authorization": f"Bearer {self.api_key}"}
url = f"{self.base_url}{endpoint}"
response = requests.request(method, url, data=data, headers=headers, files=files)
response = requests.request(
method, url, data=data, headers=headers, files=files
)
return response
@@ -34,7 +41,9 @@ class DifyClient:
def file_upload(self, user, files):
data = {"user": user}
return self._send_request_with_files("POST", "/files/upload", data=data, files=files)
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}
@@ -47,25 +56,52 @@ class DifyClient:
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}
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
"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}
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
"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)
return self._send_request(
"GET", f"/messages/{message_id}/suggested", params=params
)
def stop_message(self, task_id, user):
data = {"user": user}
@@ -75,7 +111,9 @@ class ChatClient(DifyClient):
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):
def get_conversation_messages(
self, user, conversation_id=None, first_id=None, limit=None
):
params = {"user": user}
if conversation_id:
@@ -87,9 +125,13 @@ class ChatClient(DifyClient):
return self._send_request("GET", "/messages", params=params)
def rename_conversation(self, conversation_id, name, auto_generate: bool, user: str):
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)
return self._send_request(
"POST", f"/conversations/{conversation_id}/name", data
)
def delete_conversation(self, conversation_id, user):
data = {"user": user}
@@ -102,7 +144,9 @@ class ChatClient(DifyClient):
class WorkflowClient(DifyClient):
def run(self, inputs: dict, response_mode: str = "streaming", user: str = "abc-123"):
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)
@@ -115,7 +159,9 @@ class WorkflowClient(DifyClient):
class KnowledgeBaseClient(DifyClient):
def __init__(self, api_key, base_url: str = "https://api.dify.ai/v1", dataset_id: str = None):
def __init__(
self, api_key, base_url: str = "https://api.dify.ai/v1", dataset_id: str = None
):
"""
Construct a KnowledgeBaseClient object.
@@ -137,7 +183,9 @@ class KnowledgeBaseClient(DifyClient):
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)
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, **kwargs):
"""
@@ -165,13 +213,20 @@ class KnowledgeBaseClient(DifyClient):
}
:return: Response from the API
"""
data = {"indexing_technique": "high_quality", "process_rule": {"mode": "automatic"}, "name": name, "text": text}
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, **kwargs):
def update_document_by_text(
self, document_id, name, text, extra_params: dict = None, **kwargs
):
"""
Update a document by text.
@@ -201,10 +256,14 @@ class KnowledgeBaseClient(DifyClient):
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"
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):
def create_document_by_file(
self, file_path, original_document_id=None, extra_params: dict = None
):
"""
Create a document by file.
@@ -231,15 +290,22 @@ class KnowledgeBaseClient(DifyClient):
:return: Response from the API
"""
files = {"file": open(file_path, "rb")}
data = {"process_rule": {"mode": "automatic"}, "indexing_technique": "high_quality"}
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)
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):
def update_document_by_file(
self, document_id, file_path, extra_params: dict = None
):
"""
Update a document by file.
@@ -269,8 +335,12 @@ class KnowledgeBaseClient(DifyClient):
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)
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):
"""
@@ -301,7 +371,9 @@ class KnowledgeBaseClient(DifyClient):
url = f"/datasets/{self._get_dataset_id()}/documents/{document_id}"
return self._send_request("DELETE", url)
def list_documents(self, page: int = None, page_size: int = None, keyword: str = None, **kwargs):
def list_documents(
self, page: int = None, page_size: int = None, keyword: str = None, **kwargs
):
"""
Get a list of documents in this dataset.
@@ -329,7 +401,9 @@ class KnowledgeBaseClient(DifyClient):
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, status: str = None, **kwargs):
def query_segments(
self, document_id, keyword: str = None, status: str = None, **kwargs
):
"""
Query segments in this document.

10
sdks/python-client/setup.py
View File

@@ -12,17 +12,15 @@ setup(
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/langgenius/dify",
license='MIT',
packages=['dify_client'],
license="MIT",
packages=["dify_client"],
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires=">=3.6",
install_requires=[
"requests"
],
keywords='dify nlp ai language-processing',
install_requires=["requests"],
keywords="dify nlp ai language-processing",
include_package_data=True,
)

112
sdks/python-client/tests/test_client.py
View File

@@ -2,7 +2,12 @@ import os
import time
import unittest
from dify_client.client import ChatClient, CompletionClient, DifyClient, KnowledgeBaseClient
from dify_client.client import (
ChatClient,
CompletionClient,
DifyClient,
KnowledgeBaseClient,
)
API_KEY = os.environ.get("API_KEY")
APP_ID = os.environ.get("APP_ID")
@@ -13,7 +18,9 @@ FILE_PATH_BASE = os.path.dirname(__file__)
class TestKnowledgeBaseClient(unittest.TestCase):
def setUp(self):
self.knowledge_base_client = KnowledgeBaseClient(API_KEY, base_url=API_BASE_URL)
self.README_FILE_PATH = os.path.abspath(os.path.join(FILE_PATH_BASE, "../README.md"))
self.README_FILE_PATH = os.path.abspath(
os.path.join(FILE_PATH_BASE, "../README.md")
)
self.dataset_id = None
self.document_id = None
self.segment_id = None
@@ -21,7 +28,9 @@ class TestKnowledgeBaseClient(unittest.TestCase):
def _get_dataset_kb_client(self):
self.assertIsNotNone(self.dataset_id)
return KnowledgeBaseClient(API_KEY, base_url=API_BASE_URL, dataset_id=self.dataset_id)
return KnowledgeBaseClient(
API_KEY, base_url=API_BASE_URL, dataset_id=self.dataset_id
)
def test_001_create_dataset(self):
response = self.knowledge_base_client.create_dataset(name="test_dataset")
@@ -67,7 +76,9 @@ class TestKnowledgeBaseClient(unittest.TestCase):
def _test_004_update_document_by_text(self):
client = self._get_dataset_kb_client()
self.assertIsNotNone(self.document_id)
response = client.update_document_by_text(self.document_id, "test_document_updated", "test_text_updated")
response = client.update_document_by_text(
self.document_id, "test_document_updated", "test_text_updated"
)
data = response.json()
self.assertIn("document", data)
self.assertIn("batch", data)
@@ -82,7 +93,9 @@ class TestKnowledgeBaseClient(unittest.TestCase):
def _test_006_update_document_by_file(self):
client = self._get_dataset_kb_client()
self.assertIsNotNone(self.document_id)
response = client.update_document_by_file(self.document_id, self.README_FILE_PATH)
response = client.update_document_by_file(
self.document_id, self.README_FILE_PATH
)
data = response.json()
self.assertIn("document", data)
self.assertIn("batch", data)
@@ -112,9 +125,9 @@ class TestKnowledgeBaseClient(unittest.TestCase):
def _test_010_add_segments(self):
client = self._get_dataset_kb_client()
response = client.add_segments(self.document_id, [
{"content": "test text segment 1"}
])
response = client.add_segments(
self.document_id, [{"content": "test text segment 1"}]
)
data = response.json()
self.assertIn("data", data)
self.assertGreater(len(data["data"]), 0)
@@ -131,9 +144,11 @@ class TestKnowledgeBaseClient(unittest.TestCase):
def _test_012_update_document_segment(self):
client = self._get_dataset_kb_client()
self.assertIsNotNone(self.segment_id)
response = client.update_document_segment(self.document_id, self.segment_id,
{"content": "test text segment 1 updated"}
)
response = client.update_document_segment(
self.document_id,
self.segment_id,
{"content": "test text segment 1 updated"},
)
data = response.json()
self.assertIn("data", data)
self.assertGreater(len(data["data"]), 0)
@@ -159,29 +174,37 @@ class TestChatClient(unittest.TestCase):
self.chat_client = ChatClient(API_KEY)
def test_create_chat_message(self):
response = self.chat_client.create_chat_message({}, "Hello, World!", "test_user")
response = self.chat_client.create_chat_message(
{}, "Hello, World!", "test_user"
)
self.assertIn("answer", response.text)
def test_create_chat_message_with_vision_model_by_remote_url(self):
files = [{
"type": "image",
"transfer_method": "remote_url",
"url": "your_image_url"
}]
response = self.chat_client.create_chat_message({}, "Describe the picture.", "test_user", files=files)
files = [
{"type": "image", "transfer_method": "remote_url", "url": "your_image_url"}
]
response = self.chat_client.create_chat_message(
{}, "Describe the picture.", "test_user", files=files
)
self.assertIn("answer", response.text)
def test_create_chat_message_with_vision_model_by_local_file(self):
files = [{
"type": "image",
"transfer_method": "local_file",
"upload_file_id": "your_file_id"
}]
response = self.chat_client.create_chat_message({}, "Describe the picture.", "test_user", files=files)
files = [
{
"type": "image",
"transfer_method": "local_file",
"upload_file_id": "your_file_id",
}
]
response = self.chat_client.create_chat_message(
{}, "Describe the picture.", "test_user", files=files
)
self.assertIn("answer", response.text)
def test_get_conversation_messages(self):
response = self.chat_client.get_conversation_messages("test_user", "your_conversation_id")
response = self.chat_client.get_conversation_messages(
"test_user", "your_conversation_id"
)
self.assertIn("answer", response.text)
def test_get_conversations(self):
@@ -194,28 +217,31 @@ class TestCompletionClient(unittest.TestCase):
self.completion_client = CompletionClient(API_KEY)
def test_create_completion_message(self):
response = self.completion_client.create_completion_message({"query": "What's the weather like today?"},
"blocking", "test_user")
response = self.completion_client.create_completion_message(
{"query": "What's the weather like today?"}, "blocking", "test_user"
)
self.assertIn("answer", response.text)
def test_create_completion_message_with_vision_model_by_remote_url(self):
files = [{
"type": "image",
"transfer_method": "remote_url",
"url": "your_image_url"
}]
files = [
{"type": "image", "transfer_method": "remote_url", "url": "your_image_url"}
]
response = self.completion_client.create_completion_message(
{"query": "Describe the picture."}, "blocking", "test_user", files)
{"query": "Describe the picture."}, "blocking", "test_user", files
)
self.assertIn("answer", response.text)
def test_create_completion_message_with_vision_model_by_local_file(self):
files = [{
"type": "image",
"transfer_method": "local_file",
"upload_file_id": "your_file_id"
}]
files = [
{
"type": "image",
"transfer_method": "local_file",
"upload_file_id": "your_file_id",
}
]
response = self.completion_client.create_completion_message(
{"query": "Describe the picture."}, "blocking", "test_user", files)
{"query": "Describe the picture."}, "blocking", "test_user", files
)
self.assertIn("answer", response.text)
@@ -224,7 +250,9 @@ class TestDifyClient(unittest.TestCase):
self.dify_client = DifyClient(API_KEY)
def test_message_feedback(self):
response = self.dify_client.message_feedback("your_message_id", 'like', "test_user")
response = self.dify_client.message_feedback(
"your_message_id", "like", "test_user"
)
self.assertIn("success", response.text)
def test_get_application_parameters(self):
@@ -237,9 +265,7 @@ class TestDifyClient(unittest.TestCase):
mime_type = "image/jpeg"
with open(file_path, "rb") as file:
files = {
"file": (file_name, file, mime_type)
}
files = {"file": (file_name, file, mime_type)}
response = self.dify_client.file_upload("test_user", files)
self.assertIn("name", response.text)