Class AssistantGroundedContent.TextGroundingMetadata.Segment.Builder (0.79.0)

public static final class AssistantGroundedContent.TextGroundingMetadata.Segment.Builder extends GeneratedMessage.Builder<AssistantGroundedContent.TextGroundingMetadata.Segment.Builder> implements AssistantGroundedContent.TextGroundingMetadata.SegmentOrBuilder

Grounding information for a segment of the text.

Protobuf type google.cloud.discoveryengine.v1.AssistantGroundedContent.TextGroundingMetadata.Segment

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllReferenceIndices(Iterable<? extends Integer> values)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder addAllReferenceIndices(Iterable<? extends Integer> values)

References for the segment.

repeated int32 reference_indices = 4;

Parameter
Name Description
values Iterable<? extends java.lang.Integer>

The referenceIndices to add.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

addReferenceIndices(int value)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder addReferenceIndices(int value)

References for the segment.

repeated int32 reference_indices = 4;

Parameter
Name Description
value int

The referenceIndices to add.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

build()

public AssistantGroundedContent.TextGroundingMetadata.Segment build()
Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment

buildPartial()

public AssistantGroundedContent.TextGroundingMetadata.Segment buildPartial()
Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment

clear()

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder clear()
Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder
Overrides

clearEndIndex()

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder clearEndIndex()

End of the segment, exclusive.

int64 end_index = 2;

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

clearGroundingScore()

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder clearGroundingScore()

Score for the segment.

float grounding_score = 5;

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

clearReferenceIndices()

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder clearReferenceIndices()

References for the segment.

repeated int32 reference_indices = 4;

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

clearStartIndex()

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder clearStartIndex()

Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).

int64 start_index = 1;

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

clearText()

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder clearText()

The text segment itself.

string text = 6;

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

getDefaultInstanceForType()

public AssistantGroundedContent.TextGroundingMetadata.Segment getDefaultInstanceForType()
Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndIndex()

public long getEndIndex()

End of the segment, exclusive.

int64 end_index = 2;

Returns
Type Description
long

The endIndex.

getGroundingScore()

public float getGroundingScore()

Score for the segment.

float grounding_score = 5;

Returns
Type Description
float

The groundingScore.

getReferenceIndices(int index)

public int getReferenceIndices(int index)

References for the segment.

repeated int32 reference_indices = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The referenceIndices at the given index.

getReferenceIndicesCount()

public int getReferenceIndicesCount()

References for the segment.

repeated int32 reference_indices = 4;

Returns
Type Description
int

The count of referenceIndices.

getReferenceIndicesList()

public List<Integer> getReferenceIndicesList()

References for the segment.

repeated int32 reference_indices = 4;

Returns
Type Description
List<Integer>

A list containing the referenceIndices.

getStartIndex()

public long getStartIndex()

Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).

int64 start_index = 1;

Returns
Type Description
long

The startIndex.

getText()

public String getText()

The text segment itself.

string text = 6;

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

The text segment itself.

string text = 6;

Returns
Type Description
ByteString

The bytes for text.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AssistantGroundedContent.TextGroundingMetadata.Segment other)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder mergeFrom(AssistantGroundedContent.TextGroundingMetadata.Segment other)
Parameter
Name Description
other AssistantGroundedContent.TextGroundingMetadata.Segment
Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder
Overrides

setEndIndex(long value)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder setEndIndex(long value)

End of the segment, exclusive.

int64 end_index = 2;

Parameter
Name Description
value long

The endIndex to set.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

setGroundingScore(float value)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder setGroundingScore(float value)

Score for the segment.

float grounding_score = 5;

Parameter
Name Description
value float

The groundingScore to set.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

setReferenceIndices(int index, int value)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder setReferenceIndices(int index, int value)

References for the segment.

repeated int32 reference_indices = 4;

Parameters
Name Description
index int

The index to set the value at.

value int

The referenceIndices to set.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

setStartIndex(long value)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder setStartIndex(long value)

Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).

int64 start_index = 1;

Parameter
Name Description
value long

The startIndex to set.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

setText(String value)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder setText(String value)

The text segment itself.

string text = 6;

Parameter
Name Description
value String

The text to set.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.

setTextBytes(ByteString value)

public AssistantGroundedContent.TextGroundingMetadata.Segment.Builder setTextBytes(ByteString value)

The text segment itself.

string text = 6;

Parameter
Name Description
value ByteString

The bytes for text to set.

Returns
Type Description
AssistantGroundedContent.TextGroundingMetadata.Segment.Builder

This builder for chaining.