Google Cloud Discovery Engine V1 Client - Class ControlPoint (1.3.1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ControlPoint.

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest \ BoostSpec \ ConditionBoostSpec \ BoostControlSpec

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ attribute_value string

Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD]<xref uid="\N\M">T[nH</xref>[nS]].
↳ boost_amount float

The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.

getAttributeValue

Can be one of:

  1. The numerical field value.

  2. The duration spec for freshness: The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD]<xref uid="\N\M">T[nH</xref>[nS]].

Returns
Type Description
string

setAttributeValue

Can be one of:

  1. The numerical field value.

  2. The duration spec for freshness: The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD]<xref uid="\N\M">T[nH</xref>[nS]].

Parameter
Name Description
var string
Returns
Type Description
$this

getBoostAmount

The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.

Returns
Type Description
float

setBoostAmount

The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.

Parameter
Name Description
var float
Returns
Type Description
$this