Google Cloud Discovery Engine V1 Client - Class CrowdingSpec (1.11.0)

Version latest

• 1.11.0 (latest)
• 1.10.1
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.1
• 1.4.0
• 1.3.3
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

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

Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value.

For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.

Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ field	string The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
↳ max_count	int The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in order_by), later results with the same value are "crowded away". If not specified, the default value is 1.
↳ mode	int Mode to use for documents that are crowded away.

getField

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

Returns
Type	Description
string

setField

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMaxCount

The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in order_by), later results with the same value are "crowded away".

If not specified, the default value is 1.

Returns
Type	Description
int

setMaxCount

The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in order_by), later results with the same value are "crowded away".

If not specified, the default value is 1.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMode

Mode to use for documents that are crowded away.

Returns
Type	Description
int	Enum of type Mode.

setMode

Mode to use for documents that are crowded away.

Parameter
Name	Description
var	int Enum of type Mode.

Returns
Type	Description
$this