Google Cloud Ces V1 Client - Class GroundingConfig (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class GroundingConfig.

Grounding configuration.

Generated from protobuf message google.cloud.ces.v1.DataStoreTool.GroundingConfig

Namespace

Google \ Cloud \ Ces \ V1 \ DataStoreTool

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ grounding_level float

Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.

↳ disabled bool

Optional. Whether grounding is disabled.

getGroundingLevel

Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only.

For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.

Returns
Type Description
float

setGroundingLevel

Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only.

For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.

Parameter
Name Description
var float
Returns
Type Description
$this

getDisabled

Optional. Whether grounding is disabled.

Returns
Type Description
bool

setDisabled

Optional. Whether grounding is disabled.

Parameter
Name Description
var bool
Returns
Type Description
$this