update cookbook

qingzhong1 · Dec 28, 2023 · d8f3d06 · d8f3d06
1 parent c25be5a
commit d8f3d06
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 19 deletions.
diff --git a/erniebot-agent/cookbook/langchain_function_agent_with_retrieval.ipynb b/erniebot-agent/cookbook/langchain_function_agent_with_retrieval.ipynb
@@ -17,7 +17,24 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 1. 导入第三方库\n",
+    "# 1. 使用langchain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pip install langchain"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 2. 导入第三方库\n",
     "\n",
     "主要是在导入一些必要的Python库和模块，以便实现FunctionAgentWithRetrival的功能。\n",
     "+ os: Python的标准库，用于与操作系统进行交互，如读写文件、管理路径等。\n",
@@ -58,9 +75,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 2. 预处理\n",
+    "# 3. 预处理\n",
     "\n",
-    "## 2.1 下载数据集"
+    "## 3.1 下载数据集"
    ]
   },
   {
@@ -107,7 +124,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 2.2 构建FaissSearch\n",
+    "## 3.2 构建FaissSearch\n",
     "这段代码定义了一个名为 FaissSearch 的类，用于在一个数据库中执行相似性搜索。这个类的主要功能是使用 FAISS (Facebook AI Similarity Search) 库或类似技术，对文档数据库进行高效的相似性搜索。它首先找到与查询最相似的文档，然后计算每个文档与查询的余弦相似度，最后返回包含内容、相似度得分和文档标题的搜索结果。"
    ]
   },
@@ -146,8 +163,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 3.FunctionAgentWithRetrieval\n",
-    "## 3.1 建索引库\n",
+    "# 4.FunctionAgentWithRetrieval\n",
+    "## 4.1 建索引库\n",
     "\n",
     "这段代码主要功能是用于创建或加载一个FAISS索引来进行文档相似度匹配。首先，创建一个ErnieEmbeddings对象，用于生成文档的嵌入向量。aistudio_access_token是访问AI Studio的令牌，chunk_size是用于嵌入的文档块的数量。"
    ]
@@ -199,7 +216,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "以下代码是使用FaissSearch进行搜索的一个例子，流程大致如下：\n",
+    "以下代码是使用FaissSearc进行搜索的一个例子，流程大致如下：\n",
     "1. 创建FaissSearch对象，并传入数据库对象db。\n",
     "2. 调用FaissSearch对象的search函数，并传入查询字符串\"城市管理执法主管部门的职责是什么？\"。\n",
     "3. 将搜索结果以格式化的形式进行打印，这里使用了pprint模块进行美化打印。最终的结果存储在变量res中。"
@@ -319,9 +336,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 3.2 构建FunctionAgentWithRetrieval\n",
+    "## 4.2 构建FunctionAgentWithRetrieval\n",
     "FunctionAgentWithRetrieval可以是否进行检索增强回答用户问题，以下是其示例。\n",
-    "### 3.2.1 检索增强"
+    "### 4.2.1 检索增强"
    ]
   },
   {
@@ -371,7 +388,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 3.2.2 调用tool示例\n",
+    "### 4.2.2 调用tool示例\n",
     "在这个例子中，FunctionAgentWithRetrieval没有利用其检索信息，而是直接调用工具回答用户的问题"
    ]
   },

diff --git a/erniebot-agent/cookbook/llama_index_function_agent_with_retrieval.ipynb b/erniebot-agent/cookbook/llama_index_function_agent_with_retrieval.ipynb
@@ -17,7 +17,24 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 1. 导入第三方库\n",
+    "# 1. 安装llama_index"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pip install llama-index"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 2. 导入第三方库\n",
     "\n",
     "主要是在导入一些必要的Python库和模块，以便实现FunctionAgentWithRetrival的功能。\n",
     "+ os: Python的标准库，用于与操作系统进行交互，如读写文件、管理路径等。\n",
@@ -71,9 +88,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 2. 预处理\n",
+    "# 3. 预处理\n",
     "\n",
-    "## 2.1 下载数据集"
+    "## 3.1 下载数据集"
    ]
   },
   {
@@ -117,7 +134,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 2.2 构建FaissSearch_lama\n",
+    "## 3.2 构建FaissSearch_lama\n",
     "这段代码定义了一个名为 FaissSearchLlamaIndex 的类，它使用 FAISS 库进行文档搜索。这个类使用 FAISS 来创建一个基于文档的向量存储索引，并提供了一个搜索方法来查询索引并返回最相关的文档。这种方法适用于需要快速且高效地处理大量高维向量数据的场景，如文本相似性搜索。"
    ]
   },
@@ -180,8 +197,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 3.FunctionAgentWithRetrieval\n",
-    "## 3.1 建索引库\n",
+    "# 4.FunctionAgentWithRetrieval\n",
+    "## 4.1 建索引库\n",
     "\n",
     "这段代码主要功能是用于创建或加载一个FAISS索引来进行文档相似度匹配。首先，创建一个ErnieEmbeddings对象，用于生成文档的嵌入向量。aistudio_access_token是访问AI Studio的令牌，chunk_size是用于嵌入的文档块的数量"
    ]
@@ -281,9 +298,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 3.2 构建FunctionAgentWithRetrieval\n",
+    "## 4.2 构建FunctionAgentWithRetrieval\n",
     "FunctionAgentWithRetrieval可以决定是否进行检索增强来回答用户问题，以下是其示例。\n",
-    "### 3.2.1 检索增强"
+    "### 4.2.1 检索增强"
    ]
   },
   {
@@ -333,7 +350,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 3.2.2 调用tool示例\n",
+    "### 4.2.2 调用tool示例\n",
     "在这个例子中，FunctionAgentWithRetrieval没有利用其检索信息，而是直接调用工具回答用户的问题"
    ]
   },