fix: video example, remove finetuning\knowledge\document module (#17)

Co-authored-by: zhengweijun <[email protected]>

Author: wellenzheng

.env

@@ -1,2 +1,2 @@
 PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring
-ZAI_API_KEY={your apikey}
+ZAI_API_KEY={your apikey}

examples/basic_usage.py

@@ -180,11 +180,12 @@ def ofZhipu():
 
 if __name__ == '__main__':
     # completion()
-	# completion_with_websearch()
-	# multi_modal_chat()
-	# role_play()
-	# assistant_conversation()
-	# video_generation()
-    ofZai()
-    ofZhipu()
+    # completion_with_stream()
+    # completion_with_websearch()
+    multi_modal_chat()
+    # role_play()
+    # assistant_conversation()
+    # video_generation()
+    # ofZai()
+    # ofZhipu()
 

examples/function_call_example.py

@@ -0,0 +1,120 @@
+from zai import ZhipuAiClient
+import json
+client = ZhipuAiClient()
+
+def get_flight_number(date: str, departure: str, destination: str):
+    flight_number = {
+        "Beijing": {
+            "Shanghai": "1234",
+            "Guangzhou": "5678",
+        },
+        "Shanghai": {
+            "Beijing": "4321",
+            "Guangzhou": "8765",
+        }
+    }
+    return {"flight_number": flight_number[departure][destination]}
+
+def get_ticket_price(date: str, flight_number: str):
+    return {"ticket_price": "1000"}
+
+def parse_function_call(model_response, messages):
+    # Handle function call results. According to the model's returned parameters, call the corresponding function.
+    # After getting the function result, construct a tool message and call the model again, passing the function result as input.
+    # The model will return the function result to the user in natural language.
+    if model_response.choices[0].message.tool_calls:
+        tool_call = model_response.choices[0].message.tool_calls[0]
+        args = tool_call.function.arguments
+        function_result = {}
+        if tool_call.function.name == "get_flight_number":
+            function_result = get_flight_number(**json.loads(args))
+        if tool_call.function.name == "get_ticket_price":
+            function_result = get_ticket_price(**json.loads(args))
+        messages.append({
+            "role": "tool",
+            "content": f"{json.dumps(function_result)}",
+            "tool_call_id": tool_call.id
+        })
+        response = client.chat.completions.create(
+            model="glm-4",  # Specify the model name to use
+            messages=messages,
+            tools=tools,
+        )
+        print(response.choices[0].message)
+        messages.append(response.choices[0].message.model_dump())
+
+messages = []
+tools = [
+    {
+        "type": "function",
+        "function": {
+            "name": "get_flight_number",
+            "description": "Query the flight number for a given date, departure, and destination",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "departure": {
+                        "description": "Departure city",
+                        "type": "string"
+                    },
+                    "destination": {
+                        "description": "Destination city",
+                        "type": "string"
+                    },
+                    "date": {
+                        "description": "Date",
+                        "type": "string",
+                    }
+                },
+                "required": ["departure", "destination", "date"]
+            },
+        }
+    },
+    {
+        "type": "function",
+        "function": {
+            "name": "get_ticket_price",
+            "description": "Query the ticket price for a specific flight on a specific date",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "flight_number": {
+                        "description": "Flight number",
+                        "type": "string"
+                    },
+                    "date": {
+                        "description": "Date",
+                        "type": "string",
+                    }
+                },
+                "required": ["flight_number", "date"]
+            },
+        }
+    },
+]
+
+# Clear conversation
+messages = []
+messages.append({"role": "system", "content": "Do not assume or guess the values of function parameters. If the user's description is unclear, ask the user to provide the necessary information."})
+messages.append({"role": "user", "content": "Help me check the flights from Beijing to Guangzhou on January 23."})
+
+response = client.chat.completions.create(
+    model="glm-4",  # Specify the model name to use
+    messages=messages,
+    tools=tools,
+)
+print(response.choices[0].message)
+messages.append(response.choices[0].message.model_dump())
+
+parse_function_call(response, messages)
+
+messages.append({"role": "user", "content": "What is the price of flight 8321?"})
+response = client.chat.completions.create(
+    model="glm-4",  # Specify the model name to use
+    messages=messages,
+    tools=tools,
+)
+print(response.choices[0].message)
+messages.append(response.choices[0].message.model_dump())
+
+parse_function_call(response, messages)

examples/glm4_example.py

@@ -29,7 +29,7 @@ def stream_web_search_example():
         stream=True
     )
     for chunk in response:
-        print(chunk.choices[0].delta)
+        print(chunk.choices[0].delta.content, end="", flush=True)
 
 def sync_example():
     print("=== GLM-4 Synchronous Example ===")

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zai-sdk"
-version = "0.0.1b3"
+version = "0.0.1b4"
 description = "A SDK library for accessing big model apis from Z.ai"
 authors = ["Z.ai"]
 readme = "README.md"

src/zai/_client.py

@@ -16,9 +16,7 @@
 	from zai.api_resource.chat import Chat
 	from zai.api_resource.embeddings import Embeddings
 	from zai.api_resource.files import Files
-	from zai.api_resource.fine_tuning import FineTuning
 	from zai.api_resource.images import Images
-	from zai.api_resource.knowledge import Knowledge
 	from zai.api_resource.moderations import Moderations
 	from zai.api_resource.tools import Tools
 	from zai.api_resource.videos import Videos
@@ -132,24 +130,12 @@ def embeddings(self) -> Embeddings:
 
 		return Embeddings(self)
 
-	@cached_property
-	def fine_tuning(self) -> FineTuning:
-		from zai.api_resource.fine_tuning import FineTuning
-
-		return FineTuning(self)
-
 	@cached_property
 	def batches(self) -> Batches:
 		from zai.api_resource.batch import Batches
 
 		return Batches(self)
 
-	@cached_property
-	def knowledge(self) -> Knowledge:
-		from zai.api_resource.knowledge import Knowledge
-
-		return Knowledge(self)
-
 	@cached_property
 	def tools(self) -> Tools:
 		from zai.api_resource.tools import Tools

src/zai/_version.py

@@ -1,2 +1,2 @@
 __title__ = 'Z.ai'
-__version__ = '0.0.1b2'
+__version__ = '0.0.1b4'

src/zai/api_resource/__init__.py

@@ -11,9 +11,7 @@
 )
 from .embeddings import Embeddings
 from .files import Files, FilesWithRawResponse
-from .fine_tuning import FineTuning
 from .images import Images
-from .knowledge import Knowledge
 from .moderations import Moderations
 from .tools import Tools
 from .videos import (
@@ -30,9 +28,7 @@
 	'Embeddings',
 	'Files',
 	'FilesWithRawResponse',
-	'FineTuning',
 	'Batches',
-	'Knowledge',
 	'Tools',
 	'Assistant',
 	'Audio',