55 lines
4.2 KiB
Markdown
55 lines
4.2 KiB
Markdown
|
## ClassDef KnowledgeBaseModel
|
|||
|
|
**KnowledgeBaseModel**: KnowledgeBaseModel 类的功能是定义知识库的数据模型，用于在数据库中存储和管理知识库的相关信息。
|
|||
|
|
|
|||
|
|
**属性**:
|
|||
|
|
- `id`: 知识库ID，是每个知识库的唯一标识。
|
|||
|
|
- `kb_name`: 知识库名称，用于标识和检索特定的知识库。
|
|||
|
|
- `kb_info`: 知识库简介，提供关于知识库的基本信息，用于Agent。
|
|||
|
|
- `vs_type`: 向量库类型，指定知识库使用的向量库的类型。
|
|||
|
|
- `embed_model`: 嵌入模型名称，指定用于知识库的嵌入模型。
|
|||
|
|
- `file_count`: 文件数量，记录知识库中包含的文件数目。
|
|||
|
|
- `create_time`: 创建时间，记录知识库被创建的时间。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
KnowledgeBaseModel 类继承自 Base 类，是一个ORM模型，用于映射数据库中的 `knowledge_base` 表。该类定义了知识库的基本属性，包括知识库ID、名称、简介、向量库类型、嵌入模型名称、文件数量和创建时间。通过这些属性，可以在数据库中有效地存储和管理知识库的相关信息。
|
|||
|
|
|
|||
|
|
在项目中，KnowledgeBaseModel 类被多个函数调用，以实现对知识库的增删查改操作。例如，在 `add_kb_to_db` 函数中，使用KnowledgeBaseModel 来创建新的知识库实例或更新现有知识库的信息。在 `list_kbs_from_db` 函数中，通过查询KnowledgeBaseModel 来获取满足特定条件的知识库列表。此外，`kb_exists`、`load_kb_from_db`、`delete_kb_from_db` 和 `get_kb_detail` 等函数也都涉及到对KnowledgeBaseModel 类的操作，以实现检查知识库是否存在、加载知识库信息、删除知识库和获取知识库详细信息等功能。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
在使用KnowledgeBaseModel 类进行数据库操作时，需要注意确保传入的参数类型和值符合定义的属性类型和业务逻辑要求，以避免数据类型错误或逻辑错误。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
假设数据库中有一个知识库实例，其属性值如下：
|
|||
|
|
```
|
|||
|
|
<KnowledgeBase(id='1', kb_name='技术文档库', kb_intro='存储技术相关文档', vs_type='ElasticSearch', embed_model='BERT', file_count='100', create_time='2023-04-01 12:00:00')>
|
|||
|
|
```
|
|||
|
|
这表示有一个ID为1的知识库，名称为“技术文档库”，简介为“存储技术相关文档”，使用的向量库类型为ElasticSearch，嵌入模型为BERT，包含100个文件，创建时间为2023年4月1日12点。
|
|||
|
|
### FunctionDef __repr__(self)
|
|||
|
|
**__repr__**: __repr__函数的功能是提供KnowledgeBaseModel对象的官方字符串表示。
|
|||
|
|
|
|||
|
|
**参数**: 此函数没有接受额外参数，它仅使用self来访问对象的属性。
|
|||
|
|
|
|||
|
|
**代码描述**:
|
|||
|
|
`__repr__`方法定义在KnowledgeBaseModel类中，用于生成该对象的官方字符串表示。这个字符串表示包含了对象的关键信息，使得开发者和调试者能够更容易地识别对象。具体来说，它返回一个格式化的字符串，其中包含了KnowledgeBaseModel对象的多个属性值，包括：
|
|||
|
|
- `id`：对象的唯一标识符。
|
|||
|
|
- `kb_name`：知识库的名称。
|
|||
|
|
- `kb_info`：知识库的简介。
|
|||
|
|
- `vs_type`：知识库的版本类型。
|
|||
|
|
- `embed_model`：嵌入模型的名称。
|
|||
|
|
- `file_count`：知识库中文件的数量。
|
|||
|
|
- `create_time`：知识库创建的时间。
|
|||
|
|
|
|||
|
|
这个方法通过f-string格式化字符串的方式，将对象属性嵌入到预定义的字符串模板中，从而生成易于阅读和理解的表示形式。
|
|||
|
|
|
|||
|
|
**注意**:
|
|||
|
|
- `__repr__`方法通常用于调试和日志记录，它应该返回一个明确且无歧义的对象表示。
|
|||
|
|
- 在Python中，当你尝试将对象转换为字符串时（例如使用`str()`函数或在打印时），如果没有定义`__str__`方法，Python会回退到使用`__repr__`方法。
|
|||
|
|
- 保证`__repr__`方法返回的字符串包含足够的信息，可以用来识别对象中的关键信息。
|
|||
|
|
|
|||
|
|
**输出示例**:
|
|||
|
|
```python
|
|||
|
|
<KnowledgeBase(id='1', kb_name='MyKnowledgeBase',kb_intro='This is a test knowledge base vs_type='v1.0', embed_model='BERT', file_count='100', create_time='2023-04-01')>
|
|||
|
|
```
|
|||
|
|
此示例展示了一个KnowledgeBaseModel对象的`__repr__`方法返回值的可能形式，其中包含了对象的id, kb_name, kb_intro, vs_type, embed_model, file_count, 和 create_time属性的值。
|
|||
|
|
***
|