ProductSearchParams class

Parameters for product search.

Annotations

• @JsonSerializable()

Constructors

ProductSearchParams({BoundingPoly? boundingPoly, required String productSet, required List<String> productCategories, required String filter})

ProductSearchParams.fromJson(Map<String, dynamic> json)

factory

Properties

boundingPoly → BoundingPoly?

The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

final

filter → String

The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value.

final

hashCode → int

The hash code for this object.

no setter, inherited

productCategories → List<String>

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.

final

productSet → String

The resource name of a ProductSet to be searched for similar images.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited