Skip to content

Commit

Permalink
CodeGen from PR 15699 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history 
Merge 3056de4429bb2a8d8ca6d60389e70c6df618befb into cf675c2dcf645a7b79ff0894b2cc9cb43d35a397
  • Loading branch information
SDKAuto committed Sep 2, 2021
1 parent e527f9f commit 03c16d2
Show file tree
Hide file tree
Showing 26 changed files with 3,229 additions and 264 deletions.
2 changes: 1 addition & 1 deletion sdk/cognitiveservices/cognitiveservices-personalizer/LICENSE.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2019 Microsoft
Copyright (c) 2021 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
204 changes: 64 additions & 140 deletions sdk/cognitiveservices/cognitiveservices-personalizer/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,172 +1,96 @@
## An isomorphic javascript sdk for - PersonalizerClient
## An isomorphic javascript sdk for - PersonalizerBase

This package contains an isomorphic SDK for PersonalizerClient.
This package contains an isomorphic SDK (runs both in node.js and in browsers) for PersonalizerBase.

### Currently supported environments

- Node.js version 6.x.x or higher
- Browser JavaScript
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- Latest versions of Safari, Chrome, Edge and Firefox.

### How to Install
### Prerequisites

You must have an [Azure subscription](https://azure.microsoft.com/free/).

### How to install

To use this SDK in your project, you will need to install two packages.
- `@azure/cognitiveservices-personalizer` that contains the client.
- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.

Install both packages using the below command:
```bash
npm install @azure/cognitiveservices-personalizer
npm install --save @azure/cognitiveservices-personalizer @azure/identity
```
> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.

### How to use

#### nodejs - Authentication, client creation and reward events as an example written in TypeScript.
- If you are writing a client side browser application,
- Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions.
- Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below.
- If you are writing a server side application,
- [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
- Complete the set up steps required by the credential if any.
- Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.

##### Install @azure/ms-rest-azure-js

```bash
npm install @azure/ms-rest-azure-js
```
In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.
#### nodejs - Authentication, client creation, and get serviceConfiguration as an example written in JavaScript.

##### Sample code
The following sample ranks a personalized request object. To know more, refer to the [Azure Documentation on Personalizer](https://docs.microsoft.com/azure/cognitive-services/personalizer/)

```javascript
const { PersonalizerClient } = require("@azure/cognitiveservices-personalizer");
const { CognitiveServicesCredentials } = require("@azure/ms-rest-azure-js");

async function main() {
const personalizerKey = process.env["personalizerKey"] || "<personalizerKey>";
const personalizerEndPoint =
process.env["personalizerEndPoint"] || "<personalizerEndPoint>";
const cognitiveServiceCredentials = new CognitiveServicesCredentials(
personalizerKey
);

const client = new PersonalizerClient(
cognitiveServiceCredentials,
personalizerEndPoint
);

const rankRequest = {
contextFeatures: [
{
timeOfDay: "Morning"
}
],
actions: [
{
id: "NewsArticle",
features: [
{
type: "News"
}
]
},
{
id: "SportsArticle",
features: [
{
type: "Sports"
}
]
},
{
id: "EntertainmentArticle",
features: [
{
type: "Entertainment"
}
]
}
],
excludedActions: ["SportsArticle"],
eventId: "75269AD0-BFEE-4598-8196-C57383D38E10",
deferActivation: false
};

client
.rank(rankRequest)
.then(result => {
console.log("The result is: ");
console.log(result);
})
.catch(err => {
console.log("An error occurred:");
console.error(err);
});
}

main();
const { DefaultAzureCredential } = require("@azure/identity");
const { PersonalizerBase } = require("@azure/cognitiveservices-personalizer");
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
const creds = new DefaultAzureCredential();
const client = new PersonalizerBase(creds, subscriptionId);
client.serviceConfiguration.get().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
```

#### browser - Authentication, client creation and reward events as an example written in JavaScript.
#### browser - Authentication, client creation, and get serviceConfiguration as an example written in JavaScript.

In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
- See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser.
- Note down the client Id from the previous step and use it in the browser sample below.

##### Sample code

- index.html

```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/cognitiveservices-personalizer sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/cognitiveservices-personalizer/dist/cognitiveservices-personalizer.js"></script>
<script type="text/javascript">
const personalizerKey = "<YOUR_PERSONALIZER_KEY>";
const personalizerEndPoint = "<YOUR_PERSONALIZER_ENDPOINT>";
const cognitiveServiceCredentials = new msRest.ApiKeyCredentials({
inHeader: {
"Ocp-Apim-Subscription-Key": personalizerKey
}
const subscriptionId = "<Subscription_Id>";
// Create credentials using the `@azure/identity` package.
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
const credential = new InteractiveBrowserCredential(
{
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
const client = new Azure.CognitiveservicesPersonalizer.PersonalizerBase(creds, subscriptionId);
client.serviceConfiguration.get().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
const client = new Azure.CognitiveservicesPersonalizer.PersonalizerClient(
cognitiveServiceCredentials,
personalizerEndPoint
);
const rankRequest = {
contextFeatures: [
{
timeOfDay: "Morning"
}
],
actions: [
{
id: "NewsArticle",
features: [
{
type: "News"
}
]
},
{
id: "SportsArticle",
features: [
{
type: "Sports"
}
]
},
{
id: "EntertainmentArticle",
features: [
{
type: "Entertainment"
}
]
}
],
excludedActions: ["SportsArticle"],
eventId: "75269AD0-BFEE-4598-8196-C57383D38E10",
deferActivation: false
};
client
.rank(rankRequest)
.then(result => {
console.log("The result is: ");
console.log(result);
})
.catch(err => {
console.log("An error occurred:");
console.error(err);
});
</script>
</head>
<body></body>
Expand All @@ -177,4 +101,4 @@ main();

- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcognitiveservices%2Fcognitiveservices-personalizer%2FREADME.png)
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/cognitiveservices/cognitiveservices-personalizer/README.png)
13 changes: 7 additions & 6 deletions sdk/cognitiveservices/cognitiveservices-personalizer/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
{
"name": "@azure/cognitiveservices-personalizer",
"author": "Microsoft Corporation",
"description": "PersonalizerClient Library with typescript type definitions for node.js and browser.",
"description": "PersonalizerBase Library with typescript type definitions for node.js and browser.",
"version": "2.0.1",
"dependencies": {
"@azure/ms-rest-js": "^2.0.4",
"@azure/ms-rest-js": "^2.2.0",
"@azure/core-auth": "^1.1.4",
"tslib": "^1.10.0"
},
"keywords": [
Expand All @@ -16,16 +17,16 @@
],
"license": "MIT",
"main": "./dist/cognitiveservices-personalizer.js",
"module": "./esm/personalizerClient.js",
"types": "./esm/personalizerClient.d.ts",
"module": "./esm/personalizerBase.js",
"types": "./esm/personalizerBase.d.ts",
"devDependencies": {
"typescript": "^3.5.3",
"typescript": "^3.6.0",
"rollup": "^1.18.0",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-sourcemaps": "^0.4.2",
"uglify-js": "^3.6.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/cognitiveservices/cognitiveservices-personalizer",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/cognitiveservices/cognitiveservices-personalizer",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down
6 changes: 3 additions & 3 deletions sdk/cognitiveservices/cognitiveservices-personalizer/rollup.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import sourcemaps from "rollup-plugin-sourcemaps";
* @type {rollup.RollupFileOptions}
*/
const config = {
input: "./esm/personalizerClient.js",
input: "./esm/personalizerBase.js",
external: [
"@azure/ms-rest-js",
"@azure/ms-rest-azure-js"
Expand All @@ -21,8 +21,8 @@ const config = {
"@azure/ms-rest-azure-js": "msRestAzure"
},
banner: `/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
20 changes: 20 additions & 0 deletions sdk/cognitiveservices/cognitiveservices-personalizer/src/models/evaluationsMappers.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

export {
ErrorResponse,
Evaluation,
EvaluationContract,
EvaluationsCreateHeaders,
InternalError,
PersonalizerError,
PolicyContract,
PolicyResult,
PolicyResultSummary,
PolicyResultTotalSummary
} from "../models/mappers";
4 changes: 2 additions & 2 deletions sdk/cognitiveservices/cognitiveservices-personalizer/src/models/eventsMappers.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
Loading

0 comments on commit 03c16d2

Please sign in to comment.