com.google.cloud.discoveryengine.v1alpha

Class CheckGroundingResponse.Claim

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim

All Implemented Interfaces:

CheckGroundingResponse.ClaimOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

CheckGroundingResponse

public static final class CheckGroundingResponse.Claim
extends com.google.protobuf.GeneratedMessageV3
implements CheckGroundingResponse.ClaimOrBuilder

 Text and citation info for a claim in the answer candidate.
 

Protobuf type google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckGroundingResponse.Claim.Builder Text and citation info for a claim in the answer candidate.

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	CITATION_INDICES_FIELD_NUMBER
static int	CLAIM_TEXT_FIELD_NUMBER
static int	END_POS_FIELD_NUMBER
static int	GROUNDING_CHECK_REQUIRED_FIELD_NUMBER
static int	START_POS_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)
int	getCitationIndices(int index) A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
int	getCitationIndicesCount() A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
List<Integer>	getCitationIndicesList() A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
String	getClaimText() Text for the claim in the answer candidate.
com.google.protobuf.ByteString	getClaimTextBytes() Text for the claim in the answer candidate.
static CheckGroundingResponse.Claim	getDefaultInstance()
CheckGroundingResponse.Claim	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getEndPos() Position indicating the end of the claim in the answer candidate, exclusive.
boolean	getGroundingCheckRequired() Indicates that this claim required grounding check.
com.google.protobuf.Parser<CheckGroundingResponse.Claim>	getParserForType()
int	getSerializedSize()
int	getStartPos() Position indicating the start of the claim in the answer candidate, measured in bytes.
boolean	hasEndPos() Position indicating the end of the claim in the answer candidate, exclusive.
boolean	hasGroundingCheckRequired() Indicates that this claim required grounding check.
int	hashCode()
boolean	hasStartPos() Position indicating the start of the claim in the answer candidate, measured in bytes.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CheckGroundingResponse.Claim.Builder	newBuilder()
static CheckGroundingResponse.Claim.Builder	newBuilder(CheckGroundingResponse.Claim prototype)
CheckGroundingResponse.Claim.Builder	newBuilderForType()
protected CheckGroundingResponse.Claim.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CheckGroundingResponse.Claim	parseDelimitedFrom(InputStream input)
static CheckGroundingResponse.Claim	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse.Claim	parseFrom(byte[] data)
static CheckGroundingResponse.Claim	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse.Claim	parseFrom(ByteBuffer data)
static CheckGroundingResponse.Claim	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse.Claim	parseFrom(com.google.protobuf.ByteString data)
static CheckGroundingResponse.Claim	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse.Claim	parseFrom(com.google.protobuf.CodedInputStream input)
static CheckGroundingResponse.Claim	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingResponse.Claim	parseFrom(InputStream input)
static CheckGroundingResponse.Claim	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CheckGroundingResponse.Claim>	parser()
CheckGroundingResponse.Claim.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

START_POS_FIELD_NUMBER

public static final int START_POS_FIELD_NUMBER

See Also:

Constant Field Values

END_POS_FIELD_NUMBER

public static final int END_POS_FIELD_NUMBER

See Also:

Constant Field Values

CLAIM_TEXT_FIELD_NUMBER

public static final int CLAIM_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

CITATION_INDICES_FIELD_NUMBER

public static final int CITATION_INDICES_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

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

hasStartPos

public boolean hasStartPos()

 Position indicating the start of the claim in the answer candidate,
 measured in bytes.
 

optional int32 start_pos = 1;

Specified by:

hasStartPos in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

Whether the startPos field is set.

getStartPos

public int getStartPos()

 Position indicating the start of the claim in the answer candidate,
 measured in bytes.
 

optional int32 start_pos = 1;

Specified by:

getStartPos in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

The startPos.

hasEndPos

public boolean hasEndPos()

 Position indicating the end of the claim in the answer candidate,
 exclusive.
 

optional int32 end_pos = 2;

Specified by:

hasEndPos in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

Whether the endPos field is set.

getEndPos

public int getEndPos()

 Position indicating the end of the claim in the answer candidate,
 exclusive.
 

optional int32 end_pos = 2;

Specified by:

getEndPos in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

The endPos.

getClaimText

public String getClaimText()

 Text for the claim in the answer candidate. Always provided regardless of
 whether citations or anti-citations are found.
 

string claim_text = 3;

Specified by:

getClaimText in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

The claimText.

getClaimTextBytes

public com.google.protobuf.ByteString getClaimTextBytes()

 Text for the claim in the answer candidate. Always provided regardless of
 whether citations or anti-citations are found.
 

string claim_text = 3;

Specified by:

getClaimTextBytes in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

The bytes for claimText.

getCitationIndicesList

public List<Integer> getCitationIndicesList()

 A list of indices (into 'cited_chunks') specifying the citations
 associated with the claim. For instance [1,3,4] means that
 cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
 supporting for the claim. A citation to a fact indicates that the claim
 is supported by the fact.
 

repeated int32 citation_indices = 4;

Specified by:

getCitationIndicesList in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

A list containing the citationIndices.

getCitationIndicesCount

public int getCitationIndicesCount()

 A list of indices (into 'cited_chunks') specifying the citations
 associated with the claim. For instance [1,3,4] means that
 cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
 supporting for the claim. A citation to a fact indicates that the claim
 is supported by the fact.
 

repeated int32 citation_indices = 4;

Specified by:

getCitationIndicesCount in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

The count of citationIndices.

getCitationIndices

public int getCitationIndices(int index)

 A list of indices (into 'cited_chunks') specifying the citations
 associated with the claim. For instance [1,3,4] means that
 cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
 supporting for the claim. A citation to a fact indicates that the claim
 is supported by the fact.
 

repeated int32 citation_indices = 4;

Specified by:

getCitationIndices in interface CheckGroundingResponse.ClaimOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The citationIndices at the given index.

hasGroundingCheckRequired

public boolean hasGroundingCheckRequired()

 Indicates that this claim required grounding check. When the system
 decided this claim doesn't require attribution/grounding check, this
 field will be set to false. In that case, no grounding check was done for
 the claim and therefore
 [citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.citation_indices],
 and
 [anti_citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.anti_citation_indices]
 should not be returned.
 

optional bool grounding_check_required = 6;

Specified by:

hasGroundingCheckRequired in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

Whether the groundingCheckRequired field is set.

getGroundingCheckRequired

public boolean getGroundingCheckRequired()

 Indicates that this claim required grounding check. When the system
 decided this claim doesn't require attribution/grounding check, this
 field will be set to false. In that case, no grounding check was done for
 the claim and therefore
 [citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.citation_indices],
 and
 [anti_citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.anti_citation_indices]
 should not be returned.
 

optional bool grounding_check_required = 6;

Specified by:

getGroundingCheckRequired in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

The groundingCheckRequired.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse.Claim 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.Claim parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingResponse.Claim parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static CheckGroundingResponse.Claim parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public CheckGroundingResponse.Claim.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CheckGroundingResponse.Claim.Builder newBuilder()

newBuilder

public static CheckGroundingResponse.Claim.Builder newBuilder(CheckGroundingResponse.Claim prototype)

toBuilder

public CheckGroundingResponse.Claim.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CheckGroundingResponse.Claim getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<CheckGroundingResponse.Claim> 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.Claim getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder