com.google.cloud.discoveryengine.v1beta

Class CheckGroundingResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.CheckGroundingResponse

All Implemented Interfaces:

CheckGroundingResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CheckGroundingResponse
extends com.google.protobuf.GeneratedMessageV3
implements CheckGroundingResponseOrBuilder

 Response message for the
 [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding]
 method.
 

Protobuf type google.cloud.discoveryengine.v1beta.CheckGroundingResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckGroundingResponse.Builder Response message for the [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.
static class	CheckGroundingResponse.CheckGroundingFactChunk Fact chunk for grounding check.
static interface	CheckGroundingResponse.CheckGroundingFactChunkOrBuilder
static class	CheckGroundingResponse.Claim Text and citation info for a claim in the answer candidate.
static interface	CheckGroundingResponse.ClaimOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CITED_CHUNKS_FIELD_NUMBER
static int	CITED_FACTS_FIELD_NUMBER
static int	CLAIMS_FIELD_NUMBER
static int	SUPPORT_SCORE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
FactChunk	getCitedChunks(int index) List of facts cited across all claims in the answer candidate.
int	getCitedChunksCount() List of facts cited across all claims in the answer candidate.
List<FactChunk>	getCitedChunksList() List of facts cited across all claims in the answer candidate.
FactChunkOrBuilder	getCitedChunksOrBuilder(int index) List of facts cited across all claims in the answer candidate.
List<? extends FactChunkOrBuilder>	getCitedChunksOrBuilderList() List of facts cited across all claims in the answer candidate.
CheckGroundingResponse.CheckGroundingFactChunk	getCitedFacts(int index) List of facts cited across all claims in the answer candidate.
int	getCitedFactsCount() List of facts cited across all claims in the answer candidate.
List<CheckGroundingResponse.CheckGroundingFactChunk>	getCitedFactsList() List of facts cited across all claims in the answer candidate.
CheckGroundingResponse.CheckGroundingFactChunkOrBuilder	getCitedFactsOrBuilder(int index) List of facts cited across all claims in the answer candidate.
List<? extends CheckGroundingResponse.CheckGroundingFactChunkOrBuilder>	getCitedFactsOrBuilderList() List of facts cited across all claims in the answer candidate.
CheckGroundingResponse.Claim	getClaims(int index) Claim texts and citation info across all claims in the answer candidate.
int	getClaimsCount() Claim texts and citation info across all claims in the answer candidate.
List<CheckGroundingResponse.Claim>	getClaimsList() Claim texts and citation info across all claims in the answer candidate.
CheckGroundingResponse.ClaimOrBuilder	getClaimsOrBuilder(int index) Claim texts and citation info across all claims in the answer candidate.
List<? extends CheckGroundingResponse.ClaimOrBuilder>	getClaimsOrBuilderList() Claim texts and citation info across all claims in the answer candidate.
static CheckGroundingResponse	getDefaultInstance()
CheckGroundingResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<CheckGroundingResponse>	getParserForType()
int	getSerializedSize()
float	getSupportScore() The support score for the input answer candidate.
int	hashCode()
boolean	hasSupportScore() The support score for the input answer candidate.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CheckGroundingResponse.Builder	newBuilder()
static CheckGroundingResponse.Builder	newBuilder(CheckGroundingResponse prototype)
CheckGroundingResponse.Builder	newBuilderForType()
protected CheckGroundingResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CheckGroundingResponse	parseDelimitedFrom(InputStream input)
static CheckGroundingResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse	parseFrom(byte[] data)
static CheckGroundingResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse	parseFrom(ByteBuffer data)
static CheckGroundingResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse	parseFrom(com.google.protobuf.ByteString data)
static CheckGroundingResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static CheckGroundingResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse	parseFrom(InputStream input)
static CheckGroundingResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CheckGroundingResponse>	parser()
CheckGroundingResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SUPPORT_SCORE_FIELD_NUMBER

public static final int SUPPORT_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

CITED_CHUNKS_FIELD_NUMBER

public static final int CITED_CHUNKS_FIELD_NUMBER

See Also:

Constant Field Values

CITED_FACTS_FIELD_NUMBER

public static final int CITED_FACTS_FIELD_NUMBER

See Also:

Constant Field Values

CLAIMS_FIELD_NUMBER

public static final int CLAIMS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

hasSupportScore in interface CheckGroundingResponseOrBuilder

Returns:

Whether the supportScore field is set.

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;

Specified by:

getSupportScore in interface CheckGroundingResponseOrBuilder

Returns:

The supportScore.

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;

Specified by:

getCitedChunksList in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getCitedChunksOrBuilderList in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getCitedChunksCount in interface CheckGroundingResponseOrBuilder

getCitedChunks

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;

Specified by:

getCitedChunks in interface CheckGroundingResponseOrBuilder

getCitedChunksOrBuilder

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;

Specified by:

getCitedChunksOrBuilder in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getCitedFactsList in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getCitedFactsOrBuilderList in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getCitedFactsCount in interface CheckGroundingResponseOrBuilder

getCitedFacts

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;

Specified by:

getCitedFacts in interface CheckGroundingResponseOrBuilder

getCitedFactsOrBuilder

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;

Specified by:

getCitedFactsOrBuilder in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getClaimsList in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getClaimsOrBuilderList in interface CheckGroundingResponseOrBuilder

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;

Specified by:

getClaimsCount in interface CheckGroundingResponseOrBuilder

getClaims

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;

Specified by:

getClaims in interface CheckGroundingResponseOrBuilder

getClaimsOrBuilder

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;

Specified by:

getClaimsOrBuilder in interface CheckGroundingResponseOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CheckGroundingResponse parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static CheckGroundingResponse parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckGroundingResponse parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckGroundingResponse parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static CheckGroundingResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static CheckGroundingResponse parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public CheckGroundingResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CheckGroundingResponse.Builder newBuilder()

newBuilder

public static CheckGroundingResponse.Builder newBuilder(CheckGroundingResponse prototype)

toBuilder

public CheckGroundingResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CheckGroundingResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CheckGroundingResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<CheckGroundingResponse> parser()

getParserForType

public com.google.protobuf.Parser<CheckGroundingResponse> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CheckGroundingResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder