Skip to content

Commit d5dba59

Browse files
sharathmalladiHarshaNalluru
sharathmalladi
and
HarshaNalluru
authored
Personalizer Javascript SDK (Azure#22850)
* Added autorest generated files with ci pipeline * Fix package name and folder * Updated autorest arguments and version and added tests * Accepting linter corrections * Added evaluation tests and sample code for champion scenario * Added champion scenarios * Generate sample code * Fix isUnexpected function by adjust the autorest generated code manually. Separate issue was filed to fix the issue in autorest.js project. * Updated to use swagger file that has readonly attributes. * Fixing bugs in test code * Addressing feedback comments in PR. * Added test records. * Added autorest generated files with ci pipeline * Fix package name and folder * Updated autorest arguments and version and added tests * Accepting linter corrections * Added evaluation tests and sample code for champion scenario * Added champion scenarios * Generate sample code * Fix isUnexpected function by adjust the autorest generated code manually. Separate issue was filed to fix the issue in autorest.js project. * Updated to use swagger file that has readonly attributes. * Fixing bugs in test code * Addressing feedback comments in PR. * Added test records. * Adding session records for multislot tests. * Accepting changes made to lock file after rush update. * fix browser tests - reasonable updates to personalizer tests and package.json * Fixed issue with creating session records for browser and added the session record files. * Reacting to feedback in comments. * Added tests to use aad authentication. * Fix lint and formatting. * Addressing feedback. * Replaced functions with constants in sample code. * Regenerated samples code from samples-dev folder. * Remove link to github locations that wont work because the PR is not yet merged. * fix browser tests * Added test record for aad authn test and igored links to samples to get pipelines to pass. * Replacing with generic links to fix pipeline failures. Co-authored-by: Harsha Nalluru <sanallur@microsoft.com>
1 parent 82a9b0a commit d5dba59

File tree

77 files changed

+6941
-25
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+6941
-25
lines changed

‎common/config/rush/pnpm-lock.yaml‎

Lines changed: 70 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎eng/ignore-links.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ https://docs.microsoft.com/javascript/api/@azure/arm-connectedvmware?view=azure-
2222
https://docs.microsoft.com/javascript/api/@azure/arm-nginx
2323
https://docs.microsoft.com/javascript/api/@azure/arm-nginx?view=azure-node-preview
2424
https://docs.microsoft.com/javascript/api/@azure/arm-agrifood?view=azure-node-preview
25+
https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/personalizer/ai-personalizer-rest/samples

‎rush.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,11 @@
386386
"projectFolder": "sdk/metricsadvisor/ai-metrics-advisor",
387387
"versionPolicyName": "client"
388388
},
389+
{
390+
"packageName": "@azure-rest/ai-personalizer",
391+
"projectFolder": "sdk/personalizer/ai-personalizer-rest",
392+
"versionPolicyName": "client"
393+
},
389394
{
390395
"packageName": "@azure/search-documents",
391396
"projectFolder": "sdk/search/search-documents",

‎sdk/personalizer/ai-personalizer-rest/.eslintrc.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"plugins": ["@azure/azure-sdk"],
3+
"extends": ["plugin:@azure/azure-sdk/azure-sdk-base"],
4+
"rules": {
5+
"@azure/azure-sdk/ts-modules-only-named": "warn",
6+
"@azure/azure-sdk/ts-apiextractor-json-types": "warn",
7+
"@azure/azure-sdk/ts-package-json-types": "warn",
8+
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
9+
"tsdoc/syntax": "warn"
10+
}
11+
}

‎sdk/personalizer/ai-personalizer-rest/CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2022-09-07)
4+
5+
### Features Added
6+
This is a preview of our efforts in creating a client library for Azure Personalizer service.

‎sdk/personalizer/ai-personalizer-rest/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2022 Microsoft
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎sdk/personalizer/ai-personalizer-rest/README.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Azure Personalizer client library for JavaScript
2+
3+
Personalizer Client
4+
5+
**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
6+
7+
Key links:
8+
9+
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/personalizer/ai-personalizer-rest)
10+
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/ai-personalizer)
11+
- [API reference documentation](https://docs.microsoft.com/javascript/api/)
12+
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/personalizer/ai-personalizer-rest/samples/v1-beta/javascript)
13+
## Getting started
14+
15+
### Currently supported environments
16+
17+
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
18+
- Latest versions of Safari, Chrome, Edge, and Firefox.
19+
20+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
21+
22+
### Prerequisites
23+
24+
- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
25+
26+
### Install the `@azure-rest/ai-personalizer` package
27+
28+
Install the Azure Personalizer client REST client library for JavaScript with `npm`:
29+
30+
```bash
31+
npm install @azure-rest/ai-personalizer
32+
```
33+
34+
### Create and authenticate a `PersonalizerClient`
35+
36+
To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
37+
provide an instance of the desired credential type obtained from the
38+
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
39+
40+
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
41+
42+
After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
43+
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
44+
can be used to authenticate the client.
45+
46+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
47+
AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
48+
49+
## Troubleshooting
50+
51+
### Logging
52+
53+
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
54+
55+
```javascript
56+
import { setLogLevel } from "@azure/logger";
57+
58+
setLogLevel("info");
59+
```
60+
61+
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

‎sdk/personalizer/ai-personalizer-rest/api-extractor.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
"mainEntryPointFilePath": "./types/src/index.d.ts",
4+
"docModel": { "enabled": true },
5+
"apiReport": { "enabled": true, "reportFolder": "./review" },
6+
"dtsRollup": {
7+
"enabled": true,
8+
"untrimmedFilePath": "",
9+
"publicTrimmedFilePath": "./types/ai-personalizer.d.ts"
10+
},
11+
"messages": {
12+
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
13+
"extractorMessageReporting": {
14+
"ae-missing-release-tag": { "logLevel": "none" },
15+
"ae-unresolved-link": { "logLevel": "none" }
16+
}
17+
}
18+
}

0 commit comments

Comments
 (0)