Google Cloud Discovery Engine V1 Client - Class CheckGroundingResponse (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CheckGroundingResponse.

Response message for the GroundedGenerationService.CheckGrounding method.

Generated from protobuf message google.cloud.discoveryengine.v1.CheckGroundingResponse

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ support_score float

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.

↳ cited_chunks array<Google\Cloud\DiscoveryEngine\V1\FactChunk>

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

↳ claims array<Google\Cloud\DiscoveryEngine\V1\CheckGroundingResponse\Claim>

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

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.

Returns
Type Description
float

hasSupportScore

clearSupportScore

setSupportScore

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.

Parameter
Name Description
var float
Returns
Type Description
$this

getCitedChunks

List of facts cited across all claims in the answer candidate.

These are derived from the facts supplied in the request.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCitedChunks

List of facts cited across all claims in the answer candidate.

These are derived from the facts supplied in the request.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\FactChunk>
Returns
Type Description
$this

getClaims

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setClaims

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

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\CheckGroundingResponse\Claim>
Returns
Type Description
$this