Get obligation
get_obligationReturn one obligation's verbatim regulator text with full provenance. Answer with this text: quote it exactly, with its section citation, never a paraphrase (a summary may follow the quotes, labeled as your summary). If currency is not null, tell the user its headline (e.g. two versions apply, a pending revision, superseded, expired) and which version you quoted. For specific requirements in a long section, find_in_section is faster: it returns only the paragraphs containing your terms. Paging: at most 24,000 chars per call (limit asks for fewer). paging says where you are (page N of M) and paging.how says exactly what to do next: while next_offset is a number, call again with the same obligation_id and offset=next_offset; null means the section ends in this response. chars_offset + chars_returned is your position in chars_total. truncated means this response is not the whole section: never assert that the rule does not require something until you have read every page. Two versions: an FHA 4000.1 section Update 18 revises has two obligations, the in-force text and its Update 18 revision (<id>::update-18); version says which this is and other_version gives the other's obligation_id -- quote the one that applies and say which. compare_versions: true adds version_changes: the sentences Update 18 deletes and adds in this section. canonical_citation is the section's citation in the regulator's style (e.g. "4000.1 II.A.5.d", "B3-3.3-07", "38 U.S.C. 3709(b)"; null if not derivable): cite it. If canonical_id is set, this register is a same-text copy of that one. If figures is empty the section states no figure -- say so rather than supplying one from memory.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max chars to return from offset (200-24000; default 24000). With a find_in_section passage offset, a small limit reads just around it. | |
| offset | No | ||
| obligation_id | Yes | ||
| compare_versions | No | On an FHA section Update 18 revises: also return `version_changes`, the sentences Update 18 deletes and adds (verbatim units with offsets). |