Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class GroundingSupport.
Grounding support for a claim in answer_text.
Generated from protobuf message google.cloud.discoveryengine.v1.Answer.GroundingSupport
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ Answer
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ start_index
int|string
Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).
↳ end_index
int|string
Required. End of the claim, exclusive.
↳ grounding_score
float
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.
↳ grounding_check_required
bool
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.
Required. Index indicates the start of the claim, measured in bytes
(UTF-8 unicode).
Returns
Type
Description
int|string
setStartIndex
Required. Index indicates the start of the claim, measured in bytes
(UTF-8 unicode).
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getEndIndex
Required. End of the claim, exclusive.
Returns
Type
Description
int|string
setEndIndex
Required. End of the claim, exclusive.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
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.
Returns
Type
Description
float
hasGroundingScore
clearGroundingScore
setGroundingScore
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.
Parameter
Name
Description
var
float
Returns
Type
Description
$this
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.
Returns
Type
Description
bool
hasGroundingCheckRequired
clearGroundingCheckRequired
setGroundingCheckRequired
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class GroundingSupport (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.Answer.GroundingSupport)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.Answer.GroundingSupport)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.Answer.GroundingSupport)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.Answer.GroundingSupport)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.Answer.GroundingSupport)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.Answer.GroundingSupport)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.Answer.GroundingSupport)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.Answer.GroundingSupport)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.Answer.GroundingSupport)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.Answer.GroundingSupport)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.Answer.GroundingSupport)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.Answer.GroundingSupport)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.Answer.GroundingSupport)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.Answer.GroundingSupport)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.Answer.GroundingSupport)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.Answer.GroundingSupport)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.Answer.GroundingSupport) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class GroundingSupport.\n\nGrounding support for a claim in `answer_text`.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.Answer.GroundingSupport`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ Answer\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getStartIndex\n\nRequired. Index indicates the start of the claim, measured in bytes\n(UTF-8 unicode).\n\n### setStartIndex\n\nRequired. Index indicates the start of the claim, measured in bytes\n(UTF-8 unicode).\n\n### getEndIndex\n\nRequired. End of the claim, exclusive.\n\n### setEndIndex\n\nRequired. End of the claim, exclusive.\n\n### getGroundingScore\n\nA score in the range of \\[0, 1\\] describing how grounded is a specific\nclaim by the references.\n\nHigher value means that the claim is better supported by the reference\nchunks.\n\n### hasGroundingScore\n\n### clearGroundingScore\n\n### setGroundingScore\n\nA score in the range of \\[0, 1\\] describing how grounded is a specific\nclaim by the references.\n\nHigher value means that the claim is better supported by the reference\nchunks.\n\n### getGroundingCheckRequired\n\nIndicates that this claim required grounding check. When the\nsystem decided this claim didn't require attribution/grounding check,\nthis field is set to false. In that case, no grounding check was\ndone for the claim and therefore `grounding_score`, `sources` is not\nreturned.\n\n### hasGroundingCheckRequired\n\n### clearGroundingCheckRequired\n\n### setGroundingCheckRequired\n\nIndicates that this claim required grounding check. When the\nsystem decided this claim didn't require attribution/grounding check,\nthis field is set to false. In that case, no grounding check was\ndone for the claim and therefore `grounding_score`, `sources` is not\nreturned.\n\n### getSources\n\nOptional. Citation sources for the claim.\n\n### setSources\n\nOptional. Citation sources for the claim."]]
