Google Cloud Discovery Engine V1 Client - Class GroundingSupport (1.5.1)

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.

↳ sources
array< CitationSource >

Optional. Citation sources for the claim.

getStartIndex

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.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getSources

Optional. Citation sources for the claim.

Returns
Type
Description

setSources

Optional. Citation sources for the claim.

Parameter
Name
Description
var
array< CitationSource >
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: