Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1 Client class TextMessageCitationAnchor.
Citation anchor within a TextMessage.
Generated from protobuf message google.cloud.geminidataanalytics.v1.CitationAnchor.TextMessageCitationAnchor
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1 \ CitationAnchorMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ part_index |
int
Output only. The 0-based index of the part within the TextMessage.parts field. |
↳ start_offset_bytes |
int
Output only. The offset, measured in UTF-8 bytes, within the part string where the citation begins (inclusive). Example: For the text "Hello, world" where "world" is cited, the start offset bytes (inclusive) is 7 and the end offset bytes (exclusive) is 12. |
↳ end_offset_bytes |
int
Output only. The offset, measured in UTF-8 bytes, within the part string where the citation ends (exclusive). Example: For the text "Hello, world" where "world" is cited, the start offset bytes (inclusive) is 7 and the end offset bytes (exclusive) is 12. |
↳ source_ids |
string[]
Output only. The ids of the sources that are cited. |
getPartIndex
Output only. The 0-based index of the part within the TextMessage.parts field.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPartIndex
Output only. The 0-based index of the part within the TextMessage.parts field.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartOffsetBytes
Output only. The offset, measured in UTF-8 bytes, within the part string where the citation begins (inclusive). Example: For the text "Hello, world" where "world" is cited, the start offset bytes (inclusive) is 7 and the end offset bytes (exclusive) is 12.
| Returns | |
|---|---|
| Type | Description |
int |
|
setStartOffsetBytes
Output only. The offset, measured in UTF-8 bytes, within the part string where the citation begins (inclusive). Example: For the text "Hello, world" where "world" is cited, the start offset bytes (inclusive) is 7 and the end offset bytes (exclusive) is 12.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndOffsetBytes
Output only. The offset, measured in UTF-8 bytes, within the part string where the citation ends (exclusive). Example: For the text "Hello, world" where "world" is cited, the start offset bytes (inclusive) is 7 and the end offset bytes (exclusive) is 12.
| Returns | |
|---|---|
| Type | Description |
int |
|
setEndOffsetBytes
Output only. The offset, measured in UTF-8 bytes, within the part string where the citation ends (exclusive). Example: For the text "Hello, world" where "world" is cited, the start offset bytes (inclusive) is 7 and the end offset bytes (exclusive) is 12.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceIds
Output only. The ids of the sources that are cited.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setSourceIds
Output only. The ids of the sources that are cited.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|