com.google.cloud.discoveryengine.v1

Interface Answer.GroundingSupportOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Answer.GroundingSupport, Answer.GroundingSupport.Builder

Enclosing class:

Answer

public static interface Answer.GroundingSupportOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
long	getEndIndex() Required.
boolean	getGroundingCheckRequired() Indicates that this claim required grounding check.
double	getGroundingScore() A score in the range of [0, 1] describing how grounded is a specific claim by the references.
Answer.CitationSource	getSources(int index) Optional.
int	getSourcesCount() Optional.
List<Answer.CitationSource>	getSourcesList() Optional.
Answer.CitationSourceOrBuilder	getSourcesOrBuilder(int index) Optional.
List<? extends Answer.CitationSourceOrBuilder>	getSourcesOrBuilderList() Optional.
long	getStartIndex() Required.
boolean	hasGroundingCheckRequired() Indicates that this claim required grounding check.
boolean	hasGroundingScore() A score in the range of [0, 1] describing how grounded is a specific claim by the references.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getStartIndex

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:

The startIndex.

getEndIndex

long getEndIndex()

 Required. End of the claim, exclusive.
 

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

Returns:

The endIndex.

hasGroundingScore

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:

Whether the groundingScore field is set.

getGroundingScore

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:

The groundingScore.

hasGroundingCheckRequired

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:

Whether the groundingCheckRequired field is set.

getGroundingCheckRequired

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:

The groundingCheckRequired.

getSourcesList

List<Answer.CitationSource> getSourcesList()

 Optional. Citation sources for the claim.
 

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

getSources

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

getSourcesCount

int getSourcesCount()

 Optional. Citation sources for the claim.
 

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

getSourcesOrBuilderList

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

getSourcesOrBuilder

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