com.google.cloud.discoveryengine.v1

Class Answer.GroundingSupport

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.Answer.GroundingSupport

All Implemented Interfaces:

Answer.GroundingSupportOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Answer

public static final class Answer.GroundingSupport
extends com.google.protobuf.GeneratedMessage
implements Answer.GroundingSupportOrBuilder

 Grounding support for a claim in `answer_text`.
 

Protobuf type google.cloud.discoveryengine.v1.Answer.GroundingSupport

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Answer.GroundingSupport.Builder Grounding support for a claim in `answer_text`.

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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	END_INDEX_FIELD_NUMBER
static int	GROUNDING_CHECK_REQUIRED_FIELD_NUMBER
static int	GROUNDING_SCORE_FIELD_NUMBER
static int	SOURCES_FIELD_NUMBER
static int	START_INDEX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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)
static Answer.GroundingSupport	getDefaultInstance()
Answer.GroundingSupport	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
long	getEndIndex() Required.
boolean	getGroundingCheckRequired() Indicates that this claim required grounding check.
double	getGroundingScore() A score in the range of [0, 1] describing how grounded is a specific claim by the references.
com.google.protobuf.Parser<Answer.GroundingSupport>	getParserForType()
int	getSerializedSize()
Answer.CitationSource	getSources(int index) Optional.
int	getSourcesCount() Optional.
List<Answer.CitationSource>	getSourcesList() Optional.
Answer.CitationSourceOrBuilder	getSourcesOrBuilder(int index) Optional.
List<? extends Answer.CitationSourceOrBuilder>	getSourcesOrBuilderList() Optional.
long	getStartIndex() Required.
boolean	hasGroundingCheckRequired() Indicates that this claim required grounding check.
boolean	hasGroundingScore() A score in the range of [0, 1] describing how grounded is a specific claim by the references.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Answer.GroundingSupport.Builder	newBuilder()
static Answer.GroundingSupport.Builder	newBuilder(Answer.GroundingSupport prototype)
Answer.GroundingSupport.Builder	newBuilderForType()
protected Answer.GroundingSupport.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Answer.GroundingSupport	parseDelimitedFrom(InputStream input)
static Answer.GroundingSupport	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.GroundingSupport	parseFrom(byte[] data)
static Answer.GroundingSupport	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.GroundingSupport	parseFrom(ByteBuffer data)
static Answer.GroundingSupport	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.GroundingSupport	parseFrom(com.google.protobuf.ByteString data)
static Answer.GroundingSupport	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.GroundingSupport	parseFrom(com.google.protobuf.CodedInputStream input)
static Answer.GroundingSupport	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.GroundingSupport	parseFrom(InputStream input)
static Answer.GroundingSupport	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Answer.GroundingSupport>	parser()
Answer.GroundingSupport.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

START_INDEX_FIELD_NUMBER

public static final int START_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

END_INDEX_FIELD_NUMBER

public static final int END_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

GROUNDING_SCORE_FIELD_NUMBER

public static final int GROUNDING_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

GROUNDING_CHECK_REQUIRED_FIELD_NUMBER

public static final int GROUNDING_CHECK_REQUIRED_FIELD_NUMBER

See Also:

Constant Field Values

SOURCES_FIELD_NUMBER

public static final int SOURCES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getStartIndex

public long getStartIndex()

 Required. Index indicates the start of the claim, measured in bytes
 (UTF-8 unicode).
 

int64 start_index = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getStartIndex in interface Answer.GroundingSupportOrBuilder

Returns:

The startIndex.

getEndIndex

public long getEndIndex()

 Required. End of the claim, exclusive.
 

int64 end_index = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getEndIndex in interface Answer.GroundingSupportOrBuilder

Returns:

The endIndex.

hasGroundingScore

public boolean hasGroundingScore()

 A score in the range of [0, 1] describing how grounded is a specific
 claim by the references.
 Higher value means that the claim is better supported by the reference
 chunks.
 

optional double grounding_score = 3;

Specified by:

hasGroundingScore in interface Answer.GroundingSupportOrBuilder

Returns:

Whether the groundingScore field is set.

getGroundingScore

public double getGroundingScore()

 A score in the range of [0, 1] describing how grounded is a specific
 claim by the references.
 Higher value means that the claim is better supported by the reference
 chunks.
 

optional double grounding_score = 3;

Specified by:

getGroundingScore in interface Answer.GroundingSupportOrBuilder

Returns:

The groundingScore.

hasGroundingCheckRequired

public boolean hasGroundingCheckRequired()

 Indicates that this claim required grounding check. When the
 system decided this claim didn't require attribution/grounding check,
 this field is set to false. In that case, no grounding check was
 done for the claim and therefore `grounding_score`, `sources` is not
 returned.
 

optional bool grounding_check_required = 4;

Specified by:

hasGroundingCheckRequired in interface Answer.GroundingSupportOrBuilder

Returns:

Whether the groundingCheckRequired field is set.

getGroundingCheckRequired

public boolean getGroundingCheckRequired()

 Indicates that this claim required grounding check. When the
 system decided this claim didn't require attribution/grounding check,
 this field is set to false. In that case, no grounding check was
 done for the claim and therefore `grounding_score`, `sources` is not
 returned.
 

optional bool grounding_check_required = 4;

Specified by:

getGroundingCheckRequired in interface Answer.GroundingSupportOrBuilder

Returns:

The groundingCheckRequired.

getSourcesList

public List<Answer.CitationSource> getSourcesList()

 Optional. Citation sources for the claim.
 

repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSourcesList in interface Answer.GroundingSupportOrBuilder

getSourcesOrBuilderList

public List<? extends Answer.CitationSourceOrBuilder> getSourcesOrBuilderList()

 Optional. Citation sources for the claim.
 

repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSourcesOrBuilderList in interface Answer.GroundingSupportOrBuilder

getSourcesCount

public int getSourcesCount()

 Optional. Citation sources for the claim.
 

repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSourcesCount in interface Answer.GroundingSupportOrBuilder

getSources

public Answer.CitationSource getSources(int index)

 Optional. Citation sources for the claim.
 

repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSources in interface Answer.GroundingSupportOrBuilder

getSourcesOrBuilder

public Answer.CitationSourceOrBuilder getSourcesOrBuilder(int index)

 Optional. Citation sources for the claim.
 

repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSourcesOrBuilder in interface Answer.GroundingSupportOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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 Answer.GroundingSupport parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Answer.GroundingSupport parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Answer.GroundingSupport parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Answer.GroundingSupport.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Answer.GroundingSupport.Builder newBuilder()

newBuilder

public static Answer.GroundingSupport.Builder newBuilder(Answer.GroundingSupport prototype)

toBuilder

public Answer.GroundingSupport.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Answer.GroundingSupport.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Answer.GroundingSupport getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Answer.GroundingSupport> 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.GeneratedMessage

getDefaultInstanceForType

public Answer.GroundingSupport getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder