Setting up Python SDK for Personalizer #26296

sharathmalladi · 2022-09-19T17:10:52Z

Description

Python SDK for Azure Cognitive Services Personalizer.
Swagger link: TBD

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

check-enforcer · 2022-09-19T17:21:01Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run python - [service] - ci

…zure-sdk-for-python into personalizersdk

eng/tox/tox.ini

sdk/personalizer/azure-ai-personalizer/CHANGELOG.md

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/_patch.py

sdk/personalizer/azure-ai-personalizer/tests/test_configuration.py

sdk/personalizer/azure-ai-personalizer/tests/test_configuration_async.py

sdk/personalizer/ci.yml

Added @pytest.mark.asyncio decorator for async tests.

…into personalizersdk

kristapratico

Once the tests.yml is moved up a directory, we can run /azp run prepare-pipelines to create the CI pipeline for your library.

kristapratico · 2022-10-07T00:45:26Z

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/_patch.py

+            authentication_policy=kwargs.pop("authentication_policy", _authentication_policy(credential, **kwargs)),
+            **kwargs
+        )
+        self._default_language = kwargs.pop("default_language", None)


default_language is specific to the question answering client library, you can remove it. #Resolved

kristapratico · 2022-10-07T00:47:54Z

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/aio/_patch.py

+from azure.core.pipeline.policies import AzureKeyCredentialPolicy, AsyncBearerTokenCredentialPolicy
+from ._client import PersonalizerClient as PersonalizerClientGenerated
+
+__all__: List[str] = []  # Add all objects you want publicly available to users at this package level


this looks like a duplicate, it's defined on L83 #Resolved

Fixed. Thanks!

kristapratico · 2022-10-07T00:57:54Z

...ure-ai-personalizer/samples/async_samples/multi_slot_rank_actions_and_reward_events_async.py

+DESCRIPTION:
+    This sample demos sending a rank and reward call to personalizer for multi-slot configuration.
+USAGE: python multi_slot_rank_actions_and_reward_events_async.py
+"""


We should describe the environment variables needed to run this sample under the comment header. #Resolved

kristapratico · 2022-10-07T01:06:16Z

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/operations/_operations.py

+        return cast(Iterator[bytes], deserialized)
+
+    @distributed_trace
+    def import_method(self, body: IO, **kwargs: Any) -> None:  # pylint: disable=inconsistent-return-statements


import is a keyword in Python so it looks like the generator is appending "method" to the method name. I missed this on the first review but we should probably give this a better name. Can you rename it through the swagger transform? Should look something like:

directive: - rename-operation: from: Model_Import to: Model_ImportModel

This will rename it to import_model (or whatever it should be named) #Resolved

Thanks for the suggestion. Fixed.

kristapratico · 2022-10-07T01:08:33Z

sdk/personalizer/azure-ai-personalizer/tests.yml

+      ServiceDirectory: personalizer
+      MatrixReplace:
+        - TestSamples=.*/true
+      Clouds: Canary


I don't think we need to run tests in Canary (it doesn't look like we do in the other languages).

Suggested change

Clouds: Canary

kristapratico · 2022-10-07T01:09:26Z

sdk/personalizer/azure-ai-personalizer/tests.yml

@@ -0,0 +1,18 @@
+trigger: none


This file should be up one level: sdk/personalizer/tests.yml #Resolved

sharathmalladi · 2022-10-07T22:14:54Z

/azp run prepare-pipelines

azure-pipelines · 2022-10-07T22:15:03Z

Azure Pipelines successfully started running 1 pipeline(s).

sharathmalladi · 2022-10-07T22:15:41Z

Added the comment in github pr.

In reply to: 1133773653

azure-sdk · 2022-10-07T22:55:42Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-ai-personalizer

sharathmalladi · 2022-10-09T06:30:35Z

All comments have been addressed. This PR is being replaced with a different PR: #26719

sharathmalladi · 2022-10-10T20:18:54Z

Abandoning this PR as it had some leaked apikeys (the keys were rotated and so the risk is mitigated). This PR is superceded by this one: #26719

Release sql microsoft.sql 2023 05 01 preview (Azure#26289) * Adds base for updating Microsoft.Sql from version preview/2023-02-01-preview to version 2023-05-01-preview * Updates readme * Updates API version in new specs and examples * Adding JobPrivateEndpoints API to version 2023-05-01-preview (Azure#24902) * Adds base for updating Microsoft.Sql from version preview/2022-11-01-preview to version 2023-02-01-preview * Updates readme * Updates API version in new specs and examples * add mi refresh API (Azure#24093) * add mi refresh API * remove stray character * add examples * fix lro error * fix lro error only in example * fixing prettier issue * Test commit - adding error schema * Test2 * Test - changing error type * Revert "Test - changing error type" This reverts commit 84fff94ea9cefca5312d2f5c12e099f315e0c064. * Reverting 3 test commits * Test - adding commong error type reference * fix type format errors --------- Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com> * Adding changes from main to release branch. PRs 24175 and 24185 (Azure#24221) * Enable multiple partner servers and failover of read-only endpoint for SQL DB Failover Group in version 2023-02-01-preview. (Azure#24132) * Added the swagger spec and example json files for failvoer group API update in V2023-020-1 * Corrected the FailoverGroupGet.json example * Updated the auto-generated FailoverGroups.json Fixed FailoverGroups.json swagger arm-id attribute for databases field * Added the missing headers field manually * Fix FailoverGroups.json --------- Co-authored-by: Sharan Singh <sharanlobana@gmail.com> * Changes to Location Capabilities (Azure#24209) * Loc cap changes * removing changes not related to my changes in dsmain * DAG API 2023-02-01 (Azure#24108) * add new dag api version * Update swagger * Update swagger * patch resource * make replicationMode writable * Add FreeLimitExhaustion Capability in 2023-02-01-preview API (Azure#24224) * Add FreeLimitExhaustion Capability in 2023-02-01-preview API * Change property from name to exhaustionBehaviorType * generate swagger for LocationCapabilites (Azure#24290) * inital commit for LTR Policy Immutability (Azure#24347) * inital commit for immutable ltr backups (Azure#24349) * Update Servers swagger files with adding property "IsIPv6Enabled" (Azure#24305) * Update swagger files for Server API * Add v5 tag for Servers * Restore none for minimal TLS version * Add auto rotation param to databases api (Azure#24339) * Add auto rotation param to databases api * add armid * Adding IsFreemium and CreateTime to Get MI API (Azure#24239) * job private endpoint swagger * rerun pipelines * adding job private endpoints to readme * rerun pipelines * trying to fix lint errors * fixing typos - singular resource name and description. * adding arm-id * Moving files to the new version; no changes to the files themselves. * adding job agent private endpoints to readme --------- Co-authored-by: Jeremy Frosti <111934615+jeremyfrosti@users.noreply.github.com> Co-authored-by: guptanitish-ms <68623376+guptanitish-ms@users.noreply.github.com> Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com> Co-authored-by: lobashh <56324552+lobashh@users.noreply.github.com> Co-authored-by: Sharan Singh <sharanlobana@gmail.com> Co-authored-by: Aleksand4rZivanovic <60347245+Aleksand4rZivanovic@users.noreply.github.com> Co-authored-by: a-lazarlazic <106240189+a-lazarlazic@users.noreply.github.com> Co-authored-by: mykolian <34487118+mykolian@users.noreply.github.com> Co-authored-by: Srna Nikolic <133877309+srnanikolicmdcs@users.noreply.github.com> Co-authored-by: rebeccaxu-ms <104461363+rebeccaxu-ms@users.noreply.github.com> Co-authored-by: LeiWang3 <84884417+LeiWang3@users.noreply.github.com> Co-authored-by: viparek <78561564+viparek@users.noreply.github.com> Co-authored-by: Nikola Mirkovic <135128634+nmirkovic-microsoft@users.noreply.github.com> * DAG API 2023-05-01 for MI First (Azure#25638) * mi first dag api 2023-05-01 * adding x-ms-identifiers * adding job step and target group apis to version 2023-05-01-preview (Azure#25689) * adding job step and target group apis to versoin 2023-05-01-preview * remove required credential --------- Co-authored-by: Ray Boyd <rayboyd@microsoft.com> * updating location capabilities for 2023-05-01-preview (Azure#25539) Co-authored-by: Ray Boyd <rayboyd@microsoft.com> * Updating Instance Pool swagger for 2023-05-01-preview (Azure#25580) * Updating Instance Pool swagger for 2023-05-01-preview * Add format specification * Update examples --------- Co-authored-by: Kosta Bizetic <bizetickosta@microsoft.com> Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com> * Add Archive option to LTR Policy and LTR Backup for SQL DB (Azure#25799) * added changes * fix swagger validation failures * adding fixes * added more changes * added fixes * fixed LintDiff * added changes * fix lintDiff * Swagger validations for serverless parameters added in SQL API (Azure#25852) * Swagger validations for serverless parameters added in SQL API * Fixing spellcheck in example file * Fix LintDiff error --------- Co-authored-by: Yash Udasi <yudasi@microsoft.com> * Add AAD support to job agents version 2023-05-01-preview (Azure#25553) * adding job agent identity support to 2023-05-01-preview * updated swagger with just aad changes --------- Co-authored-by: Ray Boyd <rayboyd@microsoft.com> * Dev/sonjac/ltr api update (Azure#25701) * Adding generated files. * Fixing swagger errors. * Managed Instance swagger to support Authentication Metadata (Azure#25795) * generated swagger * fixed prettier: * fixed minor stuff * swagger fixes * added missing example file * removed unused file * externalgovernance fixes * minor fixes * missing character * Adding JobAgents API with SKU support to version 2023-05-01-preview (Azure#24995) * Adds base for updating Microsoft.Sql from version preview/2022-11-01-preview to version 2023-02-01-preview * Updates readme * Updates API version in new specs and examples * add mi refresh API (Azure#24093) * add mi refresh API * remove stray character * add examples * fix lro error * fix lro error only in example * fixing prettier issue * Test commit - adding error schema * Test2 * Test - changing error type * Revert "Test - changing error type" This reverts commit 84fff94ea9cefca5312d2f5c12e099f315e0c064. * Reverting 3 test commits * Test - adding commong error type reference * fix type format errors --------- Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com> * Adding changes from main to release branch. PRs 24175 and 24185 (Azure#24221) * Enable multiple partner servers and failover of read-only endpoint for SQL DB Failover Group in version 2023-02-01-preview. (Azure#24132) * Added the swagger spec and example json files for failvoer group API update in V2023-020-1 * Corrected the FailoverGroupGet.json example * Updated the auto-generated FailoverGroups.json Fixed FailoverGroups.json swagger arm-id attribute for databases field * Added the missing headers field manually * Fix FailoverGroups.json --------- Co-authored-by: Sharan Singh <sharanlobana@gmail.com> * Changes to Location Capabilities (Azure#24209) * Loc cap changes * removing changes not related to my changes in dsmain * DAG API 2023-02-01 (Azure#24108) * add new dag api version * Update swagger * Update swagger * patch resource * make replicationMode writable * Add FreeLimitExhaustion Capability in 2023-02-01-preview API (Azure#24224) * Add FreeLimitExhaustion Capability in 2023-02-01-preview API * Change property from name to exhaustionBehaviorType * generate swagger for LocationCapabilites (Azure#24290) * inital commit for LTR Policy Immutability (Azure#24347) * inital commit for immutable ltr backups (Azure#24349) * Update Servers swagger files with adding property "IsIPv6Enabled" (Azure#24305) * Update swagger files for Server API * Add v5 tag for Servers * Restore none for minimal TLS version * Add auto rotation param to databases api (Azure#24339) * Add auto rotation param to databases api * add armid * Adding IsFreemium and CreateTime to Get MI API (Azure#24239) * Updated the examples for LTR Policies and LTR Backups (Azure#24821) * Updated the examples for LTR Policies and LTR Backups * Not sure why makeBackupsImmutable got deleted * swagger changes * api version changed * adding identity files to the version on review * change of getjobagent * change test * nit fix * Changes to use SKU name to specify SLO * Changes for job agent update SLO with 2023-05-01 version * removing files of 2023-02-01 * fix * removing changes on JobAgents 2023-02-01 --------- Co-authored-by: Jeremy Frosti <111934615+jeremyfrosti@users.noreply.github.com> Co-authored-by: guptanitish-ms <68623376+guptanitish-ms@users.noreply.github.com> Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com> Co-authored-by: lobashh <56324552+lobashh@users.noreply.github.com> Co-authored-by: Sharan Singh <sharanlobana@gmail.com> Co-authored-by: Aleksand4rZivanovic <60347245+Aleksand4rZivanovic@users.noreply.github.com> Co-authored-by: a-lazarlazic <106240189+a-lazarlazic@users.noreply.github.com> Co-authored-by: mykolian <34487118+mykolian@users.noreply.github.com> Co-authored-by: Srna Nikolic <133877309+srnanikolicmdcs@users.noreply.github.com> Co-authored-by: rebeccaxu-ms <104461363+rebeccaxu-ms@users.noreply.github.com> Co-authored-by: LeiWang3 <84884417+LeiWang3@users.noreply.github.com> Co-authored-by: viparek <78561564+viparek@users.noreply.github.com> Co-authored-by: Nikola Mirkovic <135128634+nmirkovic-microsoft@users.noreply.github.com> * added swagger spec and example json files for failovergroup api (Azure#25837) * Updating Managed Instance swagger for 2023-05-01-preview (Azure#26098) * Modifying ManagedInstances.json and corresponding examples * Remove example * Fix syntax errors * Swagger API changes to support PUT and PATCH to update replication link type (Azure#25690) * Add Swagger files for Replication Link Update Link Type * resolve validation error * Modify property description * resolve lint errors * Reverting MI change for readme to fix merge conflict with main (Azure#26296) --------- Co-authored-by: jacobopac <104868942+jacobopac@users.noreply.github.com> Co-authored-by: guptanitish-ms <68623376+guptanitish-ms@users.noreply.github.com> Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com> Co-authored-by: lobashh <56324552+lobashh@users.noreply.github.com> Co-authored-by: Sharan Singh <sharanlobana@gmail.com> Co-authored-by: Aleksand4rZivanovic <60347245+Aleksand4rZivanovic@users.noreply.github.com> Co-authored-by: a-lazarlazic <106240189+a-lazarlazic@users.noreply.github.com> Co-authored-by: mykolian <34487118+mykolian@users.noreply.github.com> Co-authored-by: Srna Nikolic <133877309+srnanikolicmdcs@users.noreply.github.com> Co-authored-by: rebeccaxu-ms <104461363+rebeccaxu-ms@users.noreply.github.com> Co-authored-by: LeiWang3 <84884417+LeiWang3@users.noreply.github.com> Co-authored-by: viparek <78561564+viparek@users.noreply.github.com> Co-authored-by: Nikola Mirkovic <135128634+nmirkovic-microsoft@users.noreply.github.com> Co-authored-by: ms-mjovkovic <140057686+ms-mjovkovic@users.noreply.github.com> Co-authored-by: Ray Boyd <rayboyd30@gmail.com> Co-authored-by: Ray Boyd <rayboyd@microsoft.com> Co-authored-by: Kosta Bizetić <kosta.bizetic@gmail.com> Co-authored-by: Kosta Bizetic <bizetickosta@microsoft.com> Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com> Co-authored-by: CelinaJiangJXY <124339390+CelinaJiangJXY@users.noreply.github.com> Co-authored-by: Yash Udasi <36713809+Yashu1818@users.noreply.github.com> Co-authored-by: Yash Udasi <yudasi@microsoft.com> Co-authored-by: Sonja Ciric <78421408+sonjaciric@users.noreply.github.com> Co-authored-by: Nebojsa Savic <112883615+nesavicMSFT@users.noreply.github.com> Co-authored-by: alejandro182 <140119874+alejandro182@users.noreply.github.com> Co-authored-by: saljain0101 <145347114+saljain0101@users.noreply.github.com> Co-authored-by: Marko Milovanovic <147002062+mmilovanovic95@users.noreply.github.com> Co-authored-by: Archana Sahoo <109509626+archanasahoo22@users.noreply.github.com>

Setting up Python SDK for Personalizer

18bd3df

sharathmalladi and others added 7 commits September 22, 2022 16:55

Adding tests.

e0f8959

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-python

45c67c8

Merge branch 'main' into personalizersdk

7eabbd3

packaging updates for file inclusion

4e1d02e

Merge branch 'personalizersdk' of https://github.com/sharathmalladi/a…

1e090f8

…zure-sdk-for-python into personalizersdk

Fix lint errors.

adda7a6

Add async tests and samples.

06c50d2

sharathmalladi marked this pull request as ready for review September 27, 2022 00:30

sharathmalladi requested review from scbedd, benbp, weshaggard and lmazuel as code owners September 27, 2022 00:30

kristapratico self-requested a review September 27, 2022 00:37

kristapratico reviewed Sep 27, 2022

View reviewed changes

sharathmalladi added 6 commits September 27, 2022 14:26

Addressing feedback:

e52c7bf

Added @pytest.mark.asyncio decorator for async tests.

Added test recordings.

cdadb20

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-python …

9e06ac2

…into personalizersdk

Added support for AAD authentication

1e549d4

Fixing tox errors.

c01123d

Addressing feedback. Update tests to use test proxy.

c929c2a

kristapratico reviewed Oct 7, 2022

View reviewed changes

Addressed more feedback comments.

ef96d81

sharathmalladi force-pushed the personalizersdk branch from 692b9c0 to ef96d81 Compare October 7, 2022 22:14

Merge branch 'main' into personalizersdk

4859d6d

sharathmalladi force-pushed the personalizersdk branch from d4df8e0 to 4859d6d Compare October 7, 2022 22:38

Fix spell check errors

95b2efd

sharathmalladi closed this Oct 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setting up Python SDK for Personalizer #26296

Setting up Python SDK for Personalizer #26296

sharathmalladi commented Sep 19, 2022

check-enforcer bot commented Sep 19, 2022

kristapratico left a comment

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

sharathmalladi Oct 7, 2022

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

sharathmalladi Oct 7, 2022

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

sharathmalladi Oct 7, 2022

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

sharathmalladi Oct 7, 2022

kristapratico Oct 7, 2022

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

sharathmalladi Oct 7, 2022

sharathmalladi commented Oct 7, 2022

azure-pipelines bot commented Oct 7, 2022

sharathmalladi commented Oct 7, 2022

azure-sdk commented Oct 7, 2022

sharathmalladi commented Oct 9, 2022

sharathmalladi commented Oct 10, 2022

Setting up Python SDK for Personalizer #26296

Setting up Python SDK for Personalizer #26296

Conversation

sharathmalladi commented Sep 19, 2022

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Testing Guidelines

check-enforcer bot commented Sep 19, 2022

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

kristapratico left a comment

Choose a reason for hiding this comment

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading

Choose a reason for hiding this comment

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading

Choose a reason for hiding this comment

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading

Choose a reason for hiding this comment

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading

Choose a reason for hiding this comment

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

kristapratico Oct 7, 2022

Choose a reason for hiding this comment

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading

Choose a reason for hiding this comment

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

sharathmalladi commented Oct 7, 2022

azure-pipelines bot commented Oct 7, 2022

sharathmalladi commented Oct 7, 2022

azure-sdk commented Oct 7, 2022

sharathmalladi commented Oct 9, 2022

sharathmalladi commented Oct 10, 2022

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading