TOOL API

doc.resolve_document_structure

Retrieves the structure tree of a Tencent Docs document as a flat node list, so you can locate positions before calling write tools that need idx, index, or ranges. Nodes are typed Paragraph, Heading (heading_level 1..9), Title, Subtitle, or Table; highlights are flagged with has_highlights and detailed in highlight_spans inside the Paragraph, keyed by paragraph_index (a global 1-based node number covering headings too). Three modes: outline gives previews for headings only, compact (the default) adds a 10-character preview plus light signals like has_highlights, row_count×col_count, children_count, and is_numbering per node, and full fills in highlight_spans, table cells, and numbering details. Pass idx to target a single paragraph (returns full detail and skips pagination); for long documents page with offset and limit (default limit 150).

productivityOAuth1 credits

Call information

Tool slug
tencent-docs.doc.resolve_document_structure
Provider
Tencent Docs
Average response
0 ms
Calls in 7 days
0

Input parameters

file_id

在线文档DOC的文档唯一标识符(与file_url二选一)

file_url

腾讯文档的URL链接(推荐),与file_id二选一

has_idx

idx是否显式传入

has_text_preview_length

text_preview_length 是否显式传入(区分「未设置」与「设为0」)

idx

可选,传入字符位置索引,只返回包含该位置的块的结构信息

include_highlights

是否返回 highlight_spans(mode==full 时无论此值都返回)

include_table_cells

是否返回表格内单元格详情(mode==full 时无论此值都返回)

include_textbox_children

是否返回文本框子节点(mode==full 时无论此值都返回)

limit

顶层节点数组分页条数;0=不限(has_idx==true 时忽略);默认150

mode

详细程度模式:0=outline(只给标题出preview,骨架级);1=compact(默认,每节点10字符preview + has_highlights/row_count×col_count/children_count/is_numbering等轻量信号位);2=full(highlight_spans/table cells/numbering详情全部回填)

offset

顶层节点数组分页偏移(has_idx==true 时忽略)

text_preview_length

text_preview 字符上限;0=不返回预览;负数或不传=使用 mode 默认值

version_info

版本参数