Console

Class SearchParams (2.1.0)
Stay organized with collections Save and categorize content based on your preferences.

SearchParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Search parameters.

Attributes
Name	Description
`filter`	`str` Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.
`canonical_filter`	`str` Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.
`sort_by`	`str` Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as [SearchRequest.sort][].
`boost_spec`	`google.cloud.retail_v2alpha.types.SearchRequest.BoostSpec` Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-04-29 UTC.

Attributes