deploy: be8db4c

modelscope · May 6, 2024 · 6f887d8 · 6f887d8
1 parent e639a44
commit 6f887d8
Show file tree

Hide file tree

Showing 40 changed files with 2,128 additions and 23 deletions.
diff --git a/en/.doctrees/agentscope.models.doctree b/en/.doctrees/agentscope.models.doctree
diff --git a/en/.doctrees/agentscope.models.zhipu_model.doctree b/en/.doctrees/agentscope.models.zhipu_model.doctree
diff --git a/en/.doctrees/environment.pickle b/en/.doctrees/environment.pickle
diff --git a/en/.doctrees/index.doctree b/en/.doctrees/index.doctree
diff --git a/en/.doctrees/tutorial/203-model.doctree b/en/.doctrees/tutorial/203-model.doctree
diff --git a/en/.doctrees/tutorial/206-prompt.doctree b/en/.doctrees/tutorial/206-prompt.doctree
diff --git a/en/_modules/agentscope/models.html b/en/_modules/agentscope/models.html
@@ -132,6 +132,10 @@ <h1>Source code for agentscope.models</h1><div class="highlight"><pre>
     <span class="n">GeminiChatWrapper</span><span class="p">,</span>
     <span class="n">GeminiEmbeddingWrapper</span><span class="p">,</span>
 <span class="p">)</span>
+<span class="kn">from</span> <span class="nn">.zhipu_model</span> <span class="kn">import</span> <span class="p">(</span>
+    <span class="n">ZhipuAIChatWrapper</span><span class="p">,</span>
+    <span class="n">ZhipuAIEmbeddingWrapper</span><span class="p">,</span>
+<span class="p">)</span>
 
 
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
@@ -152,6 +156,8 @@ <h1>Source code for agentscope.models</h1><div class="highlight"><pre>
     <span class="s2">&quot;OllamaGenerationWrapper&quot;</span><span class="p">,</span>
     <span class="s2">&quot;GeminiChatWrapper&quot;</span><span class="p">,</span>
     <span class="s2">&quot;GeminiEmbeddingWrapper&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;ZhipuAIChatWrapper&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;ZhipuAIEmbeddingWrapper&quot;</span><span class="p">,</span>
     <span class="s2">&quot;load_model_by_config_name&quot;</span><span class="p">,</span>
     <span class="s2">&quot;read_model_configs&quot;</span><span class="p">,</span>
     <span class="s2">&quot;clear_model_configs&quot;</span><span class="p">,</span>

diff --git a/en/_modules/agentscope/models/zhipu_model.html b/en/_modules/agentscope/models/zhipu_model.html
diff --git a/en/_modules/index.html b/en/_modules/index.html
@@ -118,6 +118,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="agentscope/models/openai_model.html">agentscope.models.openai_model</a></li>
 <li><a href="agentscope/models/post_model.html">agentscope.models.post_model</a></li>
 <li><a href="agentscope/models/response.html">agentscope.models.response</a></li>
+<li><a href="agentscope/models/zhipu_model.html">agentscope.models.zhipu_model</a></li>
 </ul><li><a href="agentscope/msghub.html">agentscope.msghub</a></li>
 <li><a href="agentscope/parsers/code_block_parser.html">agentscope.parsers.code_block_parser</a></li>
 <li><a href="agentscope/parsers/json_object_parser.html">agentscope.parsers.json_object_parser</a></li>

diff --git a/en/_sources/agentscope.models.zhipu_model.rst.txt b/en/_sources/agentscope.models.zhipu_model.rst.txt
@@ -0,0 +1,6 @@
+agentscope.models.zhipu_model
+=============================
+.. automodule:: agentscope.models.zhipu_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/en/_sources/tutorial/203-model.md.txt b/en/_sources/tutorial/203-model.md.txt
@@ -14,6 +14,7 @@ Currently, AgentScope supports the following model service APIs:
 - OpenAI API, including chat, image generation (DALL-E), and Embedding.
 - DashScope API, including chat, image sythesis and text embedding.
 - Gemini API, including chat and embedding.
+- ZhipuAI API, including chat and embedding.
 - Ollama API, including chat, embedding and generation.
 - Post Request API, model inference services based on Post
   requests, including Huggingface/ModelScope Inference API and various
@@ -81,6 +82,8 @@ In the current AgentScope, the supported `model_type` types, the corresponding
 |                        | Multimodal      | [`DashScopeMultiModalWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/dashscope_model.py)     | `"dashscope_multimodal"`      | qwen-vl-plus, qwen-vl-max, qwen-audio-turbo, ... |
 | Gemini API             | Chat            | [`GeminiChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/gemini_model.py)                 | `"gemini_chat"`               | gemini-pro, ...                                  |
 |                        | Embedding       | [`GeminiEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/gemini_model.py)            | `"gemini_embedding"`          | models/embedding-001, ...                        |
+| ZhipuAI API             | Chat            | [`ZhipuAIChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/zhipu_model.py)                 | `"zhipuai_chat"`               | glm4, ...                                  |
+|                        | Embedding       | [`ZhipuAIEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/zhipu_model.py)            | `"zhipuai_embedding"`          | embedding-2, ...                        |
 | ollama                 | Chat            | [`OllamaChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)                 | `"ollama_chat"`               | llama2, ...                                      |
 |                        | Embedding       | [`OllamaEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)            | `"ollama_embedding"`          | llama2, ...                                      |
 |                        | Generation      | [`OllamaGenerationWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)           | `"ollama_generate"`           | llama2, ...                                      |
@@ -303,6 +306,48 @@ Here we provide example configurations for different model wrappers.
 
 <br/>
 
+
+#### ZhipuAI API
+
+<details>
+<summary>ZhipuAI Chat API (<code><a href="https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/zhipu_model.py">agentscope.models.ZhipuAIChatWrapper</a></code>)</summary>
+
+```python
+{
+    "config_name": "my_zhipuai_chat_config",
+    "model_type": "zhipuai_chat",
+
+    # Required parameters
+    "model_name": "{model_name}",               # The model name in ZhipuAI API, e.g. glm-4
+
+    # Optional parameters
+    "api_key": "{your_api_key}"
+}
+```
+
+</details>
+
+<details>
+<summary>ZhipuAI Embedding API (<code><a href="https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/zhipu_model.py">agentscope.models.ZhipuAIEmbeddingWrapper</a></code>)</summary>
+
+```python
+{
+    "config_name": "my_zhipuai_embedding_config",
+    "model_type": "zhipuai_embedding",
+
+    # Required parameters
+    "model_name": "{model_name}",               # The model name in ZhipuAI API, e.g. embedding-2
+
+    # Optional parameters
+    "api_key": "{your_api_key}",
+}
+```
+
+</details>
+
+<br/>
+
+
 #### Ollama API
 
 <details>

diff --git a/en/_sources/tutorial/206-prompt.md.txt b/en/_sources/tutorial/206-prompt.md.txt
@@ -44,6 +44,7 @@ generation model APIs.
 - [OllamaChatWrapper](#ollamachatwrapper)
 - [OllamaGenerationWrapper](#ollamagenerationwrapper)
 - [GeminiChatWrapper](#geminichatwrapper)
+- [ZhipuAIChatWrapper](#zhipuaichatwrapper)
 
 These strategies are implemented in the `format` functions of the model
 wrapper classes.
@@ -365,6 +366,47 @@ print(prompt)
 ]
 ```
 
+### `ZhipuAIChatWrapper`
+
+`ZhipuAIChatWrapper` encapsulates the ZhipuAI chat API, which takes a list of messages as input. The message must obey the following rules:
+
+- Require `role` and `content` fields, and `role` must be either `"user"`
+  `"system"` or `"assistant"`.
+- There must be at least one `user` message.
+
+#### Prompt Strategy
+
+If the role field of the first message is `"system"`, it will be converted into a single message with the `role` field as `"system"` and the `content` field as the system message. The rest of the messages will be converted into a message with the `role` field as `"user"` and the `content` field as the dialogue history.
+
+An example is shown below:
+
+```python
+from agentscope.models import ZhipuAIChatWrapper
+from agentscope.message import Msg
+
+model = ZhipuAIChatWrapper(
+    config_name="", # empty since we directly initialize the model wrapper
+    model_name="glm-4",
+    api_key="your api key",
+)
+
+prompt = model.format(
+   Msg("system", "You're a helpful assistant", role="system"),   # Msg object
+   [                                                             # a list of Msg objects
+      Msg(name="Bob", content="Hi!", role="assistant"),
+      Msg(name="Alice", content="Nice to meet you!", role="assistant"),
+   ],
+)
+print(prompt)
+```
+
+```bash
+[
+  {"role": "system", "content": "You are a helpful assistant"},
+  {"role": "user", "content": "## Dialogue History\nBob: Hi!\nAlice: Nice to meet you!"},
+]
+```
+
 ## Prompt Engine (Will be deprecated in the future)
 
 AgentScope provides the `PromptEngine` class to simplify the process of crafting