Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class CheckGroundingResponse.Claim (0.71.0)

public static final class CheckGroundingResponse.Claim extends GeneratedMessageV3 implements CheckGroundingResponse.ClaimOrBuilder

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

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CheckGroundingResponse.Claim

Implements

CheckGroundingResponse.ClaimOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CITATION_INDICES_FIELD_NUMBER

public static final int CITATION_INDICES_FIELD_NUMBER

Field Value
Type	Description
`int`

CLAIM_TEXT_FIELD_NUMBER

public static final int CLAIM_TEXT_FIELD_NUMBER

Field Value
Type	Description
`int`

END_POS_FIELD_NUMBER

public static final int END_POS_FIELD_NUMBER

Field Value
Type	Description
`int`

GROUNDING_CHECK_REQUIRED_FIELD_NUMBER

public static final int GROUNDING_CHECK_REQUIRED_FIELD_NUMBER

Field Value
Type	Description
`int`

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER

Field Value
Type	Description
`int`

START_POS_FIELD_NUMBER

public static final int START_POS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static CheckGroundingResponse.Claim getDefaultInstance()

Returns
Type	Description
`CheckGroundingResponse.Claim`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CheckGroundingResponse.Claim.Builder newBuilder()

Returns
Type	Description
`CheckGroundingResponse.Claim.Builder`

newBuilder(CheckGroundingResponse.Claim prototype)

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

Parameter
Name	Description
`prototype`	`CheckGroundingResponse.Claim`

Returns
Type	Description
`CheckGroundingResponse.Claim.Builder`

parseDelimitedFrom(InputStream input)

public static CheckGroundingResponse.Claim parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingResponse.Claim parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CheckGroundingResponse.Claim parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingResponse.Claim parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CheckGroundingResponse.Claim parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingResponse.Claim parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CheckGroundingResponse.Claim parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingResponse.Claim parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CheckGroundingResponse.Claim parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingResponse.Claim parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CheckGroundingResponse.Claim parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingResponse.Claim parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CheckGroundingResponse.Claim`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CheckGroundingResponse.Claim> parser()

Returns
Type	Description
`Parser<Claim>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCitationIndices(int index)

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;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`int`	The citationIndices at the given index.

getCitationIndicesCount()

public int getCitationIndicesCount()

repeated int32 citation_indices = 4;

Returns
Type	Description
`int`	The count of citationIndices.

getCitationIndicesList()

public List<Integer> getCitationIndicesList()

repeated int32 citation_indices = 4;

Returns
Type	Description
`List<Integer>`	A list containing the citationIndices.

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;

Returns
Type	Description
`String`	The claimText.

getClaimTextBytes()

public 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;

Returns
Type	Description
`ByteString`	The bytes for claimText.

getDefaultInstanceForType()

public CheckGroundingResponse.Claim getDefaultInstanceForType()

Returns
Type	Description
`CheckGroundingResponse.Claim`

getEndPos()

public int getEndPos()

Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).

optional int32 end_pos = 2;

Returns
Type	Description
`int`	The endPos.

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 should not be returned.

optional bool grounding_check_required = 6;

Returns
Type	Description
`boolean`	The groundingCheckRequired.

getParserForType()

public Parser<CheckGroundingResponse.Claim> getParserForType()

Returns
Type	Description
`Parser<Claim>`

Overrides

GeneratedMessageV3.getParserForType()

getScore()

public double getScore()

Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when CheckGroundingRequest.grounding_spec.enable_claim_level_score is true.

optional double score = 7;

Returns
Type	Description
`double`	The score.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getStartPos()

public int getStartPos()

Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).

optional int32 start_pos = 1;

Returns
Type	Description
`int`	The startPos.

hasEndPos()

public boolean hasEndPos()

optional int32 end_pos = 2;

Returns
Type	Description
`boolean`	Whether the endPos field is set.

hasGroundingCheckRequired()

public boolean hasGroundingCheckRequired()

optional bool grounding_check_required = 6;

Returns
Type	Description
`boolean`	Whether the groundingCheckRequired field is set.

hasScore()

public boolean hasScore()

Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when CheckGroundingRequest.grounding_spec.enable_claim_level_score is true.

optional double score = 7;

Returns
Type	Description
`boolean`	Whether the score field is set.

hasStartPos()

public boolean hasStartPos()

optional int32 start_pos = 1;

Returns
Type	Description
`boolean`	Whether the startPos field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CheckGroundingResponse.Claim.Builder newBuilderForType()

Returns
Type	Description
`CheckGroundingResponse.Claim.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CheckGroundingResponse.Claim.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`CheckGroundingResponse.Claim.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CheckGroundingResponse.Claim.Builder toBuilder()

Returns
Type	Description
`CheckGroundingResponse.Claim.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`