byted-viking-aisearch-feishu

Files (5)

• README.md
• SKILL.md
• requirements.txt
• __init__.py · scripts/
• feishu_search.py · scripts/

SKILL.md (first lines)

# Viking AISearch Feishu Skill

你是一个专注于飞书「云文档 / 电子表格 / 多维表格 / 知识库（Wiki）」的搜索与内容读取助手。你必须严格只读，不实现任何写操作。

## 🎯 核心功能

- 搜索：聚合搜索云文档（doc/docx）、电子表格（sheet）、多维表格（bitable）、知识库空间与节点（wiki）
- 读取：读取 doc/docx 原文；读取 sheet 预览区间数据；读取 bitable 表结构与记录样本；读取 wiki 节点（自动跳转到关联对象内容）与 wiki 空间子节点列表

## 🚦 场景路由

| 用户意图示例 | 匹配场景 | 主要方法 | 产出 |
| :-- | :-- | :-- | :-- |
| “搜一下飞书里关于‘Q4’的资料” | 聚合搜索 | `search_items()` / `search_docs()` | 返回条目列表（title/type/token/url/source…） |
| “读取这个 docx / sheet / base 的内容” | 内容读取 | `fetch_raw_content()` | 返回 `content`（纯文本/TSV/JSON 摘要） |
| “列出我有权限的知识库空间” | 知识库空间 | `list_wiki_spaces()` / `search_wiki_spaces()` | 返回空间列表 |
| “列出某个知识库空间的子节点” | 空间子节点 | `list_wiki_space_nodes()` | 返回节点列表 |

## 📚 主要接口使用方法

### 1) 初始化

```python
from scripts.feishu_search import FeishuDocSearch

# 方式一：使用环境变量（推荐）
# export LARK_USER_ACCESS_TOKEN="u-xxxxxxxxxxxxxxxxxxxxxxxx"
tool = FeishuDocSearch()

# 方式二：显式传入 access_token
tool = FeishuDocSearch(access_token="u-xxx")
```

### 2) 聚合搜索 - `search_items()`

**功能**：按关键词搜索云文档/电子表格/多维表格，并可选聚合知识库节点与知识库空间

**参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
| :-- | :-- | :-- | :-- | :-- |
| `search_key` | `str` | 是 | - | 搜索关键词 |
| `count` | `int` | 否 | `10` | 返回数量（分页后） |
| `offset` | `int` | 否 | `0` | 偏移量（分页后） |
| `types` | `List[str]` | 否 | `["doc","docx","sheet","bitable","wiki","wiki_space"]` | 搜索类型集合 |
| `owner_ids` | `List[str]` | 否 | `None` | 所有者 Open ID 过滤（仅 suite docs 搜索） |
| `chat_ids` | `List[str]` | 否 | `None` | 群聊 ID 过滤（仅 suite docs 搜索） |
| `space_id` | `str` | 否 | `None` | 仅搜索该知识库空间内节点（wiki 节点搜索） |

**返回语义**：

- 只要至少一条搜索路径返回可用结果，`search_items()` 仍可返回 `success=true`
- 若某一路径失败或降级，结果会在 `data.warnings` 中显式暴露，不再静默吞掉
- 常见 warning 键包括：`suite_error`、`suite_fallback_error`、`wiki_nodes_error`、`wiki_spaces_error`、`wiki_spaces_warning`

**典型部分成功返回**：

```json
{
  "success": true,
  "message": "搜索成功",
  "data": {
    "total": 3,
    "has_more": false,
    "items": [],
    "warnings": {
      "suite_error": {
        "message": "文档套件搜索失败",
        "error": {}
      }
    }
  }
}
```

### 3) 兼容接口 - `search_docs()`

`search_docs()` 为历史兼容接口，内部基于 `search_items()` 实现，默认包含 `doc/docx/sheet/bitable/wiki`。

**使用示例**：

```python
# 基础搜索
result = tool.search_docs(search_key="项目计划")

# 指定类型搜索
result = tool.search_docs(
    search_key="季度报告",
    docs_types=["doc", "docx", "sheet", "bitable", "wiki"]
)

# 分页搜索
result = tool.search_docs(
    search_key="技术方案",
    count=20,
    offset=0
)
```

**返回示例**：

```json
{
  "success": true,
  "message": "搜索成功",
  "data": {
    "total": 12,
    "has_more": false,
    "warnings": {
      "wiki_error": {
        "message": "权限不足，请为应用开通 wiki 搜索相关权限",
        "error": {
          "type": "permission_denied",
          "detail": "HTTP 403: ..."
        }
      }
    },
    "items": [
      {

From bytedance/agentkit-samples, Apache-2.0.

More from bytedance/agentkit-samples