get_text
Retrieve structured paragraph data from Word documents, including styles and indexes. Filter by content, slice by paragraph range, or include text boxes to extract the exact text you need.
Instructions
Read body paragraphs as [{index, text, style, ...}] with effective styles. start/end slice by paragraph index (0-based, end EXCLUSIVE); contains filters. include_textboxes=True appends text-box content as labeled extras, body indices untouched; textbox=true (or {"index": n}) returns ONLY text-box content, with the box_index set_textbox_text (media-forms pack) takes; file-mode only. Open documents read live, same shape. Equations read via list_elements type='equations'. Read-only. Orientation: get_document_view.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | ||
| live | No | auto | |
| start | No | ||
| textbox | No | ||
| contains | No | ||
| file_path | Yes | ||
| include_textboxes | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |