Skip to content

[text analytics] param to ivar in model docstrings #11788

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

Merged
merged 2 commits into from
Jun 3, 2020
Merged

[text analytics] param to ivar in model docstrings #11788

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6dd0d74
param to ivar in model docstrings
iscai-msft Jun 3, 2020
b521f59
type -> vartype
iscai-msft Jun 3, 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
136 changes: 68 additions & 68 deletions sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ class DetectedLanguage(DictMixin):
"""DetectedLanguage contains the predicted language found in text,
its confidence score, and ISO 639-1 representation.

:param name: Long name of a detected language (e.g. English,
:ivar name: Long name of a detected language (e.g. English,
French).
:type name: str
Copy link
Member

Choose a reason for hiding this comment

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

pretty sure :type: needs to be changed to :vartype: too

:param iso6391_name: A two letter representation of the detected
:ivar iso6391_name: A two letter representation of the detected
language according to the ISO 639-1 standard (e.g. en, fr).
:type iso6391_name: str
:param confidence_score: A confidence score between 0 and 1. Scores close
:ivar confidence_score: A confidence score between 0 and 1. Scores close
to 1 indicate 100% certainty that the identified language is true.
:type confidence_score: float
"""
Expand All @@ -94,21 +94,21 @@ class RecognizeEntitiesResult(DictMixin):
"""RecognizeEntitiesResult is a result object which contains
the recognized entities from a particular document.

:param id: Unique, non-empty document identifier that matches the
:ivar id: Unique, non-empty document identifier that matches the
document id that was passed in with the request. If not specified
in the request, an id is assigned for the document.
:type id: str
:param entities: Recognized entities in the document.
:ivar entities: Recognized entities in the document.
:type entities:
list[~azure.ai.textanalytics.CategorizedEntity]
:param warnings: Warnings encountered while processing document. Results will still be returned
:ivar warnings: Warnings encountered while processing document. Results will still be returned
if there are warnings, but they may not be fully accurate.
:type warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning]
:param statistics: If show_stats=true was specified in the request this
:ivar statistics: If show_stats=true was specified in the request this
field will contain information about the document payload.
:type statistics:
~azure.ai.textanalytics.TextDocumentStatistics
:param bool is_error: Boolean check for error item when iterating over list of
:ivar bool is_error: Boolean check for error item when iterating over list of
results. Always False for an instance of a RecognizeEntitiesResult.
"""

Expand All @@ -128,20 +128,20 @@ class DetectLanguageResult(DictMixin):
"""DetectLanguageResult is a result object which contains
the detected language of a particular document.

:param id: Unique, non-empty document identifier that matches the
:ivar id: Unique, non-empty document identifier that matches the
document id that was passed in with the request. If not specified
in the request, an id is assigned for the document.
:type id: str
:param primary_language: The primary language detected in the document.
:ivar primary_language: The primary language detected in the document.
:type primary_language: ~azure.ai.textanalytics.DetectedLanguage
:param warnings: Warnings encountered while processing document. Results will still be returned
:ivar warnings: Warnings encountered while processing document. Results will still be returned
if there are warnings, but they may not be fully accurate.
:type warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning]
:param statistics: If show_stats=true was specified in the request this
:ivar statistics: If show_stats=true was specified in the request this
field will contain information about the document payload.
:type statistics:
~azure.ai.textanalytics.TextDocumentStatistics
:param bool is_error: Boolean check for error item when iterating over list of
:ivar bool is_error: Boolean check for error item when iterating over list of
results. Always False for an instance of a DetectLanguageResult.
"""

Expand All @@ -162,13 +162,13 @@ class CategorizedEntity(DictMixin):
"""CategorizedEntity contains information about a particular
entity found in text.

:param text: Entity text as appears in the request.
:ivar text: Entity text as appears in the request.
:type text: str
:param category: Entity category, such as Person/Location/Org/SSN etc
:ivar category: Entity category, such as Person/Location/Org/SSN etc
:type category: str
:param subcategory: Entity subcategory, such as Age/Year/TimeRange etc
:ivar subcategory: Entity subcategory, such as Age/Year/TimeRange etc
:type subcategory: str
:param confidence_score: Confidence score between 0 and 1 of the extracted
:ivar confidence_score: Confidence score between 0 and 1 of the extracted
entity.
:type confidence_score: float
"""
Expand Down Expand Up @@ -199,15 +199,15 @@ class TextAnalyticsError(DictMixin):
other details that explain why the batch or individual document
failed to be processed by the service.

:param code: Error code. Possible values include:
:ivar code: Error code. Possible values include:
'invalidRequest', 'invalidArgument', 'internalServerError',
'serviceUnavailable', 'invalidParameterValue', 'invalidRequestBodyFormat',
'emptyRequest', 'missingInputRecords', 'invalidDocument', 'modelVersionIncorrect',
'invalidDocumentBatch', 'unsupportedLanguageCode', 'invalidCountryHint'
:type code: str
:param message: Error message.
:ivar message: Error message.
:type message: str
:param target: Error target.
:ivar target: Error target.
:type target: str
"""

Expand Down Expand Up @@ -238,10 +238,10 @@ class TextAnalyticsWarning(DictMixin):
"""TextAnalyticsWarning contains the warning code and message that explains why
the response has a warning.

:param code: Warning code. Possible values include: 'LongWordsInDocument',
:ivar code: Warning code. Possible values include: 'LongWordsInDocument',
'DocumentTruncated'.
:type code: str
:param message: Warning message.
:ivar message: Warning message.
:type message: str
"""

Expand All @@ -265,22 +265,22 @@ class ExtractKeyPhrasesResult(DictMixin):
"""ExtractKeyPhrasesResult is a result object which contains
the key phrases found in a particular document.

:param id: Unique, non-empty document identifier that matches the
:ivar id: Unique, non-empty document identifier that matches the
document id that was passed in with the request. If not specified
in the request, an id is assigned for the document.
:type id: str
:param key_phrases: A list of representative words or phrases.
:ivar key_phrases: A list of representative words or phrases.
The number of key phrases returned is proportional to the number of words
in the input document.
:type key_phrases: list[str]
:param warnings: Warnings encountered while processing document. Results will still be returned
:ivar warnings: Warnings encountered while processing document. Results will still be returned
if there are warnings, but they may not be fully accurate.
:type warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning]
:param statistics: If show_stats=true was specified in the request this
:ivar statistics: If show_stats=true was specified in the request this
field will contain information about the document payload.
:type statistics:
~azure.ai.textanalytics.TextDocumentStatistics
:param bool is_error: Boolean check for error item when iterating over list of
:ivar bool is_error: Boolean check for error item when iterating over list of
results. Always False for an instance of a ExtractKeyPhrasesResult.
"""

Expand All @@ -300,21 +300,21 @@ class RecognizeLinkedEntitiesResult(DictMixin):
"""RecognizeLinkedEntitiesResult is a result object which contains
links to a well-known knowledge base, like for example, Wikipedia or Bing.

:param id: Unique, non-empty document identifier that matches the
:ivar id: Unique, non-empty document identifier that matches the
document id that was passed in with the request. If not specified
in the request, an id is assigned for the document.
:type id: str
:param entities: Recognized well-known entities in the document.
:ivar entities: Recognized well-known entities in the document.
:type entities:
list[~azure.ai.textanalytics.LinkedEntity]
:param warnings: Warnings encountered while processing document. Results will still be returned
:ivar warnings: Warnings encountered while processing document. Results will still be returned
if there are warnings, but they may not be fully accurate.
:type warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning]
:param statistics: If show_stats=true was specified in the request this
:ivar statistics: If show_stats=true was specified in the request this
field will contain information about the document payload.
:type statistics:
~azure.ai.textanalytics.TextDocumentStatistics
:param bool is_error: Boolean check for error item when iterating over list of
:ivar bool is_error: Boolean check for error item when iterating over list of
results. Always False for an instance of a RecognizeLinkedEntitiesResult.
"""

Expand All @@ -335,29 +335,29 @@ class AnalyzeSentimentResult(DictMixin):
the overall predicted sentiment and confidence scores for your document
and a per-sentence sentiment prediction with scores.

:param id: Unique, non-empty document identifier that matches the
:ivar id: Unique, non-empty document identifier that matches the
document id that was passed in with the request. If not specified
in the request, an id is assigned for the document.
:type id: str
:param sentiment: Predicted sentiment for document (Negative,
:ivar sentiment: Predicted sentiment for document (Negative,
Neutral, Positive, or Mixed). Possible values include: 'positive',
'neutral', 'negative', 'mixed'
:type sentiment: str
:param warnings: Warnings encountered while processing document. Results will still be returned
:ivar warnings: Warnings encountered while processing document. Results will still be returned
if there are warnings, but they may not be fully accurate.
:type warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning]
:param statistics: If show_stats=true was specified in the request this
:ivar statistics: If show_stats=true was specified in the request this
field will contain information about the document payload.
:type statistics:
~azure.ai.textanalytics.TextDocumentStatistics
:param confidence_scores: Document level sentiment confidence
:ivar confidence_scores: Document level sentiment confidence
scores between 0 and 1 for each sentiment label.
:type confidence_scores:
~azure.ai.textanalytics.SentimentConfidenceScores
:param sentences: Sentence level sentiment analysis.
:ivar sentences: Sentence level sentiment analysis.
:type sentences:
list[~azure.ai.textanalytics.SentenceSentiment]
:param bool is_error: Boolean check for error item when iterating over list of
:ivar bool is_error: Boolean check for error item when iterating over list of
results. Always False for an instance of a AnalyzeSentimentResult.
"""

Expand All @@ -381,10 +381,10 @@ class TextDocumentStatistics(DictMixin):
"""TextDocumentStatistics contains information about
the document payload.

:param character_count: Number of text elements recognized in
:ivar character_count: Number of text elements recognized in
the document.
:type character_count: int
:param transaction_count: Number of transactions for the
:ivar transaction_count: Number of transactions for the
document.
:type transaction_count: int
"""
Expand All @@ -411,13 +411,13 @@ class DocumentError(DictMixin):
"""DocumentError is an error object which represents an error on
the individual document.

:param id: Unique, non-empty document identifier that matches the
:ivar id: Unique, non-empty document identifier that matches the
document id that was passed in with the request. If not specified
in the request, an id is assigned for the document.
:type id: str
:param error: The document error.
:ivar error: The document error.
:type error: ~azure.ai.textanalytics.TextAnalyticsError
:param bool is_error: Boolean check for error item when iterating over list of
:ivar bool is_error: Boolean check for error item when iterating over list of
results. Always True for an instance of a DocumentError.
"""

Expand Down Expand Up @@ -458,11 +458,11 @@ def __repr__(self):
class DetectLanguageInput(LanguageInput):
"""The input document to be analyzed for detecting language.

:param id: Required. Unique, non-empty document identifier.
:ivar id: Required. Unique, non-empty document identifier.
:type id: str
:param text: Required. The input text to process.
:ivar text: Required. The input text to process.
:type text: str
:param country_hint: A country hint to help better detect
:ivar country_hint: A country hint to help better detect
the language of the text. Accepts two letter country codes
specified by ISO 3166-1 alpha-2. Defaults to "US". Pass
in the string "none" to not use a country_hint.
Expand All @@ -486,19 +486,19 @@ class LinkedEntity(DictMixin):
or Bing. It additionally includes all of the matches of this
entity found in the document.

:param name: Entity Linking formal name.
:ivar name: Entity Linking formal name.
:type name: str
:param matches: List of instances this entity appears in the text.
:ivar matches: List of instances this entity appears in the text.
:type matches:
list[~azure.ai.textanalytics.LinkedEntityMatch]
:param language: Language used in the data source.
:ivar language: Language used in the data source.
:type language: str
:param data_source_entity_id: Unique identifier of the recognized entity from the data
:ivar data_source_entity_id: Unique identifier of the recognized entity from the data
source.
:type data_source_entity_id: str
:param url: URL to the entity's page from the data source.
:ivar url: URL to the entity's page from the data source.
:type url: str
:param data_source: Data source used to extract entity linking,
:ivar data_source: Data source used to extract entity linking,
such as Wiki/Bing etc.
:type data_source: str
"""
Expand Down Expand Up @@ -533,11 +533,11 @@ class LinkedEntityMatch(DictMixin):
the confidence score of the prediction and where the entity
was found in the text.

:param confidence_score: If a well-known item is recognized, a
:ivar confidence_score: If a well-known item is recognized, a
decimal number denoting the confidence level between 0 and 1 will be
returned.
:type confidence_score: float
:param text: Entity text as appears in the request.
:ivar text: Entity text as appears in the request.
:type text: str
"""

Expand All @@ -561,11 +561,11 @@ def __repr__(self):
class TextDocumentInput(MultiLanguageInput):
"""The input document to be analyzed by the service.

:param id: Required. A unique, non-empty document identifier.
:ivar id: Required. A unique, non-empty document identifier.
:type id: str
:param text: Required. The input text to process.
:ivar text: Required. The input text to process.
:type text: str
:param language: This is the 2 letter ISO 639-1 representation
:ivar language: This is the 2 letter ISO 639-1 representation
of a language. For example, use "en" for English; "es" for Spanish etc. If
not set, uses "en" for English as default.
:type language: str
Expand All @@ -587,15 +587,15 @@ class TextDocumentBatchStatistics(DictMixin):
request payload. Note: This object is not returned
in the response and needs to be retrieved by a response hook.

:param document_count: Number of documents submitted in the request.
:ivar document_count: Number of documents submitted in the request.
:type document_count: int
:param valid_document_count: Number of valid documents. This
:ivar valid_document_count: Number of valid documents. This
excludes empty, over-size limit or non-supported languages documents.
:type valid_document_count: int
:param erroneous_document_count: Number of invalid documents.
:ivar erroneous_document_count: Number of invalid documents.
This includes empty, over-size limit or non-supported languages documents.
:type erroneous_document_count: int
:param transaction_count: Number of transactions for the request.
:ivar transaction_count: Number of transactions for the request.
:type transaction_count: long
"""

Expand Down Expand Up @@ -626,12 +626,12 @@ class SentenceSentiment(DictMixin):
"""SentenceSentiment contains the predicted sentiment and
confidence scores for each individual sentence in the document.

:param text: The sentence text.
:ivar text: The sentence text.
:type text: str
:param sentiment: The predicted Sentiment for the sentence.
:ivar sentiment: The predicted Sentiment for the sentence.
Possible values include: 'positive', 'neutral', 'negative'
:type sentiment: str
:param confidence_scores: The sentiment confidence score between 0
:ivar confidence_scores: The sentiment confidence score between 0
and 1 for the sentence for all labels.
:type confidence_scores:
~azure.ai.textanalytics.SentimentConfidenceScores
Expand Down Expand Up @@ -662,11 +662,11 @@ class SentimentConfidenceScores(DictMixin):
"""The confidence scores (Softmax scores) between 0 and 1.
Higher values indicate higher confidence.

:param positive: Positive score.
:ivar positive: Positive score.
:type positive: float
:param neutral: Neutral score.
:ivar neutral: Neutral score.
:type neutral: float
:param negative: Negative score.
:ivar negative: Negative score.
:type negative: float
"""

Expand Down