项目简介
☁️ 云API最简单的入门方法是使用我们的云 API。该 API 可免费使用(在合理限制内)。 安装克隆存储库
gitclonehttps://github.com/superagent-ai/super-ragcdsuper-rag 2. 设置虚拟环境 # Using virtualenv virtualenv env source env/bin/activate
# Or using venv python3 -m venv env source env/bin/activate
3. 安装所需的包 4.将.env.example重命名为.env并设置环境变量
5.运行服务器
口译模式Super-Rag 内置了对使用由 E2B.dev 自定义运行时支持的代码解释器运行计算问答的支持。您可以注册接收 API 密钥,以便在云环境中利用沙箱,或者按照这些说明设置您自己的沙箱。 ? 使用方法Super-Rag 配备了由 FastApi 提供支持的内置 REST API。 摄取文档// POST: /api/v1/ingest
// Payload{"files": [{"name": "My file", // Optional"url": "https://path-to-my-file.pdf"}],"document_processor": { // Optional"encoder": {"dimensions": 384,"model_name": "embed-multilingual-light-v3.0","provider": "cohere"},"unstructured": {"hi_res_model_name": "detectron2_onnx","partition_strategy": "auto","process_tables": false},"splitter": {"max_tokens": 400,"min_tokens": 30,"name": "semantic","prefix_summary": true,"prefix_title": true,"rolling_window_size": 1}},"vector_database": {"type": "qdrant","config": {"api_key": "YOUR API KEY","host": "THE QDRANT HOST"}},"index_name": "my_index","webhook_url": "https://my-webhook-url"}
查询文件// POST: /api/v1/query
// Payload{"input": "What is ReAct","vector_database": {"type": "qdrant","config": {"api_key": "YOUR API KEY","host": "THE QDRANT HOST"}},"index_name": "YOUR INDEX","interpreter_mode": true,"encoder": {"provider": "cohere","name": "embed-multilingual-light-v3.0","dimensions": 384},"exclude_fields": ["metadata"], // Exclude specific fields"interpreter_mode": False, // Set to True if you wish to run computation Q&A with a code interpreter"session_id": "my_session_id" // keeps micro-vm sessions and enables caching }
删除文档// POST: /api/v1/delete
// Payload{"file_url": "A file url to delete","vector_database": {"type": "qdrant","config": {"api_key": "YOUR API KEY","host": "THE QDRANT HOST"}},"index_name": "my_index",}
http://github.com/superagent-ai/super-rag
|