开源项目安装与配置指南：WhyHow知识图谱工作室

开源项目安装与配置指南：WhyHow知识图谱工作室

knowledge-graph-studio WhyHow Knowledge Graph Studio 项目地址: https://gitcode.com/gh_mirrors/kn/knowledge-graph-studio

1. 项目基础介绍

WhyHow知识图谱工作室是一个用于创建和管理RAG原生知识图谱的平台。它支持规则基础的实体解析、模块化的图构建、灵活的数据摄入以及以API为优先的设计，并提供相应的SDK。该平台适用于处理结构化或非结构化数据，构建探索性图或高度模式约束的图，旨在提供可扩展性和灵活性，以支持动态的图启用AI工作流，适用于实验和大规模使用。

主要编程语言：Python

2. 关键技术和框架

• NoSQL数据库：项目基于NoSQL数据库构建，如MongoDB，为构建知识图谱提供了灵活、可扩展的存储层。
• API-first设计：通过API优先的设计哲学，确保了平台的灵活性和可扩展性。
• SDK支持：提供软件开发工具包（SDK），方便开发者快速接入和使用。

3. 安装和配置准备工作

在开始安装之前，请确保您已经安装了以下环境和工具：

• Python 3.10 或更高版本
• MongoDB账户（推荐使用MongoDB Atlas）
• OpenAI API密钥

安装步骤

步骤 1：克隆项目仓库

首先，您需要从GitHub上克隆项目仓库：

git clone git@github.com:whyhow-ai/knowledge-graph-studio.git
cd knowledge-graph-studio

步骤 2：安装依赖

接着，使用pip安装项目所需的依赖：

pip install .

如果您是开发者并希望进行可编辑的安装，以及安装开发和文档依赖，可以使用以下命令：

pip install -e .[dev,docs]

步骤 3：配置环境变量

将.env.sample文件复制为.env，并根据您的环境更新其中的值。至少需要配置以下环境变量：

cp .env.sample .env

在.env文件中设置如下变量：

WHYHOW__EMBEDDING__OPENAI__API_KEY=<您的openai api密钥>
WHYHOW__GENERATIVE__OPENAI__API_KEY=<您的openai api密钥 - 可以与上面相同>
WHYHOW__MONGODB__USERNAME=<您的altas数据库用户名>
WHYHOW__MONGODB__PASSWORD=<您的altas数据库密码>
WHYHOW__MONGODB__DATABASE_NAME=main
WHYHOW__MONGODB__HOST=<您的altas主机地址>

步骤 4：设置MongoDB

使用MongoDB Compass或MongoDB Atlas浏览器创建数据库、集合和索引。您也可以使用项目提供的CLI脚本来简化这一步骤：

cd src/whyhow_api/cli/
python admin.py setup-collections --config-file collection_index_config.json

步骤 5：创建用户

创建用户并复制API密钥，以便通过SDK与后端通信的SDK进行配置：

python admin.py create-user --email <您的电子邮件地址> --openai-key <您的openai api密钥>

步骤 6：启动API服务

配置完成后，可以启动API服务器：

uvicorn src.whyhow_api.main:app

可以使用whyhow-locate工具脚本来获取完整的路径：

uvicorn $(whyhow-locate)

接着，您可以在浏览器中访问http://localhost:8000/docs来查看Swagger UI。

通过上述步骤，您应该能够成功安装并配置WhyHow知识图谱工作室。接下来，您可以按照项目提供的文档进行进一步的测试和使用。

knowledge-graph-studio WhyHow Knowledge Graph Studio 项目地址: https://gitcode.com/gh_mirrors/kn/knowledge-graph-studio