Segment

class Segment


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

Summary

Public constructors

Segment(startIndex: Int, endIndex: Int, partIndex: Int, text: String)

Public properties

Int

The zero-based end index of the segment within the specified Part, measured in UTF-8 bytes.

Int

The zero-based index of the Part object within the parts array of its parent Content object.

Int

The zero-based start index of the segment within the specified Part, measured in UTF-8 bytes.

String

The text corresponding to the segment from the response.

Public constructors

Segment

Segment(startIndex: Int, endIndex: Int, partIndex: Int, text: String)

Public properties

endIndex

val endIndexInt

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

val partIndexInt

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

val startIndexInt

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.

text

val textString

The text corresponding to the segment from the response.