Get Text
get_textRetrieve Word document paragraphs with styles, start/end indexes, and filters. Optionally include textboxes and read equations from live or file-based documents.
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: file or live; force: live; off: refuse | auto |
| start | No | ||
| textbox | No | ||
| contains | No | ||
| file_path | Yes | ||
| include_textboxes | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |