Interface CheckGroundingResponseOrBuilder (0.38.0)

public interface CheckGroundingResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCitedChunks(int index)

public abstract FactChunk getCitedChunks(int index)

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

repeated .google.cloud.discoveryengine.v1beta.FactChunk cited_chunks = 3;

Parameter
Name Description
index int
Returns
Type Description
FactChunk

getCitedChunksCount()

public abstract int getCitedChunksCount()

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

repeated .google.cloud.discoveryengine.v1beta.FactChunk cited_chunks = 3;

Returns
Type Description
int

getCitedChunksList()

public abstract List<FactChunk> getCitedChunksList()

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

repeated .google.cloud.discoveryengine.v1beta.FactChunk cited_chunks = 3;

Returns
Type Description
List<FactChunk>

getCitedChunksOrBuilder(int index)

public abstract FactChunkOrBuilder getCitedChunksOrBuilder(int index)

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

repeated .google.cloud.discoveryengine.v1beta.FactChunk cited_chunks = 3;

Parameter
Name Description
index int
Returns
Type Description
FactChunkOrBuilder

getCitedChunksOrBuilderList()

public abstract List<? extends FactChunkOrBuilder> getCitedChunksOrBuilderList()

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

repeated .google.cloud.discoveryengine.v1beta.FactChunk cited_chunks = 3;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.FactChunkOrBuilder>

getClaims(int index)

public abstract CheckGroundingResponse.Claim getClaims(int index)

Claim texts and citation info across all claims in the answer candidate.

repeated .google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim claims = 4;

Parameter
Name Description
index int
Returns
Type Description
CheckGroundingResponse.Claim

getClaimsCount()

public abstract int getClaimsCount()

Claim texts and citation info across all claims in the answer candidate.

repeated .google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim claims = 4;

Returns
Type Description
int

getClaimsList()

public abstract List<CheckGroundingResponse.Claim> getClaimsList()

Claim texts and citation info across all claims in the answer candidate.

repeated .google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim claims = 4;

Returns
Type Description
List<Claim>

getClaimsOrBuilder(int index)

public abstract CheckGroundingResponse.ClaimOrBuilder getClaimsOrBuilder(int index)

Claim texts and citation info across all claims in the answer candidate.

repeated .google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim claims = 4;

Parameter
Name Description
index int
Returns
Type Description
CheckGroundingResponse.ClaimOrBuilder

getClaimsOrBuilderList()

public abstract List<? extends CheckGroundingResponse.ClaimOrBuilder> getClaimsOrBuilderList()

Claim texts and citation info across all claims in the answer candidate.

repeated .google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim claims = 4;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.CheckGroundingResponse.ClaimOrBuilder>

getSupportScore()

public abstract float getSupportScore()

The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.

optional float support_score = 1;

Returns
Type Description
float

The supportScore.

hasSupportScore()

public abstract boolean hasSupportScore()

The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.

optional float support_score = 1;

Returns
Type Description
boolean

Whether the supportScore field is set.