BaseModel
is supposed to be rendered as an inline icon, optionally marking a text
range it belongs to.
If Citation is included together with content in the message part,
the citation belongs to that content and renders at the Part position.
This way may be used for non-text content, like images and files.
Alternatively, start_index and end_index may define a text range,
counting characters in the current Message across all Parts containing plain
text, where the citation will be rendered. If one of start_index and
end_index is missing or their values are equal, the citation renders only
as an inline icon at that position.
If both start_index and end_index are not present and Part has empty
content, the citation renders as inline icon only at the Part position.
Properties:
- url: URL of the source document.
- title: Title of the source document.
- description: Accompanying text, which may be a general description of the source document, or a specific snippet.
Class Attributes
| Attribute | Type | Default |
|---|---|---|
start_index | int | None | None |
end_index | int | None | None |
url | str | None | None |
title | str | None | None |
description | str | None | None |