Google Cloud Discovery Engine V1beta Client - Class CheckGroundingRequest (0.11.2)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class CheckGroundingRequest.

Request message for GroundedGenerationService.CheckGrounding method.

Generated from protobuf message google.cloud.discoveryengine.v1beta.CheckGroundingRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ grounding_config string

Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.

↳ answer_candidate string

Answer candidate to check.

↳ facts array<Google\Cloud\DiscoveryEngine\V1beta\GroundingFact>

List of facts for the grounding check. We support up to 200 facts.

↳ grounding_spec Google\Cloud\DiscoveryEngine\V1beta\CheckGroundingSpec

Configuration of the grounding check.

getGroundingConfig

Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.

Returns
Type Description
string

setGroundingConfig

Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.

Parameter
Name Description
var string
Returns
Type Description
$this

getAnswerCandidate

Answer candidate to check.

Returns
Type Description
string

setAnswerCandidate

Answer candidate to check.

Parameter
Name Description
var string
Returns
Type Description
$this

getFacts

List of facts for the grounding check.

We support up to 200 facts.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFacts

List of facts for the grounding check.

We support up to 200 facts.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1beta\GroundingFact>
Returns
Type Description
$this

getGroundingSpec

Configuration of the grounding check.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1beta\CheckGroundingSpec|null

hasGroundingSpec

clearGroundingSpec

setGroundingSpec

Configuration of the grounding check.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1beta\CheckGroundingSpec
Returns
Type Description
$this