public static final class CheckGroundingResponse.Builder extends GeneratedMessageV3.Builder<CheckGroundingResponse.Builder> implements CheckGroundingResponseOrBuilder
Response message for the
GroundedGenerationService.CheckGrounding
method.
Protobuf type google.cloud.discoveryengine.v1.CheckGroundingResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllCitedChunks(Iterable<? extends FactChunk> values)
public CheckGroundingResponse.Builder addAllCitedChunks(Iterable<? extends FactChunk> values)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Parameter |
| Name |
Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.FactChunk>
|
addAllClaims(Iterable<? extends CheckGroundingResponse.Claim> values)
public CheckGroundingResponse.Builder addAllClaims(Iterable<? extends CheckGroundingResponse.Claim> values)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Parameter |
| Name |
Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim>
|
addCitedChunks(FactChunk value)
public CheckGroundingResponse.Builder addCitedChunks(FactChunk value)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
addCitedChunks(FactChunk.Builder builderForValue)
public CheckGroundingResponse.Builder addCitedChunks(FactChunk.Builder builderForValue)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
addCitedChunks(int index, FactChunk value)
public CheckGroundingResponse.Builder addCitedChunks(int index, FactChunk value)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
addCitedChunks(int index, FactChunk.Builder builderForValue)
public CheckGroundingResponse.Builder addCitedChunks(int index, FactChunk.Builder builderForValue)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
addCitedChunksBuilder()
public FactChunk.Builder addCitedChunksBuilder()
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
addCitedChunksBuilder(int index)
public FactChunk.Builder addCitedChunksBuilder(int index)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Parameter |
| Name |
Description |
index |
int
|
addClaims(CheckGroundingResponse.Claim value)
public CheckGroundingResponse.Builder addClaims(CheckGroundingResponse.Claim value)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
addClaims(CheckGroundingResponse.Claim.Builder builderForValue)
public CheckGroundingResponse.Builder addClaims(CheckGroundingResponse.Claim.Builder builderForValue)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
addClaims(int index, CheckGroundingResponse.Claim value)
public CheckGroundingResponse.Builder addClaims(int index, CheckGroundingResponse.Claim value)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
addClaims(int index, CheckGroundingResponse.Claim.Builder builderForValue)
public CheckGroundingResponse.Builder addClaims(int index, CheckGroundingResponse.Claim.Builder builderForValue)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
addClaimsBuilder()
public CheckGroundingResponse.Claim.Builder addClaimsBuilder()
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
addClaimsBuilder(int index)
public CheckGroundingResponse.Claim.Builder addClaimsBuilder(int index)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Parameter |
| Name |
Description |
index |
int
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CheckGroundingResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public CheckGroundingResponse build()
buildPartial()
public CheckGroundingResponse buildPartial()
clear()
public CheckGroundingResponse.Builder clear()
Overrides
clearCitedChunks()
public CheckGroundingResponse.Builder clearCitedChunks()
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
clearClaims()
public CheckGroundingResponse.Builder clearClaims()
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
clearField(Descriptors.FieldDescriptor field)
public CheckGroundingResponse.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public CheckGroundingResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearSupportScore()
public CheckGroundingResponse.Builder clearSupportScore()
The support score for the input answer candidate.
Higher the score, higher is the fraction of claims that are supported by
the provided facts. This is always set when a response is returned.
optional float support_score = 1;
clone()
public CheckGroundingResponse.Builder clone()
Overrides
getCitedChunks(int index)
public FactChunk getCitedChunks(int index)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Parameter |
| Name |
Description |
index |
int
|
getCitedChunksBuilder(int index)
public FactChunk.Builder getCitedChunksBuilder(int index)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Parameter |
| Name |
Description |
index |
int
|
getCitedChunksBuilderList()
public List<FactChunk.Builder> getCitedChunksBuilderList()
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
getCitedChunksCount()
public int getCitedChunksCount()
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Returns |
| Type |
Description |
int |
|
getCitedChunksList()
public List<FactChunk> getCitedChunksList()
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
getCitedChunksOrBuilder(int index)
public FactChunkOrBuilder getCitedChunksOrBuilder(int index)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Parameter |
| Name |
Description |
index |
int
|
getCitedChunksOrBuilderList()
public List<? extends FactChunkOrBuilder> getCitedChunksOrBuilderList()
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1.FactChunkOrBuilder> |
|
getClaims(int index)
public CheckGroundingResponse.Claim getClaims(int index)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Parameter |
| Name |
Description |
index |
int
|
getClaimsBuilder(int index)
public CheckGroundingResponse.Claim.Builder getClaimsBuilder(int index)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Parameter |
| Name |
Description |
index |
int
|
getClaimsBuilderList()
public List<CheckGroundingResponse.Claim.Builder> getClaimsBuilderList()
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
getClaimsCount()
public int getClaimsCount()
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Returns |
| Type |
Description |
int |
|
getClaimsList()
public List<CheckGroundingResponse.Claim> getClaimsList()
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
getClaimsOrBuilder(int index)
public CheckGroundingResponse.ClaimOrBuilder getClaimsOrBuilder(int index)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Parameter |
| Name |
Description |
index |
int
|
getClaimsOrBuilderList()
public List<? extends CheckGroundingResponse.ClaimOrBuilder> getClaimsOrBuilderList()
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1.CheckGroundingResponse.ClaimOrBuilder> |
|
getDefaultInstanceForType()
public CheckGroundingResponse getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getSupportScore()
public float getSupportScore()
The support score for the input answer candidate.
Higher the score, higher is the fraction of claims that are supported by
the provided facts. This is always set when a response is returned.
optional float support_score = 1;
| Returns |
| Type |
Description |
float |
The supportScore.
|
hasSupportScore()
public boolean hasSupportScore()
The support score for the input answer candidate.
Higher the score, higher is the fraction of claims that are supported by
the provided facts. This is always set when a response is returned.
optional float support_score = 1;
| Returns |
| Type |
Description |
boolean |
Whether the supportScore field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(CheckGroundingResponse other)
public CheckGroundingResponse.Builder mergeFrom(CheckGroundingResponse other)
public CheckGroundingResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public CheckGroundingResponse.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CheckGroundingResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
removeCitedChunks(int index)
public CheckGroundingResponse.Builder removeCitedChunks(int index)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
| Parameter |
| Name |
Description |
index |
int
|
removeClaims(int index)
public CheckGroundingResponse.Builder removeClaims(int index)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
| Parameter |
| Name |
Description |
index |
int
|
setCitedChunks(int index, FactChunk value)
public CheckGroundingResponse.Builder setCitedChunks(int index, FactChunk value)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
setCitedChunks(int index, FactChunk.Builder builderForValue)
public CheckGroundingResponse.Builder setCitedChunks(int index, FactChunk.Builder builderForValue)
List of facts cited across all claims in the answer candidate.
These are derived from the facts supplied in the request.
repeated .google.cloud.discoveryengine.v1.FactChunk cited_chunks = 3;
setClaims(int index, CheckGroundingResponse.Claim value)
public CheckGroundingResponse.Builder setClaims(int index, CheckGroundingResponse.Claim value)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
setClaims(int index, CheckGroundingResponse.Claim.Builder builderForValue)
public CheckGroundingResponse.Builder setClaims(int index, CheckGroundingResponse.Claim.Builder builderForValue)
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim claims = 4;
setField(Descriptors.FieldDescriptor field, Object value)
public CheckGroundingResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CheckGroundingResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setSupportScore(float value)
public CheckGroundingResponse.Builder setSupportScore(float value)
The support score for the input answer candidate.
Higher the score, higher is the fraction of claims that are supported by
the provided facts. This is always set when a response is returned.
optional float support_score = 1;
| Parameter |
| Name |
Description |
value |
float
The supportScore to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CheckGroundingResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
