Sample Search Requests
Semantic Search
Request
{
"query": {
"text": "dress",
"filters": [
{
"field": "categories",
"values": ["dresses", "tops"]
},
{
"field": "price",
"min": 100,
"max": 200
}
],
"pagination": {
"numItems": 24,
"offset": 0
},
"user": {
"active_consent_accepted": true,
"dyid": "12264556113"
},
"session": {
"dy": "3124353434443123"
},
"context": {
"page": {
"type": "HOMEPAGE",
"location": "https://shop.biz/nice-shirt-p76311.html",
"referrer": "https://google.cz",
"locale": "en_US"
}
},
"selector": {
"name": "Semantic Search"
},
"options": {
"returnAnalyticsMetadata": false,
"isImplicitClientData": false,
"isImplicitKeywordEvent": true
}
}
}
Note: A Visual Search request follows the same structure, except it does not support pagination.
Visual & Semantic Search Response
{
"id": 24,
"name": "Visual Search",
"type": "VISUAL_SEARCH_DECISION",
"decisionId": "d29ybGQK",
"variations": [
{
"id": 203,
"payload": {
"type": "SEARCH",
"data": {
"totalNumResults" : 1000,
"facets": [{
"column": "color",
"valuesType": "string",
"displayName": "Color",
"values": [
{
"name": "Black dark",
"count": 560
},
{
"name": "White dusty light",
"count": 191
}
]
}
}],
"slots": [
{
"slotId": "aGVsbG93b3JsZAo=",
"sku": "SKU_C",
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_A"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_B"
}
]
}
}
}
]
}
Shopping Muse
Request
{
"query": {
"text": "Suggest modern office dresses suitable for summer",
"chatId": "gAAAAABn85XBEaWKxRxEABWj2P2E8VecQcjXv8qvaZEOs-PlP1Lbt8b4VjHvo1xWOmHTNF-QlD"
},
"user": {
"active_consent_accepted": true,
"dyid": "12264556113"
},
"session": {
"dy": "3124353434443123"
},
"context": {
"page": {
"type": "HOMEPAGE",
"location": "https://shop.biz/nice-shirt-p76311.html",
"referrer": "https://google.cz",
"locale": "en_US"
}
},
"selector": {
"name": "Shopping Muse"
},
"options": {
"returnAnalyticsMetadata": false,
"isImplicitClientData": false,
"isImplicitKeywordEvent": true
}
}
Response
{
"id": 74,
"name": "Shopping Muse",
"type": "SHOPPING_MUSE_DECISION",
"decisionId": "d29ybGQK",
"variations": [
{
"id": 423,
"payload": {
"type": "SHOPPING_MUSE",
"data": {
"assistant": "Modern summer office dresses are a great choice! Let’s explore some options.",
"support": false,
"chatId": "gAAAAABnD34yb0Q5RLo8nmcpo5GikahgDh0i-zKjn7VNWdI-HlObaZTdvxENLnFPCNzjp",
"widgets": [
{
"title": "Sleek Professional",
"slots": [
{
"slotId": "aGVsbG93b3JsZAo=",
"sku": "SKU_1"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_2"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_3"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_4"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_5"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_6"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_7"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_8"
},
{
"title": "Sparkling Glamour",
"slots": [
{
"slotId": "aGVsbG93b3JsZAo=",
"sku": "SKU_11"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_12"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_13"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_14"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_15"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_16"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_17"
},
{
"slotId": "d2VsY29tZWR1ZAo=",
"sku": "SKU_18"
}
]
}
]
}
}
}
]
}
Updated 1 day ago