DataMarket and Data Services are being retired and will stop accepting new orders after 12/31/2016. Existing subscriptions will be retired and cancelled starting 3/31/2017. Please reach out to your service provider for options if you want to continue service.

Recommendations

Data

Published by: Azure Machine Learning
Categories: Machine Learning, Retail & Hospitality
Date added: 10/2/2014
Get support for this offering

Recommendations API is an example built with Microsoft Azure Machine Learning that helps your customer discover items in your catalog. Customer activity in your digital store is used to recommend items and to improve conversion in your digital store. The recommendation engine may be trained by uploading data about past customer activity or by collecting data directly from your digital store. When the customer returns to your store you will be able to feature recommended items from your catalog that may increase your conversion rate. Microsoft Azure Machine Learning’s Recommendations includes Item to Item recommendations: a customer who bought this also bought that and Customer to Item recommendations: a customer like you also bought that.

Service root URL

https://api.datamarket.azure.com/amla/recommendations/v3/

This service supports fixed query. Some queries may include required input parameters. (learn more about query types)

ItemRecommend

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
includeMetadata false Boolean Required
itemIds 6F7A9FE7-FA23-4308-A6F0-0E76140A021D String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
numberOfResults 10 Int32 Required
buildId 1000084 Int64

Results:

Name Type
Id String
Name String
Rating Double
Reasoning String

ItemFbtRecommend

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
includeMetadata false Boolean Required
itemId 6F7A9FE7-FA23-4308-A6F0-0E76140A021D String Required
minimalScore 0.1 Double Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
numberOfResults 10 Int32 Required
buildId 1000084 Int64

Results:

Name Type
Id1 String
Name1 String
Id2 String
Name2 String
Rating Double
Reasoning String

UserRecommend

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
includeMetadata false Boolean Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
numberOfResults 10 Int32 Required
userId sampleUserId String Required
buildId 1000084 Int64
itemsIds 6F7A9FE7-FA23-4308-A6F0-0E76140A021D String

Results:

Name Type
Id String
Name String
Rating Double
Reasoning String

GetModel

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
id 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
Id String
Name String
Date String
Status String
HasActiveBuild String
BuildId String
BuildStatus String
UsageFileNames String
CatalogId String
UserName String
Description String
CatalogFileName String

GetAllModels

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required

Results:

Name Type
Id String
Name String
Date String
Status String
HasActiveBuild String
BuildId String
UsageFileNames String
CatalogId String
UserName String
Description String
CatalogFileName String

CreateModel

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelName myNewModel String Required

Results:

Name Type
Id String
Name String
Date String
Status String
HasActiveBuild String
BuildId String
Mpr String
UserName String
Description String

BuildModel

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
userDescription description String Required
buildType Recommendation String

Results:

Name Type
Id String
UserName String
ModelId String
ModelName String
Type String
CreationTime String
Progress_BuildId String
Progress_ModelId String
Progress_UserName String
Progress_IsExecutionStarted String
Progress_IsExecutionEnded String
Progress_Percent String
Progress_StartTime String
Progress_EndTime String
Progress_UpdateDateUTC String
Status String
Key1 String
Value1 String

DeleteModel

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
id 34961e60-09b4-497a-83c7-f471f8481b5b String Required

Results:

Name Type
string String

UpdateModel

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
id 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
string String

ImportCatalogFile

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
filename catalog10_small.txt String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
LineCount String
ErrorCount String

GetCatalog

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
ExternalId String
InternalId String
Name String
Category String
Description String
Metadata String

GetCatalogItemsByToken

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
token book String Required

Results:

Name Type
Id String
Name String
Rating Double
Reasoning String
Metadata String
FormattedRating Double

GetUserHistory

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
userId sampleUserId String Required
buildId 1000084 Int64

Results:

Name Type
ExternalId String
InternalId String
Name String
Category String
Description String
Metadata String

GetModelBuildsStatus

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
onlyLastBuild false Boolean Required

Results:

Name Type
UserName String
ModelName String
ModelId String
IsDeployed String
BuildId String
BuildType String
Status String
StatusMessage String
Progress String
StartTime String
EndTime String
ExecutionTime String
IsExecutionStarted String
ProgressStep String

GetUserBuildsStatus

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
onlyLastBuilds false Boolean Required

Results:

Name Type
UserName String
ModelName String
ModelId String
IsDeployed String
BuildId String
BuildType String
Status String
StatusMessage String
Progress String
StartTime String
EndTime String
ExecutionTime String
IsExecutionStarted String
ProgressStep String

ImportUsageFile

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
filename ImplicitMatrix10_Guid_small.txt String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
LineCount String
ErrorCount String
FileId String

AddUsageEvent

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required

Returns binary or unstructured data

AddUsageEventByGet

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
events String Required

Returns binary or unstructured data

GetMostPopular

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
buildId 1000084 String

Results:

Name Type
Id String
Name String

ListModelUsageFiles

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
forModelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
Id String
Length Double
DateModified String
UseInModel String

DeleteUsageFile

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
fileId 5525b598-c6a3-4983-a78e-be1d832c13f8 String Required
modelId 611dd96c-b382-4877-8bd7-1ae8cda058f3 String Required

Results:

Name Type
boolean String

CancelBuild

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
buildId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Returns binary or unstructured data

GetUsageStatistics

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
endDate 2014/08/25T00:00:00 String Required
eventTypes 1 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
startDate 2014/08/21T00:00:00 String Required

Results:

Name Type
Key String
Value String

GetUsageFileSample

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
fileId 986ede28-87c0-4a73-b59e-e9e6215b0b7b String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Returns binary or unstructured data

GetModelUsageFile

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
download 1 String Required
fid 3dc78b96-468d-44eb-bf8e-1d69ce0ca7b6 String Required
mid 01e9f496-217b-4957-8551-a7f76da9427c String Required

Returns binary or unstructured data

DeleteAllUsageFiles

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
string String

GetDataInsight

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
Key String
Value String

GetModelSample

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId fdfc1c21-a462-4262-a27c-fa7656f7fac1 String Required
buildId 1000230 String

Returns binary or unstructured data

GetModelInsight

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
buildId 1000084 String

Results:

Name Type
Key String
Value String

GetModelTop

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
numberOfHoursToInclude 1 String Required
numberOfResultsPerTable 10 String Required

Results:

Name Type
Key String
Value String

GetModelRules

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
Id String
Type String
Parameters String

AddRule

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required

Results:

Name Type
Id String
Type String
Parameters String

DeleteRule

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
filterId 1000011 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
string String

DeleteAllRules

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Results:

Name Type
string String

GetNotifications

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String

Results:

Name Type
UserName String
ModelId String
Message String
DateCreated String
NotificationType String

DeleteModelNotifications

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required

Returns binary or unstructured data

DeleteUserNotifications

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required

Returns binary or unstructured data

DeleteBuild

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
buildId 1000000 String Required

Returns binary or unstructured data

GetBuildParameters

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
buildId 1000000 String Required

Results:

Name Type
Key String
Value String

GetModelFeatures

Input parameters:

Name Sample values Type Required
apiVersion 1.0 String Required
modelId 24024f7e-b45c-419e-bfa2-dfd947e0d253 String Required
samplingSize 0 String Required
rankBuildId -1 Int64

Results:

Name Type
Name String
RankUpdateDate String
Rank String
SampleValues String

Microsoft Azure Machine Learning Recommendations API Terms of Service

(Last updated: October 2014) Currently in Public Preview
  1. What does this contract cover?

    This contract (the “Agreement”) is an agreement between you and Microsoft Corporation (“Microsoft”). Sometimes Microsoft is referred to as “we,” “us,” or “our.” This Agreement applies to your use of the Microsoft Azure Machine Learning Recommendations API service (the “API”), which can be obtained through the Microsoft Azure Marketplace at http://datamarket.azure.com. The API is intended to demonstrate the capabilities of Microsoft Azure Machine Learning in the context of providing recommendations. However, this Agreement does not grant rights to use Microsoft Azure, including Microsoft Azure Machine Learning. Access to Microsoft Azure must be obtained and (as applicable) paid for separately. For more information on using and purchasing access to Microsoft Azure, please visit http://www.azure.com. The API is intended to deliver relevant results, but please note that we do not provide warranties or a service level agreement for the API. This Agreement also limits our liability. We provide the API solely on an “as is” basis, in accordance with Section 9.

  2. What rights do you have?

    Solely to the extent that you are in compliance with all terms of this Agreement, we grant you a non-exclusive, non-transferable, non-sublicenseable license to transmit data to, and receive results from, the API. Your license to use the API is limited to solely your own applications, services, and websites (collectively, “Client Applications”). You may make your Client Applications available to others, if the Client Applications add material functionality to the API and are not primarily a substitute for the API, and are accompanied by a privacy statement as described in Section 4. We reserve all other rights.

  3. Code of conduct / restrictions on use

    You may use the API only in accordance with this Agreement. You may not reverse engineer, decompile, disassemble, or work around technical limitations in the API, except to the extent that applicable law permits it despite these restrictions. Such technical limitations may include limits or throttling of the size or frequency of calls into the API and results returned by the API, and other means to protect the API, protect our customers, or stop you from breaching this Agreement. You may not disable, tamper with, or otherwise attempt to circumvent any billing mechanism that meters your use of the API. You may not rent, lease, lend, resell, transfer, or sublicense the API or any portion thereof to or for third parties. Additionally, you will not and will not permit users of your Client Applications to use the API: • in a way prohibited by law, regulation, governmental order or decree; • to violate the rights of others; • to try to gain unauthorized access to or disrupt any service, data, account or network by any means; • to falsify any protocol or email header information (e.g., “spoofing”); • to spam or distribute malware; • in a way that could harm the API or impair anyone else’s use of it; • or for any high risk use (where failure or fault of the API could lead to death or serious bodily injury of any person, or to severe physical or environmental damage).

  4. Privacy

    All access to and use of the API is subject to the data practices set forth in the Microsoft Azure Privacy Statement, which is available here (which may be updated from time to time). Nothing in this Agreement or the API provides for the collection or transfer of any personally identifiable information of Internet users between the parties. You must maintain a prominent privacy policy for your Client Applications that access the API. Such privacy policy, at a minimum, must include a full, accurate, and clear disclosure regarding your collection and use of data in relation to activity by users of your Client Applications.

  5. How we may change the contract

    If we modify this Agreement, then we will provide notice as described in Section 11 below. If you do not agree to any such modifications, then you must stop using the API. If you do not stop using the API, then your use of the API will continue under the modified Agreement. We may choose in the future to increase charges (or ceasing charging) for all use of the API, or change the requirements for use of the API. If we choose to change the fee requirements for the API, Microsoft will provide notice of such terms as described in Sections 6 and 11 below, and you may elect to stop using the API rather than incurring additional fees. Any documents or websites incorporated into this Agreement by reference or link may be modified and updated from time to time by Microsoft and upon such modification or update will be deemed a part of this Agreement.

  6. Fees and payment

    The pricing terms for the API set forth on the Microsoft Azure Marketplace website, and the payment terms set forth here apply to your use of the API and are hereby incorporated by reference into this Agreement. Such pricing and payment terms apply only to your use of the API; you may incur separate costs associated with integrating the API into your Client Applications, support, and other activities undertaken in connection with setting up, providing, and maintaining your Client Applications, if any. Microsoft reserves the right, in its sole discretion, to charge additional (or lesser or no) fees for use of or access to some or all of the API. If Microsoft decides to charge additional (or lesser or no) fees for the API, such fees and additional terms and conditions will be disclosed to you prior to the effective date when such fees or requirements would be imposed. If you do not agree to any such modifications, then you must stop using the API. If you do not stop using the API, then your use of the API will continue under the modified Agreement.

  7. Your responsibility

    You will indemnify and hold Microsoft and its directors, officers, affiliates, and agents harmless from and against any and all loss, liability, and expense (including reasonable attorneys’ fees and costs) suffered or incurred by reason of any claims, proceedings, or suits based on or arising out of any breach (or alleged breach) by you of this Agreement, or any part of it, or that otherwise relates to your Client Application, or your use of the API. You will be solely responsible for defending any claim using mutually agreed counsel, subject to Microsoft's right to participate with counsel it selects, and you will not publicize any claim or agree to any settlement that imposes any obligation or liability on Microsoft (or its directors, officers, affiliates, and agents) without Microsoft's prior written consent, such consent provided by Microsoft in its sole discretion.

  8. Term

    This Agreement may be terminated immediately for any reason or no reason and without notice by Microsoft. If this Agreement terminates, all rights granted to you by this Agreement will automatically terminate and you will cease to have any rights to use the API. We will not be liable to you for damages resulting solely from terminating this Agreement according to its terms. All terms of this Agreement that, by their nature, are intended to survive termination will survive (including, without limitation, Sections 8, 9, and 11).

  9. Liability disclaimer; limitation of liability

    THE API IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS WITH REGARD TO THE FOREGOING, INCLUDING ALL WARRANTIES AND CONDITIONS OF MERCHANTABILITY, WHETHER EXPRESS, IMPLIED OR STATUTORY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL MICROSOFT BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA, OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF INFORMATION AVAILABLE FROM THE API. THE AGGREGATE LIABILITY OF MICROSOFT ARISING UNDER THIS AGREEMENT WILL NOT EXCEED $5.00 USD.

  10. Changes to the API

    We may change (including by removing features, or charging additional fees for features previously provided free or at different rates), update, or enhance (collectively, “modify,” or “modification”) the API at any time and may require you to use the most recent version. Modifications may affect your ability to use the API and may require you to change (at your sole cost) the way you previously used them. If any modification is unacceptable to you, your only recourse is to stop using the API. Your continued use of the API following any posted update or change to the API will constitute your binding acceptance to these terms as revised by the update or change. We will not be liable for any costs that you incur, or for lost profits or damages of any kind, related to any such modification. We may cancel or suspend your use of the API or our offering of the API partially or in its entirety at any time. Our cancellation or suspension may be without cause, without notice, or both. Upon cancellation, your right to use the API (including, without limitation, the API) will cease immediately. Once the API is cancelled or suspended, any data you have stored on the API (to the extent applicable) may not be retrieved later.

  11. Miscellaneous

    • Assignment. We may assign this Agreement, in whole or in part, at any time with or without notice to you. You may not assign, including by operation of law, this Agreement, or any part of it, to any other person or entity without our prior written consent. Any attempt by you to do so is void. You may not transfer to anyone else, either temporarily or permanently, any rights to use the API or any part of the API. • No third-party beneficiaries. This Agreement is solely for your and our benefit. It is not for the benefit of any other person or entity, except for permitted successors and assigns under this Agreement. • Time limit for claims. Any claim related to this Agreement or the API may not be brought unless brought within one year. The one-year period begins on the date when the claim first could be filed. If it is not filed, then that claim is permanently barred. This applies to you and your successors. It also applies to us and our successors and assigns. • Export. The API is subject to United States export laws and regulations. You must comply with all domestic and international export laws and regulations that apply to the API. These laws include restrictions on destinations, end users, and end use. Additional information is provided here (as it may be updated from time to time). • Notices. You may notify Microsoft by postal mail (Microsoft does not accept email notices relating to this Agreement) addressed as follows: Microsoft Corporation, Attention: LCA – Microsoft Azure Attorneys, One Microsoft Way, Redmond, Washington 98052, USA. This Agreement is in electronic form, and you consent to Microsoft sending you any information related to this Agreement in electronic form (by email, by access to a Microsoft website designated in an email notice to you, or by posting notice on the relevant Microsoft website). • Severability. If any part of this agreement is held unenforceable, the rest remains in full force and effect. • Waiver. Failure to enforce any provision of this agreement will not constitute a waiver. • No agency. You and Microsoft are independent contractors. This agreement does not create an agency, partnership, or joint venture. • Entire agreement. This agreement is the entire agreement concerning its subject matter and supersedes any prior or concurrent communications. • Applicable law and venue. This agreement is governed by State of Washington law, without regard to its conflict of laws principles, except that (i) if you are a U.S. Government entity, this agreement is governed by the laws of the United States, and (ii) if you are a state or local government entity in the United States, this agreement is governed by the laws of that state. Any action to enforce this agreement must be brought in the State of Washington. This choice of jurisdiction does not prevent either party from seeking injunctive relief in any appropriate jurisdiction with respect to violation of intellectual property rights.