Class CheckGroundingResponse (0.48.0)

public final class CheckGroundingResponse extends GeneratedMessageV3 implements CheckGroundingResponseOrBuilder

Response message for the GroundedGenerationService.CheckGrounding method.

Protobuf type google.cloud.discoveryengine.v1.CheckGroundingResponse

Static Fields

CITED_CHUNKS_FIELD_NUMBER

public static final int CITED_CHUNKS_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()
Returns
Type Description
CheckGroundingResponse

getDescriptor()

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

newBuilder()

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

newBuilder(CheckGroundingResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Returns
Type Description
FactChunk

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;

Returns
Type Description
List<FactChunk>

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
Returns
Type Description
FactChunkOrBuilder

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
Returns
Type Description
CheckGroundingResponse.Claim

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;

Returns
Type Description
List<Claim>

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
Returns
Type Description
CheckGroundingResponse.ClaimOrBuilder

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()
Returns
Type Description
CheckGroundingResponse

getParserForType()

public Parser<CheckGroundingResponse> getParserForType()
Returns
Type Description
Parser<CheckGroundingResponse>
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()

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 CheckGroundingResponse.Builder newBuilderForType()
Returns
Type Description
CheckGroundingResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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