| Field | Type | Required | Description |
|---|---|---|---|
mime_type |
Optional[str] | ➖ | The mime type of the snippets, currently either text/plain or text/html. |
text |
Optional[str] | ➖ | A matching snippet from the document with no highlights. |
snippet_text_ordering |
Optional[int] | ➖ | Used for sorting based off the snippet's location within all_snippetable_text |
ranges |
List[models.TextRange] | ➖ | The bolded ranges within text. |
url |
Optional[str] | ➖ | A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text. |
snippet |
Optional[str] | ➖ | : warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use 'text' field instead. A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead. |