From 6dd0d74f339afffb40a30cde14e9c4591c17a724 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Wed, 3 Jun 2020 15:01:39 -0400 Subject: [PATCH 1/2] param to ivar in model docstrings --- .../azure/ai/textanalytics/_models.py | 136 +++++++++--------- 1 file changed, 68 insertions(+), 68 deletions(-) diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py index 692178449da8..945a02c0a997 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py @@ -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 - :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 """ @@ -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. """ @@ -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. """ @@ -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 """ @@ -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 """ @@ -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 """ @@ -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. """ @@ -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. """ @@ -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. """ @@ -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 """ @@ -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. """ @@ -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. @@ -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 """ @@ -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 """ @@ -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 @@ -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 """ @@ -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 @@ -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 """ From b521f59a7faea6d26e31d311c8e0ed2e1694c7b5 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Wed, 3 Jun 2020 15:05:28 -0400 Subject: [PATCH 2/2] type -> vartype --- .../azure/ai/textanalytics/_models.py | 124 +++++++++--------- 1 file changed, 62 insertions(+), 62 deletions(-) diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py index 945a02c0a997..1b1bf19b29b8 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py @@ -65,13 +65,13 @@ class DetectedLanguage(DictMixin): :ivar name: Long name of a detected language (e.g. English, French). - :type name: str + :vartype name: str :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 + :vartype iso6391_name: str :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 + :vartype confidence_score: float """ def __init__(self, **kwargs): @@ -97,16 +97,16 @@ class RecognizeEntitiesResult(DictMixin): :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 + :vartype id: str :ivar entities: Recognized entities in the document. - :type entities: + :vartype entities: list[~azure.ai.textanalytics.CategorizedEntity] :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] + :vartype warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning] :ivar statistics: If show_stats=true was specified in the request this field will contain information about the document payload. - :type statistics: + :vartype statistics: ~azure.ai.textanalytics.TextDocumentStatistics :ivar bool is_error: Boolean check for error item when iterating over list of results. Always False for an instance of a RecognizeEntitiesResult. @@ -131,15 +131,15 @@ class DetectLanguageResult(DictMixin): :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 + :vartype id: str :ivar primary_language: The primary language detected in the document. - :type primary_language: ~azure.ai.textanalytics.DetectedLanguage + :vartype primary_language: ~azure.ai.textanalytics.DetectedLanguage :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] + :vartype warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning] :ivar statistics: If show_stats=true was specified in the request this field will contain information about the document payload. - :type statistics: + :vartype statistics: ~azure.ai.textanalytics.TextDocumentStatistics :ivar bool is_error: Boolean check for error item when iterating over list of results. Always False for an instance of a DetectLanguageResult. @@ -163,14 +163,14 @@ class CategorizedEntity(DictMixin): entity found in text. :ivar text: Entity text as appears in the request. - :type text: str + :vartype text: str :ivar category: Entity category, such as Person/Location/Org/SSN etc - :type category: str + :vartype category: str :ivar subcategory: Entity subcategory, such as Age/Year/TimeRange etc - :type subcategory: str + :vartype subcategory: str :ivar confidence_score: Confidence score between 0 and 1 of the extracted entity. - :type confidence_score: float + :vartype confidence_score: float """ def __init__(self, **kwargs): @@ -204,11 +204,11 @@ class TextAnalyticsError(DictMixin): 'serviceUnavailable', 'invalidParameterValue', 'invalidRequestBodyFormat', 'emptyRequest', 'missingInputRecords', 'invalidDocument', 'modelVersionIncorrect', 'invalidDocumentBatch', 'unsupportedLanguageCode', 'invalidCountryHint' - :type code: str + :vartype code: str :ivar message: Error message. - :type message: str + :vartype message: str :ivar target: Error target. - :type target: str + :vartype target: str """ def __init__(self, **kwargs): @@ -240,9 +240,9 @@ class TextAnalyticsWarning(DictMixin): :ivar code: Warning code. Possible values include: 'LongWordsInDocument', 'DocumentTruncated'. - :type code: str + :vartype code: str :ivar message: Warning message. - :type message: str + :vartype message: str """ def __init__(self, **kwargs): @@ -268,17 +268,17 @@ class ExtractKeyPhrasesResult(DictMixin): :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 + :vartype id: str :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] + :vartype key_phrases: list[str] :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] + :vartype warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning] :ivar statistics: If show_stats=true was specified in the request this field will contain information about the document payload. - :type statistics: + :vartype statistics: ~azure.ai.textanalytics.TextDocumentStatistics :ivar bool is_error: Boolean check for error item when iterating over list of results. Always False for an instance of a ExtractKeyPhrasesResult. @@ -303,16 +303,16 @@ class RecognizeLinkedEntitiesResult(DictMixin): :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 + :vartype id: str :ivar entities: Recognized well-known entities in the document. - :type entities: + :vartype entities: list[~azure.ai.textanalytics.LinkedEntity] :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] + :vartype warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning] :ivar statistics: If show_stats=true was specified in the request this field will contain information about the document payload. - :type statistics: + :vartype statistics: ~azure.ai.textanalytics.TextDocumentStatistics :ivar bool is_error: Boolean check for error item when iterating over list of results. Always False for an instance of a RecognizeLinkedEntitiesResult. @@ -338,24 +338,24 @@ class AnalyzeSentimentResult(DictMixin): :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 + :vartype id: str :ivar sentiment: Predicted sentiment for document (Negative, Neutral, Positive, or Mixed). Possible values include: 'positive', 'neutral', 'negative', 'mixed' - :type sentiment: str + :vartype sentiment: str :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] + :vartype warnings: list[~azure.ai.textanalytics.TextAnalyticsWarning] :ivar statistics: If show_stats=true was specified in the request this field will contain information about the document payload. - :type statistics: + :vartype statistics: ~azure.ai.textanalytics.TextDocumentStatistics :ivar confidence_scores: Document level sentiment confidence scores between 0 and 1 for each sentiment label. - :type confidence_scores: + :vartype confidence_scores: ~azure.ai.textanalytics.SentimentConfidenceScores :ivar sentences: Sentence level sentiment analysis. - :type sentences: + :vartype sentences: list[~azure.ai.textanalytics.SentenceSentiment] :ivar bool is_error: Boolean check for error item when iterating over list of results. Always False for an instance of a AnalyzeSentimentResult. @@ -383,10 +383,10 @@ class TextDocumentStatistics(DictMixin): :ivar character_count: Number of text elements recognized in the document. - :type character_count: int + :vartype character_count: int :ivar transaction_count: Number of transactions for the document. - :type transaction_count: int + :vartype transaction_count: int """ def __init__(self, **kwargs): @@ -414,9 +414,9 @@ class DocumentError(DictMixin): :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 + :vartype id: str :ivar error: The document error. - :type error: ~azure.ai.textanalytics.TextAnalyticsError + :vartype error: ~azure.ai.textanalytics.TextAnalyticsError :ivar bool is_error: Boolean check for error item when iterating over list of results. Always True for an instance of a DocumentError. """ @@ -459,14 +459,14 @@ class DetectLanguageInput(LanguageInput): """The input document to be analyzed for detecting language. :ivar id: Required. Unique, non-empty document identifier. - :type id: str + :vartype id: str :ivar text: Required. The input text to process. - :type text: str + :vartype text: str :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. - :type country_hint: str + :vartype country_hint: str """ def __init__(self, **kwargs): @@ -487,20 +487,20 @@ class LinkedEntity(DictMixin): entity found in the document. :ivar name: Entity Linking formal name. - :type name: str + :vartype name: str :ivar matches: List of instances this entity appears in the text. - :type matches: + :vartype matches: list[~azure.ai.textanalytics.LinkedEntityMatch] :ivar language: Language used in the data source. - :type language: str + :vartype language: str :ivar data_source_entity_id: Unique identifier of the recognized entity from the data source. - :type data_source_entity_id: str + :vartype data_source_entity_id: str :ivar url: URL to the entity's page from the data source. - :type url: str + :vartype url: str :ivar data_source: Data source used to extract entity linking, such as Wiki/Bing etc. - :type data_source: str + :vartype data_source: str """ def __init__(self, **kwargs): @@ -536,9 +536,9 @@ class LinkedEntityMatch(DictMixin): :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 + :vartype confidence_score: float :ivar text: Entity text as appears in the request. - :type text: str + :vartype text: str """ def __init__(self, **kwargs): @@ -562,13 +562,13 @@ class TextDocumentInput(MultiLanguageInput): """The input document to be analyzed by the service. :ivar id: Required. A unique, non-empty document identifier. - :type id: str + :vartype id: str :ivar text: Required. The input text to process. - :type text: str + :vartype text: str :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 + :vartype language: str """ def __init__(self, **kwargs): @@ -588,15 +588,15 @@ class TextDocumentBatchStatistics(DictMixin): in the response and needs to be retrieved by a response hook. :ivar document_count: Number of documents submitted in the request. - :type document_count: int + :vartype document_count: int :ivar valid_document_count: Number of valid documents. This excludes empty, over-size limit or non-supported languages documents. - :type valid_document_count: int + :vartype valid_document_count: int :ivar erroneous_document_count: Number of invalid documents. This includes empty, over-size limit or non-supported languages documents. - :type erroneous_document_count: int + :vartype erroneous_document_count: int :ivar transaction_count: Number of transactions for the request. - :type transaction_count: long + :vartype transaction_count: long """ def __init__(self, **kwargs): @@ -627,13 +627,13 @@ class SentenceSentiment(DictMixin): confidence scores for each individual sentence in the document. :ivar text: The sentence text. - :type text: str + :vartype text: str :ivar sentiment: The predicted Sentiment for the sentence. Possible values include: 'positive', 'neutral', 'negative' - :type sentiment: str + :vartype sentiment: str :ivar confidence_scores: The sentiment confidence score between 0 and 1 for the sentence for all labels. - :type confidence_scores: + :vartype confidence_scores: ~azure.ai.textanalytics.SentimentConfidenceScores """ @@ -663,11 +663,11 @@ class SentimentConfidenceScores(DictMixin): Higher values indicate higher confidence. :ivar positive: Positive score. - :type positive: float + :vartype positive: float :ivar neutral: Neutral score. - :type neutral: float + :vartype neutral: float :ivar negative: Negative score. - :type negative: float + :vartype negative: float """ def __init__(self, **kwargs):