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.

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

[text analytics] add versionadded sphinx documentation #13450

Merged
merged 2 commits into from
Sep 1, 2020
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# coding=utf-8
# coding=utf-8 pylint: disable=too-many-lines
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Expand Down Expand Up @@ -215,6 +215,8 @@ class CategorizedEntity(DictMixin):
:ivar confidence_score: Confidence score between 0 and 1 of the extracted
entity.
:vartype confidence_score: float
.. versionadded:: v3.1-preview.1
The *offset* and *length* properties.
"""

def __init__(self, **kwargs):
Expand Down Expand Up @@ -653,6 +655,8 @@ class LinkedEntityMatch(DictMixin):
:ivar int length: The length of the linked entity match text. Returned
in unicode code points. Only returned for api versions v3.1-preview.1 and up.
:vartype text: str
.. versionadded:: v3.1-preview.1
The *offset* and *length* properties.
"""

def __init__(self, **kwargs):
Expand Down Expand Up @@ -767,9 +771,12 @@ class SentenceSentiment(DictMixin):
:ivar mined_opinions: The list of opinions mined from this sentence.
For example in "The food is good, but the service is bad", we would
mind these two opinions "food is good", "service is bad". Only returned
if `show_opinion_mining` is set to True in the call to `analyze_sentiment`.
if `show_opinion_mining` is set to True in the call to `analyze_sentiment` and
api version is v3.1-preview.1 and up.
:vartype mined_opinions:
list[~azure.ai.textanalytics.MinedOpinion]
.. versionadded:: v3.1-preview.1
The *offset*, *length*, and *mined_opinions* properties.
"""

def __init__(self, **kwargs):
Expand Down