| title | description | services | documentationcenter | author | manager | editor | ms.assetid | ms.service | ms.workload | ms.tgt_pltfrm | ms.devlang | ms.topic | ms.date | ms.author |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Machine Learning Recommendations API Documentation | Microsoft Docs |
Azure Machine Learning Recommendations API documentation for a recommendations engine available in the Microsoft Azure Marketplace. |
machine-learning |
LuisCabrer |
jhubbard |
cgronlun |
32c3ab2f-fdd7-48cc-b501-ad55c79b87dc |
machine-learning |
data-services |
na |
na |
article |
12/07/2016 |
LuisCa |
Note
You should start using the Recommendations API Cognitive Service instead of this version. The Recommendations Cognitive Service will be replacing this service, and all the new features will be developed there. It has new capabilities like batching support, a better API Explorer, a cleaner API surface, more consistent signup/billing experience, etc. Learn more about Migrating to the new Cognitive Service
This document depicts Microsoft Azure Machine Learning Recommendations APIs.
[!INCLUDE machine-learning-free-trial]
This document is an API reference. You should start with the “Azure Machine Learning Recommendation - Quick Start” document.
The Azure Machine Learning Recommendations API can be divided into the following logical groups:
- Limitations - Recommendations API limitations.
- General Information - Information on authentication, service URI and versioning.
- Model Basic - APIs that enable you to do the basic operations on model (e.g. create, update and delete a model).
- Model Advanced - APIs that enable you to get advanced data insights on the model.
- Model Business Rules - APIs that enable you to manage business rules on the model recommendation results.
- Catalog - APIs that enable you to do basic operations on a model catalog. A catalog contains metadata information on the items of the usage data.
- Feature - APIs that enable to get insights on item into the catalog and how to use this information to build better recommendations.
- Usage Data - APIs that enable you to do basic operations on the model usage data. Usage data in the basic form consists of rows that include pairs of <userId>,<itemId>.
- Build - APIs that enable you to trigger a model build and do basic operations that are related to this build. You can trigger a model build once you have valuable usage data.
- Recommendation - APIs that enable you to consume recommendations once the build of a model ends.
- User Data - APIs that enable you to fetch information on the user usage data.
- Notifications - APIs that enable you to receive notifications on problems related to your API operations. (For example, you are reporting usage data via Data Acquisition and most of the events processing are failing. An error notification will be raised.)
- The maximum number of models per subscription is 10.
- The maximum number of builds per model is 20.
- The maximum number of items that a catalog can hold is 100,000.
- The maximum number of usage points that are kept is ~5,000,000. The oldest will be deleted if new ones will be uploaded or reported.
- The maximum size of data that can be sent in POST (e.g. import catalog data, import usage data) is 200MB.
- The maximum number of items that can be asked for when getting recommendations is 150.
Please follow the Microsoft Azure Marketplace guidelines regarding authentication. The marketplace supports either the Basic or OAuth authentication method.
The service root URI for the Azure Machine Learning Recommendations APIs is here.
The full service URI is expressed using elements of the OData specification.
Each API call will have, at the end, a query parameter called apiVersion that should be set to 1.0.
IDs, returned by any of the APIs, are case sensitive and should be used as such when passed as parameters in subsequent API calls. For instance, model IDs and catalog IDs are case sensitive.
Creating a recommendation model is usually enough to allow the system to provide recommendations. Nevertheless, recommendation quality varies based on the usage processed and the coverage of the catalog. For example if you have a lot of cold items (items without significant usage), the system will have difficulties providing a recommendation for such an item or using such an item as a recommended one. In order to overcome the cold item problem, the system allows the use of metadata of the items to enhance the recommendations. This metadata is referred to as features. Typical features are a book's author or a movie's actor. Features are provided via the catalog in the form of key/value strings. For the full format of the catalog file, please refer to the import catalog section.
Features can enhance the recommendation model, but to do so requires the use of meaningful features. For this purpose a new build was introduced - a rank build. This build will rank the usefulness of features. A meaningful feature is a feature with a rank score of 2 and up.
After understanding which of the features are meaningful, trigger a recommendation build with the list (or sublist) of meaningful features. It is possible to use these feature for the enhancement of both warm items and cold items. In order to use them for warm items, the UseFeatureInModel build parameter should be set up. In order to use features for cold items, the AllowColdItemPlacement build parameter should be enabled.
Note: It is not possible to enable AllowColdItemPlacement without enabling UseFeatureInModel.
Recommendation reasoning is another aspect of feature usage. Indeed, the Azure Machine Learning Recommendations engine can use features to provide recommendation explanations (a.k.a. reasoning), leading to more confidence in the recommended item from the recommendation consumer.
To enable reasoning, the AllowFeatureCorrelation and ReasoningFeatureList parameters should be setup prior to requesting a recommendation build.
Creates a “create model” request.
| HTTP Method | URI |
|---|---|
| POST | <rootURI>/CreateModel?modelName=%27<model_name>%27&apiVersion=%271.0%27Example: <rootURI>/CreateModel?modelName=%27MyFirstModel%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelName | Only letters (A-Z, a-z), numbers (0-9), hyphens (-) and underscore (_) are allowed. Max length: 20 |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
feed/entry/content/properties/id- Contains the model ID. Note: model ID is case sensitive.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/CreateModel" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Create A New Model</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/CreateModel?modelName='MyFirstModel'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-05T06:35:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/CreateModel?modelName='MyFirstModel'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/CreateModel?modelName='MyFirstModel'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">CreateANewModelEntity2</title>
<updated>2014-10-05T06:35:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/CreateModel?modelName='MyFirstModel'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">a658c626-2baa-43a7-ac98-f6ee26120a12</d:Id>
<d:Name m:type="Edm.String">MyFirstModel</d:Name>
<d:Date m:type="Edm.String">10/5/2014 6:35:19 AM</d:Date>
<d:Status m:type="Edm.String">Created</d:Status>
<d:HasActiveBuild m:type="Edm.String">false</d:HasActiveBuild>
<d:BuildId m:type="Edm.String">-1</d:BuildId>
<d:Mpr m:type="Edm.String">0</d:Mpr>
<d:UserName m:type="Edm.String">[email protected]</d:UserName>
<d:Description m:type="Edm.String"></d:Description>
</m:properties>
</content>
</entry>
</feed>
Creates a “get model” request.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetModel?id=%27<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/GetModel?id=%271cac7b76-def4-41f1-bc81-29b806adb1de%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| id | Unique identifier of the model (case sensitive) |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The model data can be found under the following elements:
feed/entry/content/properties/Id- Model unique ID.feed/entry/content/properties/Name- Model name.feed/entry/content/properties/Date- Model creation date.feed/entry/content/properties/Status- Model status. One of the following:- Created - Model is created and does not contain Catalog and Usage.
- ReadyForBuild - Model is created and contains Catalog and Usage.
feed/entry/content/properties/HasActiveBuild- Indicates if the model was built successfully.feed/entry/content/properties/BuildId- Model active build ID.feed/entry/content/properties/Mpr- Model mean percentile ranking (MPR - see ModelInsight for more information).feed/entry/content/properties/UserName- Model internal user name.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get A List Of All Models</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-28T14:35:51Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetAListOfAllModelsEntity</title>
<updated>2014-10-28T14:35:51Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">68b232f2-1037-45f7-8f49-af822695ee63</d:Id>
<d:Name m:type="Edm.String">vah-11111</d:Name>
<d:Date m:type="Edm.String">10/28/2014 2:16:07 PM</d:Date>
<d:Status m:type="Edm.String">ReadyForBuild</d:Status>
<d:HasActiveBuild m:type="Edm.String">false</d:HasActiveBuild>
<d:BuildId m:type="Edm.String">-1</d:BuildId>
<d:Mpr m:type="Edm.String">0</d:Mpr>
<d:UsageFileNames m:type="Edm.String">ImplicitMatrix10_Guid_small.txt, ImplicitMatrix11_Guid_small.txt</d:UsageFileNames>
<d:CatalogId m:type="Edm.String">626babdb-cab6-43a6-82ef-4fb86345700c</d:CatalogId>
<d:UserName m:type="Edm.String">[email protected]</d:UserName>
<d:Description m:type="Edm.String">short description</d:Description>
<d:CatalogFileName m:type="Edm.String">catalog10_small.txt</d:CatalogFileName>
</m:properties>
</content>
</entry>
</feed>
Retrieves all models of the current user.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetAllModels?apiVersion=%271.0%27Example: <rootURI>/GetAllModels?apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
feed/entry/content/properties/Id- Model unique ID.feed/entry/content/properties/Name- Model name.feed/entry/content/properties/Date- Model creation date.feed/entry/content/properties/Status- Model status. One of the following:- Created - Model is created and does not contain Catalog and Usage.
- ReadyForBuild - Model is created and contains Catalog and Usage.
feed/entry/content/properties/HasActiveBuild- Indicates if the model was built successfully.feed/entry/content/properties/BuildId- Model active build ID.feed/entry/content/properties/Mpr- Model MPR (see ModelInsight for more information).feed/entry/content/properties/UserName- Model internal user name.feed/entry/content/properties/UsageFileNames- List of model usage files separated by comma.feed/entry/content/properties/CatalogId- Model catalog ID.feed/entry/content/properties/Description- Model description.feed/entry/content/properties/CatalogFileName- Model catalog file name.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get A List Of All Models</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-28T14:35:51Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetAListOfAllModelsEntity</title>
<updated>2014-10-28T14:35:51Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetAllModels?apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">68b232f2-1037-45f7-8f49-af822695ee63</d:Id>
<d:Name m:type="Edm.String">vah-11111</d:Name>
<d:Date m:type="Edm.String">10/28/2014 2:16:07 PM</d:Date>
<d:Status m:type="Edm.String">ReadyForBuild</d:Status>
<d:HasActiveBuild m:type="Edm.String">false</d:HasActiveBuild>
<d:BuildId m:type="Edm.String">-1</d:BuildId>
<d:Mpr m:type="Edm.String">0</d:Mpr>
<d:UsageFileNames m:type="Edm.String">ImplicitMatrix10_Guid_small.txt, ImplicitMatrix11_Guid_small.txt</d:UsageFileNames>
<d:CatalogId m:type="Edm.String">626babdb-cab6-43a6-82ef-4fb86345700c</d:CatalogId>
<d:UserName m:type="Edm.String">[email protected]</d:UserName>
<d:Description m:type="Edm.String">short description</d:Description>
<d:CatalogFileName m:type="Edm.String">catalog10_small.txt</d:CatalogFileName>
</m:properties>
</content>
</entry>
</feed>
You can update the model description or the active build ID.
Active build ID - Every build for every model has a build ID. The active build ID is the first successful build of every new model. Once you have an active build ID and you do additional builds for the same model, you need to explicitly set it as the default build ID if you want to. When you consume recommendations, if you do not specify the build ID that you want to use, the default one will be used automatically.
This mechanism enables you - once you have a recommendation model in production - to build new models and test them before you promote them to production.
| HTTP Method | URI |
|---|---|
| PUT | <rootURI>/UpdateModel?id=%27<modelId>%27&apiVersion=%271.0%27Example: <rootURI>/UpdateModel?id=%279559872f-7a53-4076-a3c7-19d9385c1265%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| id | Unique identifier of the model (case sensitive) |
| apiVersion | 1.0 |
| Request Body | <ModelUpdateParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><Description>New Description</Description><ActiveBuildId>-1</ActiveBuildId> </ModelUpdateParams>Note that the XML tags Description and ActiveBuildId are optional. If you do not want to set Description or ActiveBuildId, remove the entire tag. |
Response:
HTTP Status code: 200
Deletes an existing model by ID.
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteModel?id=%27<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/DeleteModel?id=%271cac7b76-def4-41f1-bc81-29b806adb1de%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| id | Unique identifier of the model (case sensitive) |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/DeleteModel" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Delete Model by Id</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/DeleteModel?id='1cac7b76-def4-41f1-bc81-29b806adb1de'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-28T10:39:33Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/DeleteModel?id='1cac7b76-def4-41f1-bc81-29b806adb1de'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/DeleteModel?id='1cac7b76-def4-41f1-bc81-29b806adb1de'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">DeleteModelByIdEntity</title>
<updated>2014-10-28T10:39:33Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/DeleteModel?id='1cac7b76-def4-41f1-bc81-29b806adb1de'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:string m:type="Edm.String"></d:string>
</m:properties>
</content>
</entry>
</feed>
Returns statistical data on the usage data that this model was built with.
Available only for Recommendation build.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetDataInsight?modelId=%27<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/GetDataInsight?modelId=%271cac7b76-def4-41f1-bc81-29b806adb1de%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The data is returned as a collection of properties.
feed/entry/id/content/properties/key- Holds the property name.feed/entry/id/content/properties/value- Holds the property value.
The table below depicts the value that each key represents.
| Key | Description |
|---|---|
| AvgItemLength | Average number of distinct users per item. |
| AvgUserLength | Average number of distinct items per user. |
| DensificationNumberOfItems | Number of items after pruning items that cannot be modelled. |
| DensificationNumberOfUsers | Number of usage points after pruning users and items that can't be modelled. |
| DensificationNumberOfRecords | Number of usage points after pruning users and items that can't be modelled. |
| MaxItemLength | Number of distinct users for the most popular item. |
| MaxUserLength | Maximal number of distinct items for a user. |
| MinItemLength | Maximal number of distinct users for an item. |
| MinUserLength | Minimal number of distinct items for a user. |
| RawNumberOfItems | Number of items in the usage files. |
| RawNumberOfUsers | Number of usage points before any pruning. |
| RawNumberOfRecords | Number of usage points before any pruning. |
| SamplingNumberOfItems | N/A |
| SamplingNumberOfRecords | N/A |
| SamplingNumberOfUsers | N/A |
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get data insight statistics</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">AvgItemLength</d:Key>
<d:Value m:type="Edm.String">18.936</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">AvgUserLength</d:Key>
<d:Value m:type="Edm.String">51.879</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">DensificationNumberOfItems</d:Key>
<d:Value m:type="Edm.String">2,000</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=3&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=3&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">DensificationNumberOfRecords</d:Key>
<d:Value m:type="Edm.String">37,872</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=4&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=4&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">DensificationNumberOfUsers</d:Key>
<d:Value m:type="Edm.String">730</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=5&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=5&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">MaxItemLength</d:Key>
<d:Value m:type="Edm.String">4,704</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=6&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=6&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">MaxUserLength</d:Key>
<d:Value m:type="Edm.String">190</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=7&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=7&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">MinItemLength</d:Key>
<d:Value m:type="Edm.String">8</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=8&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=8&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">MinUserLength</d:Key>
<d:Value m:type="Edm.String">20</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=9&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=9&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">RawNumberOfItems</d:Key>
<d:Value m:type="Edm.String">2,000</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=10&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=10&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">RawNumberOfRecords</d:Key>
<d:Value m:type="Edm.String">72,022</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=11&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=11&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">RawNumberOfUsers</d:Key>
<d:Value m:type="Edm.String">9,044</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=12&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=12&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">SampelingNumberOfItems</d:Key>
<d:Value m:type="Edm.String">2,000</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=13&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=13&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">SampelingNumberOfRecords</d:Key>
<d:Value m:type="Edm.String">72,022</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=14&$top=1</id>
<title type="text">GetDataInsightStatisticsEntity</title>
<updated>2014-10-27T14:21:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetDataInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=14&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">SampelingNumberOfUsers</d:Key>
<d:Value m:type="Edm.String">9,044</d:Value>
</m:properties>
</content>
</entry>
</feed>
Returns model insight on the active build or (if given) on a specific build.
Available only for Recommendation build.
| HTTP Method | URI |
|---|---|
| GET | With active build ID:<rootURI>/GetModelInsight?modelId=%27<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/GetModelInsight?modelId=%271cac7b76-def4-41f1-bc81-29b806adb1de%27&apiVersion=%271.0%27With specific build ID: <rootURI>/GetModelInsight?modelId=%27<model_id>%27&buildId=%27<build_id>%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| buildId | Optional - number that identifies a successful build. |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The data is returned as a collection of properties.
feed/entry/id/content/properties/keyfeed/entry/id/content/properties/value
The table below depicts the value that each key represents.
| Key | Description |
|---|---|
| CatalogCoverage | What part of the catalog can be modelled with usage patterns. The rest of the items will need content-based features. |
| Mpr | Mean percentile ranking of the model. Lower is better. |
| NumberOfDimensions | Number of dimensions used by the matrix factorization algorithm. |
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get model insight statistics</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-27T14:27:11Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetModelInsightStatisticsEntity</title>
<updated>2014-10-27T14:27:11Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">CatalogCoverage</d:Key>
<d:Value m:type="Edm.String">1.000</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetModelInsightStatisticsEntity</title>
<updated>2014-10-27T14:27:11Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">Mpr</d:Key>
<d:Value m:type="Edm.String">0.367</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">GetModelInsightStatisticsEntity</title>
<updated>2014-10-27T14:27:11Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelInsight?modelId='6254b40d-0514-49cb-a298-b81256d2b3ca'&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">NumberOfDimensions</d:Key>
<d:Value m:type="Edm.String">20</d:Value>
</m:properties>
</content>
</entry>
</feed>
Gets a sample of the recommendation model.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetModelSample?modelId=%27<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/GetModelSample?modelId=%271cac7b76-def4-41f1-bc81-29b806adb1de%27&apiVersion=%271.0%27With specific build ID: <rootURI>/GetModelSample?modelId=%27<model_id>%27&buildId=%27<build_id>%27&apiVersion=%271.0%27Example: <rootURI>/GetModelSample?modelId=%271cac7b76-def4-41f1-bc81-29b806adb1de%27&buildId=%271500068%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
OData XML
Response is returned in raw text format:
Level 1
---------------
655fc955-a5a3-4a26-9723-3090859cb27b, Prey: A Novel
655fc955-a5a3-4a26-9723-3090859cb27b, Prey: A Novel Rating: 0.5215
3f471802-f84f-44a0-99c8-6d2e7418eec1, Black Hawk Down: A Story of Modern War Rating: 0.5151
07b10e28-9e7c-4032-90b7-10acab7f2460, Cryptonomicon Rating: 0.5148
6afc18e4-8c2a-43d1-9021-57543d6b11d8, Imajica Rating: 0.5146
e4cc5e69-3567-43ab-b00f-f0d8d0506870, Hit List Rating: 0.514
56b61441-0eed-46cc-a8f6-112775b81892, Life and Death in Shanghai
56b61441-0eed-46cc-a8f6-112775b81892, Life and Death in Shanghai Rating: 0.5218
53156702-cc0c-443d-b718-6fb74b2491d3, Son of \ Rating: 0.5212
fb8cf7a6-8719-46ee-97d4-92f931d77a3a, Smoke and Mirrors: Short Fictions and Illusions Rating: 0.5188
8f5fe006-79e4-4679-816b-950989d1db4b, A Place I've Never Been (Contemporary American Fiction) Rating: 0.5156
d8db4583-cc0f-49ce-bc95-b7fa3491623f, Happiness: A Novel Rating: 0.5156
50471eec-9aeb-4900-84d7-21567ab18546, If the Buddha Dated: A Handbook for Finding Love on a Spiritual Path
cfe922a1-7ca0-4f8d-ad9d-b7cc87bfe0ef, Divine Secrets of the Ya-Ya Sisterhood: A Novel Rating: 0.5266
ff91a483-1ce5-4b37-a6fd-5ffcf21f8745, The Poisonwood Bible: A Novel Rating: 0.5252
973f8cbd-0846-4f6b-9d28-4dd0d7dc3a19, Pigs in Heaven Rating: 0.5244
e2cbf7ad-0636-4117-8b30-298da6df7077, Animal Dreams Rating: 0.5227
6c818fd3-5a09-417d-9ab4-7ffe090f0fef, Confessions of an Ugly Stepsister: A Novel Rating: 0.5222
5e97148f-defb-4d74-af2d-80f4763bf531, The Deep End of the Ocean (Oprah's Book Club)
5e97148f-defb-4d74-af2d-80f4763bf531, The Deep End of the Ocean (Oprah's Book Club) Rating: 0.537
5dcbac37-2946-4f2a-a0b3-bbe710f9409a, Up Island: A Novel Rating: 0.5277
bc5b69db-733b-4346-adde-3927544258f7, Downtown Rating: 0.5275
31fe5c63-3e5a-48d0-802b-d3b0f989a634, Have a Nice Day: A Tale of Blood and Sweatsocks Rating: 0.5252
0adf981a-b65b-4c11-b36b-78aca2f948a2, The Perfect Storm: A True Story of Men Against the Sea Rating: 0.5238
68f97068-ae1a-4163-9e94-396b800b743d, Modoc: The True Story of the Greatest Elephant That Ever Lived
68f97068-ae1a-4163-9e94-396b800b743d, Modoc: The True Story of the Greatest Elephant That Ever Lived Rating: 0.5379
6724862e-e4e7-4022-9614-1468d8b902ff, Little House on the Prairie Rating: 0.5345
cdedb837-1620-496d-94c4-6ccfed888320, Little House in the Big Woods Rating: 0.5325
382164ba-406b-4187-b726-d7a54b9d790d, The Tao of Pooh Rating: 0.5309
6a068d6a-bb74-4ba3-b3f2-a956c4f9d1b5, On the Banks of Plum Creek Rating: 0.5285
37ef8e74-e348-44e5-aabc-1d7f9efcb25b, Men Are from Mars Women Are from Venus: A Practical Guide for Improving Communication and Getting What You Want in Your Relationships
37ef8e74-e348-44e5-aabc-1d7f9efcb25b, Men Are from Mars, Women Are from Venus: A Practical Guide for Improving Communication and Getting What You Want in Your Relationships Rating: 0.5397
f2be16d4-5faf-4d32-ab83-7ba74d29261e, Politically Correct Bedtime Stories: Modern Tales for Our Life and Times Rating: 0.5207
ef732c5c-334b-4d6b-ab82-7255eb7286d0, Honor Among Thieves Rating: 0.5195
0b209b8c-7cdd-47fd-b940-05c7ff7c60fc, The Giving Tree Rating: 0.5194
883b360f-8b42-407f-b977-2f44ad840877, Scary Stories to Tell in the Dark: Collected from American Folklore (Scary Stories) Rating: 0.5184
ff51b67e-fa8e-4c5e-8f4d-02a928de735d, Men at Work: The Craft of Baseball
d008dae9-c73a-40a1-9a9b-96d5cf546f36, The Gulag Archipelago 1918-1956: An Experiment in Literary Investigation I-II Rating: 0.5416
ff51b67e-fa8e-4c5e-8f4d-02a928de735d, Men at Work: The Craft of Baseball Rating: 0.5403
49dec30e-0adb-411a-b186-48eaabf6f8bc, Fatherland Rating: 0.5394
cc7964fd-d30f-478e-a425-93ddbdf094ed, Magic the Gathering: Arena Vol. 1 Rating: 0.5379
8a1e9f36-97af-4614-bed9-24e3940a05f3, More Sniglets: Any Word That Doesn't Appear in the Dictionary but Should Rating: 0.5377
12a6d988-be21-4a09-8143-9d5f4261ba16, A Dream of Eagles
07b10e28-9e7c-4032-90b7-10acab7f2460, Cryptonomicon Rating: 0.5417
e4cc5e69-3567-43ab-b00f-f0d8d0506870, Hit List Rating: 0.5416
1f1a34c4-9781-49f5-a3cc-acec3ae3c71d, The Family Rating: 0.5371
56daeffe-7d48-43cd-8ef8-7dffd0c103d3, Kilo Class Rating: 0.5366
b2fe511e-5cb9-4a56-b823-2801e63e6a96, Legal Tender Rating: 0.5366
df87525b-e435-4bd6-8701-4e60ad344e28, Finding Fish
56d33036-dfda-46b9-8e2a-76cb03921bb0, The X-Files: Ground Zero Rating: 0.5417
0780cde8-6529-4e1d-b6c6-082c1b80e596, Twelve Red Herrings Rating: 0.5416
df87525b-e435-4bd6-8701-4e60ad344e28, Finding Fish Rating: 0.5408
400fe331-2c35-490c-adbc-b28b4b73d56c, Shall We Tell the President? Rating: 0.5383
f86ad7d0-5c03-42b3-aebf-13d44aec8b30, Shades of Grace Rating: 0.5358
de1f62a4-89e6-44d2-aaee-992a4bf093f1, The Map That Changed the World: William Smith and the Birth of Modern Geology
de1f62a4-89e6-44d2-aaee-992a4bf093f1, The Map That Changed the World: William Smith and the Birth of Modern Geology Rating: 0.5422
b303538f-e2c6-4a2c-b425-8d21e684fc3e, My Uncle Oswald Rating: 0.5385
34b84627-48af-4a4c-96c4-b26fb3863f56, Midnight In the Garden of Good and Evil Rating: 0.5379
306cbaa7-b1a8-4142-9d55-e11b5018a7a8, The Street Lawyer Rating: 0.5376
e53b4baa-8c09-45c4-95c0-b6a26b98770b, Miss Smillas Feeling for Snow Rating: 0.5367
Level 2
---------------
352aaea1-6b12-454d-a3d5-46379d9e4eb2, The Sinister Pig (Hillerman Tony)
352aaea1-6b12-454d-a3d5-46379d9e4eb2, The Sinister Pig (Hillerman Tony) Rating: 0.5425
74c49398-bc10-4af5-a658-a996a1201254, Children of the Storm (Peters Elizabeth) Rating: 0.5387
9ba80080-196e-43fd-8025-391d963f77e7, The Floating Girl Rating: 0.5372
e68f81d5-7745-4cc7-b943-fedb8fcc2ced, Killer Smile (Scottoline Lisa) Rating: 0.5353
b2fe511e-5cb9-4a56-b823-2801e63e6a96, Legal Tender Rating: 0.5332
c65c3995-abf7-4c7b-bb3c-8eb5aa9be7a5, Lake Wobegon days
0adf981a-b65b-4c11-b36b-78aca2f948a2, The Perfect Storm: A True Story of Men Against the Sea Rating: 0.5433
c65c3995-abf7-4c7b-bb3c-8eb5aa9be7a5, Lake Wobegon days Rating: 0.543
a00ae6ad-4a7f-4211-9836-75ce8834eb11, Sniglets (Snig'lit: Any Word That Doesn't Appear in the Dictionary But Should) Rating: 0.5327
6f6e192e-0d64-49ca-9b63-f09413ea1ee6, Politically Correct Holiday Stories: For an Enlightened Yuletide Season Rating: 0.5307
798051a8-147d-4d46-b0dc-e836325029e6, AGE OF INNOCENCE (MOVIE TIE-IN) Rating: 0.5301
73f3e25a-e996-4162-9ed8-ff3d34075650, O Pioneers! (Penguin Twentieth-Century Classics)
cba8163f-6536-436b-8130-47b4a43c827f, Trust No One (The Official Guide to the X-Files Vol. 2) Rating: 0.5434
5708e4cb-2492-49c0-94a8-cc413eec5d89, Small Gods (Discworld Novels (Paperback)) Rating: 0.5406
73f3e25a-e996-4162-9ed8-ff3d34075650, O Pioneers! (Penguin Twentieth-Century Classics) Rating: 0.5403
d885b0bd-ae4b-452d-bdf2-faa90197dbc9, The Color of Magic Rating: 0.539
b133a9c4-4784-4db3-b100-d0d6dffb94d2, The Truth Is Out There (The Official Guide to the X-Files Vol. 1) Rating: 0.5367
271700a5-854a-4d5a-8409-6b57a5ee4de4, Fluke: Or I Know Why the Winged Whale Sings
271700a5-854a-4d5a-8409-6b57a5ee4de4, Fluke: Or I Know Why the Winged Whale Sings Rating: 0.5445
2de1c354-90ff-47c5-a0db-1bad7d88ef94, The Salaryman's Wife (Children of Violence Series) Rating: 0.5329
d279416e-19c0-43f8-9ec9-a585947879ca, Zen Attitude Rating: 0.5316
c8f854d7-3de3-4b23-8217-f4f851670fd4, Revenge of the Cootie Girls: A Robin Hudson Mystery (Robin Hudson Mysteries (Paperback)) Rating: 0.5305
8ef4751c-7074-409e-a3ac-d49b222fc864, Where the Wild Things Are Rating: 0.5289
9ad1b620-0a7b-4543-8673-66d4c3bcb2f1, Their Eyes Were Watching God
9ad1b620-0a7b-4543-8673-66d4c3bcb2f1, Their Eyes Were Watching God Rating: 0.5446
da45c4d5-aba1-413b-a9bd-50df98b1e1d2, The Bean Trees Rating: 0.5389
65ecbdd1-131c-40c3-a3d6-d86ca281377a, The God of Small Things Rating: 0.5387
c78743bf-7947-4a0c-8db7-8a3bfe69ba70, The Stone Diaries Rating: 0.5355
973f8cbd-0846-4f6b-9d28-4dd0d7dc3a19, Pigs in Heaven Rating: 0.5344
5f17d90a-2604-4fe8-8977-1a280b9098b1, One for the Money (Stephanie Plum Novels (Paperback))
5f17d90a-2604-4fe8-8977-1a280b9098b1, One for the Money (Stephanie Plum Novels (Paperback)) Rating: 0.5446
57169b2b-9a8a-486b-9aac-1ed98ce57168, Final Appeal Rating: 0.5332
efcb1bc4-7278-4a8f-b491-befde02070d6, Moment of Truth Rating: 0.5329
1efa91a2-993b-4c43-9f5c-3454fc12612d, Burn Factor Rating: 0.5309
24c59962-458a-4ec8-b95d-d694e861919c, At Home in Mitford (The Mitford Years) Rating: 0.5303
4fd48c46-1a20-4c57-bc7f-a02ef123dc52, As Nature Made Him: The Boy Who Was Raised As a Girl
4fd48c46-1a20-4c57-bc7f-a02ef123dc52, As Nature Made Him: The Boy Who Was Raised As a Girl Rating: 0.5449
cd5f2c03-20cb-43be-a1fb-3b4233e63222, Pigs in Heaven Rating: 0.5329
19985fdb-d07a-4a25-ae4a-97b9cb61e5d1, Love in the Time of Cholera (Penguin Great Books of the 20th Century) Rating: 0.5267
15689d09-c711-4844-84d8-130a90237b26, Bel Canto Rating: 0.5245
ff91a483-1ce5-4b37-a6fd-5ffcf21f8745, The Poisonwood Bible: A Novel Rating: 0.5235
98df28ec-41e7-4fca-b77f-8b0d3109085d, Star Trek Memories
f874b5a3-5d40-4436-94ff-0fa1c090ddf5, The Sun Also Rises (A Scribner classic) Rating: 0.5451
98df28ec-41e7-4fca-b77f-8b0d3109085d, Star Trek Memories Rating: 0.5442
0ce0014a-9a48-4013-a08a-7f2c11877930, H.M.S. Unseen Rating: 0.5421
15316ca6-1e38-425f-893d-691944a47000, More Scary Stories To Tell In The Dark Rating: 0.5409
329d5682-3dc3-4206-8aa2-eef4b1032258, Letters from the Earth Rating: 0.54
5b9445d5-c072-419c-8d49-6f669bb1b0a9, Daughter of Fortune: A Novel (Oprah's Book Club (Hardcover))
5b9445d5-c072-419c-8d49-6f669bb1b0a9, Daughter of Fortune: A Novel (Oprah's Book Club (Hardcover)) Rating: 0.5462
ff91a483-1ce5-4b37-a6fd-5ffcf21f8745, The Poisonwood Bible: A Novel Rating: 0.5372
604eb3bd-6026-4f51-bffd-9fb54f180400, Family Pictures: A Novel Rating: 0.5341
8d06d01d-31cd-4678-b6b1-140a67987ce9, Songs in Ordinary Time (Oprah's Book Club (Paperback)) Rating: 0.5334
da45c4d5-aba1-413b-a9bd-50df98b1e1d2, The Bean Trees Rating: 0.5319
d5358189-d70f-4e35-8add-34b83b4942b3, Pigs in Heaven
d5358189-d70f-4e35-8add-34b83b4942b3, Pigs in Heaven Rating: 0.5491
ff91a483-1ce5-4b37-a6fd-5ffcf21f8745, The Poisonwood Bible: A Novel Rating: 0.5401
c78743bf-7947-4a0c-8db7-8a3bfe69ba70, The Stone Diaries Rating: 0.5393
8d06d01d-31cd-4678-b6b1-140a67987ce9, Songs in Ordinary Time (Oprah's Book Club (Paperback)) Rating: 0.5382
973f8cbd-0846-4f6b-9d28-4dd0d7dc3a19, Pigs in Heaven Rating: 0.5367
These are the types of rules supported:
- BlockList - BlockList enables you to provide a list of items that you do not want to return in the recommendation results.
- FeatureBlockList - Feature BlockList enables you to block items based on the values of its features.
Do not send more than 1000 items in a single blocklist rule or your call may timeout. If you need to block more than 1000 items, you can make several blocklist calls.
- Upsale - Upsale enables you to enforce items to return in the recommendation results.
- WhiteList - White List enables you to only suggest recommendations from a list of items.
- FeatureWhiteList - Feature White List enables you to only recommend items that have specific feature values.
- PerSeedBlockList - Per Seed Block List enables you to provide per item a list of items that cannot be returned as recommendation results.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetModelRules?modelId=%27<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/GetModelRules?modelId=%271cac7b76-def4-41f1-bc81-29b806adb1de%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
feed/entry/content/properties/Id- Unique identifier of this rule.feed/entry/content/properties/Type- Type of the rule.feed/entry/content/properties/Parameter- Rule parameter.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelRules" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get a list of rules for a model</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelRules?modelId='5e824626-50d3-469d-a824-564d38453103'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-11-05T12:58:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelRules?modelId='5e824626-50d3-469d-a824-564d38453103'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelRules?modelId='5e824626-50d3-469d-a824-564d38453103'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetAListOfRulesForAModelEntity</title>
<updated>2014-11-05T12:58:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelRules?modelId='5e824626-50d3-469d-a824-564d38453103'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">1000043</d:Id>
<d:Type m:type="Edm.String">BlockList</d:Type>
<d:Parameters m:type="Edm.String">{"ItemsToExclude":["1000"]}</d:Parameters>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelRules?modelId='5e824626-50d3-469d-a824-564d38453103'&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetAListOfRulesForAModelEntity</title>
<updated>2014-11-05T12:58:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelRules?modelId='5e824626-50d3-469d-a824-564d38453103'&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">1000044</d:Id>
<d:Type m:type="Edm.String">BlockList</d:Type>
<d:Parameters m:type="Edm.String">{"ItemsToExclude":["1001"]}</d:Parameters>
</m:properties>
</content>
</entry>
</feed>
| HTTP Method | URI |
|---|---|
| POST | <rootURI>/AddRule?apiVersion=%271.0%27 |
| HEADER | "Content-Type", "text/xml" |
| Parameter Name | Valid Values |
|---|---|
| apiVersion | 1.0 |
| Request Body |
Whenever providing Item Ids for business rules, make sure to use the External Id of the item (the same Id that you used in the catalog file)
To add a BlockList rule:<ApiFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ModelId>24024f7e-b45c-419e-bfa2-dfd947e0d253</ModelId><Type>BlockList</Type><Value>{"ItemsToExclude":["2406E770-769C-4189-89DE-1C9283F93A96","3906E110-769C-4189-89DE-1C9283F98888"]}</Value></ApiFilter>
To add a FeatureBlockList rule:
<ApiFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ModelId>24024f7e-b45c-419e-bfa2-dfd947e0d253</ModelId><Type>FeatureBlockList</Type><Value>{"Name":"Movie_category","Values":["Adult","Drama"]}</Value></ApiFilter>
To add an Upsale rule:<ApiFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ModelId>24024f7e-b45c-419e-bfa2-dfd947e0d253</ModelId><Type>Upsale</Type><Value>{"ItemsToUpsale":["2406E770-769C-4189-89DE-1C9283F93A96"],"NumberOfItemsToUpsale":5}</Value></ApiFilter>
To add a WhiteList rule:
<ApiFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ModelId>24024f7e-b45c-419e-bfa2-dfd947e0d253</ModelId><Type>WhiteList</Type><Value>{"ItemsToInclude":["2406E770-769C-4189-89DE-1C9283F93A96","1116E770-769C-4189-89DE-1C9283F88888"]}</Value></ApiFilter>
To add a FeatureWhiteList rule:
<ApiFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ModelId>24024f7e-b45c-419e-bfa2-dfd947e0d253</ModelId><Type>FeatureWhiteList</Type><Value>{"Name":"Movie_rating","Values":["PG13"]}</Value></ApiFilter>
To add a PerSeedBlockList rule:<ApiFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ModelId>24024f7e-b45c-419e-bfa2-dfd947e0d253</ModelId><Type>PerSeedBlockList</Type><Value>{"SeedItems":["9949"],"ItemsToExclude":["9862","8158","8244"]}</Value></ApiFilter>|
Response:
HTTP Status code: 200
The API returns the newly created rule with its details. The rules property can be retrieved from the following paths:
feed/entry/content/properties/Id- Unique identifier of this rule.feed/entry/content/properties/Type- Type of the rule: BlockList or Upsale.feed/entry/content/properties/Parameter- Rule parameter.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/AddRule" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Add A Rule</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/AddRule?apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-11-05T11:13:28Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/AddRule?apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/AddRule?apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">AddARuleEntity</title>
<updated>2014-11-05T11:13:28Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/AddRule?apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">1000041</d:Id>
<d:Type m:type="Edm.String">BlockList</d:Type>
<d:Parameters m:type="Edm.String">{"ItemsToExclude":["1002"]}</d:Parameters>
</m:properties>
</content>
</entry>
</feed>
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteRule?modelId=%27<model_id>%27&filterId=%27<filter_Id>%27&apiVersion=%271.0%27Example: DeleteRule?modelId=%2724024f7e-b45c-419e-bfa2-dfd947e0d253%27&filterId=%271000011%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| filterId | Unique identifier of the filter |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteAllRules?modelId=%27<model_id>%27&apiVersion=%271.0%27Example: DeleteAllRules?modelId=%2724024f7e-b45c-419e-bfa2-dfd947e0d253%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
If you upload several catalog files to the same model with several calls, we will insert only the new catalog items. Existing items will remain with the original values. You cannot update catalog data by using this method.
The catalog data should follow the following format:
- Without features -
<Item Id>,<Item Name>,<Item Category>[,<Description>] - With features -
<Item Id>,<Item Name>,<Item Category>,[<Description>],<Features list>
Note: The maximum file size is 200MB.
** Format details **
| Name | Mandatory | Type | Description |
|---|---|---|---|
| Item Id | Yes | [A-z], [a-z], [0-9], [_] (Underscore), [-] (Dash) Max length: 50 |
Unique identifier of an item. |
| Item Name | Yes | Any alphanumeric characters Max length: 255 |
Item name. |
| Item Category | Yes | Any alphanumeric characters Max length: 255 |
Category to which this item belongs (e.g. Cooking Books, Drama…); can be empty. |
| Description | No, unless features are present (but can be empty) | Any alphanumeric characters Max length: 4000 |
Description of this item. |
| Features list | No | Any alphanumeric characters Max length: 4000; Max number of features:20 |
Comma-separated list of feature name=feature value that can be used to enhance model recommendation; see Advanced topics section. |
| HTTP Method | URI |
|---|---|
| POST | <rootURI>/ImportCatalogFile?modelId=%27<modelId>%27&filename=%27<fileName>%27&apiVersion=%271.0%27Example: <rootURI>/ImportCatalogFile?modelId=%27a658c626-2baa-43a7-ac98-f6ee26120a12%27&filename=%27catalog10_small.txt%27&apiVersion=%271.0%27 |
| HEADER | "Content-Type", "text/xml" |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| filename | Textual identifier of the catalog. Only letters (A-Z, a-z), numbers (0-9), hyphens (-) and underscore (_) are allowed. Max length: 50 |
| apiVersion | 1.0 |
| Request Body | Example (with features): 2406e770-769c-4189-89de-1c9283f93a96,Clara Callan,Book,the book description,author=Richard Wright,publisher=Harper Flamingo Canada,year=2001 21bf8088-b6c0-4509-870c-e1c7ac78304a,The Forgetting Room: A Fiction (Byzantium Book),Book,,author=Nick Bantock,publisher=Harpercollins,year=1997 3bb5cb44-d143-4bdd-a55c-443964bf4b23,Spadework,Book,,author=Timothy Findley, publisher=HarperFlamingo Canada, year=2001 552a1940-21e4-4399-82bb-594b46d7ed54,Restraint of Beasts,Book,the book description,author=Magnus Mills, publisher=Arcade Publishing, year=1998 |
Response:
HTTP Status code: 200
The API returns a report of the import.
feed\entry\content\properties\LineCount- Number of lines accepted.feed\entry\content\properties\ErrorCount- Number of lines that were not inserted due to an error.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/ImportCatalogFile" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Import catalog file</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ImportCatalogFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='catalog10_small.txt'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-05T06:58:04Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ImportCatalogFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='catalog10_small.txt'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ImportCatalogFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='catalog10_small.txt'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">ImportCatalogFileEntity2</title>
<updated>2014-10-05T06:58:04Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ImportCatalogFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='catalog10_small.txt'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:LineCount m:type="Edm.String">4</d:LineCount>
<d:ErrorCount m:type="Edm.String">0</d:ErrorCount>
</m:properties>
</content>
</entry>
</feed>
Retrieves all catalog items. The catalog will be retrieved one page at a time. If you want to get items at a particular index, you can use the $skip odata parameter. For instance if you want to get items starting at position 100, add the parameter $skip=100 to the request.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetCatalog?modelId=%27<model_id>%27&apiVersion=%271.0%27Example: GetCatalog?modelId=%2724024f7e-b45c-419e-bfa2-dfd947e0d253%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The response includes one entry per catalog item. Each entry has the following data:
feed/entry/content/properties/ExternalId- Catalog item external ID, the one provided by the customer.feed/entry/content/properties/InternalId- Catalog item internal ID, the one that Azure Machine Learning Recommendations has generated.feed/entry/content/properties/Name- Catalog item name.feed/entry/content/properties/Category- Catalog item category.feed/entry/content/properties/Description- Catalog item description.feed/entry/content/properties/Metadata- Catalog item metadata.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get All Catalog Items</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-29T11:13:26Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">AllCatalogItemsEntity</title>
<updated>2014-10-29T11:13:26Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:ExternalId m:type="Edm.String">552A1940-21E4-4399-82BB-594B46D7ED54</d:ExternalId>
<d:InternalId m:type="Edm.String">060db26a-e6a6-464e-bb52-436d2da82a50</d:InternalId>
<d:Name m:type="Edm.String">Restraint of Beasts</d:Name>
<d:Category m:type="Edm.String">Book</d:Category>
<d:Description m:type="Edm.String"></d:Description>
<d:Metadata m:type="Edm.String"></d:Metadata>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">AllCatalogItemsEntity</title>
<updated>2014-10-29T11:13:26Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:ExternalId m:type="Edm.String">2406E770-769C-4189-89DE-1C9283F93A96</d:ExternalId>
<d:InternalId m:type="Edm.String">209d7bfe-2eb9-4455-92a3-7c867a41a74a</d:InternalId>
<d:Name m:type="Edm.String">Clara Callan</d:Name>
<d:Category m:type="Edm.String">Book</d:Category>
<d:Description m:type="Edm.String"></d:Description>
<d:Metadata m:type="Edm.String"></d:Metadata>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">AllCatalogItemsEntity</title>
<updated>2014-10-29T11:13:26Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:ExternalId m:type="Edm.String">3BB5CB44-D143-4BDD-A55C-443964BF4B23</d:ExternalId>
<d:InternalId m:type="Edm.String">913ff79b-059b-4d4d-8042-6fa4cc1391dd</d:InternalId>
<d:Name m:type="Edm.String">Spadework</d:Name>
<d:Category m:type="Edm.String">Book</d:Category>
<d:Description m:type="Edm.String"></d:Description>
<d:Metadata m:type="Edm.String"></d:Metadata>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=3&$top=1</id>
<title type="text">AllCatalogItemsEntity</title>
<updated>2014-10-29T11:13:26Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalog?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&apiVersion='1.0'&$skip=3&$top=1" />
<content type="application/xml">
<m:properties>
<d:ExternalId m:type="Edm.String">21BF8088-B6C0-4509-870C-E1C7AC78304A</d:ExternalId>
<d:InternalId m:type="Edm.String">ea65e4fa-768c-40b4-92c3-69d3e8178691</d:InternalId>
<d:Name m:type="Edm.String">The Forgetting Room: A Fiction (Byzantium Book)</d:Name>
<d:Category m:type="Edm.String">Book</d:Category>
<d:Description m:type="Edm.String"></d:Description>
<d:Metadata m:type="Edm.String"></d:Metadata>
</m:properties>
</content>
</entry>
</feed>
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetCatalogItemsByToken?modelId=%27<modelId>%27&token=%27<token>%27&apiVersion=%271.0%27Example: GetCatalogItemsByToken?modelId=%270dbb55fa-7f11-418d-8537-8ff2d9d1d9c6%27&token=%27Cla%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| token | Token of the catalog item’s name. Should contain at least 3 characters. |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The response includes one entry per catalog item. Each entry has the following data:
feed/entry/content/properties/InternalId- Catalog item internal ID, the one that Azure Machine Learning Recommendations has generated.feed/entry/content/properties/Name- Catalog item name.feed/entry/content/properties/Rating- (for future use)feed/entry/content/properties/Reasoning- (for future use)feed/entry/content/properties/Metadata- (for future use)feed/entry/content/properties/FormattedRating- (for future use)
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalogItemsByToken" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get Catalog items that contain a token</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalogItemsByToken?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&token='Cla'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-29T11:48:19Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalogItemsByToken?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&token='Cla'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalogItemsByToken?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&token='Cla'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">CatalogItemsThatContainATokenEntity</title>
<updated>2014-10-29T11:48:19Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetCatalogItemsByToken?modelId='0dbb55fa-7f11-418d-8537-8ff2d9d1d9c6'&token='Cla'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">2406E770-769C-4189-89DE-1C9283F93A96</d:Id>
<d:Name m:type="Edm.String">Clara Callan</d:Name>
<d:Rating m:type="Edm.Double">0</d:Rating>
<d:Reasoning m:type="Edm.String"></d:Reasoning>
<d:Metadata m:type="Edm.String"></d:Metadata>
<d:FormattedRating m:type="Edm.Double" m:null="true"></d:FormattedRating>
</m:properties>
</content>
</entry>
</feed>
This section shows how to upload usage data by using a file. You can call this API several times with usage data. All usage data will be saved for all calls.
| HTTP Method | URI |
|---|---|
| POST | <rootURI>/ImportUsageFile?modelId=%27<modelId>%27&filename=%27<fileName>%27&apiVersion=%271.0%27Example: <rootURI>/ImportUsageFile?modelId=%27a658c626-2baa-43a7-ac98-f6ee26120a12%27&filename=%27ImplicitMatrix10_Guid_small.txt%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| modelId | Unique identifier of the model | ||||||||||||||||||||
| filename | Textual identifier of the catalog. Only letters (A-Z, a-z), numbers (0-9), hyphens (-) and underscore (_) are allowed. Max length: 50 |
||||||||||||||||||||
| apiVersion | 1.0 | ||||||||||||||||||||
| Request Body | Usage data. Format:<User Id>,<Item Id>[,<Time>,<Event>]
Maximum file size: 200MB Example: 149452,1b3d95e2-84e4-414c-bb38-be9cf461c347 |
Response:
HTTP Status code: 200
Feed\entry\content\properties\LineCount- Number of lines accepted.Feed\entry\content\properties\ErrorCount- Number of lines that were not inserted due to an error.Feed\entry\content\properties\FileId- File identifier.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/ImportUsageFile" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Add bulk usage data (usage file)</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ImportUsageFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='ImplicitMatrix10_Guid_small.txt'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-05T07:21:44Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ImportUsageFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='ImplicitMatrix10_Guid_small.txt'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ImportUsageFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='ImplicitMatrix10_Guid_small.txt'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">AddBulkUsageDataUsageFileEntity2</title>
<updated>2014-10-05T07:21:44Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ImportUsageFile?modelId='a658c626-2baa-43a7-ac98-f6ee26120a12'&filename='ImplicitMatrix10_Guid_small.txt'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:LineCount m:type="Edm.String">33</d:LineCount>
<d:ErrorCount m:type="Edm.String">0</d:ErrorCount>
<d:FileId m:type="Edm.String">fead7c1c-db01-46c0-872f-65bcda36025d</d:FileId>
</m:properties>
</content>
</entry>
</feed>
This section shows how to send events in real time to Azure Machine Learning Recommendations, usually from your website.
| HTTP Method | URI |
|---|---|
| POST | <rootURI>/AddUsageEvent?apiVersion=%271.0%27 |
| HEADER | "Content-Type", "text/xml" |
| Parameter Name | Valid Values |
|---|---|
| apiVersion | 1.0 |
| Request body | Event data entry for each event you want to send. You should send for the same user or browser session the same ID in the SessionId field. (See sample of event body below.) |
-
Example for event 'Click':
<Event xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ModelId>2779c063-48fb-46c1-bae3-74acddc8c1d1</ModelId> <SessionId>11112222</SessionId> <EventData> <EventData> <Name>Click</Name> <ItemId>21BF8088-B6C0-4509-870C-E1C7AC78304A</ItemId> </EventData> </EventData> </Event> -
Example for event 'RecommendationClick':
<Event xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ModelId>2779c063-48fb-46c1-bae3-74acddc8c1d1</ModelId> <SessionId>11112222</SessionId> <EventData> <EventData> <Name>RecommendationClick</Name> <ItemId>21BF8088-B6C0-4509-870C-E1C7AC78304A</ItemId> </EventData> </EventData> </Event> -
Example for event 'AddShopCart':
<Event xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ModelId>2779c063-48fb-46c1-bae3-74acddc8c1d1</ModelId> <SessionId>11112222</SessionId> <EventData> <EventData> <Name>AddShopCart</Name> <ItemId>21BF8088-B6C0-4509-870C-E1C7AC78304A</ItemId> </EventData> </EventData> </Event> -
Example for event 'RemoveShopCart':
<Event xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ModelId>2779c063-48fb-46c1-bae3-74acddc8c1d1</ModelId> <SessionId>11112222</SessionId> <EventData> <EventData> <Name>RemoveShopCart</Name> <ItemId>21BF8088-B6C0-4509-870C-E1C7AC78304A</ItemId> </EventData> </EventData> </Event> -
Example for event 'Purchase':
<Event xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ModelId>2779c063-48fb-46c1-bae3-74acddc8c1d1</ModelId> <SessionId>11112222</SessionId> <EventData> <EventData> <Name>Purchase</Name> <PurchaseItems> <PurchaseItem> <ItemId>ABBF8081-C5C0-4F09-9701-E1C7AC78304A</ItemId> <Count>1</Count> </PurchaseItem> <PurchaseItem> <ItemId>21BF8088-B6C0-4509-870C-11C0AC7F304B</ItemId> <Count>3</Count> </PurchaseItem> </PurchaseItems> </EventData> </EventData> </Event> -
Example sending 2 events, 'Click' and 'AddShopCart':
<Event xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ModelId>2779c063-48fb-46c1-bae3-74acddc8c1d1</ModelId> <SessionId>11112222</SessionId> <EventData> <EventData> <Name>Click</Name> <ItemId>21BF8088-B6C0-4509-870C-E1C7AC78304A</ItemId> <ItemName>itemName</ItemName> <ItemDescription>item description</ItemDescription> <ItemCategory>category</ItemCategory> </EventData> <EventData> <Name>AddShopCart</Name> <ItemId>552A1940-21E4-4399-82BB-594B46D7ED54</ItemId> </EventData> </EventData> </Event>
Response: HTTP Status code: 200
Retrieves metadata of all model usage files. The usage files will be retrieved one page at a time. Each page containes 100 items. If you want to get items at a particular index, you can use the $skip odata parameter. For instance if you want to get items starting at position 100, add the parameter $skip=100 to the request.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/ListModelUsageFiles?forModelId=%27<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/ListModelUsageFiles?forModelId=%270dbb55fa-7f11-418d-8537-8ff2d9d1d9c6%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| forModelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The response includes one entry per usage file. Each entry has the following data:
feed\entry\content\properties\Id- Usage file ID.feed\entry\content\properties\Length- Usage file length in MB.feed\entry\content\properties\DateModified- Date when the usage file was created.feed\entry\content\properties\UseInModel- Whether the usage file is used in the model.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/ListModelUsageFiles" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get a list of model's usage files info</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ListModelUsageFiles?forModelId='1c1110f8-7d9f-4c64-a807-4c9c5329993a'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-30T09:40:25Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ListModelUsageFiles?forModelId='1c1110f8-7d9f-4c64-a807-4c9c5329993a'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ListModelUsageFiles?forModelId='1c1110f8-7d9f-4c64-a807-4c9c5329993a'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetAListOfModelsUsageFilesInfoEntity</title>
<updated>2014-10-30T09:40:25Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ListModelUsageFiles?forModelId='1c1110f8-7d9f-4c64-a807-4c9c5329993a'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">4c067b42-e975-4cb2-8c98-a6ab80ed6d63</d:Id>
<d:Length m:type="Edm.Double">0</d:Length>
<d:DateModified m:type="Edm.String">10/30/2014 9:19:57 AM</d:DateModified>
<d:UseInModel m:type="Edm.String">true</d:UseInModel>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ListModelUsageFiles?forModelId='1c1110f8-7d9f-4c64-a807-4c9c5329993a'&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetAListOfModelsUsageFilesInfoEntity</title>
<updated>2014-10-30T09:40:25Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ListModelUsageFiles?forModelId='1c1110f8-7d9f-4c64-a807-4c9c5329993a'&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">3126d816-4e80-4248-8339-1ebbdb9d544d</d:Id>
<d:Length m:type="Edm.Double">0.001</d:Length>
<d:DateModified m:type="Edm.String">10/30/2014 9:21:44 AM</d:DateModified>
<d:UseInModel m:type="Edm.String">true</d:UseInModel>
</m:properties>
</content>
</entry>
Gets usage statistics.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetUsageStatistics?modelId=%27<modelId>%27& startDate=%27<date>%27&endDate=%27<date>%27&eventTypes=%27<types>%27&apiVersion=%271.0%27Example: <rootURI>/GetUsageStatistics?modelId=%271d20c34f-dca1-4eac-8e5d-f299e4e4ad66%27&startDate=%272014%2F10%2F17T00%3A00%3A00%27&endDate=%272014%2F11%2F16T00%3A00%3A00%27&eventTypes=%271%2C2%2C3%2C4%2C5%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| startDate | Start date. Format: yyyy/MM/ddTHH:mm:ss |
| endDate | End date. Format: yyyy/MM/ddTHH:mm:ss |
| eventTypes | Comma-separated string of event types or null to get all events |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
A collection of key/value elements. Each one contains the sum of events for a specific event type grouped by hour.
feed\entry[i]\content\properties\Key- Contains the time (grouped by hour) and the event type.feed\entry[i]\content\properties\Value- Total event count.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get usage statistics</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-11-18T11:39:16Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetUsageStatisticsEntity</title>
<updated>2014-11-18T11:39:16Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Event m:type="Edm.String">11/9/2014 8:00:00 AM;Click</d:Event>
<d:Value m:type="Edm.String">5</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetUsageStatisticsEntity</title>
<updated>2014-11-18T11:39:16Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Event m:type="Edm.String">11/9/2014 8:00:00 AM;RecommendationClick</d:Event>
<d:Value m:type="Edm.String">10</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">GetUsageStatisticsEntity</title>
<updated>2014-11-18T11:39:16Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:Event m:type="Edm.String">11/1/2014 8:00:00 AM;RemoveShopCart</d:Event>
<d:Value m:type="Edm.String">10</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=3&$top=1</id>
<title type="text">GetUsageStatisticsEntity</title>
<updated>2014-11-18T11:39:16Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUsageStatistics?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&startDate='2014/10/12T00:00:00'&endDate='2014/11/10T00:00:00'&eventTypes=''&apiVersion='1.0'&$skip=3&$top=1" />
<content type="application/xml">
<m:properties>
<d:Event m:type="Edm.String">11/5/2014 8:00:00 AM;RemoveShopCart</d:Event>
<d:Value m:type="Edm.String">10</d:Value>
</m:properties>
</content>
</entry>
</feed>
Retrieves the first 2KB of usage file content.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetUsageFileSample?modelId=%27<modelId>%27& fileId=%27<fileId>%27&apiVersion=%271.0%27Example: <rootURI>/GetUsageFileSample?modelId=%271c1110f8-7d9f-4c64-a807-4c9c5329993a%27&fileId=%274c067b42-e975-4cb2-8c98-a6ab80ed6d63%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| fileId | Unique identifier of the model usage file |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
Response is returned in raw text format:
85526,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 210926,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 116866,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 177458,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 274004,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 123883,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 37712,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 152249,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 250948,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 235588,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 158254,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 271195,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 141157,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 171118,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 225087,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1
Retrieves the full content of the usage file.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetModelUsageFile?mid=%27<modelId>%27& fid=%27<fileId>%27&download=%27<download_value>%27&apiVersion=%271.0%27Example: <rootURI>/GetModelUsageFile?mid=%271c1110f8-7d9f-4c64-a807-4c9c5329993a%27&fid=%273126d816-4e80-4248-8339-1ebbdb9d544d%27&download=%271%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| mid | Unique identifier of the model |
| fid | Unique identifier of the model usage file |
| download | 1 |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
Response is returned in raw text format:
85526,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 210926,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 116866,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 177458,2406E770-769C-4189-89DE-1C9283F93A96,2014/11/02T13:40:15,True,1 274004,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 123883,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 37712,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 152249,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 250948,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 235588,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 158254,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 271195,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 141157,21BF8088-B6C0-4509-870C-E1C7AC78304A,2014/11/02T13:40:15,True,1 171118,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 225087,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 244881,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 50547,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 213090,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 260655,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 72214,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 189334,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 36326,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 189336,3BB5CB44-D143-4BDD-A55C-443964BF4B23,2014/11/02T13:40:15,True,1 189334,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 260655,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 162100,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 54946,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 260965,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 102758,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 112602,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 163925,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 262998,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1 144717,552A1940-21E4-4399-82BB-594B46D7ED54,2014/11/02T13:40:15,True,1
Deletes the specified model usage file.
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteUsageFile?modelId=%27<modelId>%27&fileId=%27<fileId>%27&apiVersion=%271.0%27Example: <rootURI>/DeleteUsageFile?modelId=%270f86d698-d0f4-4406-a684-d13d22c47a73%27&fileId=%27f2e0b09d-be5c-46b2-9ac2-c7f622e5e1a5%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| fileId | Unique identifier of the file to be deleted |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
Deletes all model usage files.
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteAllUsageFiles?modelId=%27<modelId>%27&apiVersion=%271.0%27Example: <rootURI>/DeleteAllUsageFiles?modelId=%271c1110f8-7d9f-4c64-a807-4c9c5329993a%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
This section shows how to retrieve feature information, such as the imported features and their values, their rank, and when this rank was allocated. Features are imported as part of the catalog data, and then their rank is associated when a rank build is done. Feature rank can change according to the pattern of usage data and type of items. But for consistent usage/items, the rank should have only small fluctuations. The rank of features is a non-negative number. The number 0 means that the feature was not ranked (happens if you invoke this API prior to the completion of the first rank build). The date at which the rank was attributed is called the score freshness.
Retrieves the feature information, including ranking, for the last successful rank build.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetModelFeatures?modelId=%27<modelId>%27&samplingSize=%27<samplingSize>%27&apiVersion=%271.0%27Example: <rootURI>/GetModelFeatures?modelId=%271c1110f8-7d9f-4c64-a807-4c9c5329993a%27&samplingSize=10%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| samplingSize | Number of values to include for each feature according to the data present in the catalog. Possible values are: -1 - All samples. 0 - No sampling. N - Return N samples for each feature name. |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The response contains a list of feature info entries. Each entry contains:
feed/entry/content/m:properties/d:Name- Feature name.feed/entry/content/m:properties/d:RankUpdateDate- Date at which the rank was allocated to this feature, a.k.a. score freshness feature. A historical date ('0001-01-01T00:00:00') means that no rank build was performed.feed/entry/content/m:properties/d:Rank- Feature rank (float). A rank of 2.0 and up is considered a good feature.feed/entry/content/m:properties/d:SampleValues- Comma-separated list of values up to the sampling size requested.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get the features of a model</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2015-01-08T13:15:02Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">ModelFeaturesEntity</title>
<updated>2015-01-08T13:15:02Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Name m:type="Edm.String">Author</d:Name>
<d:RankUpdateDate m:type="Edm.String">0001-01-01T00:00:00</d:RankUpdateDate>
<d:Rank m:type="Edm.String">0</d:Rank>
<d:SampleValues m:type="Edm.String">A. A. Attanasio, A. A. Milne, A. Bates, A. C. Bhaktivedanta Swami Prabhupada et al., A. C. Crispin, A. C. Doyle, A. C. H. Smith, A. E. Parker, A. J. Holt, A. J. Matthews</d:SampleValues>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">ModelFeaturesEntity</title>
<updated>2015-01-08T13:15:02Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Name m:type="Edm.String">Publisher</d:Name>
<d:RankUpdateDate m:type="Edm.String">0001-01-01T00:00:00</d:RankUpdateDate>
<d:Rank m:type="Edm.String">0</d:Rank>
<d:SampleValues m:type="Edm.String">A. Mondadori, Abacus, Abacus Press, Abacus Uk, Abstract Studio, Acacia Press, Academy Chicago Publishers, Ace Books, ACE Charter, Actar</d:SampleValues>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">ModelFeaturesEntity</title>
<updated>2015-01-08T13:15:02Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&apiVersion='1.0'&$skip=2&$top=1"/>
<contenttype="application/xml">
<m:properties>
<d:Name m:type="Edm.String">Year</d:Name>
<d:RankUpdateDate m:type="Edm.String">0001-01-01T00:00:00</d:RankUpdateDate>
<d:Rank m:type="Edm.String">0</d:Rank>
<d:SampleValues m:type="Edm.String">0, 1920, 1926, 1927, 1929, 1930, 1932, 1942, 1943, 1946</d:SampleValues>
</m:properties>
</content>
</entry>
Retrieves the feature information, including the ranking for a specific rank build.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetModelFeatures?modelId=%27<modelId>%27&samplingSize=%27<samplingSize>%27&rankBuildId=<rankBuildId>&apiVersion=%271.0%27Example: <rootURI>/GetModelFeatures?modelId=%271c1110f8-7d9f-4c64-a807-4c9c5329993a%27&samplingSize=10%27&rankBuildId=1000551&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| samplingSize | Number of values to include for each feature according to the data present in the catalog. Possible values are: -1 - All samples. 0 - No sampling. N - Return N samples for each feature name. |
| rankBuildId | Unique identifier of the rank build or -1 for the last rank build |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
The response contains a list of feature info entries. Each entry contains:
feed/entry/content/m:properties/d:Name- Feature name.feed/entry/content/m:properties/d:RankUpdateDate- Date at which the rank was allocated to this feature, a.k.a. score freshness feature. A historical date ('0001-01-01T00:00:00') means that no rank build was performed.feed/entry/content/m:properties/d:Rank- Feature rank (float). A rank of 2.0 and up is considered a good feature.feed/entry/content/m:properties/d:SampleValues- Comma-separated list of values up to the sampling size requested.
OData
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get the features of a model</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'</id>
<rights type="text" />
<updated>2015-01-08T13:54:22Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">ModelFeaturesEntity</title>
<updated>2015-01-08T13:54:22Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Name m:type="Edm.String">Author</d:Name>
<d:RankUpdateDate m:type="Edm.String">2015-01-08T13:52:14.673</d:RankUpdateDate>
<d:Rank m:type="Edm.String">3.38867426</d:Rank>
<d:SampleValues m:type="Edm.String">A. A. Attanasio, A. A. Milne, A. Bates, A. C. Bhaktivedanta Swami Prabhupada et al., A. C. Crispin, A. C. Doyle, A. C. H. Smith, A. E. Parker, A. J. Holt, A. J. Matthews</d:SampleValues>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">ModelFeaturesEntity</title>
<updated>2015-01-08T13:54:22Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Name m:type="Edm.String">Publisher</d:Name>
<d:RankUpdateDate m:type="Edm.String">2015-01-08T13:52:14.673</d:RankUpdateDate>
<d:Rank m:type="Edm.String">1.67839336</d:Rank>
<d:SampleValues m:type="Edm.String">A. Mondadori, Abacus, Abacus Press, Abacus Uk, Abstract Studio, Acacia Press, Academy Chicago Publishers, Ace Books, ACE Charter, Actar</d:SampleValues>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">ModelFeaturesEntity</title>
<updated>2015-01-08T13:54:22Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelFeatures?modelId='f13ab2e8-b530-4aa1-86f7-2f4a24714765'&samplingSize='10'&rankBuildId=1000653&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:Name m:type="Edm.String">Year</d:Name>
<d:RankUpdateDate m:type="Edm.String">2015-01-08T13:52:14.673</d:RankUpdateDate>
<d:Rank m:type="Edm.String">1.12352145</d:Rank>
<d:SampleValues m:type="Edm.String">0, 1920, 1926, 1927, 1929, 1930, 1932, 1942, 1943, 1946</d:SampleValues>
</m:properties>
</content>
</entry>
</feed>
This section explains the different APIs related to builds. There are 3 types of builds: a recommendation build, a rank build and an FBT (frequently bought together) build.
The recommendation build's purpose is to generate a recommendation model used for predictions. Predictions (for this type of build) come in two flavors:
- I2I - a.k.a. Item to Item recommendations - given an item or a list of items this option will predict a list of items that are likely to be of high interest.
- U2I - a.k.a. User to Item recommendations - given a user id (and optionally a list of items) this option will predict a list of items that are likely to be of high interest for the given user (and its additional choice of items). The U2I recommendations are based on the history of items that were of interest for the user up to the time the model was built.
A rank build is a technical build that allows you to learn about the usefulness of your features. Usually, in order to get the best result for a recommendation model involving features, you should take the following steps:
- Trigger a rank build (unless the score of your features is stable) and wait till you get the feature score.
- Retrieve the rank of your features by calling the Get Features Info API.
- Configure a recommendation build with the following parameters:
useFeatureInModel- Set to True.ModelingFeatureList- Set to a comma-separated list of features with a score of 2.0 or more (according to the ranks you retrieved in the previous step).AllowColdItemPlacement- Set to True.- Optionally you can set
EnableFeatureCorrelationto True andReasoningFeatureListto the list of features you want to use for explanations (usually the same list of features used in modelling or a sublist).
- Trigger the recommendation build with the configured parameters.
Note: If you do not configure any parameters (e.g. invoke the recommendation build without parameters) or you do not explicitly disable the usage of features (e.g. UseFeatureInModel set to False), the system will set up the feature-related parameters to the explained values above in case a rank build exists.
There is no restriction on running a rank build and a recommendation build concurrently for the same model. Nevertheless, you cannot run two builds of the same type on the same model in parallel.
An FBT (Frequently bought together) build is yet another recommendations algorithm called sometimes "conservative" recommender, which is good for catalogs that are not homogeneous in nature (homogeneous: books, movies, some food, fashion; non-homogeneous: computer and devices, cross-domain, highly diverse).
Note: if the usage files that you uploaded contain the optional field "event type" then for FBT modelling only "Purchase" events will be used. If no event type is provided all events will be considered as purchase.
Each build type can be configured via a set of parameters (depicted below). If you don't configure the parameters, the system will automatically attribute values to the parameters according to the information present at the time you trigger a build.
Users or items with few usage points might contain more noise than information. The system attempts to predict the minimal number of usage points per user/item to be used in a model. This number will be within the range defined by the ItemCutoffLowerBound and ItemCutoffUpperBound parameters for items, and the range defined by the UserCutOffLowerBound and UserCutoffUpperBound parameters for users. The condenser effect on items or users can be minimized by setting at least one of the corresponding bounds to zero.
The table below depicts the build parameters for a rank build.
| Key | Description | Type | Valid Value |
|---|---|---|---|
| NumberOfModelIterations | The number of iterations the model performs is reflected by the overall compute time and the model accuracy. The higher the number, the better accuracy you will get, but the compute time will take longer. | Integer | 10-50 |
| NumberOfModelDimensions | The number of dimensions relates to the number of 'features' the model will try to find within your data. Increasing the number of dimensions will allow better fine-tuning of the results into smaller clusters. However, too many dimensions will prevent the model from finding correlations between items. | Integer | 10-40 |
| ItemCutOffLowerBound | Defines the item lower bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| ItemCutOffUpperBound | Defines the item upper bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| UserCutOffLowerBound | Defines the user lower bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| UserCutOffUpperBound | Defines the user upper bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
The table below depicts the build parameters for recommendation build.
| Key | Description | Type | Valid Value |
|---|---|---|---|
| NumberOfModelIterations | The number of iterations the model performs is reflected by the overall compute time and the model accuracy. The higher the number, the better accuracy you will get, but the compute time will take longer. | Integer | 10-50 |
| NumberOfModelDimensions | The number of dimensions relates to the number of 'features' the model will try to find within your data. Increasing the number of dimensions will allow better fine-tuning of the results into smaller clusters. However, too many dimensions will prevent the model from finding correlations between items. | Integer | 10-40 |
| ItemCutOffLowerBound | Defines the item lower bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| ItemCutOffUpperBound | Defines the item upper bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| UserCutOffLowerBound | Defines the user lower bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| UserCutOffUpperBound | Defines the user upper bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| Description | Build description. | String | Any text, maximum 512 chars |
| EnableModelingInsights | Allows you to compute metrics on the recommendation model. | Boolean | True/False |
| UseFeaturesInModel | Indicates if features can be used in order to enhance the recommendation model. | Boolean | True/False |
| ModelingFeatureList | Comma-separated list of feature names to be used in the recommendation build, in order to enhance the recommendation. | String | Feature names, up to 512 chars |
| AllowColdItemPlacement | Indicates if the recommendation should also push cold items via feature similarity. | Boolean | True/False |
| EnableFeatureCorrelation | Indicates if features can be used in reasoning. | Boolean | True/False |
| ReasoningFeatureList | Comma-separated list of feature names to be used for reasoning sentences (e.g. recommendation explanations). | String | Feature names, up to 512 chars |
| EnableU2I | Allow the personalized recommendation a.k.a. U2I (user to item recommendations). | Boolean | True/False (default true) |
The table below depicts the build parameters for recommendation build.
| Key | Description | Type | Valid Value (Default) |
|---|---|---|---|
| FbtSupportThreshold | How conservative the model is. Number of co-occurrences of items to be considered for modeling. | Integer | 3-50 (6) |
| FbtMaxItemSetSize | Bounds the number of items in a frequent set. | Integer | 2-3 (2) |
| FbtMinimalScore | Minimal score that a frequent set should have in order to be included in the returned results. The higher the better. | Double | 0 and above (0) |
| FbtSimilarityFunction | Defines the similarity function to be used by the build. Lift favors serendipity, Co-occurrence favors predictability, and Jaccard is a nice compromise between the two. | String | cooccurrence, lift, jaccard (lift) |
By default this API will trigger a recommendation model build. To trigger a rank build (in order to score features), the build API variant with build type parameter should be used.
| HTTP Method | URI |
|---|---|
| POST | <rootURI>/BuildModel?modelId=%27<modelId>%27&userDescription=%27<description>%27&apiVersion=%271.0%27Example: <rootURI>/BuildModel?modelId=%27a658c626-2baa-43a7-ac98-f6ee26120a12%27&userDescription=%27First%20build%27&apiVersion=%271.0%27 |
| HEADER | "Content-Type", "text/xml" (If sending Request Body) |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| userDescription | Textual identifier of the catalog. Note that if you use spaces you must encode it with %20 instead. See example above. Max length: 50 |
| apiVersion | 1.0 |
| Request Body | If left empty then the build will be executed with the default build parameters. If you want to set the build parameters, send the parameters as XML into the body as in the following sample. (See the "Build parameters" section for an explanation of the parameters.) <NumberOfModelIterations>40</NumberOfModelIterations><NumberOfModelDimensions>20</NumberOfModelDimensions><MinItemAppearance>5</MinItemAppearance><MinUserAppearance>5</MinUserAppearance><EnableModelingInsights>true</EnableModelingInsights><UseFeaturesInModel>false</UseFeaturesInModel><ModelingFeatureList>feature_name_1,feature_name_2,...</ModelingFeatureList><AllowColdItemPlacement>false</AllowColdItemPlacement><EnableFeatureCorrelation>false</EnableFeatureCorrelation><ReasoningFeatureList>feature_name_a,feature_name_b,...</ReasoningFeatureList></BuildParametersList> |
Response:
HTTP Status code: 200
This is an asynchronous API. You will get a build ID as a response. To know when the build has ended, you should call the “Get Builds Status of a Model” API and locate this build ID in the response. Note that a build can take from minutes to hours depending on the size of the data.
You cannot consume recommendations till the build ends.
Valid build status:
- Create - Build request was created.
- Queued - Build request was sent and it is queued.
- Building - Build is in progress.
- Success - Build ended successfully.
- Error - Build ended with a failure.
- Cancelled - Build was cancelled.
- Cancelling - A cancel request for the build was sent.
Note that the build ID can be found under the following path: Feed\entry\content\properties\Id
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Build a Model with RequestBody</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First build'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-05T08:56:34Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First%20build'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First build'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">BuildAModelEntity2</title>
<updated>2014-10-05T08:56:34Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First%20build'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">1000272</d:Id>
<d:UserName m:type="Edm.String"></d:UserName>
<d:ModelId m:type="Edm.String">9559872f-7a53-4076-a3c7-19d9385c1265</d:ModelId>
<d:ModelName m:type="Edm.String">docTest</d:ModelName>
<d:Type m:type="Edm.String">Recommendation</d:Type>
<d:CreationTime m:type="Edm.String">2014-10-05T08:56:31.893</d:CreationTime>
<d:Progress_BuildId m:type="Edm.String">1000272</d:Progress_BuildId>
<d:Progress_ModelId m:type="Edm.String">9559872f-7a53-4076-a3c7-19d9385c1265</d:Progress_ModelId>
<d:Progress_UserName m:type="Edm.String">[email protected]</d:Progress_UserName>
<d:Progress_IsExecutionStarted m:type="Edm.String">false</d:Progress_IsExecutionStarted>
<d:Progress_IsExecutionEnded m:type="Edm.String">false</d:Progress_IsExecutionEnded>
<d:Progress_Percent m:type="Edm.String">0</d:Progress_Percent>
<d:Progress_StartTime m:type="Edm.String">0001-01-01T00:00:00</d:Progress_StartTime>
<d:Progress_EndTime m:type="Edm.String">0001-01-01T00:00:00</d:Progress_EndTime>
<d:Progress_UpdateDateUTC m:type="Edm.String"></d:Progress_UpdateDateUTC>
<d:Status m:type="Edm.String">Queued</d:Status>
<d:Key1 m:type="Edm.String">UseFeaturesInModel</d:Key1>
<d:Value1 m:type="Edm.String">False</d:Value1>
</m:properties>
</content>
</entry>
</feed>
| HTTP Method | URI |
|---|---|
| POST | <rootURI>/BuildModel?modelId=%27<modelId>%27&userDescription=%27<description>%27&buildType=%27<buildType>%27&apiVersion=%271.0%27Example: <rootURI>/BuildModel?modelId=%27a658c626-2baa-43a7-ac98-f6ee26120a12%27&userDescription=%27First%20build%27&buildType=%27Ranking%27&apiVersion=%271.0%27 |
| HEADER | "Content-Type", "text/xml" (If sending Request Body) |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| userDescription | Textual identifier of the catalog. Note that if you use spaces you must encode it with %20 instead. See example above. Max length: 50 |
| buildType | Type of the build to invoke: - 'Recommendation' for recommendation build - 'Ranking' for rank build - 'Fbt' for FBT build |
| apiVersion | 1.0 |
| Request Body | If left empty then the build will be executed with the default build parameters. If you want to set build parameters, send them as XML into the body like in the following sample. (See the "Build parameters" section for an explanation and full list of the parameters.) <BuildParametersList><NumberOfModelIterations>40</NumberOfModelIterations><NumberOfModelDimensions>20</NumberOfModelDimensions><MinItemAppearance>5</MinItemAppearance><MinUserAppearance>5</MinUserAppearance></BuildParametersList> |
Response:
HTTP Status code: 200
This is an asynchronous API. You will get a build ID as a response. To know when the build has ended, you should call the “Get Builds Status of a Model” API and locate this build ID in the response. Note that a build can take from minutes to hours depending on the size of the data.
You cannot consume recommendations till the build ends.
Valid build status:
- Create - Model was created.
- Queued - Model build was triggered and it is queued.
- Building - Model is being built.
- Success - Build ended successfully.
- Error - Build ended with a failure.
- Cancelled - Build was cancelled.
- Cancelling - Build is being cancelled.
Note that the build ID can be found under the following path: Feed\entry\content\properties\Id
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Build a Model with RequestBody</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First build'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-05T08:56:34Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First%20build'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First build'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">BuildAModelEntity2</title>
<updated>2014-10-05T08:56:34Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/BuildModel?modelId='9559872f-7a53-4076-a3c7-19d9385c1265'&userDescription='First%20build'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">1000272</d:Id>
<d:UserName m:type="Edm.String"></d:UserName>
<d:ModelId m:type="Edm.String">9559872f-7a53-4076-a3c7-19d9385c1265</d:ModelId>
<d:ModelName m:type="Edm.String">docTest</d:ModelName>
<d:Type m:type="Edm.String">Recommendation</d:Type>
<d:CreationTime m:type="Edm.String">2014-10-05T08:56:31.893</d:CreationTime>
<d:Progress_BuildId m:type="Edm.String">1000272</d:Progress_BuildId>
<d:Progress_ModelId m:type="Edm.String">9559872f-7a53-4076-a3c7-19d9385c1265</d:Progress_ModelId>
<d:Progress_UserName m:type="Edm.String">[email protected]</d:Progress_UserName>
<d:Progress_IsExecutionStarted m:type="Edm.String">false</d:Progress_IsExecutionStarted>
<d:Progress_IsExecutionEnded m:type="Edm.String">false</d:Progress_IsExecutionEnded>
<d:Progress_Percent m:type="Edm.String">0</d:Progress_Percent>
<d:Progress_StartTime m:type="Edm.String">0001-01-01T00:00:00</d:Progress_StartTime>
<d:Progress_EndTime m:type="Edm.String">0001-01-01T00:00:00</d:Progress_EndTime>
<d:Progress_UpdateDateUTC m:type="Edm.String"></d:Progress_UpdateDateUTC>
<d:Status m:type="Edm.String">Queued</d:Status>
<d:Key1 m:type="Edm.String">UseFeaturesInModel</d:Key1>
<d:Value1 m:type="Edm.String">False</d:Value1>
</m:properties>
</content>
</entry>
</feed>
Retrieves builds and their status for a specified model.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetModelBuildsStatus?modelId=%27<modelId>%27&onlyLastBuild=<bool>&apiVersion=%271.0%27Example: <rootURI>/GetModelBuildsStatus?modelId=%279559872f-7a53-4076-a3c7-19d9385c1265%27&onlyLastBuild=true&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| onlyLastBuild | Indicates whether to return all the build history of the model or only the status of the most recent build |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per build. Each entry has the following data:
feed/entry/content/properties/UserName- Name of the user.feed/entry/content/properties/ModelName- Name of the model.feed/entry/content/properties/ModelId- Model unique identifier.feed/entry/content/properties/IsDeployed- Whether the build is deployed (a.k.a. active build).feed/entry/content/properties/BuildId- Build unique identifier.feed/entry/content/properties/BuildType- Type of the build.feed/entry/content/properties/Status- Build status. Can be one of the following: Error, Building, Queued, Cancelling, Cancelled, Success.feed/entry/content/properties/StatusMessage- Detailed status message (applies only to specific states).feed/entry/content/properties/Progress- Build progress (%).feed/entry/content/properties/StartTime- Build start time.feed/entry/content/properties/EndTime- Build end time.feed/entry/content/properties/ExecutionTime- Build duration.feed/entry/content/properties/ProgressStep- Details about the current stage of a build in progress.
Valid build status:
- Created - Build request entry was created.
- Queued - Build request was triggered and it is queued.
- Building - Build is in process.
- Success - Build ended successfully.
- Error - Build ended with a failure.
- Cancelled - Build was cancelled.
- Cancelling - Build is being cancelled.
Valid values for build type:
- Rank - Rank build.
- Recommendation - Recommendation build.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelBuildsStatus" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get builds status of a model</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelBuildsStatus?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&onlyLastBuild=False&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-11-05T17:51:10Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelBuildsStatus?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&onlyLastBuild=False&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetModelBuildsStatus?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&onlyLastBuild=False&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetBuildsStatusEntity</title>
<updated>2014-11-05T17:51:10Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetModelBuildsStatus?modelId='1d20c34f-dca1-4eac-8e5d-f299e4e4ad66'&onlyLastBuild=False&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:UserName m:type="Edm.String">[email protected]</d:UserName>
<d:ModelName m:type="Edm.String">ModelName</d:ModelName>
<d:ModelId m:type="Edm.String">1d20c34f-dca1-4eac-8e5d-f299e4e4ad66</d:ModelId>
<d:IsDeployed m:type="Edm.String">true</d:IsDeployed>
<d:BuildId m:type="Edm.String">1000272</d:BuildId>
<d:BuildType m:type="Edm.String">Recommendation</d:BuildType>
<d:Status m:type="Edm.String">Success</d:Status>
<d:StatusMessage m:type="Edm.String"></d:StatusMessage>
<d:Progress m:type="Edm.String">0</d:Progress>
<d:StartTime m:type="Edm.String">2014-11-02T13:43:51</d:StartTime>
<d:EndTime m:type="Edm.String">2014-11-02T13:45:10</d:EndTime>
<d:ExecutionTime m:type="Edm.String">00:01:19</d:ExecutionTime>
<d:IsExecutionStarted m:type="Edm.String">false</d:IsExecutionStarted>
<d:ProgressStep m:type="Edm.String"></d:ProgressStep>
</m:properties>
</content>
</entry>
</feed>
Retrieves build statuses of all models of a user.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetUserBuildsStatus?onlyLastBuilds=<bool>&apiVersion=%271.0%27Example: <rootURI>/GetUserBuildsStatus?onlyLastBuilds=true&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| onlyLastBuild | Indicates whether to return all the build history of the model or only the status of the most recent build. |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per build. Each entry has the following data:
feed/entry/content/properties/UserName- Name of the user.feed/entry/content/properties/ModelName- Name of the model.feed/entry/content/properties/ModelId- Model unique identifier.feed/entry/content/properties/IsDeployed- Whether the build is deployed.feed/entry/content/properties/BuildId- Build unique identifier.feed/entry/content/properties/BuildType- Type of the build.feed/entry/content/properties/Status- Build status. Can be one of the following: Error, Building, Queued, Cancelled, Cancelling, Success.feed/entry/content/properties/StatusMessage- Detailed status message (applies only to specific states).feed/entry/content/properties/Progress- Build progress (%).feed/entry/content/properties/StartTime- Build start time.feed/entry/content/properties/EndTime- Build end time.feed/entry/content/properties/ExecutionTime- Build duration.feed/entry/content/properties/ProgressStep- Details about the current stage of a build in progress.
Valid build status:
- Created - Build request entry was created.
- Queued - Build request was triggered and it is queued.
- Building - Build is in process.
- Success - Build ended successfully.
- Error - Build ended with a failure.
- Cancelled - Build was cancelled.
- Cancelling - Build is being cancelled.
Valid values for build type:
- Rank - Rank build.
- Recommendation - Recommendation build.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetUserBuildsStatus" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get builds status of a user</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUserBuildsStatus?onlyLastBuilds=False&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-11-05T18:41:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUserBuildsStatus?onlyLastBuilds=False&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUserBuildsStatus?onlyLastBuilds=False&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetBuildsStatusEntity</title>
<updated>2014-11-05T18:41:21Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUserBuildsStatus?onlyLastBuilds=False&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:UserName m:type="Edm.String">[email protected]</d:UserName>
<d:ModelName m:type="Edm.String">ModelName</d:ModelName>
<d:ModelId m:type="Edm.String">1d20c34f-dca1-4eac-8e5d-f299e4e4ad66</d:ModelId>
<d:IsDeployed m:type="Edm.String">true</d:IsDeployed>
<d:BuildId m:type="Edm.String">1000272</d:BuildId>
<d:BuildType m:type="Edm.String">Recommendation</d:BuildType>
<d:Status m:type="Edm.String">Success</d:Status>
<d:StatusMessage m:type="Edm.String"></d:StatusMessage>
<d:Progress m:type="Edm.String">0</d:Progress>
<d:StartTime m:type="Edm.String">2014-11-02T13:43:51</d:StartTime>
<d:EndTime m:type="Edm.String">2014-11-02T13:45:10</d:EndTime>
<d:ExecutionTime m:type="Edm.String">00:01:19</d:ExecutionTime>
<d:IsExecutionStarted m:type="Edm.String">false</d:IsExecutionStarted>
<d:ProgressStep m:type="Edm.String"></d:ProgressStep>
</m:properties>
</content>
</entry>
</feed>
Deletes a build.
NOTE:
You cannot delete an active build. The model should be updated to a different active build before you delete it.
You cannot delete an in-progress build. You should cancel the build first by calling Cancel Build.
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteBuild?buildId=%27<buildId>%27&apiVersion=%271.0%27Example: <rootURI>/DeleteBuild?buildId=%271500068%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| buildId | Unique identifier of the build. |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
Cancels a build that is in building status.
| HTTP Method | URI |
|---|---|
| PUT | <rootURI>/CancelBuild?buildId=%27<buildId>%27&apiVersion=%271.0%27Example: <rootURI>/CancelBuild?buildId=%271500076%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| buildId | Unique identifier of the build. |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
Retrieves build parameters.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetBuildParameters?buildId=%27<buildId>%27&apiVersion=%271.0%27Example: <rootURI>/GetBuildParameters?buildId=%271000653%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| buildId | Unique identifier of the build. |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
This API returns a collection of key/value elements. Each element represents a parameter and its value:
feed/entry/content/properties/Key- Build parameter name.feed/entry/content/properties/Value- Build parameter value.
The table below depicts the value that each key represents.
| Key | Description | Type | Valid Value |
|---|---|---|---|
| NumberOfModelIterations | The number of iterations the model performs is reflected by the overall compute time and the model accuracy. The higher the number, the better accuracy you will get, but the compute time will take longer. | Integer | 10-50 |
| NumberOfModelDimensions | The number of dimensions relates to the number of 'features' the model will try to find within your data. Increasing the number of dimensions will allow better fine-tuning of the results into smaller clusters. However, too many dimensions will prevent the model from finding correlations between items. | Integer | 10-40 |
| ItemCutOffLowerBound | Defines the item lower bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| ItemCutOffUpperBound | Defines the item upper bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| UserCutOffLowerBound | Defines the user lower bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| UserCutOffUpperBound | Defines the user upper bound for the condenser. See usage condenser above. | Integer | 2 or more (0 disable condenser) |
| Description | Build description. | String | Any text, maximum 512 chars |
| EnableModelingInsights | Allows you to compute metrics on the recommendation model. | Boolean | True/False |
| UseFeaturesInModel | Indicates if features can be used in order to enhance the recommendation model. | Boolean | True/False |
| ModelingFeatureList | Comma-separated list of feature names to be used in the recommendation build, in order to enhance the recommendation. | String | Feature names, up to 512 chars |
| AllowColdItemPlacement | Indicates if the recommendation should also push cold items via feature similarity. | Boolean | True/False |
| EnableFeatureCorrelation | Indicates if features can be used in reasoning. | Boolean | True/False |
| ReasoningFeatureList | Comma-separated list of feature names to be used for reasoning sentences (e.g. recommendation explanations). | String | Feature names, up to 512 chars |
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get build parameters</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">UseFeaturesInModel</d:Key>
<d:Value m:type="Edm.String">False</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">AllowColdItemPlacement</d:Key>
<d:Value m:type="Edm.String">False</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">EnableFeatureCorrelation</d:Key>
<d:Value m:type="Edm.String">False</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=3&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=3&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">EnableModelingInsights</d:Key>
<d:Value m:type="Edm.String">False</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=4&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=4&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">NumberOfModelIterations</d:Key>
<d:Value m:type="Edm.String">10</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=5&$top=1</id>
<titletype="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=5&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">NumberOfModelDimensions</d:Key>
<d:Value m:type="Edm.String">10</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=6&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<linkrel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=6&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">ItemCutOffLowerBound</d:Key>
<d:Value m:type="Edm.String">2</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=7&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=7&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">ItemCutOffUpperBound</d:Key>
<d:Value m:type="Edm.String">2147483647</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=8&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=8&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">UserCutOffLowerBound</d:Key>
<d:Value m:type="Edm.String">2</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=9&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=9&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">UserCutOffUpperBound</d:Key>
<d:Value m:type="Edm.String">2147483647</d:Value>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=10&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=10&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">ModelingFeatureList</d:Key>
<d:Value m:type="Edm.String"/>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=11&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=11&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">ReasoningFeatureList</d:Key>
<d:Value m:type="Edm.String"/>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=12&$top=1</id>
<title type="text">GetBuildParametersEntity</title>
<updated>2015-01-08T13:50:57Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetBuildParameters?buildId='1000653'&apiVersion='1.0'&$skip=12&$top=1" />
<content type="application/xml">
<m:properties>
<d:Key m:type="Edm.String">Description</d:Key>
<d:Value m:type="Edm.String">rankBuild</d:Value>
</m:properties>
</content>
</entry>
</feed>
Get recommendations of the active build of type "Recommendation" or "Fbt" based on a list of seeds (input) items.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/ItemRecommend?modelId=%27<modelId>%27&itemIds=%27<itemId>%27&numberOfResults=<int>&includeMetadata=<bool>&apiVersion=%271.0%27Example: <rootURI>/ItemRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&itemIds=%271003%27&numberOfResults=10&includeMetadata=false&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| itemIds | Comma-separated list of the items to recommend for. If the active build is of type FBT then you can send only one item. Max length: 1024 |
| numberOfResults | Number of required results Max: 150 |
| includeMetatadata | Future use, always false |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item. Each entry has the following data:
Feed\entry\content\properties\Id- Recommended item ID.Feed\entry\content\properties\Name- Name of the item.Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
The example response below includes 10 recommended items.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get Recommendation</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">159</d:Id>
<d:Name m:type="Edm.String">159</d:Name>
<d:Rating m:type="Edm.Double">0.543343480387708</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '159'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">52</d:Id>
<d:Name m:type="Edm.String">52</d:Name>
<d:Rating m:type="Edm.Double">0.539588900748721</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '52'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">35</d:Id>
<d:Name m:type="Edm.String">35</d:Name>
<d:Rating m:type="Edm.Double">0.53842946443853</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '35'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=3&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=3&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">124</d:Id>
<d:Name m:type="Edm.String">124</d:Name>
<d:Rating m:type="Edm.Double">0.536712832792886</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '124'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=4&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=4&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">120</d:Id>
<d:Name m:type="Edm.String">120</d:Name>
<d:Rating m:type="Edm.Double">0.533673023762878</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '120'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=5&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=5&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">96</d:Id>
<d:Name m:type="Edm.String">96</d:Name>
<d:Rating m:type="Edm.Double">0.532544826370521</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '96'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=6&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=6&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">69</d:Id>
<d:Name m:type="Edm.String">69</d:Name>
<d:Rating m:type="Edm.Double">0.531678607847759</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '69'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=7&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=7&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">172</d:Id>
<d:Name m:type="Edm.String">172</d:Name>
<d:Rating m:type="Edm.Double">0.530957821375951</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '172'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=8&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=8&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">155</d:Id>
<d:Name m:type="Edm.String">155</d:Name>
<d:Rating m:type="Edm.Double">0.529093541481333</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '155'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=9&$top=1</id>
<title type="text">GetRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=10&includeMetadata=false&apiVersion='1.0'&$skip=9&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">32</d:Id>
<d:Name m:type="Edm.String">32</d:Name>
<d:Rating m:type="Edm.Double">0.528917978168322</d:Rating>
<d:Reasoning m:type="Edm.String">People who like '1003' also like '32'</d:Reasoning>
</m:properties>
</content>
</entry>
</feed>
Get recommendations of a specific build of type "Recommendation" or "Fbt".
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/ItemRecommend?modelId=%27<modelId>%27&itemIds=%27<itemId>%27&numberOfResults=<int>&includeMetadata=<bool>&buildId=<int>&apiVersion=%271.0%27Example: <rootURI>/ItemRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&itemIds=%271003%27&numberOfResults=10&includeMetadata=false&buildId=1234&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| itemIds | Comma-separated list of the items to recommend for. If the active build is of type FBT then you can send only one item. Max length: 1024 |
| numberOfResults | Number of required results Max: 150 |
| includeMetatadata | Future use, always false |
| buildId | the build id to use for this recommendation request |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item. Each entry has the following data:
Feed\entry\content\properties\Id- Recommended item ID.Feed\entry\content\properties\Name- Name of the item.Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
See a response example in 12.1
Get recommendations of the active build of type "Fbt" based on a seed (input) item.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/ItemFbtRecommend?modelId=%27<modelId>%27&itemId=%27<itemId>%27&numberOfResults=<int>&minimalScore=<double>&includeMetadata=<bool>&apiVersion=%271.0%27Example: <rootURI>/ItemFbtRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&itemId=%271003%27&numberOfResults=10&minimalScore=<double>&includeMetadata=false&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| itemId | Item to recommend for. Max length: 1024 |
| numberOfResults | Number of required results Max: 150 |
| minimalScore | Minimal score that a frequent set should have in order to be included in the returned results |
| includeMetatadata | Future use, always false |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item set (a set of items which are usually bought together with the seed/input item). Each entry has the following data:
Feed\entry\content\properties\Id1- Recommended item ID.Feed\entry\content\properties\Name1- Name of the item.Feed\entry\content\properties\Id2- 2nd recommended item ID (optional).Feed\entry\content\properties\Name2- Name of the 2nd item (optional).Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
The example response below includes 3 recommended item sets.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get Recommendation</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemId='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetFbtRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id1 m:type="Edm.String">159</d:Id1>
<d:Name1 m:type="Edm.String">159</d:Name1>
<d:Id2 m:type="Edm.String"></d:Id2>
<d:Name2 m:type="Edm.String"></d:Name2>
<d:Rating m:type="Edm.Double">0.543343480387708</d:Rating>
<d:Reasoning m:type="Edm.String">People who bought '1003' also bought '159'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'&$skip=1&$top=1</id>
<title type="text">GetFbtRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'&$skip=1&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id1 m:type="Edm.String">52</d:Id1>
<d:Name1 m:type="Edm.String">52</d:Name1>
<d:Id2 m:type="Edm.String"></d:Id2>
<d:Name2 m:type="Edm.String"></d:Name2>
<d:Rating m:type="Edm.Double">0.533343480387708</d:Rating>
<d:Reasoning m:type="Edm.String">People who bought '1003' also bought '52'</d:Reasoning>
</m:properties>
</content>
</entry>
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'&$skip=2&$top=1</id>
<title type="text">GetFbtRecommendationEntity</title>
<updated>2014-10-05T12:28:48Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/ItemFbtRecommend?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&itemIds='1003'&numberOfResults=3&minimalScore=0.1&includeMetadata=false&apiVersion='1.0'&$skip=2&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id1 m:type="Edm.String">35</d:Id1>
<d:Name1 m:type="Edm.String">35</d:Name1>
<d:Id2 m:type="Edm.String">102</d:Id2>
<d:Name2 m:type="Edm.String">102</d:Name2>
<d:Rating m:type="Edm.Double">0.523343480387708</d:Rating>
<d:Reasoning m:type="Edm.String">People who bought '1003' also bought '35' and '102'</d:Reasoning>
</m:properties>
</content>
</entry>
</feed>
Get recommendations of a specific build of type "Fbt".
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/ItemFbtRecommend?modelId=%27<modelId>%27&itemId=%27<itemId>%27&numberOfResults=<int>&minimalScore=<double>&includeMetadata=<bool>&buildId=<int>&apiVersion=%271.0%27Example: <rootURI>/ItemFbtRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&itemId=%271003%27&numberOfResults=10&minimalScore=0.1&includeMetadata=false&buildId=1234&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| itemId | Item to recommend for. Max length: 1024 |
| numberOfResults | Number of required results Max: 150 |
| minimalScore | Minimal score that a frequent set should have in order to be included in the returned results |
| includeMetatadata | Future use, always false |
| buildId | the build id to use for this recommendation request |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item set (a set of items which are usually bought together with the seed/input item). Each entry has the following data:
Feed\entry\content\properties\Id1- Recommended item ID.Feed\entry\content\properties\Name1- Name of the item.Feed\entry\content\properties\Id2- 2nd recommended item ID (optional).Feed\entry\content\properties\Name2- Name of the 2nd item (optional).Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
See a response example in 12.3
Get user recommendations of a build of type "Recommendation" marked as active build.
The API will return a list of predicted item according to the usage history of the user.
Notes:
- There is no user recommendation for FBT build.
- If the active build is FBT this method will returns an error.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/UserRecommend?modelId=%27<modelId>%27&userId=%27<userId>%27&numberOfResults=<int>&includeMetadata=<bool>&apiVersion=%271.0%27Example: <rootURI>/UserRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&userId=%27u1101%27&numberOfResults=10&includeMetadata=false&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| userId | Unique identifier of the user |
| numberOfResults | Number of required results |
| includeMetatadata | Future use, always false |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item. Each entry has the following data:
Feed\entry\content\properties\Id- Recommended item ID.Feed\entry\content\properties\Name- Name of the item.Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
See a response example in 12.1
Get user recommendations of a build of type "Recommendation" marked as active build with an additional list of items
The API will return a list of predicted item according to the usage history of the user and the additional provided items.
Notes:
- There is no user recommendation for FBT build.
- If the active build is FBT this method will returns an error.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/UserRecommend?modelId=%27<modelId>%27&userId=%27<userId>&itemsIds=%27<itemsIds>%27&numberOfResults=<int>&includeMetadata=<bool>&apiVersion=%271.0%27Example: <rootURI>/UserRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&userId=%27u1101%27&itemsIds=%271003%2C1000%27&numberOfResults=10&includeMetadata=false&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| userId | Unique identifier of the user |
| itemsIds | Comma-separated list of the items to recommend for. Max length: 1024 |
| numberOfResults | Number of required results |
| includeMetatadata | Future use, always false |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item. Each entry has the following data:
Feed\entry\content\properties\Id- Recommended item ID.Feed\entry\content\properties\Name- Name of the item.Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
See a response example in 12.1
Get user recommendations of a specific build of type "Recommendation".
The API will return a list of predicted item according to the usage history of the user (used in the specific build).
Note: There is no user recommendation for FBT build.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/UserRecommend?modelId=%27<modelId>%27&userId=%27<userId>%27&numberOfResults=<int>&includeMetadata=<bool>&buildId=<int>&apiVersion=%271.0%27Example: <rootURI>/UserRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&userId=%27u1101%27&numberOfResults=10&includeMetadata=false&buildId=50012&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| userId | Unique identifier of the user |
| numberOfResults | Number of required results |
| includeMetatadata | Future use, always false |
| buildId | the build id to use for this recommendation request |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item. Each entry has the following data:
Feed\entry\content\properties\Id- Recommended item ID.Feed\entry\content\properties\Name- Name of the item.Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
See a response example in 12.1
Get user recommendations of a specific build of type "Recommendation" and the list of additional items.
The API will return a list of predicted item according to the usage history of the user and the additional list of items.
Note: Tthere is no user recommendation for FBT build.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/UserRecommend?modelId=%27<modelId>%27&userId=%27<userId>%27&itemsIds=%27<itemsIds>%27&numberOfResults=<int>&includeMetadata=<bool>&buildId=<int>&apiVersion=%271.0%27Example: <rootURI>/UserRecommend?modelId=%272779c063-48fb-46c1-bae3-74acddc8c1d1%27&userId=%27u1101%27&itemsIds=%271003%27&numberOfResults=10&includeMetadata=false&buildId=50012&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| userId | Unique identifier of the user |
| itemIds | Comma-separated list of the items to recommend for. Max length: 1024 |
| numberOfResults | Number of required results |
| includeMetatadata | Future use, always false |
| buildId | the build id to use for this recommendation request |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item. Each entry has the following data:
Feed\entry\content\properties\Id- Recommended item ID.Feed\entry\content\properties\Name- Name of the item.Feed\entry\content\properties\Rating- Rating of the recommendation; higher number means higher confidence.Feed\entry\content\properties\Reasoning- Recommendation reasoning (e.g. recommendation explanations).
See a response example in 12.1
Once a recommendation model was built the system will allow to retrieve the user history (items associated to a specific user) used for the build. This API allow to retrieve the user history
Note: the user history is currently available only for recommendation builds.
Retrieve the list of item used in the active build or in the specified build for the given user id.
| HTTP Method | URI |
|---|---|
| GET | Get the user history for the active build.<rootURI>/GetUserHistory?modelId=%27<model_id>%27&userId=%27<userId>%27&apiVersion=%271.0%27Get the user history for the given build <rootURI>/GetUserHistory?modelId=%27<model_id>%27&userId=%27<userId>%27&buildId=<int>&apiVersion=%271.0%27Example: <rootURI>/GetUserHistory?modelId=%2727967136e8-f868-4258-9331-10d567f87fae%27&&userId=%27u_1013%27&apiVersion=%271.0%277 |
| Parameter Name | Valid Values |
|---|---|
| modelId | the unique identifier of the model. |
| userId | the unique identifier of the user. |
| buildId | optional parameter, allow to indicate from which build the user history should be fetch |
| apiVersion | 1.0 |
Response:
HTTP Status code: 200
The response includes one entry per recommended item. Each entry has the following data:
Feed\entry\content\properties\Id- Recommended item ID.Feed\entry\content\properties\Name- Name of the item.Feed\entry\content\properties\Rating- N/A.Feed\entry\content\properties\Reasoning- N/A.
OData XML
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetUserHistory" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get User History</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUserHistory?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&userId='u_1013'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2015-05-26T15:32:47Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUserHistory?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&userId='u_1013'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetUserHistory?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&userId='u_1013'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">CatalogItemsThatContainATokenEntity</title>
<updated>2015-05-26T15:32:47Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetUserHistory?modelId='2779c063-48fb-46c1-bae3-74acddc8c1d1'&userId='u_1013'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.String">2406E770-769C-4189-89DE-1C9283F93A96</d:Id>
<d:Name m:type="Edm.String">Clara Callan</d:Name>
<d:Rating m:type="Edm.Double">0</d:Rating>
<d:Reasoning m:type="Edm.String"/>
<d:Metadata m:type="Edm.String"/>
<d:FormattedRating m:type="Edm.Double" m:null="true"/>
</m:properties>
</content>
</entry>
Azure Machine Learning Recommendations creates notifications when persistent errors happen in the system. There are 3 types of notifications:
- Build failure - This notification is triggered for every build failure.
- Data acquisition processing failure - This notification is triggered when we have more than 100 errors in the last 5 minutes in the processing of usage events per model.
- Recommendation consumption failure - This notification is triggered when we have more than 100 errors in the last 5 minutes in the processing of recommendation requests per model.
Retrieves all the notifications for all models or for a single model.
| HTTP Method | URI |
|---|---|
| GET | <rootURI>/GetNotifications?modelId=%27<model_id>%27&apiVersion=%271.0%27Getting all notifications for all models: <rootURI>/GetNotifications?apiVersion=%271.0%27Example for getting notifications for a specific model: <rootURI>/GetNotifications?modelId=%27967136e8-f868-4258-9331-10d567f87fae%27&apiVersion=%271.0%277 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Optional parameter. When omitted, you will get all notifications for all models. Valid value: unique identifier of the model. |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
OData XML
The response includes one entry per notification. Each entry has the following data:
* feed\entry\content\properties\UserName - Internal user name identification.
* feed\entry\content\properties\ModelId - Model ID.
* feed\entry\content\properties\Message - Notification message.
* feed\entry\content\properties\DateCreated - Date that this notification was created in UTC format.
* feed\entry\content\properties\NotificationType - Notification types. Values are BuildFailure, RecommendationFailure, and DataAquisitionFailure.
<feed xmlns:base="https://api.datamarket.azure.com/amla/recommendations/v3/GetNotifications" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">
<title type="text" />
<subtitle type="text">Get a list of Notifications for a user</subtitle>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetNotifications?modelId='967136e8-f868-4258-9331-10d567f87fae'&apiVersion='1.0'</id>
<rights type="text" />
<updated>2014-11-04T13:24:23Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetNotifications?modelId='967136e8-f868-4258-9331-10d567f87fae'&apiVersion='1.0'" />
<entry>
<id>https://api.datamarket.azure.com/amla/recommendations/v3/GetNotifications?modelId='967136e8-f868-4258-9331-10d567f87fae'&apiVersion='1.0'&$skip=0&$top=1</id>
<title type="text">GetAListOfNotificationsForAUserEntity</title>
<updated>2014-11-04T13:24:23Z</updated>
<link rel="self" href="https://api.datamarket.azure.com/amla/recommendations/v3/GetNotifications?modelId='967136e8-f868-4258-9331-10d567f87fae'&apiVersion='1.0'&$skip=0&$top=1" />
<content type="application/xml">
<m:properties>
<d:UserName m:type="Edm.String">[email protected]</d:UserName>
<d:ModelId m:type="Edm.String">967136e8-f868-4258-9331-10d567f87fae</d:ModelId>
<d:Message m:type="Edm.String">Build failed for user</d:Message>
<d:DateCreated m:type="Edm.String">2014-11-04T13:23:14.383</d:DateCreated>
<d:NotificationType m:type="Edm.String">BuildFailure</d:NotificationType>
</m:properties>
</content>
</entry>
</feed>
Deletes all read notifications for a model.
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteModelNotifications?modelId=%<model_id>%27&apiVersion=%271.0%27Example: <rootURI>/DeleteModelNotifications?modelId=%27967136e8-f868-4258-9331-10d567f87fae%27&apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| modelId | Unique identifier of the model |
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
Deletes all notifications for all models.
| HTTP Method | URI |
|---|---|
| DELETE | <rootURI>/DeleteUserNotifications?apiVersion=%271.0%27 |
| Parameter Name | Valid Values |
|---|---|
| apiVersion | 1.0 |
| Request Body | NONE |
Response:
HTTP Status code: 200
This document is provided “as-is”. Information and views expressed in this document, including URL and other Internet Web site references, may change without notice.
Some examples depicted herein are provided for illustration only and are fictitious. No real association or connection is intended or should be inferred.
This document does not provide you with any legal rights to any intellectual property in any Microsoft product. You may copy and use this document for your internal, reference purposes.
© 2015 Microsoft. All rights reserved.