Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction.
Adjusts order of products in returned list.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#boost
defboost()->::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=
defboost=(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
defdata_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=
defdata_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
deffilter()->::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=
deffilter=(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.
[[["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,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-Control-BoostAction) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction.\n\nAdjusts order of products in returned list. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #boost\n\n def boost() -\u003e ::Float\n\n**Returns**\n\n- (::Float) --- Required. Strength of the boost, which should be in \\[-1, 1\\]. Negative boost means demotion. Default is 0.0 (No-op).\n\n### #boost=\n\n def boost=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::Float) --- Required. Strength of the boost, which should be in \\[-1, 1\\]. Negative boost means demotion. Default is 0.0 (No-op). \n**Returns**\n\n- (::Float) --- Required. Strength of the boost, which should be in \\[-1, 1\\]. Negative boost means demotion. Default is 0.0 (No-op).\n\n### #data_store\n\n def data_store() -\u003e ::String\n\n**Returns**\n\n- (::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\n\n### #data_store=\n\n def data_store=(value) -\u003e ::String\n\n**Parameter**\n\n- **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 \n**Returns**\n\n- (::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\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Specifies which products to apply the boost to.\n\n If no filter is provided all products will be boosted (No-op).\n Syntax documentation:\n https://cloud.google.com/retail/docs/filter-and-order\n Maximum length is 5000 characters.\n Otherwise an INVALID ARGUMENT error is thrown.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Specifies which products to apply the boost to.\n\n\n If no filter is provided all products will be boosted (No-op).\n Syntax documentation:\n https://cloud.google.com/retail/docs/filter-and-order\n Maximum length is 5000 characters.\nOtherwise an INVALID ARGUMENT error is thrown. \n**Returns**\n\n- (::String) --- Required. Specifies which products to apply the boost to.\n\n If no filter is provided all products will be boosted (No-op).\n Syntax documentation:\n https://cloud.google.com/retail/docs/filter-and-order\n Maximum length is 5000 characters.\n Otherwise an INVALID ARGUMENT error is thrown."]]
