v3

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-0554486.4 KB

Catalog Text Search Products

Search for products in the Octogen e-commerce catalog. The search is performed using text embedding similarity on the input query text with the pre-computed product embeddings. The additional parameters are used filters to narrow down the search results. The number of results is determined by the limit parameter.

post/catalog/text_search

Request body

textstring required

The text is converted to a vector embedding and used to search for products in the e-commerce catalog with pre-computed product embeddings.

limitinteger

The maximum number of results to return from the search. The default is 10.

ranking_textstring nullable

The text is converted to a vector embedding and used to rank the search results.

retrieval_embedding_columnstring

The column to use for the retrieval embedding. The default is 'embedding'.

ranking_embedding_columnstring

The column to use for the ranking embedding. The default is 'embedding'.

price_minnumber nullable

The products will be filtered to have a price greater than or equal to the specified value.

price_maxnumber nullable

The products will be filtered to have a price less than or equal to the specified value.

Response

Successful Response

total_foundinteger required

The total number of products returned by the search.

errorstring nullable

The error message if the search query is invalid or the search failed. The products field will be an empty list if the search fails and total_found will be 0.