Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::Control::BoostAction (v1.0.1)

Version 1.0.1

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Control::BoostAction.

Adjusts order of products in returned list.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#boost

def boost() -> ::Float

Returns

• (::Float) — Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

#boost=

def boost=(value) -> ::Float

Parameter

• value (::Float) — Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

Returns

• (::Float) — Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

#data_store

def data_store() -> ::String

Returns

• (::String) — Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

#data_store=

def data_store=(value) -> ::String

Parameter

• value (::String) — Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

Returns

• (::String) — Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

#filter

def filter() -> ::String

Returns

• (::String) — Required. Specifies which products to apply the boost to.

  If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.

#filter=

def filter=(value) -> ::String

Parameter

• value (::String) — Required. Specifies which products to apply the boost to.

  If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.

Returns

• (::String) — Required. Specifies which products to apply the boost to.

  If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.