public final class CheckGroundingResponse extends GeneratedMessageV3 implements CheckGroundingResponseOrBuilder
Response message for the
GroundedGenerationService.CheckGrounding
method.
Protobuf type google.cloud.discoveryengine.v1beta.CheckGroundingResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CITED_CHUNKS_FIELD_NUMBER
public static final int CITED_CHUNKS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CITED_FACTS_FIELD_NUMBER
public static final int CITED_FACTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLAIMS_FIELD_NUMBER
public static final int CLAIMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUPPORT_SCORE_FIELD_NUMBER
public static final int SUPPORT_SCORE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CheckGroundingResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CheckGroundingResponse.Builder newBuilder()
newBuilder(CheckGroundingResponse prototype)
public static CheckGroundingResponse.Builder newBuilder(CheckGroundingResponse prototype)
public static CheckGroundingResponse parseDelimitedFrom(InputStream input)
public static CheckGroundingResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CheckGroundingResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CheckGroundingResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CheckGroundingResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CheckGroundingResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CheckGroundingResponse parseFrom(CodedInputStream input)
public static CheckGroundingResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CheckGroundingResponse parseFrom(InputStream input)
public static CheckGroundingResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CheckGroundingResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CheckGroundingResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CheckGroundingResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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.v1beta.FactChunk cited_chunks = 3;
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta.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.v1beta.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.v1beta.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.v1beta.FactChunk cited_chunks = 3;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.FactChunkOrBuilder> |
|
getCitedFacts(int index)
public CheckGroundingResponse.CheckGroundingFactChunk getCitedFacts(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.v1beta.CheckGroundingResponse.CheckGroundingFactChunk cited_facts = 6;
| Parameter |
| Name |
Description |
index |
int
|
getCitedFactsCount()
public int getCitedFactsCount()
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.v1beta.CheckGroundingResponse.CheckGroundingFactChunk cited_facts = 6;
| Returns |
| Type |
Description |
int |
|
getCitedFactsList()
public List<CheckGroundingResponse.CheckGroundingFactChunk> getCitedFactsList()
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.v1beta.CheckGroundingResponse.CheckGroundingFactChunk cited_facts = 6;
getCitedFactsOrBuilder(int index)
public CheckGroundingResponse.CheckGroundingFactChunkOrBuilder getCitedFactsOrBuilder(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.v1beta.CheckGroundingResponse.CheckGroundingFactChunk cited_facts = 6;
| Parameter |
| Name |
Description |
index |
int
|
getCitedFactsOrBuilderList()
public List<? extends CheckGroundingResponse.CheckGroundingFactChunkOrBuilder> getCitedFactsOrBuilderList()
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.v1beta.CheckGroundingResponse.CheckGroundingFactChunk cited_facts = 6;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.CheckGroundingResponse.CheckGroundingFactChunkOrBuilder> |
|
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.v1beta.CheckGroundingResponse.Claim claims = 4;
| Parameter |
| Name |
Description |
index |
int
|
getClaimsCount()
public int getClaimsCount()
Claim texts and citation info across all claims in the answer candidate.
repeated .google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.CheckGroundingResponse.Claim claims = 4;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.CheckGroundingResponse.ClaimOrBuilder> |
|
getDefaultInstanceForType()
public CheckGroundingResponse getDefaultInstanceForType()
getParserForType()
public Parser<CheckGroundingResponse> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CheckGroundingResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CheckGroundingResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CheckGroundingResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
