219 lines
17 KiB
Markdown
219 lines
17 KiB
Markdown
|
## FunctionDef search_knowledge_base_iter(database, query)
|
|||
|
|
**search_knowledge_base_iter**: 该函数用于异步迭代地搜索知识库并获取相关回答。
|
|||
|
|
|
|||
|
|
**参数**:
|
|||
|
|
- `database`: 知识库的名称，类型为字符串。
|
|||
|
|
- `query`: 用户的查询语句，类型为字符串。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
`search_knowledge_base_iter` 函数是一个异步函数，它接收两个参数：`database` 和 `query`。这个函数首先调用 `knowledge_base_chat` 函数，向指定的知识库发送查询请求，并设置了一系列参数，如模型名称、温度值、历史记录、向量搜索的 top_k 值、最大 token 数、提示名称、分数阈值以及是否以流的形式输出。这些参数的设置是为了精确控制知识库搜索和回答生成的行为。
|
|||
|
|
|
|||
|
|
函数内部，通过异步迭代 `response.body_iterator`，处理每一块返回的数据。每一块数据被假定为一个 JSON 字符串，其中包含了回答和相关文档的信息。函数解析这些 JSON 数据，提取出回答内容，并将它们拼接起来。同时，也会处理相关文档的信息，但在当前代码实现中，文档信息 (`docs`) 被提取出来之后并没有被进一步使用。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- 在使用此函数时，需要确保 `database` 参数指定的知识库存在，否则可能无法正常获取回答。
|
|||
|
|
- 由于函数内部涉及异步操作，调用此函数时需要使用 `await` 关键字。
|
|||
|
|
- 函数返回的是拼接后的回答内容，如果需要获取更详细的信息（如相关文档信息），可能需要对函数进行适当的修改。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
调用 `search_knowledge_base_iter` 函数可能返回的示例：
|
|||
|
|
```json
|
|||
|
|
"这是根据您的查询生成的回答。"
|
|||
|
|
```
|
|||
|
|
这个输出示例仅展示了回答内容的一部分。实际返回的回答内容将根据查询语句和知识库的内容而有所不同。
|
|||
|
|
## ClassDef LLMKnowledgeChain
|
|||
|
|
Doc is waiting to be generated...
|
|||
|
|
### ClassDef Config
|
|||
|
|
**Config**: Config 类的功能是定义一个严格的配置对象模型。
|
|||
|
|
|
|||
|
|
**属性**:
|
|||
|
|
- `extra`: 控制额外字段的处理方式。
|
|||
|
|
- `arbitrary_types_allowed`: 允许使用任意类型的字段。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
Config 类是一个配置对象，它使用 Pydantic 库来定义。Pydantic 是一个数据验证和设置管理的库，它允许开发者以标准的Python类型提示方式来定义数据结构，同时提供强大的数据验证功能。
|
|||
|
|
|
|||
|
|
在这个 Config 类中，有两个关键的配置项被设置：
|
|||
|
|
|
|||
|
|
1. `extra = Extra.forbid`：这个设置指定了如果传入的数据包含了模型未声明的字段，则会抛出错误。这是一种严格的数据验证方式，确保了数据对象的纯净性和一致性，防止了意外的数据被接受进来。
|
|||
|
|
|
|||
|
|
2. `arbitrary_types_allowed = True`：这个设置允许模型字段使用任意类型。默认情况下，Pydantic 要求所有的字段类型都是标准的Python类型或者是 Pydantic 定义的类型。通过启用这个选项，开发者可以使用更加灵活的类型定义，比如自定义类或者其他复杂的数据结构。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- 使用 Config 类时，需要注意数据的严格性和类型的灵活性之间的平衡。虽然允许任意类型可以提供更大的灵活性，但也可能增加数据处理的复杂性。
|
|||
|
|
- 在实际应用中，应当根据具体需求来决定是否启用 `arbitrary_types_allowed` 选项。如果项目中使用了大量自定义类型，那么启用这个选项可能是有益的。反之，如果项目主要使用标准类型，可能不需要启用这个选项。
|
|||
|
|
- `extra = Extra.forbid` 的设置使得 Config 类非常适合用于需要高数据一致性和安全性的场景。开发者应当在设计API或数据交互接口时考虑到这一点。
|
|||
|
|
***
|
|||
|
|
### FunctionDef raise_deprecation(cls, values)
|
|||
|
|
**raise_deprecation**: 此函数的功能是在使用已弃用的方式实例化LLMKnowledgeChain时发出警告，并在适当的情况下自动转换为推荐的实例化方式。
|
|||
|
|
|
|||
|
|
**参数**:
|
|||
|
|
- `cls`: 类方法的第一个参数，指代当前类。
|
|||
|
|
- `values`: 一个字典，包含实例化LLMKnowledgeChain时传入的参数。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
此函数检查`values`字典中是否包含键`llm`。如果存在，首先会发出一个警告，提示用户直接使用`llm`参数实例化LLMKnowledgeChain已被弃用，并建议使用`llm_chain`参数或`from_llm`类方法进行实例化。接着，如果`values`中不存在`llm_chain`键且`llm`键对应的值不为`None`，函数会从`values`中获取`prompt`键的值（如果不存在，则使用默认提示`PROMPT`），并使用`llm`和`prompt`的值创建一个`LLMChain`实例，将其赋值给`values`字典中的`llm_chain`键。最后，函数返回更新后的`values`字典。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- 使用此函数时，应确保传入的`values`字典中的`llm`键（如果存在）对应的值是预期的，因为该函数会基于该值创建`LLMChain`实例。
|
|||
|
|
- 调用此函数后，应检查返回的`values`字典，以确认是否已按照推荐方式更新了实例化参数。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
假设传入的`values`字典为`{"llm": some_llm_object, "prompt": "Example prompt"}`，且`PROMPT`为默认提示，则函数可能返回的`values`字典为：
|
|||
|
|
```
|
|||
|
|
{
|
|||
|
|
"llm": some_llm_object,
|
|||
|
|
"prompt": "Example prompt",
|
|||
|
|
"llm_chain": LLMChain(llm=some_llm_object, prompt="Example prompt")
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
在这个示例中，`llm_chain`键被添加到字典中，其值为一个使用`some_llm_object`和`"Example prompt"`实例化的`LLMChain`对象。
|
|||
|
|
***
|
|||
|
|
### FunctionDef input_keys(self)
|
|||
|
|
**input_keys**: 此函数的功能是返回一个包含单个输入键的列表。
|
|||
|
|
|
|||
|
|
**参数**: 此函数没有参数。
|
|||
|
|
|
|||
|
|
**函数描述**: `input_keys` 函数是一个私有方法，设计用于内部使用，不建议在类的外部直接调用。它的主要作用是提供一个包含单个元素的列表，该元素是此实例的 `input_key` 属性值。这个方法的存在可能是为了与其他需要返回多个键的方法保持一致的接口，或者为了将来的扩展保留空间。
|
|||
|
|
|
|||
|
|
**注意**: 由于此方法被标记为私有（通过 `:meta private:` 注释），它主要用于类的内部逻辑，而不是作为类的公共接口的一部分。因此，在类的外部调用此方法时应当谨慎，因为它的行为或签名在未来的版本中可能会改变，而不会有任何向后兼容性的保证。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
```python
|
|||
|
|
['example_input_key']
|
|||
|
|
```
|
|||
|
|
在这个示例中，假设实例的 `input_key` 属性被设置为 `'example_input_key'`，那么调用 `input_keys` 方法将会返回一个只包含字符串 `'example_input_key'` 的列表。
|
|||
|
|
***
|
|||
|
|
### FunctionDef output_keys(self)
|
|||
|
|
**output_keys**: 此函数的功能是返回一个包含输出键的列表。
|
|||
|
|
|
|||
|
|
**参数**: 此函数没有参数。
|
|||
|
|
|
|||
|
|
**代码描述**: `output_keys`函数是`LLMKnowledgeChain`类的一个方法，它被标记为私有方法，意味着它主要供类内部使用，而不是设计给外部调用。此方法的目的是提供一个包含单个输出键的列表。这里的`self.output_key`是`LLMKnowledgeChain`类的一个属性，此方法通过将该属性包装在列表中返回，提供了对输出键的访问。这种设计允许将来的扩展性，例如，如果需要返回多个输出键，可以在不改变方法签名的情况下进行调整。
|
|||
|
|
|
|||
|
|
**注意**: 由于此方法被标记为私有（通过`:meta private:`标记），它主要用于类的内部逻辑，不建议在类的外部直接调用此方法。在使用时应注意，尽管它目前返回的是单个输出键的列表，但设计上允许返回多个键，这意味着在处理返回值时应考虑到可能的未来变化。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
```python
|
|||
|
|
['output_key_value']
|
|||
|
|
```
|
|||
|
|
在这个示例中，`output_key_value`代表`self.output_key`属性的值。实际的值将取决于`LLMKnowledgeChain`实例在其生命周期中对`self.output_key`属性的赋值。
|
|||
|
|
***
|
|||
|
|
### FunctionDef _evaluate_expression(self, dataset, query)
|
|||
|
|
**_evaluate_expression**: 该函数的功能是基于给定的数据集和查询语句，异步搜索知识库并返回搜索结果。
|
|||
|
|
|
|||
|
|
**参数**:
|
|||
|
|
- `dataset`: 数据集名称，类型为字符串。它指定了要搜索的知识库。
|
|||
|
|
- `query`: 查询语句，类型为字符串。它是用户希望在知识库中搜索的问题或关键词。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
`_evaluate_expression` 函数首先尝试调用 `search_knowledge_base_iter` 函数，以异步方式搜索知识库。该函数接收两个参数：`dataset` 和 `query`，分别代表知识库的名称和用户的查询语句。如果搜索成功，`search_knowledge_base_iter` 函数将返回搜索到的结果；如果在搜索过程中遇到任何异常（例如，知识库不存在或查询语句有误），则会捕获这些异常，并将输出设置为“输入的信息有误或不存在知识库”。最终，函数返回搜索结果或错误信息。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- 在调用此函数之前，需要确保提供的 `dataset`（知识库名称）是存在的，否则可能会导致搜索失败。
|
|||
|
|
- 由于 `search_knowledge_base_iter` 是一个异步函数，`_evaluate_expression` 函数内部使用了 `asyncio.run` 来运行它。这意味着 `_evaluate_expression` 函数本身是同步的，但它内部执行了异步操作。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
调用 `_evaluate_expression` 函数可能返回的示例：
|
|||
|
|
```
|
|||
|
|
"这是根据您的查询生成的回答。"
|
|||
|
|
```
|
|||
|
|
这个示例展示了一个简单的回答内容。实际返回的内容将根据查询语句和知识库的内容而有所不同。如果遇到错误，可能会返回：
|
|||
|
|
```
|
|||
|
|
"输入的信息有误或不存在知识库"
|
|||
|
|
```
|
|||
|
|
这表示提供的信息有误，或者指定的知识库不存在。
|
|||
|
|
***
|
|||
|
|
### FunctionDef _process_llm_result(self, llm_output, llm_input, run_manager)
|
|||
|
|
**_process_llm_result**: 此函数的功能是处理语言模型的输出结果，并返回格式化的答案。
|
|||
|
|
|
|||
|
|
**参数**:
|
|||
|
|
- `llm_output`: 字符串类型，表示语言模型的原始输出。
|
|||
|
|
- `llm_input`: 字符串类型，表示传递给语言模型的原始输入。
|
|||
|
|
- `run_manager`: `CallbackManagerForChainRun`类型，用于管理回调函数的执行。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
`_process_llm_result` 函数首先通过 `run_manager` 的 `on_text` 方法以绿色文本输出语言模型的原始输出，并设置是否详细输出。接着，函数尝试通过正则表达式匹配输出中的文本块。如果匹配成功，将提取文本块内容，并调用 `_evaluate_expression` 函数处理这部分内容和原始输入，生成最终的答案。如果原始输出以 "Answer:" 开头，或包含 "Answer:"，则直接将其作为答案。如果以上条件都不满足，则返回一个错误信息，指出输入格式不正确。最后，函数返回一个字典，包含处理后的答案或错误信息。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- `_process_llm_result` 函数依赖于 `_evaluate_expression` 函数来处理提取的文本块内容。因此，确保 `_evaluate_expression` 函数能正确执行是使用此函数的前提。
|
|||
|
|
- 此函数处理的输出格式特定于语言模型的输出结构，因此在不同的模型输出中可能需要调整正则表达式或处理逻辑。
|
|||
|
|
- 函数返回的字典中包含的键由 `self.output_key` 决定，这意味着在使用此函数之前，需要确保 `self.output_key` 已经被正确设置。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
调用 `_process_llm_result` 函数可能返回的示例之一：
|
|||
|
|
```
|
|||
|
|
{"output_key": "Answer: 这是根据您的查询生成的回答。"}
|
|||
|
|
```
|
|||
|
|
如果输入的格式不正确，可能会返回：
|
|||
|
|
```
|
|||
|
|
{"output_key": "输入的格式不对: 原始语言模型输出内容"}
|
|||
|
|
```
|
|||
|
|
这个示例展示了函数如何根据不同的情况返回不同的处理结果。实际返回的内容将根据语言模型的输出和输入的处理逻辑而有所不同。
|
|||
|
|
***
|
|||
|
|
### FunctionDef _aprocess_llm_result(self, llm_output, run_manager)
|
|||
|
|
Doc is waiting to be generated...
|
|||
|
|
***
|
|||
|
|
### FunctionDef _call(self, inputs, run_manager)
|
|||
|
|
Doc is waiting to be generated...
|
|||
|
|
***
|
|||
|
|
### FunctionDef _acall(self, inputs, run_manager)
|
|||
|
|
Doc is waiting to be generated...
|
|||
|
|
***
|
|||
|
|
### FunctionDef _chain_type(self)
|
|||
|
|
**函数名称**: _chain_type
|
|||
|
|
|
|||
|
|
**函数功能**: 返回链类型的字符串表示。
|
|||
|
|
|
|||
|
|
**参数**: 此函数没有参数。
|
|||
|
|
|
|||
|
|
**代码描述**: `_chain_type`函数是`LLMKnowledgeChain`类的一个私有方法，用于返回表示链类型的字符串。在这个上下文中，链类型被固定定义为`"llm_knowledge_chain"`，这意味着该函数返回的字符串用于标识或表示一个基于长期记忆模型（Long-term Language Model，LLM）的知识链。这种类型的知识链可能涉及到使用大型语言模型来处理和链接知识库中的信息。由于这是一个私有方法，它主要用于`LLMKnowledgeChain`类内部，可能用于日志记录、调试或者在类的其他方法中区分处理不同类型的知识链。
|
|||
|
|
|
|||
|
|
**注意**: 由于`_chain_type`是一个私有方法，它不应该直接从类的实例外部调用。它的设计初衷是为了类内部使用，以提供一种一致的方式来引用链类型。如果需要在类外部获取链类型信息，应该通过类提供的公共接口或方法来实现。
|
|||
|
|
|
|||
|
|
**输出示例**: 调用`_chain_type`方法将返回字符串`"llm_knowledge_chain"`。
|
|||
|
|
***
|
|||
|
|
### FunctionDef from_llm(cls, llm, prompt)
|
|||
|
|
**from_llm**: 此函数的功能是从语言模型创建一个知识链对象。
|
|||
|
|
|
|||
|
|
**参数**:
|
|||
|
|
- `cls`: 类方法的传统参数，表示要实例化的类本身。
|
|||
|
|
- `llm`: `BaseLanguageModel`类型，代表要使用的语言模型。
|
|||
|
|
- `prompt`: `BasePromptTemplate`类型，默认为`PROMPT`，代表用于语言模型的提示模板。
|
|||
|
|
- `**kwargs`: 接受任意额外的关键字参数，这些参数将传递给`LLMKnowledgeChain`的构造函数。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
`from_llm`函数是`LLMKnowledgeChain`类的一个类方法，它接受一个语言模型实例`llm`和一个可选的提示模板`prompt`作为输入。此函数首先使用提供的语言模型和提示模板创建一个`LLMChain`实例。然后，它使用这个`LLMChain`实例和任何其他提供的关键字参数来创建并返回一个`LLMKnowledgeChain`实例。这个过程允许`LLMKnowledgeChain`对象直接从一个语言模型实例化，简化了使用语言模型进行知识搜索和处理的流程。
|
|||
|
|
|
|||
|
|
在项目中，`from_llm`函数被`search_knowledgebase_once`函数调用。在这个调用中，`model`（一个语言模型实例）和`PROMPT`（一个提示模板）被传递给`from_llm`，同时还传递了`verbose=True`作为关键字参数。这表明在创建`LLMKnowledgeChain`实例时，会启用详细模式。然后，`search_knowledgebase_once`函数使用返回的`LLMKnowledgeChain`实例来执行对给定查询的搜索，展示了如何在实际应用中利用`from_llm`方法来处理和搜索知识。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- 确保传递给`from_llm`的`llm`参数是一个有效的`BaseLanguageModel`实例，以保证知识链的正确构建和操作。
|
|||
|
|
- 在使用`**kwargs`传递额外参数时，应确保这些参数是`LLMKnowledgeChain`构造函数所支持的，以避免运行时错误。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
由于`from_llm`返回的是一个`LLMKnowledgeChain`实例，因此输出示例将取决于`LLMKnowledgeChain`类的具体实现和初始化时传递的参数。假设`LLMKnowledgeChain`有一个方法`run`，可以接受一个查询并返回相关的答案，一个可能的使用示例可能如下：
|
|||
|
|
```python
|
|||
|
|
llm_knowledge_chain = LLMKnowledgeChain.from_llm(model, prompt=PROMPT, verbose=True)
|
|||
|
|
answer = llm_knowledge_chain.run("这是一个查询示例")
|
|||
|
|
print(answer) # 输出将展示查询的答案
|
|||
|
|
```
|
|||
|
|
***
|
|||
|
|
## FunctionDef search_knowledgebase_once(query)
|
|||
|
|
Doc is waiting to be generated...
|
|||
|
|
## ClassDef KnowledgeSearchInput
|
|||
|
|
**KnowledgeSearchInput**: KnowledgeSearchInput类的功能是定义一个搜索知识库的输入模型。
|
|||
|
|
|
|||
|
|
**属性**:
|
|||
|
|
- location: 表示要搜索的查询字符串。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
KnowledgeSearchInput类继承自BaseModel，这表明它是一个模型类，用于定义数据结构。在这个类中，定义了一个名为`location`的属性，该属性用于存储要在知识库中搜索的查询字符串。通过使用`Field`函数，为`location`属性提供了描述信息，即"The query to be searched"，这有助于理解该属性的用途。
|
|||
|
|
|
|||
|
|
此类在项目中的作用是作为搜索知识库操作的输入数据模型。它通过定义必要的输入字段（在本例中为查询位置），使得其他部分的代码可以构建基于这些输入的搜索请求。尽管在提供的信息中没有直接的调用示例，但可以推断，该类的实例将被创建并填充相应的搜索查询，然后传递给执行搜索操作的函数或方法。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- 在使用KnowledgeSearchInput类时，需要确保`location`属性被正确赋值，因为它是执行搜索操作所必需的。
|
|||
|
|
- 由于这个类继承自BaseModel，可以利用Pydantic库提供的数据验证功能来确保输入数据的有效性。例如，如果有特定格式或值范围的要求，可以通过修改Field函数的参数来实现。
|
|||
|
|
- 在实际应用中，可能需要根据知识库的具体结构和搜索需求，对KnowledgeSearchInput类进行扩展，添加更多的属性和验证逻辑。
|