Interface Answer.GroundingSupportOrBuilder (0.58.0)

public static interface Answer.GroundingSupportOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndIndex()

public abstract 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 abstract 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 abstract 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.

getSources(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.