Segment interface

Represents a specific segment within aContent object, often used to pinpoint the exact location of text or data that grounding information refers to.

Signature:

exportinterfaceSegment

Properties

PropertyTypeDescription
endIndexnumberThe zero-based end index of the segment within the specifiedPart, measured in UTF-8 bytes. This offset is exclusive, meaning the character at this index is not included in the segment.
partIndexnumberThe zero-based index of thePart object within theparts array of its parentContent object. This identifies which part of the content the segment belongs to.
startIndexnumberThe zero-based start index of the segment within the specifiedPart, measured in UTF-8 bytes. This offset is inclusive, starting from 0 at the beginning of the part's content (e.g.,Part.text).
textstringThe text corresponding to the segment from the response.

Segment.endIndex

The zero-based end index of the segment within the specifiedPart, 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 thePart object within theparts array of its parentContent 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 specifiedPart, 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 theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-17 UTC.