Search APIs
Perform search for a given index.
Endpoint
GET https://api.conversecart.com/search/
Input
Parameter | Type | Required | Description |
---|---|---|---|
query | string | Yes | The search query string. |
indexID | string | Yes | The ID of the index to search against. |
sessionID | string | No | The ID of the user’s search session generated in the previous step. |
top_k | integer | No | The maximum number of results to return. Default value is 30. |
loc | integer | No | The location of the search query. Currently This future is not supported. |
JSON Response example
{
"searchID": "<searchID>",
"results": [...]
}
Search by ID
Finds documents similar to the specified document in the given index.
Endpoint
GET https://api.conversecart.com/search/similar
Input
Parameter | Type | Required | Description |
---|---|---|---|
documentID | string | Yes | The ID of the document to find similar items to. |
indexID | string | Yes | The ID of the index to search against. |
sessionID | string | No | The ID of the user’s search session generated in the previous step. |
top_k | integer | No | The maximum number of results to return. Default value is 30. |
loc | integer | No | The location of the search query. Currently This future is not supported. |
JSON Response example
{
"searchID": "<searchID>",
"results": [...]
}