Segment interface
Stay organized with collections
Save and categorize content based on your preferences.
Represents a specific segment within a Content object, often used to pinpoint the exact location of text or data that grounding information refers to.
Signature:
export interface Segment
Properties
| Property |
Type |
Description |
| endIndex |
number |
The zero-based end index of the segment within the specified Part, measured in UTF-8 bytes. This offset is exclusive, meaning the character at this index is not included in the segment. |
| partIndex |
number |
The zero-based index of the Part object within the parts array of its parent Content object. This identifies which part of the content the segment belongs to. |
| startIndex |
number |
The zero-based start index of the segment within the specified Part, measured in UTF-8 bytes. This offset is inclusive, starting from 0 at the beginning of the part's content (e.g., Part.text). |
| text |
string |
The text corresponding to the segment from the response. |
Segment.endIndex
The zero-based end index of the segment within the specified Part, measured in UTF-8 bytes. This offset is exclusive, meaning the character at this index is not included in the segment.
Signature:
endIndex: number;
Segment.partIndex
The zero-based index of the Part object within the parts array of its parent Content object. This identifies which part of the content the segment belongs to.
Signature:
partIndex: number;
Segment.startIndex
The zero-based start index of the segment within the specified Part, measured in UTF-8 bytes. This offset is inclusive, starting from 0 at the beginning of the part's content (e.g., Part.text).
Signature:
startIndex: number;
Segment.text
The text corresponding to the segment from the response.
Signature:
text: string;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-17 UTC.
[null,null,["Last updated 2025-07-17 UTC."],[],[],null,["Represents a specific segment within a [Content](./ai.content.md#content_interface) object, often used to pinpoint the exact location of text or data that grounding information refers to.\n\n**Signature:** \n\n export interface Segment \n\nProperties\n\n| Property | Type | Description |\n|-------------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [endIndex](./ai.segment.md#segmentendindex) | number | The zero-based end index of the segment within the specified `Part`, measured in UTF-8 bytes. This offset is exclusive, meaning the character at this index is not included in the segment. |\n| [partIndex](./ai.segment.md#segmentpartindex) | number | The zero-based index of the [Part](./ai.md#part) object within the `parts` array of its parent [Content](./ai.content.md#content_interface) object. This identifies which part of the content the segment belongs to. |\n| [startIndex](./ai.segment.md#segmentstartindex) | number | The zero-based start index of the segment within the specified `Part`, measured in UTF-8 bytes. This offset is inclusive, starting from 0 at the beginning of the part's content (e.g., `Part.text`). |\n| [text](./ai.segment.md#segmenttext) | string | The text corresponding to the segment from the response. |\n\nSegment.endIndex\n\nThe zero-based end index of the segment within the specified `Part`, measured in UTF-8 bytes. This offset is exclusive, meaning the character at this index is not included in the segment.\n\n**Signature:** \n\n endIndex: number;\n\nSegment.partIndex\n\nThe zero-based index of the [Part](./ai.md#part) object within the `parts` array of its parent [Content](./ai.content.md#content_interface) object. This identifies which part of the content the segment belongs to.\n\n**Signature:** \n\n partIndex: number;\n\nSegment.startIndex\n\nThe zero-based start index of the segment within the specified `Part`, measured in UTF-8 bytes. This offset is inclusive, starting from 0 at the beginning of the part's content (e.g., `Part.text`).\n\n**Signature:** \n\n startIndex: number;\n\nSegment.text\n\nThe text corresponding to the segment from the response.\n\n**Signature:** \n\n text: string;"]]
