Class CheckGroundingResponse.Claim.Builder (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class CheckGroundingResponse.Claim.Builder extends GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder> implements CheckGroundingResponse.ClaimOrBuilder

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

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

Inheritance

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

Implements

CheckGroundingResponse.ClaimOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllCitationIndices(Iterable<? extends Integer> values)

public CheckGroundingResponse.Claim.Builder addAllCitationIndices(Iterable<? extends Integer> values)

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
values	Iterable<? extends java.lang.Integer> The citationIndices to add.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

addCitationIndices(int value)

public CheckGroundingResponse.Claim.Builder addCitationIndices(int value)

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
value	int The citationIndices to add.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CheckGroundingResponse.Claim.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CheckGroundingResponse.Claim build()

Returns
Type	Description
CheckGroundingResponse.Claim

buildPartial()

public CheckGroundingResponse.Claim buildPartial()

Returns
Type	Description
CheckGroundingResponse.Claim

clear()

public CheckGroundingResponse.Claim.Builder clear()

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCitationIndices()

public CheckGroundingResponse.Claim.Builder clearCitationIndices()

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;

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

clearClaimText()

public CheckGroundingResponse.Claim.Builder clearClaimText()

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
CheckGroundingResponse.Claim.Builder	This builder for chaining.

clearEndPos()

public CheckGroundingResponse.Claim.Builder clearEndPos()

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

optional int32 end_pos = 2;

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CheckGroundingResponse.Claim.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGroundingCheckRequired()

public CheckGroundingResponse.Claim.Builder clearGroundingCheckRequired()

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, anti_citation_indices, and score should not be returned.

optional bool grounding_check_required = 6;

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CheckGroundingResponse.Claim.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearStartPos()

public CheckGroundingResponse.Claim.Builder clearStartPos()

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

optional int32 start_pos = 1;

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

clone()

public CheckGroundingResponse.Claim.Builder clone()

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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()

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;

Returns
Type	Description
int	The count of citationIndices.

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;

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEndPos()

public int getEndPos()

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

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, anti_citation_indices, and score should not be returned.

optional bool grounding_check_required = 6;

Returns
Type	Description
boolean	The groundingCheckRequired.

getStartPos()

public int getStartPos()

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

optional int32 start_pos = 1;

Returns
Type	Description
int	The startPos.

hasEndPos()

public boolean hasEndPos()

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

optional int32 end_pos = 2;

Returns
Type	Description
boolean	Whether the endPos field is set.

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, anti_citation_indices, and score should not be returned.

optional bool grounding_check_required = 6;

Returns
Type	Description
boolean	Whether the groundingCheckRequired field is set.

hasStartPos()

public boolean hasStartPos()

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

optional int32 start_pos = 1;

Returns
Type	Description
boolean	Whether the startPos field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CheckGroundingResponse.Claim other)

public CheckGroundingResponse.Claim.Builder mergeFrom(CheckGroundingResponse.Claim other)

Parameter
Name	Description
other	CheckGroundingResponse.Claim

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CheckGroundingResponse.Claim.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CheckGroundingResponse.Claim.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CheckGroundingResponse.Claim.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCitationIndices(int index, int value)

public CheckGroundingResponse.Claim.Builder setCitationIndices(int index, int value)

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;

Parameters
Name	Description
index	int The index to set the value at.
value	int The citationIndices to set.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

setClaimText(String value)

public CheckGroundingResponse.Claim.Builder setClaimText(String value)

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

string claim_text = 3;

Parameter
Name	Description
value	String The claimText to set.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

setClaimTextBytes(ByteString value)

public CheckGroundingResponse.Claim.Builder setClaimTextBytes(ByteString value)

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

string claim_text = 3;

Parameter
Name	Description
value	ByteString The bytes for claimText to set.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

setEndPos(int value)

public CheckGroundingResponse.Claim.Builder setEndPos(int value)

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

optional int32 end_pos = 2;

Parameter
Name	Description
value	int The endPos to set.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CheckGroundingResponse.Claim.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGroundingCheckRequired(boolean value)

public CheckGroundingResponse.Claim.Builder setGroundingCheckRequired(boolean value)

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, anti_citation_indices, and score should not be returned.

optional bool grounding_check_required = 6;

Parameter
Name	Description
value	boolean The groundingCheckRequired to set.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CheckGroundingResponse.Claim.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStartPos(int value)

public CheckGroundingResponse.Claim.Builder setStartPos(int value)

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

optional int32 start_pos = 1;

Parameter
Name	Description
value	int The startPos to set.

Returns
Type	Description
CheckGroundingResponse.Claim.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CheckGroundingResponse.Claim.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CheckGroundingResponse.Claim.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)