Class Answer.GroundingSupport (0.58.0)

public static final class Answer.GroundingSupport extends GeneratedMessageV3 implements Answer.GroundingSupportOrBuilder

Grounding support for a claim in answer_text.

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

Static Fields

END_INDEX_FIELD_NUMBER

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

GROUNDING_SCORE_FIELD_NUMBER

public static final int GROUNDING_SCORE_FIELD_NUMBER
Field Value
Type Description
int

SOURCES_FIELD_NUMBER

public static final int SOURCES_FIELD_NUMBER
Field Value
Type Description
int

START_INDEX_FIELD_NUMBER

public static final int START_INDEX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Answer.GroundingSupport getDefaultInstance()
Returns
Type Description
Answer.GroundingSupport

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Answer.GroundingSupport.Builder newBuilder()
Returns
Type Description
Answer.GroundingSupport.Builder

newBuilder(Answer.GroundingSupport prototype)

public static Answer.GroundingSupport.Builder newBuilder(Answer.GroundingSupport prototype)
Parameter
Name Description
prototype Answer.GroundingSupport
Returns
Type Description
Answer.GroundingSupport.Builder

parseDelimitedFrom(InputStream input)

public static Answer.GroundingSupport parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Answer.GroundingSupport parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Answer.GroundingSupport parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Answer.GroundingSupport parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Answer.GroundingSupport parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Answer.GroundingSupport parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Answer.GroundingSupport parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Answer.GroundingSupport parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Answer.GroundingSupport parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Answer.GroundingSupport parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Answer.GroundingSupport parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Answer.GroundingSupport parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Answer.GroundingSupport> parser()
Returns
Type Description
Parser<GroundingSupport>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Answer.GroundingSupport getDefaultInstanceForType()
Returns
Type Description
Answer.GroundingSupport

getEndIndex()

public long getEndIndex()

Required. End of the claim, exclusive.

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

Returns
Type Description
long

The endIndex.

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;

Returns
Type Description
boolean

The groundingCheckRequired.

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;

Returns
Type Description
double

The groundingScore.

getParserForType()

public Parser<Answer.GroundingSupport> getParserForType()
Returns
Type Description
Parser<GroundingSupport>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSources(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Answer.CitationSource

getSourcesCount()

public int getSourcesCount()

Optional. Citation sources for the claim.

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

Returns
Type Description
int

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

Returns
Type Description
List<CitationSource>

getSourcesOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Answer.CitationSourceOrBuilder

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

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.Answer.CitationSourceOrBuilder>

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

Returns
Type Description
long

The startIndex.

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;

Returns
Type Description
boolean

Whether the groundingCheckRequired field is set.

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;

Returns
Type Description
boolean

Whether the groundingScore field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Answer.GroundingSupport.Builder newBuilderForType()
Returns
Type Description
Answer.GroundingSupport.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Answer.GroundingSupport.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Answer.GroundingSupport.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Answer.GroundingSupport.Builder toBuilder()
Returns
Type Description
Answer.GroundingSupport.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException