Class GroundingSupport (3.50.0)

public final class GroundingSupport extends GeneratedMessageV3 implements GroundingSupportOrBuilder

Grounding support.

Protobuf type google.cloud.aiplatform.v1.GroundingSupport

Static Fields

CONFIDENCE_SCORES_FIELD_NUMBER

public static final int CONFIDENCE_SCORES_FIELD_NUMBER
Field Value
Type Description
int

GROUNDING_CHUNK_INDICES_FIELD_NUMBER

public static final int GROUNDING_CHUNK_INDICES_FIELD_NUMBER
Field Value
Type Description
int

SEGMENT_FIELD_NUMBER

public static final int SEGMENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GroundingSupport getDefaultInstance()
Returns
Type Description
GroundingSupport

getDescriptor()

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

newBuilder()

public static GroundingSupport.Builder newBuilder()
Returns
Type Description
GroundingSupport.Builder

newBuilder(GroundingSupport prototype)

public static GroundingSupport.Builder newBuilder(GroundingSupport prototype)
Parameter
Name Description
prototype GroundingSupport
Returns
Type Description
GroundingSupport.Builder

parseDelimitedFrom(InputStream input)

public static GroundingSupport parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GroundingSupport
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingSupport parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingSupport
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GroundingSupport parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GroundingSupport parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GroundingSupport parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GroundingSupport parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GroundingSupport parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GroundingSupport
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingSupport parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingSupport
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GroundingSupport parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GroundingSupport
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingSupport parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingSupport
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GroundingSupport parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GroundingSupport parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GroundingSupport> parser()
Returns
Type Description
Parser<GroundingSupport>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfidenceScores(int index)

public float getConfidenceScores(int index)

Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.

repeated float confidence_scores = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
float

The confidenceScores at the given index.

getConfidenceScoresCount()

public int getConfidenceScoresCount()

Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.

repeated float confidence_scores = 3;

Returns
Type Description
int

The count of confidenceScores.

getConfidenceScoresList()

public List<Float> getConfidenceScoresList()

Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.

repeated float confidence_scores = 3;

Returns
Type Description
List<Float>

A list containing the confidenceScores.

getDefaultInstanceForType()

public GroundingSupport getDefaultInstanceForType()
Returns
Type Description
GroundingSupport

getGroundingChunkIndices(int index)

public int getGroundingChunkIndices(int index)

A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.

repeated int32 grounding_chunk_indices = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The groundingChunkIndices at the given index.

getGroundingChunkIndicesCount()

public int getGroundingChunkIndicesCount()

A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.

repeated int32 grounding_chunk_indices = 2;

Returns
Type Description
int

The count of groundingChunkIndices.

getGroundingChunkIndicesList()

public List<Integer> getGroundingChunkIndicesList()

A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.

repeated int32 grounding_chunk_indices = 2;

Returns
Type Description
List<Integer>

A list containing the groundingChunkIndices.

getParserForType()

public Parser<GroundingSupport> getParserForType()
Returns
Type Description
Parser<GroundingSupport>
Overrides

getSegment()

public Segment getSegment()

Segment of the content this support belongs to.

optional .google.cloud.aiplatform.v1.Segment segment = 1;

Returns
Type Description
Segment

The segment.

getSegmentOrBuilder()

public SegmentOrBuilder getSegmentOrBuilder()

Segment of the content this support belongs to.

optional .google.cloud.aiplatform.v1.Segment segment = 1;

Returns
Type Description
SegmentOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasSegment()

public boolean hasSegment()

Segment of the content this support belongs to.

optional .google.cloud.aiplatform.v1.Segment segment = 1;

Returns
Type Description
boolean

Whether the segment field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GroundingSupport.Builder newBuilderForType()
Returns
Type Description
GroundingSupport.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GroundingSupport.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GroundingSupport.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GroundingSupport.Builder toBuilder()
Returns
Type Description
GroundingSupport.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException