public static final class GroundingSupport.Builder extends GeneratedMessageV3.Builder<GroundingSupport.Builder> implements GroundingSupportOrBuilderGrounding support.
Protobuf type google.cloud.vertexai.v1.GroundingSupport
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GroundingSupport.BuilderImplements
GroundingSupportOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllConfidenceScores(Iterable<? extends Float> values)
public GroundingSupport.Builder addAllConfidenceScores(Iterable<? extends Float> values)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 |
values |
Iterable<? extends java.lang.Float>The confidenceScores to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
This builder for chaining. |
addAllGroundingChunkIndices(Iterable<? extends Integer> values)
public GroundingSupport.Builder addAllGroundingChunkIndices(Iterable<? extends Integer> values)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 |
values |
Iterable<? extends java.lang.Integer>The groundingChunkIndices to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
This builder for chaining. |
addConfidenceScores(float value)
public GroundingSupport.Builder addConfidenceScores(float value)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 |
value |
floatThe confidenceScores to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
This builder for chaining. |
addGroundingChunkIndices(int value)
public GroundingSupport.Builder addGroundingChunkIndices(int value)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 |
value |
intThe groundingChunkIndices to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GroundingSupport.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
build()
public GroundingSupport build()| Returns | |
|---|---|
| Type | Description |
GroundingSupport |
|
buildPartial()
public GroundingSupport buildPartial()| Returns | |
|---|---|
| Type | Description |
GroundingSupport |
|
clear()
public GroundingSupport.Builder clear()| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
clearConfidenceScores()
public GroundingSupport.Builder clearConfidenceScores()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 |
GroundingSupport.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public GroundingSupport.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
clearGroundingChunkIndices()
public GroundingSupport.Builder clearGroundingChunkIndices()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 |
GroundingSupport.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GroundingSupport.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
clearSegment()
public GroundingSupport.Builder clearSegment()Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
clone()
public GroundingSupport.Builder clone()| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
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 |
intThe 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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
intThe 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. |
getSegment()
public Segment getSegment()Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Returns | |
|---|---|
| Type | Description |
Segment |
The segment. |
getSegmentBuilder()
public Segment.Builder getSegmentBuilder()Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Returns | |
|---|---|
| Type | Description |
Segment.Builder |
|
getSegmentOrBuilder()
public SegmentOrBuilder getSegmentOrBuilder()Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Returns | |
|---|---|
| Type | Description |
SegmentOrBuilder |
|
hasSegment()
public boolean hasSegment()Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the segment field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GroundingSupport other)
public GroundingSupport.Builder mergeFrom(GroundingSupport other)| Parameter | |
|---|---|
| Name | Description |
other |
GroundingSupport |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GroundingSupport.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GroundingSupport.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
mergeSegment(Segment value)
public GroundingSupport.Builder mergeSegment(Segment value)Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Segment |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GroundingSupport.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
setConfidenceScores(int index, float value)
public GroundingSupport.Builder setConfidenceScores(int index, float value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
floatThe confidenceScores to set. |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public GroundingSupport.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
setGroundingChunkIndices(int index, int value)
public GroundingSupport.Builder setGroundingChunkIndices(int index, int value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe groundingChunkIndices to set. |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GroundingSupport.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
setSegment(Segment value)
public GroundingSupport.Builder setSegment(Segment value)Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Segment |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
setSegment(Segment.Builder builderForValue)
public GroundingSupport.Builder setSegment(Segment.Builder builderForValue)Segment of the content this support belongs to.
optional .google.cloud.vertexai.v1.Segment segment = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Segment.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final GroundingSupport.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|