Item-to-Item Recommendations - Get Similar Items

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

Returns a list of item-to-item recommendations. Recommended items can be similar to the seed item or related in some way, based on the way data is structured and the algorithm.

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

URI Parameters

Name In Required Type Description
seedItemId
 path True

string

Item for which recommendations are requested.
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.
count
 query

integer

Number of items to return.
modeling
 query

string

Modeling instance name.
skipItems
 query

integer

Number of items to skip, used for paging the recommendation results.
userId
 query

string

User identifier, used to apply personalization on the results. To turn on personalization, set other flags to true.

Responses

Name Type Description
200 OK

recoResponse

Successful. The response includes the list of items.
Other Status Codes

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
pagingInfo
recommendedItems
recoResponse

pagingInfo

Name Type Description
totalItems

integer

recommendedItems

Name Type Description
id

string

trackingId

string

recoResponse

Name Type Description
id

string

interactionsVersion

string

items

recommendedItems[]

longTitle

string

name

string

pagingInfo

pagingInfo

status

string

title

string

titleId

integer

version

string