com.google.cloud.discoveryengine.v1beta

Class CheckGroundingResponse.Claim.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

com.google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.Builder

All Implemented Interfaces:

CheckGroundingResponse.ClaimOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

CheckGroundingResponse.Claim

public static final class CheckGroundingResponse.Claim.Builder
extends com.google.protobuf.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

Method Summary

Modifier and Type	Method and Description
CheckGroundingResponse.Claim.Builder	addAllCitationIndices(Iterable<? extends Integer> values) A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
CheckGroundingResponse.Claim.Builder	addCitationIndices(int value) A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
CheckGroundingResponse.Claim.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CheckGroundingResponse.Claim	build()
CheckGroundingResponse.Claim	buildPartial()
CheckGroundingResponse.Claim.Builder	clear()
CheckGroundingResponse.Claim.Builder	clearCitationIndices() A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
CheckGroundingResponse.Claim.Builder	clearClaimText() Text for the claim in the answer candidate.
CheckGroundingResponse.Claim.Builder	clearEndPos() Position indicating the end of the claim in the answer candidate, exclusive.
CheckGroundingResponse.Claim.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
CheckGroundingResponse.Claim.Builder	clearGroundingCheckRequired() Indicates that this claim required grounding check.
CheckGroundingResponse.Claim.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
CheckGroundingResponse.Claim.Builder	clearStartPos() Position indicating the start of the claim in the answer candidate, measured in bytes.
CheckGroundingResponse.Claim.Builder	clone()
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.
CheckGroundingResponse.Claim	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getEndPos() Position indicating the end of the claim in the answer candidate, exclusive.
boolean	getGroundingCheckRequired() Indicates that this claim required grounding check.
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.
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()
CheckGroundingResponse.Claim.Builder	mergeFrom(CheckGroundingResponse.Claim other)
CheckGroundingResponse.Claim.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
CheckGroundingResponse.Claim.Builder	mergeFrom(com.google.protobuf.Message other)
CheckGroundingResponse.Claim.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
CheckGroundingResponse.Claim.Builder	setCitationIndices(int index, int value) A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
CheckGroundingResponse.Claim.Builder	setClaimText(String value) Text for the claim in the answer candidate.
CheckGroundingResponse.Claim.Builder	setClaimTextBytes(com.google.protobuf.ByteString value) Text for the claim in the answer candidate.
CheckGroundingResponse.Claim.Builder	setEndPos(int value) Position indicating the end of the claim in the answer candidate, exclusive.
CheckGroundingResponse.Claim.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CheckGroundingResponse.Claim.Builder	setGroundingCheckRequired(boolean value) Indicates that this claim required grounding check.
CheckGroundingResponse.Claim.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
CheckGroundingResponse.Claim.Builder	setStartPos(int value) Position indicating the start of the claim in the answer candidate, measured in bytes.
CheckGroundingResponse.Claim.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<CheckGroundingResponse.Claim.Builder>

clear

public CheckGroundingResponse.Claim.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

getDefaultInstanceForType

public CheckGroundingResponse.Claim getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public CheckGroundingResponse.Claim build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public CheckGroundingResponse.Claim buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public CheckGroundingResponse.Claim.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

clearField

public CheckGroundingResponse.Claim.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

clearOneof

public CheckGroundingResponse.Claim.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

mergeFrom

public CheckGroundingResponse.Claim.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CheckGroundingResponse.Claim.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CheckGroundingResponse.Claim.Builder>

Throws:

IOException

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.

setStartPos

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;

Parameters:

value - The startPos to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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.

setEndPos

public CheckGroundingResponse.Claim.Builder setEndPos(int value)

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

optional int32 end_pos = 2;

Parameters:

value - The endPos to set.

Returns:

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:

This builder for chaining.

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.

setClaimText

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;

Parameters:

value - The claimText to set.

Returns:

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:

This builder for chaining.

setClaimTextBytes

public CheckGroundingResponse.Claim.Builder setClaimTextBytes(com.google.protobuf.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;

Parameters:

value - The bytes for claimText to set.

Returns:

This builder for chaining.

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.

setCitationIndices

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:

index - The index to set the value at.

value - The citationIndices to set.

Returns:

This builder for chaining.

addCitationIndices

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;

Parameters:

value - The citationIndices to add.

Returns:

This builder for chaining.

addAllCitationIndices

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;

Parameters:

values - The citationIndices to add.

Returns:

This builder for chaining.

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:

This builder for chaining.

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.v1beta.CheckGroundingResponse.Claim.citation_indices],
 [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
 and
 [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
 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.v1beta.CheckGroundingResponse.Claim.citation_indices],
 [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
 and
 [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
 should not be returned.
 

optional bool grounding_check_required = 6;

Specified by:

getGroundingCheckRequired in interface CheckGroundingResponse.ClaimOrBuilder

Returns:

The groundingCheckRequired.

setGroundingCheckRequired

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][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
 [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
 and
 [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
 should not be returned.
 

optional bool grounding_check_required = 6;

Parameters:

value - The groundingCheckRequired to set.

Returns:

This builder for chaining.

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][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
 [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
 and
 [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
 should not be returned.
 

optional bool grounding_check_required = 6;

Returns:

This builder for chaining.

setUnknownFields

public final CheckGroundingResponse.Claim.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>

mergeUnknownFields

public final CheckGroundingResponse.Claim.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CheckGroundingResponse.Claim.Builder>