-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Background
PR #831 added Feishu/Lark cloud document parsing support (docx, wiki, sheets, bitable). The feature is implemented and tested, but documentation has not been updated yet.
Tasks
Resource docs (docs/{en,zh}/api/02-resources.md)
- Add Feishu entry to the "Supported Formats" table (e.g.,
Feishu | URL | Cloud document parsing via lark-oapi) - Add a Feishu URL usage example in the
add_resource()section:client.add_resource("https://example.feishu.cn/docx/doxcnABC123")
Configuration docs (docs/{en,zh}/guides/01-configuration.md)
- Document the
feishuconfig section inov.conf:{ "feishu": { "app_id": "", "app_secret": "", "domain": "https://open.feishu.cn", "max_rows_per_sheet": 1000, "max_records_per_table": 1000 } } - Document environment variable alternatives:
FEISHU_APP_ID,FEISHU_APP_SECRET - Note the optional dependency:
pip install 'openviking[bot-feishu]'
Supported document types
Document the four supported Feishu URL patterns:
https://*.feishu.cn/docx/{id}— Documentshttps://*.feishu.cn/wiki/{token}— Wiki pages (auto-resolved to underlying type)https://*.feishu.cn/sheets/{token}— Spreadsheetshttps://*.feishu.cn/base/{token}— Bitable (multi-dimensional tables)
Also mention Lark international URLs (*.larksuite.com).
Context
- Implementation PR: feat(parse): add Feishu/Lark cloud document parser #831
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
Done