# linkthings

**Repository Path**: giaog/linkthings

## Basic Information

- **Project Name**: linkthings
- **Description**: 模型评测代码--各种
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-20
- **Last Updated**: 2025-11-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# linkthings

#### 介绍

模型评测代码--各种

#### 软件架构

软件架构说明

#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

# API 使用说明（RAG-Flow）

简要说明：本项目提供一组用于操作 RAG-Flow 后端的脚本与函数，支持列出数据集/文档/块、添加/更新/删除块、以及批量上传日志块。输出文件统一写入项目的 [output/](output/) 目录。

主要配置

-   全局配置: [api/config.py](api/config.py)
-   输出目录: output/

主要脚本与接口（可直接运行或在脚本中调用）

-   命令行集合：[`api/ragflow_api_list.py`](api/ragflow_api_list.py)

    -   主要命令：datasets, documents, chunks, add_chunk, update_chunk, delete_chunks
    -   相关函数：[`ragflow_api_list.list_datasets`](api/ragflow_api_list.py)、[`ragflow_api_list.list_documents`](api/ragflow_api_list.py)、[`ragflow_api_list.list_chunks`](api/ragflow_api_list.py)、[`ragflow_api_list.add_chunk`](api/ragflow_api_list.py)、[`ragflow_api_list.update_chunk`](api/ragflow_api_list.py)、[`ragflow_api_list.delete_chunks`](api/ragflow_api_list.py)

-   独立脚本（示例/便捷工具）
    -   添加单块：[api/add_chunk.py](api/add_chunk.py) （函数：[`add_chunk`](api/add_chunk.py)）
    -   列文档：[api/list_documents.py](api/list_documents.py)
    -   列块：[api/list_chunks.py](api/list_chunks.py)
    -   删除块：[api/delete_chunks.py](api/delete_chunks.py)
    -   批量上传日志/块：[api/upload_chunks.py](api/upload_chunks.py)（读取 JSON 并批量调用 [`ragflow_api_list.add_chunk`](api/ragflow_api_list.py)）
    -   API 客户端封装：[`api/ragflow_api.py`](api/ragflow_api.py)（类：[`ragflow_api.RagFlowAPI`](api/ragflow_api.py)）

快速命令行示例

-   列出数据集：
    python api/ragflow_api_list.py datasets --page 1 --page_size 50
-   列出某数据集的文档：
    python api/ragflow_api_list.py documents <DATASET_ID> --page 1 --page_size 50
-   列出某文档的块：
    python api/ragflow_api_list.py chunks <DATASET_ID> <DOCUMENT_ID> --page 1 --page_size 1024
-   添加块（CLI）：
    python api/ragflow_api_list.py add_chunk <DATASET_ID> <DOCUMENT_ID> "块内容" --keywords "k1,k2" --questions "q1,q2"
    或使用 [api/add_chunk.py](api/add_chunk.py)
-   更新块（CLI）：
    python api/ragflow_api_list.py update_chunk <DATASET_ID> <DOCUMENT_ID> <CHUNK_ID> --content "新内容" --important_keywords "a,b" --available true
-   删除块（CLI，支持交互确认）：
    python api/ragflow_api_list.py delete_chunks <DATASET_ID> <DOCUMENT_ID> <CHUNK_ID1> <CHUNK_ID2>

在 Python 脚本中使用客户端

```python
from api.ragflow_api import RagFlowAPI  # -> [ragflow_api.py](http://_vscodecontentref_/0)

api = RagFlowAPI(base_url="http://your-host/api/v1", api_key="your-key")
res = api.list_datasets(page=1, page_size=20)
docs = api.list_documents(dataset_id="dataset-id")
# 或直接调用 ragflow_api_list 中的函数：
from api.ragflow_api_list import add_chunk
add_chunk("dataset_id", "document_id", "内容文本", important_keywords=["k1","k2"])
```

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request

#### 特技

1.  使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)