Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CheckGroundingRequest.
Request message for GroundedGenerationService.CheckGrounding method.
Generated from protobuf message google.cloud.discoveryengine.v1.CheckGroundingRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
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. Can have a maximum length of 1024 characters.
↳ facts
array< Google\Cloud\DiscoveryEngine\V1\GroundingFact
>
List of facts for the grounding check. We support up to 200 facts.
↳ grounding_spec
↳ user_labels
array| Google\Protobuf\Internal\MapField
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.
getGroundingConfig
Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config
.
string
setGroundingConfig
Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config
.
var
string
$this
getAnswerCandidate
Answer candidate to check. Can have a maximum length of 1024 characters.
string
setAnswerCandidate
Answer candidate to check. Can have a maximum length of 1024 characters.
var
string
$this
getFacts
List of facts for the grounding check.
We support up to 200 facts.
setFacts
List of facts for the grounding check.
We support up to 200 facts.
$this
getGroundingSpec
Configuration of the grounding check.
hasGroundingSpec
clearGroundingSpec
setGroundingSpec
Configuration of the grounding check.
$this
getUserLabels
The user labels applied to a resource must meet the following requirements:
-
Each resource can have multiple labels, up to a maximum of 64.
-
Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
- Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.
setUserLabels
The user labels applied to a resource must meet the following requirements:
-
Each resource can have multiple labels, up to a maximum of 64.
-
Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
- Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.
$this
