Discovery - Get Item Selectors

  • Reference
Service:
Intelligent Recommendations
API Version:
2021-07-14-GA-010

Use this helper API to receive selectors or filters (if applicable) for the visually similar recommendations lists.

GET https://<ir-account-name>-<service-endpoint-name>.mir.prod.reco.microsoft.com/reco/v1.0/discovery/similar/selectors/{itemId}
With optional parameters: 
GET https://<ir-account-name>-<service-endpoint-name>.mir.prod.reco.microsoft.com/reco/v1.0/discovery/similar/selectors/{itemId}?modeling={modeling}&channelId={channelId}&catalogId={catalogId}&algoType={algoType}

URI Parameters

Name In Required Type Description
itemId
 path True

string

The item you query about.
algoType
 query

string

Algorithm (or similarity) type selector. More information: Use algoType parameter
catalogId
 query

string

Items may be assigned to a catalog entity within a channel, allowing Intelligent Recommendations to provide recommendations only within the confines of a specific catalog. Items from other catalogs are automatically filtered out. This parameter is optional, relevant only for customers who have previously defined a catalog ID in their dataset.
channelId
 query

string

Items may be assigned to a channel entity, allowing Intelligent Recommendations to provide recommendations only within the confines of a specific channel. Items from other channels are automatically filtered out. This parameter is optional, relevant only for customers who have previously defined a channel ID in their dataset.
modeling
 query

string

Modeling instance name.

Responses

Name Type Description
200 OK

discoveryResponse

Successful. The response includes the list of selectors.

Security

azure_auth

Azure Active Directory OAuth 2.0 flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Impersonate your user account.

Definitions

Name Description
discoveryResponse
keyValue
selectors

discoveryResponse

Name Type Description
testInfo

object

Debug information, for internal use only.
value

selectors[]

Array of selectors.

keyValue

Name Type Description
valueString

string

(Key,value) entities that describe item selectors. For example, (color,red).

selectors

Name Type Description
keyName

string

The key of the item selector. For example, color or size.
values

keyValue[]

(Key,value) entities that describe item selectors. For example, (color,red).