Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[text analytics] default to v3.1-preview.2, have it listed under enum V3_1_PREVIEW #13708

Merged
merged 6 commits into from
Sep 10, 2020
Merged

[text analytics] default to v3.1-preview.2, have it listed under enum V3_1_PREVIEW #13708

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d1764b5
refer to v3.1-preview in docstrings and code
iscai-msft Sep 8, 2020
405f94f
fix tests and re-record for westcentralus
iscai-msft Sep 10, 2020
ed12ef6
regenerate without v3.1-preview.1
iscai-msft Sep 10, 2020
d80abfc
remove v3.1-preview.1 imports in generated code
iscai-msft Sep 10, 2020
0be7709
skip aad tests since not deployed yet to v3.1-preview.2
iscai-msft Sep 10, 2020
a2e5a19
improve changelog based on krista's comment
iscai-msft Sep 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
improve changelog based on krista's comment
  • Loading branch information
@iscai-msft
iscai-msft committed Sep 10, 2020
commit a2e5a19f8cf8abc1dbc0edb5953e455d61c0dd3b
2 changes: 1 addition & 1 deletion sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
**New features**
- We are now targeting the service's v3.1-preview API as the default. If you would like to still use version v3.0 of the service,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could be confusing to the user, especially that you referred to the concrete preview version before in older changelog notes here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's fair, but I think with these two new versions, it's unnecessary to support both, and once the service GAs, we're also only going to support v3.0 and v3.1, so I'm comfortable squashing v3.1-preview.1 and v3.1-preview.2 into one api version

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my comment is not about supporting both but rather about being consistent with the service naming of the endpoints. Otherwise the user would wonder what is v3.1-preview because no such version exist in the service docs.

Copy link
Contributor Author

@iscai-msft iscai-msft Sep 10, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point, @kristapratico and I had discussed this, and I think we both overall prefer exposing it as v3.0 and v3.1-preview instead of v3.1-preivew.2. Since we've never actually done a release on our side targeting the v3.1-preview.1 API, I think it would be weird to come out directly with a v3.1-preview.2, and I think it overall reduces some overhead for the user exposing it as v3.1-preview version instead of specifically v3.1-preview.2 in all of the docstrings. How strongly do you feel about this @deyaaeldeen ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@deyaaeldeen what I meant by overhead was having to explicitly now that this was the second preview version. Since there's no reason for a user to discern between 3.1-preview.1 and 3.1-preview.2, I think it would be cleaner to just combine them as 3.1-preview

pass in `v3.0` to the kwarg `api_version` when creating your TextAnalyticsClient
- We have added an API `recognize_pii_entities` which returns entities containing personal information for a batch of documents. Only available for API version v3.1-preview versions.
- We have added an API `recognize_pii_entities` which returns entities containing personally identifiable information for a batch of documents. Only available for API version v3.1-preview and up.
- Added `offset` and `length` properties for `CategorizedEntity`, `SentenceSentiment`, and `LinkedEntityMatch`. These properties are only available for API versions v3.1-preview and up.
- `length` is the number of characters in the text of these models
- `offset` is the offset of the text from the start of the document
Expand Down