Skip to content

Commit

Permalink
[text analytics] add versionadded sphinx documentation (#13450)
Browse files Browse the repository at this point in the history
  • Loading branch information
iscai-msft authored Sep 1, 2020
1 parent 9b1b9ec commit 537dd08
Showing 1 changed file with 8 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,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 @@ -673,6 +675,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 @@ -787,9 +791,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

0 comments on commit 537dd08

Please sign in to comment.