diff --git a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md index 9fd8c63953d16..d6ede2e70a91c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md +++ b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 5.1.0 (2021-07-08) +## 5.1.0 (2021-07-07) #### Feature Added - We are now targeting the service's v3.1 API as the default instead of v3.1-preview.4. - Added a new class, `HealthcareEntityCategory` to replace the `String` type of property `category` in the `HealthcareEntity`. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClient.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClient.java index 7d07a8062a33d..738956414e637 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClient.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClient.java @@ -85,7 +85,7 @@ public final class TextAnalyticsAsyncClient { final AnalyzeActionsAsyncClient analyzeActionsAsyncClient; /** - * Create a {@link TextAnalyticsAsyncClient} that sends requests to the Text Analytics services's endpoint. Each + * Creates a {@link TextAnalyticsAsyncClient} that sends requests to the Text Analytics service's endpoint. Each * service call goes through the {@link TextAnalyticsClientBuilder#pipeline http pipeline}. * * @param service The proxy service used to perform REST calls. @@ -110,18 +110,18 @@ public final class TextAnalyticsAsyncClient { } /** - * Get default country hint code. + * Gets default country hint code. * - * @return the default country hint code + * @return The default country hint code */ public String getDefaultCountryHint() { return defaultCountryHint; } /** - * Get default language when the builder is setup. + * Gets default language when the builder is setup. * - * @return the default language + * @return The default language */ public String getDefaultLanguage() { return defaultLanguage; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClient.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClient.java index a9cc29408b09d..f7f6a1ceadf7c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClient.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClient.java @@ -62,7 +62,7 @@ public final class TextAnalyticsClient { private final TextAnalyticsAsyncClient client; /** - * Create a {@code TextAnalyticsClient client} that sends requests to the Text Analytics service's endpoint. + * Creates a {@code TextAnalyticsClient client} that sends requests to the Text Analytics service's endpoint. * Each service call goes through the {@link TextAnalyticsClientBuilder#pipeline http pipeline}. * * @param client The {@link TextAnalyticsClient} that the client routes its request through. @@ -72,7 +72,7 @@ public final class TextAnalyticsClient { } /** - * Get default country hint code. + * Gets default country hint code. * * @return The default country hint code */ @@ -81,7 +81,7 @@ public String getDefaultCountryHint() { } /** - * Get default language when the builder is setup. + * Gets default language when the builder is setup. * * @return The default language */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOperationDetail.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOperationDetail.java index 848570e4e624d..e67d2ee704111 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOperationDetail.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOperationDetail.java @@ -79,7 +79,7 @@ public void setLastModifiedAt(AnalyzeActionsOperationDetail operationDetail, /** * Gets the operationId property of the {@link AnalyzeActionsOperationDetail}. * - * @return the operationId property of the {@link AnalyzeActionsOperationDetail}. + * @return The operationId property of the {@link AnalyzeActionsOperationDetail}. */ public String getOperationId() { return operationId; @@ -88,7 +88,7 @@ public String getOperationId() { /** * Gets the displayName property of the {@link AnalyzeActionsOperationDetail}. * - * @return the displayName property of the {@link AnalyzeActionsOperationDetail}. + * @return The displayName property of the {@link AnalyzeActionsOperationDetail}. */ public String getDisplayName() { return displayName; @@ -97,7 +97,7 @@ public String getDisplayName() { /** * Gets the failed number of actions. * - * @return the failed number of actions. + * @return The failed number of actions. */ public int getFailedCount() { return failedCount; @@ -106,7 +106,7 @@ public int getFailedCount() { /** * Gets the in-progress number of actions. * - * @return the in-progress number of actions. + * @return The in-progress number of actions. */ public int getInProgressCount() { return inProgressCount; @@ -115,7 +115,7 @@ public int getInProgressCount() { /** * Gets the successfully completed number of actions. * - * @return the successfully completed number of actions. + * @return The successfully completed number of actions. */ public int getSucceededCount() { return succeededCount; @@ -124,7 +124,7 @@ public int getSucceededCount() { /** * Gets the total number of actions. * - * @return the total number of actions. + * @return The total number of actions. */ public int getTotalCount() { return totalCount; @@ -133,7 +133,7 @@ public int getTotalCount() { /** * Gets the created time of an action. * - * @return the created time of an action. + * @return The created time of an action. */ public OffsetDateTime getCreatedAt() { return createdAt; @@ -142,7 +142,7 @@ public OffsetDateTime getCreatedAt() { /** * Gets the expiration time of an action. * - * @return the expiration time of an action. + * @return The expiration time of an action. */ public OffsetDateTime getExpiresAt() { return expiresAt; @@ -151,7 +151,7 @@ public OffsetDateTime getExpiresAt() { /** * Gets the last updated time of an action. * - * @return the last updated time of an action. + * @return The last updated time of an action. */ public OffsetDateTime getLastModifiedAt() { return lastModifiedAt; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOptions.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOptions.java index e431e386f427d..62d8ff990dd62 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOptions.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOptions.java @@ -13,7 +13,7 @@ public final class AnalyzeActionsOptions { private boolean includeStatistics; /** - * Get the value of {@code includeStatistics}. + * Gets the value of {@code includeStatistics}. * * @return The value of {@code includeStatistics}. */ @@ -22,7 +22,7 @@ public boolean isIncludeStatistics() { } /** - * Set the value of {@code includeStatistics}. The default value is false by default. + * Sets the value of {@code includeStatistics}. The default value is false by default. * If set to true, indicates that the service should return document and document batch statistics * with the results of the operation. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsResult.java index 194361487f562..5187d0a6a9716 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsResult.java @@ -55,48 +55,48 @@ public void setAnalyzeSentimentResults(AnalyzeActionsResult analyzeActionsResult } /** - * Get the {@code recognizeEntitiesActionResults} property: The categorized entities recognition action results + * Gets the {@code recognizeEntitiesResults} property: The categorized entities recognition action results * property. * - * @return the recognizeEntitiesActionResults value. + * @return The recognizeEntitiesResults value. */ public IterableStream getRecognizeEntitiesResults() { return this.recognizeEntitiesResults; } /** - * Get the {@code recognizeLinkedEntitiesActionResults} property: The linked entities recognition action results + * Gets the {@code recognizeLinkedEntitiesResults} property: The linked entities recognition action results * property. * - * @return the recognizeLinkedEntitiesActionResults value. + * @return The recognizeLinkedEntitiesResults value. */ public IterableStream getRecognizeLinkedEntitiesResults() { return this.recognizeLinkedEntitiesResults; } /** - * Get the {@code recognizePiiEntitiesActionResults} property: The PII entities recognition actions results + * Gets the {@code recognizePiiEntitiesResults} property: The PII entities recognition actions results * property. * - * @return the recognizePiiEntitiesActionResults value. + * @return The recognizePiiEntitiesResults value. */ public IterableStream getRecognizePiiEntitiesResults() { return this.recognizePiiEntitiesResults; } /** - * Get the {@code extractKeyPhrasesActionResults} property: The key phrases extraction actions results property. + * Gets the {@code extractKeyPhrasesResults} property: The key phrases extraction actions results property. * - * @return the extractKeyPhrasesActionResults value. + * @return The extractKeyPhrasesResults value. */ public IterableStream getExtractKeyPhrasesResults() { return this.extractKeyPhrasesResults; } /** - * Get the {@code analyzeSentimentActionResults} property: The sentiment analysis actions results property. + * Gets the {@code analyzeSentimentResults} property: The sentiment analysis actions results property. * - * @return the analyzeSentimentActionResults value. + * @return The analyzeSentimentResults value. */ public IterableStream getAnalyzeSentimentResults() { return this.analyzeSentimentResults; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOperationDetail.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOperationDetail.java index e0f0d29395a08..b792b888ef28e 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOperationDetail.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOperationDetail.java @@ -52,7 +52,7 @@ public void setLastModifiedAt(AnalyzeHealthcareEntitiesOperationDetail operation /** * Gets the operationId property of the {@link AnalyzeHealthcareEntitiesOperationDetail}. * - * @return the operationId property of the {@link AnalyzeHealthcareEntitiesOperationDetail}. + * @return The operationId property of the {@link AnalyzeHealthcareEntitiesOperationDetail}. */ public String getOperationId() { return operationId; @@ -61,7 +61,7 @@ public String getOperationId() { /** * Gets the created time of an action. * - * @return the created time of an action. + * @return The created time of an action. */ public OffsetDateTime getCreatedAt() { return createdAt; @@ -70,7 +70,7 @@ public OffsetDateTime getCreatedAt() { /** * Gets the expiration time of an action. * - * @return the expiration time of an action. + * @return The expiration time of an action. */ public OffsetDateTime getExpiresAt() { return expiresAt; @@ -79,7 +79,7 @@ public OffsetDateTime getExpiresAt() { /** * Gets the last updated time of an action. * - * @return the last updated time of an action. + * @return The last updated time of an action. */ public OffsetDateTime getLastModifiedAt() { return lastModifiedAt; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOptions.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOptions.java index 43c663bdceffd..74845d96f035f 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOptions.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOptions.java @@ -11,7 +11,7 @@ @Fluent public final class AnalyzeHealthcareEntitiesOptions extends TextAnalyticsRequestOptions { /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -25,12 +25,12 @@ public AnalyzeHealthcareEntitiesOptions setModelVersion(String modelVersion) { } /** - * Set the value of {@code includeStatistics}. + * Sets the value of {@code includeStatistics}. * * @param includeStatistics If a boolean value was specified in the request this field will contain * information about the document payload. * - * @return the {@link AnalyzeHealthcareEntitiesOptions} object itself. + * @return The {@link AnalyzeHealthcareEntitiesOptions} object itself. */ @Override public AnalyzeHealthcareEntitiesOptions setIncludeStatistics(boolean includeStatistics) { @@ -39,13 +39,13 @@ public AnalyzeHealthcareEntitiesOptions setIncludeStatistics(boolean includeStat } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'true'. This means, Text Analytics service * does not log your input text. Setting this property to 'false', enables the service to log your text input for * 48 hours, solely to allow for troubleshooting issues. * - * @return the {@link AnalyzeHealthcareEntitiesOptions} object itself. + * @return The {@link AnalyzeHealthcareEntitiesOptions} object itself. */ @Override public AnalyzeHealthcareEntitiesOptions setServiceLogsDisabled(boolean disableServiceLogs) { diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesResult.java index a16624780a5af..b160c6b56bf1d 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesResult.java @@ -52,7 +52,7 @@ public AnalyzeHealthcareEntitiesResult(String id, TextDocumentStatistics textDoc } /** - * Get an {@link IterableStream} of {@link HealthcareEntity}. + * Gets an {@link IterableStream} of {@link HealthcareEntity}. * * @return An {@link IterableStream} of {@link HealthcareEntity}. * @@ -65,7 +65,7 @@ public IterableStream getEntities() { } /** - * Get the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. + * Gets the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. * * @return {@link IterableStream} of {@link TextAnalyticsWarning}. */ @@ -74,9 +74,9 @@ public IterableStream getWarnings() { } /** - * Get the {@link IterableStream} of {@link HealthcareEntityRelation}. + * Gets the {@link IterableStream} of {@link HealthcareEntityRelation}. * - * @return the {@link IterableStream} of {@link HealthcareEntityRelation}. + * @return The {@link IterableStream} of {@link HealthcareEntityRelation}. */ public IterableStream getEntityRelations() { return this.entityRelations; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentAction.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentAction.java index a3ca98843f17b..17d4e9cf71d23 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentAction.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentAction.java @@ -25,7 +25,7 @@ public String getModelVersion() { } /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -38,7 +38,7 @@ public AnalyzeSentimentAction setModelVersion(String modelVersion) { } /** - * Get the value of {@code disableServiceLogs}. + * Gets the value of {@code disableServiceLogs}. * * @return The value of {@code disableServiceLogs}. The default value of this property is 'false'. This means, * Text Analytics service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting @@ -49,13 +49,13 @@ public boolean isServiceLogsDisabled() { } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'false'. This means, Text Analytics service logs * your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true, * disables input logging and may limit our ability to investigate issues that occur. * - * @return the {@link AnalyzeSentimentAction} object itself. + * @return The {@link AnalyzeSentimentAction} object itself. */ public AnalyzeSentimentAction setServiceLogsDisabled(boolean disableServiceLogs) { this.disableServiceLogs = disableServiceLogs; @@ -63,24 +63,24 @@ public AnalyzeSentimentAction setServiceLogsDisabled(boolean disableServiceLogs) } /** - * Get the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the + * Gets the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the * returned result. If this flag is specified, you'll get a {@code opinions} property on SentenceSentiment. * It is provided by service v3.1 and later. * - * @return the value of {@code includeOpinionMining}. + * @return The value of {@code includeOpinionMining}. */ public boolean isIncludeOpinionMining() { return includeOpinionMining; } /** - * Set the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the + * Sets the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the * returned result. If this flag is specified, you'll get a {@code opinions} property on SentenceSentiment. * It is provided by service v3.1 and later. * * @param includeOpinionMining The boolean indicator to include opinion mining data in the returned result. * - * @return the {@link AnalyzeSentimentAction} object itself. + * @return The {@link AnalyzeSentimentAction} object itself. */ public AnalyzeSentimentAction setIncludeOpinionMining(boolean includeOpinionMining) { this.includeOpinionMining = includeOpinionMining; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentActionResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentActionResult.java index 9a9ac80aab3fd..d4c8d5fc14185 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentActionResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentActionResult.java @@ -20,9 +20,9 @@ public final class AnalyzeSentimentActionResult extends TextAnalyticsActionResul } /** - * Gets the key phrases extraction action result. + * Gets the sentiment analysis action result. * - * @return the key phrases extraction action result. + * @return The sentiment analysis action result. * * @throws TextAnalyticsException if result has {@code isError} equals to true and when a non-error property * was accessed. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentOptions.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentOptions.java index 651cf7715a273..7a6ff5fbc6b5a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentOptions.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentOptions.java @@ -14,12 +14,12 @@ public final class AnalyzeSentimentOptions extends TextAnalyticsRequestOptions { /* * The boolean indicator to include opinion mining data in the returned result. If this * flag is specified, you'll get a {@code opinions} property on SentenceSentiment. It is provided by service - * v3.1-preview.1 and later. + * v3.1 and later. */ private boolean includeOpinionMining; /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -33,14 +33,14 @@ public AnalyzeSentimentOptions setModelVersion(String modelVersion) { } /** - * Set the value of {@code includeStatistics}. The default value is false by default. + * Sets the value of {@code includeStatistics}. The default value is false by default. * If set to true, indicates that the service should return document and document batch statistics * with the results of the operation. * * @param includeStatistics If a boolean value was specified in the request this field will contain * information about the document payload. * - * @return the {@link AnalyzeSentimentOptions} object itself. + * @return The {@link AnalyzeSentimentOptions} object itself. */ @Override public AnalyzeSentimentOptions setIncludeStatistics(boolean includeStatistics) { @@ -49,14 +49,14 @@ public AnalyzeSentimentOptions setIncludeStatistics(boolean includeStatistics) { } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'false', except for methods like * 'beginAnalyzeHealthcareEntities' and 'recognizePiiEntities'. This means, Text Analytics service logs * your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true, * disables input logging and may limit our ability to investigate issues that occur. * - * @return the {@link AnalyzeSentimentOptions} object itself. + * @return The {@link AnalyzeSentimentOptions} object itself. */ @Override public AnalyzeSentimentOptions setServiceLogsDisabled(boolean disableServiceLogs) { @@ -65,24 +65,24 @@ public AnalyzeSentimentOptions setServiceLogsDisabled(boolean disableServiceLogs } /** - * Get the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the + * Gets the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the * returned result. If this flag is specified, you'll get a {@code opinions} property on SentenceSentiment. * It is provided by service v3.1 and later. * - * @return the value of {@code includeOpinionMining}. + * @return The value of {@code includeOpinionMining}. */ public boolean isIncludeOpinionMining() { return includeOpinionMining; } /** - * Set the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the + * Sets the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the * returned result. If this flag is specified, you'll get a {@code opinions} property on SentenceSentiment. * It is provided by service v3.1 and later. * * @param includeOpinionMining The boolean indicator to include opinion mining data in the returned result. * - * @return the AnalyzeSentimentOptions object itself. + * @return The AnalyzeSentimentOptions object itself. */ public AnalyzeSentimentOptions setIncludeOpinionMining(boolean includeOpinionMining) { this.includeOpinionMining = includeOpinionMining; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentResult.java index 0c89a8535903a..566620939cd6d 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentResult.java @@ -27,7 +27,7 @@ public AnalyzeSentimentResult(String id, TextDocumentStatistics textDocumentStat } /** - * Get the document sentiment. + * Gets the document sentiment. * * @return The document sentiment. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AssessmentSentiment.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AssessmentSentiment.java index ac7d0c8908b8a..75dc9171ebcfe 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AssessmentSentiment.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AssessmentSentiment.java @@ -55,7 +55,7 @@ public void setLength(AssessmentSentiment assessmentSentiment, int length) { } /** - * Get the opinion text property. + * Gets the opinion text property. * * @return The text value. */ @@ -64,7 +64,7 @@ public String getText() { } /** - * Get the opinion text sentiment label: POSITIVE, NEGATIVE, MIXED. {@link TextSentiment} has + * Gets the opinion text sentiment label: POSITIVE, NEGATIVE, MIXED. {@link TextSentiment} has * {@code neutral} sentiment type additionally, but target sentiment can only be positive, negative, or mixed. * * @return The sentiment value. @@ -74,7 +74,7 @@ public TextSentiment getSentiment() { } /** - * Get the offset of opinion text. + * Gets the offset of opinion text. * * @return The offset of opinion text. */ @@ -83,7 +83,7 @@ public int getOffset() { } /** - * Get the length of opinion text. + * Gets the length of opinion text. * * @return The length of opinion text. */ @@ -92,7 +92,7 @@ public int getLength() { } /** - * Get the boolean indicator to show if the text is negative. + * Gets the boolean indicator to show if the text is negative. * * @return The boolean indicator to show if the text is negative. */ @@ -101,9 +101,9 @@ public boolean isNegated() { } /** - * Get the confidence score of the sentiment label. All score values sum up to 1, the higher the score, the - * higher the confidence in the sentiment. OpinionSentiment only has positive or negative confidence score value - * because there is no neutral sentiment label in the OpinionSentiment. + * Gets the confidence score of the sentiment label. All score values sum up to 1, the higher the score, the + * higher the confidence in the sentiment. {@link AssessmentSentiment} only has positive or negative confidence + * score value because there is no neutral sentiment label in the {@link AssessmentSentiment}. * * @return The {@link SentimentConfidenceScores}. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntity.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntity.java index a2b42cdf09815..56e195c84dbd6 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntity.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntity.java @@ -48,7 +48,7 @@ public void setOffset(CategorizedEntity entity, int offset) { } /** - * Get the text property: Categorized entity text as appears in the request. + * Gets the text property: Categorized entity text as appears in the request. * * @return The text value. */ @@ -57,7 +57,7 @@ public String getText() { } /** - * Get the category property: Categorized entity category, such as Person/Location/Org/SSN etc. + * Gets the category property: Categorized entity category, such as Person/Location/Org/SSN etc. * * @return The category value. */ @@ -66,7 +66,7 @@ public EntityCategory getCategory() { } /** - * Get the subcategory property: Categorized entity sub category, such as Age/Year/TimeRange etc. + * Gets the subcategory property: Categorized entity sub category, such as Age/Year/TimeRange etc. * * @return The subcategory value. */ @@ -75,7 +75,7 @@ public String getSubcategory() { } /** - * Get the score property: If a well-known item is recognized, a decimal + * Gets the score property: If a well-known item is recognized, a decimal * number denoting the confidence level between 0 and 1 will be returned. * * @return The score value. @@ -85,7 +85,7 @@ public double getConfidenceScore() { } /** - * Get the offset of entity text. The start position for the entity text in a document. + * Gets the offset of entity text. The start position for the entity text in a document. * * @return The offset of entity text. */ @@ -98,7 +98,7 @@ private void setOffset(int offset) { } /** - * Get the length of entity text. + * Gets the length of entity text. * * @return The length of entity text. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntityCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntityCollection.java index 5c1218ba34146..94ae4b2992186 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntityCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/CategorizedEntityCollection.java @@ -26,7 +26,7 @@ public CategorizedEntityCollection(IterableStream entities, } /** - * Get the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. + * Gets the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. * * @return {@link IterableStream} of {@link TextAnalyticsWarning}. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageInput.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageInput.java index 4997d2527ca59..68313ab4d821c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageInput.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageInput.java @@ -53,7 +53,7 @@ public DetectLanguageInput(String id, String text, String countryHint) { } /** - * Get the id property: Unique, non-empty document identifier. + * Gets the id property: Unique, non-empty document identifier. * * @return The id value. */ @@ -62,7 +62,7 @@ public String getId() { } /** - * Get the text property: The text property. + * Gets the text property: The text property. * * @return The text value. */ @@ -71,7 +71,7 @@ public String getText() { } /** - * Get the countryHint property: The {@code countryHint} property. + * Gets the countryHint property: The {@code countryHint} property. * * @return The {@code countryHint} value. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageResult.java index 49ab2a4a0feec..b8649e9d5b8d0 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectLanguageResult.java @@ -12,7 +12,7 @@ public final class DetectLanguageResult extends TextAnalyticsResult { private final DetectedLanguage primaryLanguage; /** - * Create a {@link DetectLanguageResult} model that describes detected languages result. + * Creates a {@link DetectLanguageResult} model that describes detected languages result. * * @param id Unique, non-empty document identifier. * @param textDocumentStatistics The text document statistics. @@ -26,7 +26,7 @@ public DetectLanguageResult(String id, TextDocumentStatistics textDocumentStatis } /** - * Get the detected primary language. + * Gets the detected primary language. * * @return The detected language. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectedLanguage.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectedLanguage.java index 9a1aa6f2384f0..d0a72ffe33af9 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectedLanguage.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DetectedLanguage.java @@ -50,7 +50,7 @@ public DetectedLanguage(String name, String iso6391Name, double confidenceScore, } /** - * Get the name property: Long name of a detected language (e.g. English, + * Gets the name property: Long name of a detected language (e.g. English, * French). * * @return the name value. @@ -60,7 +60,7 @@ public String getName() { } /** - * Get the iso6391Name property: A two letter representation of the + * Gets the iso6391Name property: A two letter representation of the * detected language according to the ISO 639-1 standard (e.g. en, fr). * * @return the iso6391Name value. @@ -70,7 +70,7 @@ public String getIso6391Name() { } /** - * Get the confidenceScore property: A confidence score between 0 and 1. + * Gets the confidenceScore property: A confidence score between 0 and 1. * Scores close to 1 indicate 100% certainty that the identified language * is true. * @@ -81,7 +81,7 @@ public double getConfidenceScore() { } /** - * Get the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. + * Gets the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. * * @return {@link IterableStream} of {@link TextAnalyticsWarning}. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DocumentSentiment.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DocumentSentiment.java index 39db850edbe88..659a430693b71 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DocumentSentiment.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/DocumentSentiment.java @@ -14,7 +14,7 @@ public final class DocumentSentiment { private final TextSentiment sentiment; private final SentimentConfidenceScores confidenceScores; - private final IterableStream sentences; + private final IterableStream sentences; private final IterableStream warnings; /** @@ -35,7 +35,7 @@ public DocumentSentiment(TextSentiment sentiment, SentimentConfidenceScores conf } /** - * Get the text sentiment label: POSITIVE, NEGATIVE, NEUTRAL, or MIXED. + * Gets the text sentiment label: POSITIVE, NEGATIVE, NEUTRAL, or MIXED. * * @return The {@link TextSentiment}. */ @@ -44,7 +44,7 @@ public TextSentiment getSentiment() { } /** - * Get the sentiment confidence score (Softmax score) between 0 and 1, for each sentiment label. + * Gets the sentiment confidence score (Softmax score) between 0 and 1, for each sentiment label. * Higher values signify higher confidence. * * @return The {@link SentimentConfidenceScores}. @@ -54,7 +54,7 @@ public SentimentConfidenceScores getConfidenceScores() { } /** - * Get a list of sentence sentiments. + * Gets a list of sentence sentiments. * * @return A list of sentence sentiments. */ @@ -63,7 +63,7 @@ public IterableStream getSentences() { } /** - * Get the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. + * Gets the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. * * @return An {@link IterableStream} of {@link TextAnalyticsWarning}. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/EntityDataSource.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/EntityDataSource.java index 58abae425f1f8..1c7914605c133 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/EntityDataSource.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/EntityDataSource.java @@ -38,7 +38,7 @@ public void setEntityId(EntityDataSource entityDataSource, String entityId) { } /** - * Get the data source name property: Entity Catalog. Examples include: UMLS, CHV, MSH, etc. + * Gets the data source name property: Entity Catalog. Examples include: UMLS, CHV, MSH, etc. * * @return the data source name. */ @@ -47,7 +47,7 @@ public String getName() { } /** - * Get the data source entity ID property: data source entity ID in the given source catalog. + * Gets the data source entity ID property: data source entity ID in the given source catalog. * * @return the data source entity ID. */ @@ -59,7 +59,7 @@ public String getEntityId() { * The private setter to set the data source name property * via {@link EntityDataSourcePropertiesHelper.EntityDataSourceAccessor}. * - * @param name the data source name property: Entity Catalog. Examples include: UMLS, CHV, MSH, etc. + * @param name The data source name property: Entity Catalog. Examples include: UMLS, CHV, MSH, etc. */ private void setName(String name) { this.name = name; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhraseResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhraseResult.java index e2aa9fdf51145..f29c275bffb7d 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhraseResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhraseResult.java @@ -13,7 +13,7 @@ public final class ExtractKeyPhraseResult extends TextAnalyticsResult { private final KeyPhrasesCollection keyPhrases; /** - * Create a {@link ExtractKeyPhraseResult} model that describes extracted key phrases result. + * Creates a {@link ExtractKeyPhraseResult} model that describes extracted key phrases result. * * @param id Unique, non-empty document identifier. * @param textDocumentStatistics The text document statistics. @@ -27,7 +27,7 @@ public ExtractKeyPhraseResult(String id, TextDocumentStatistics textDocumentStat } /** - * Get a {@link KeyPhrasesCollection} contains a list of key phrases and warnings. + * Gets a {@link KeyPhrasesCollection} contains a list of key phrases and warnings. * * @return A {@link KeyPhrasesCollection} contains a list of key phrases and warnings. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesAction.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesAction.java index 161ca9a35eb92..a81acfe44620a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesAction.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesAction.java @@ -24,7 +24,7 @@ public String getModelVersion() { } /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -37,7 +37,7 @@ public ExtractKeyPhrasesAction setModelVersion(String modelVersion) { } /** - * Get the value of {@code disableServiceLogs}. + * Gets the value of {@code disableServiceLogs}. * * @return The value of {@code disableServiceLogs}. The default value of this property is 'false'. This means, * Text Analytics service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting @@ -48,7 +48,7 @@ public boolean isServiceLogsDisabled() { } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'false'. This means, Text Analytics service logs * your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true, diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesActionResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesActionResult.java index 2a0f6bb1355ac..3ae68e4059353 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesActionResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/ExtractKeyPhrasesActionResult.java @@ -23,7 +23,7 @@ public final class ExtractKeyPhrasesActionResult extends TextAnalyticsActionResu /** * Gets the key phrases extraction action result. * - * @return the key phrases extraction action result. + * @return The key phrases extraction action result. * * @throws TextAnalyticsException if result has {@code isError} equals to true and when a non-error property * was accessed. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntity.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntity.java index c9cc5f2fa1a88..c0900f3dbdd46 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntity.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntity.java @@ -73,7 +73,7 @@ public void setAssertion(HealthcareEntity healthcareEntity, HealthcareEntityAsse } /** - * Get the text property: Healthcare entity text as appears in the request. + * Gets the text property: Healthcare entity text as appears in the request. * * @return The text value. */ @@ -82,7 +82,7 @@ public String getText() { } /** - * Get the normalized text property: The normalized text is preferred name for the entity. + * Gets the normalized text property: The normalized text is preferred name for the entity. * Example: 'histologically' would have a 'name' of 'histologic'. * * @return The normalized text value. @@ -92,7 +92,7 @@ public String getNormalizedText() { } /** - * Get the category property: Healthcare entity category, such as Person/Location/Org/SSN etc. + * Gets the category property: Healthcare entity category, such as Person/Location/Org/SSN etc. * * @return The category value. */ @@ -101,7 +101,7 @@ public HealthcareEntityCategory getCategory() { } /** - * Get the subcategory property: Healthcare entity subcategory, such as DateTime etc. + * Gets the subcategory property: Healthcare entity subcategory, such as DateTime etc. * * @return The subcategory value. */ @@ -110,7 +110,7 @@ public String getSubcategory() { } /** - * Get the score property: If a well-known item is recognized, a decimal + * Gets the score property: If a well-known item is recognized, a decimal * number denoting the confidence level between 0 and 1 will be returned. * * @return The score value. @@ -120,7 +120,7 @@ public double getConfidenceScore() { } /** - * Get the offset of entity text. The start position for the entity text in a document. + * Gets the offset of entity text. The start position for the entity text in a document. * * @return The offset of entity text. */ @@ -129,7 +129,7 @@ public int getOffset() { } /** - * Get the length of entity text. + * Gets the length of entity text. * * @return The length of entity text. */ @@ -138,7 +138,7 @@ public int getLength() { } /** - * Get the healthcare entity data sources property: Entity references in known data sources. + * Gets the healthcare entity data sources property: Entity references in known data sources. * * @return the dataSources value. */ @@ -147,7 +147,7 @@ public IterableStream getDataSources() { } /** - * Get the assertion property. + * Gets the assertion property. * * @return the assertion property. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityAssertion.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityAssertion.java index e85e573c88c2e..793c8354c486e 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityAssertion.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityAssertion.java @@ -49,9 +49,9 @@ public void setConditionality(HealthcareEntityAssertion assertion, } /** - * Get the conditionality property: Describes any conditionality on the entity. + * Gets the conditionality property: Describes any conditionality on the entity. * - * @return the conditionality value. + * @return The conditionality value. */ public EntityConditionality getConditionality() { return this.conditionality; @@ -59,18 +59,19 @@ public EntityConditionality getConditionality() { /** - * Get the certainty property: Describes the entities certainty and polarity. + * Gets the certainty property: Describes the entities certainty and polarity. * - * @return the certainty value. + * @return The certainty value. */ public EntityCertainty getCertainty() { return this.certainty; } /** - * Get the association property: Describes if the entity is the subject of the text or if it describes someone else. + * Gets the association property: Describes if the entity is the subject of the text or if it describes someone + * else. * - * @return the association value. + * @return The association value. */ public EntityAssociation getAssociation() { return this.association; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelation.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelation.java index 096016c529713..75ace7cad376b 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelation.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelation.java @@ -43,19 +43,19 @@ public void setRoles(HealthcareEntityRelation healthcareEntityRelation, } /** - * Get the relationType property: Type of relation. Examples include: `DosageOfMedication` or + * Gets the relationType property: Type of relation. Examples include: `DosageOfMedication` or * 'FrequencyOfMedication', etc. * - * @return the relationType value. + * @return The relationType value. */ public HealthcareEntityRelationType getRelationType() { return this.relationType; } /** - * Get the entities property: The entities in the relation. + * Gets the entities property: The entities in the relation. * - * @return the entities value. + * @return The entities value. */ public IterableStream getRoles() { return this.roles; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelationRole.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelationRole.java index 1cd3cf42eb110..ba730c698269d 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelationRole.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/HealthcareEntityRelationRole.java @@ -37,20 +37,20 @@ public void setEntity(HealthcareEntityRelationRole healthcareEntityRelationRole, } /** - * Get the role property: Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell + * Gets the role property: Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell * lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive * (Expression), diffuse large B-cell lymphoma (Diagnosis). * - * @return the role name value. + * @return The role name value. */ public String getName() { return this.name; } /** - * Get the healthcare entity object. + * Gets the healthcare entity object. * - * @return the healthcare entity object. + * @return The healthcare entity object. */ public HealthcareEntity getEntity() { return this.entity; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/KeyPhrasesCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/KeyPhrasesCollection.java index c6a3df127411e..c7c1b44944b51 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/KeyPhrasesCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/KeyPhrasesCollection.java @@ -25,7 +25,7 @@ public KeyPhrasesCollection(IterableStream keyPhrases, IterableStream matches, Stri } /** - * Get the name property: Entity Linking formal name. + * Gets the name property: Entity Linking formal name. * * @return The name value. */ @@ -84,7 +84,7 @@ public String getName() { } /** - * Get the linked entities matched property: List of instances this entity appears in the text. + * Gets the linked entities matched property: List of instances this entity appears in the text. * * @return The linked entities matched value. */ @@ -93,7 +93,7 @@ public IterableStream getMatches() { } /** - * Get the language property: Language used in the data source. + * Gets the language property: Language used in the data source. * * @return The language value. */ @@ -102,7 +102,7 @@ public String getLanguage() { } /** - * Get the id property: Unique identifier of the recognized entity from the data source. + * Gets the id property: Unique identifier of the recognized entity from the data source. * * @return The id value. */ @@ -111,7 +111,7 @@ public String getDataSourceEntityId() { } /** - * Get the url property: URL for the entity's page from the data source. + * Gets the url property: URL for the entity's page from the data source. * * @return The URL value. */ @@ -120,7 +120,7 @@ public String getUrl() { } /** - * Get the dataSource property: Data source used to extract entity linking, such as Wiki/Bing etc. + * Gets the dataSource property: Data source used to extract entity linking, such as Wiki/Bing etc. * * @return The dataSource value. */ @@ -129,7 +129,7 @@ public String getDataSource() { } /** - * Get the bingEntitySearchApiId property: Bing Entity Search unique identifier of the recognized entity. + * Gets the bingEntitySearchApiId property: Bing Entity Search unique identifier of the recognized entity. * Use in conjunction with the Bing Entity Search SDK to fetch additional relevant information. Only available * for API version v3.1 and up. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityCollection.java index 5009d6340359a..2efbab162b8dc 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityCollection.java @@ -26,7 +26,7 @@ public LinkedEntityCollection(IterableStream entities, } /** - * Get the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. + * Gets the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}. * * @return {@link IterableStream} of {@link TextAnalyticsWarning}. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityMatch.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityMatch.java index 308a442e98b62..0aba9920829c3 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityMatch.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/LinkedEntityMatch.java @@ -45,7 +45,7 @@ public void setOffset(LinkedEntityMatch entity, int offset) { } /** - * Get the linked entity match text property: linked entity text as appears in the request. + * Gets the linked entity match text property: linked entity text as appears in the request. * * @return The text value. */ @@ -54,7 +54,7 @@ public String getText() { } /** - * Get the score property: If a well-known item is recognized, a decimal + * Gets the score property: If a well-known item is recognized, a decimal * number denoting the confidence level between 0 and 1 will be returned. * * @return The score value. @@ -64,7 +64,7 @@ public double getConfidenceScore() { } /** - * Get the offset of linked entity match text. The start position for the linked entity match text in a document. + * Gets the offset of linked entity match text. The start position for the linked entity match text in a document. * * @return The offset of linked entity match text. */ @@ -77,7 +77,7 @@ private void setOffset(int offset) { } /** - * Get the length of entity text. + * Gets the length of entity text. * * @return The length of entity text. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntity.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntity.java index d213c2aa32750..c170a16a6e5aa 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntity.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntity.java @@ -73,7 +73,7 @@ public void setLength(PiiEntity entity, int length) { } /** - * Get the text property: PII entity text as appears in the request. + * Gets the text property: PII entity text as appears in the request. * * @return The {@code text} value. */ @@ -82,7 +82,7 @@ public String getText() { } /** - * Get the category property: Categorized entity category, such as Person/Location/Org/SSN etc. + * Gets the category property: Categorized entity category, such as Person/Location/Org/SSN etc. * * @return The {@code category} value. */ @@ -91,7 +91,7 @@ public PiiEntityCategory getCategory() { } /** - * Get the subcategory property: Categorized entity subcategory, such as Medical/Stock exchange/Sports etc. + * Gets the subcategory property: Categorized entity subcategory, such as Medical/Stock exchange/Sports etc. * * @return The {@code subcategory} value. */ @@ -100,7 +100,7 @@ public String getSubcategory() { } /** - * Get the score property: Confidence score between 0 and 1 of the recognized entity. + * Gets the score property: Confidence score between 0 and 1 of the recognized entity. * * @return The {@code confidenceScore} value. */ @@ -109,7 +109,7 @@ public double getConfidenceScore() { } /** - * Get the offset property: the start position for the entity text. + * Gets the offset property: the start position for the entity text. * * @return The {@code offset} value. */ @@ -118,7 +118,7 @@ public int getOffset() { } /** - * Get the length of entity text. + * Gets the length of entity text. * * @return The length of entity text. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityCollection.java index 5ab32d11e34c5..9a4f9cc735d69 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityCollection.java @@ -15,7 +15,8 @@ public final class PiiEntityCollection extends IterableStream { private final IterableStream warnings; /** - * Creates a {@link PiiEntityCollection} model that describes a entities collection including warnings. + * Creates a {@link PiiEntityCollection} model that describes a Personally Identifiable Information entities + * collection including warnings. * * @param entities An {@link IterableStream} of {@link PiiEntity Personally Identifiable Information entities}. * @param redactedText The text of the input document with all of the PII information redacted out. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityDomain.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityDomain.java index 57e2a23dff4d0..49cdf9eded39c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityDomain.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/PiiEntityDomain.java @@ -22,10 +22,10 @@ public final class PiiEntityDomain extends ExpandableStringEnum public static final PiiEntityDomain NONE = fromString("none"); /** - * Creates or finds a {@link EntityCategory} from its string representation. + * Creates or finds a {@link PiiEntityDomain} from its string representation. * * @param name The string name to look for. - * @return The corresponding {@link EntityCategory}. + * @return The corresponding {@link PiiEntityDomain}. */ public static PiiEntityDomain fromString(String name) { return fromString(name, PiiEntityDomain.class); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesAction.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesAction.java index 1b1bc2b12ebce..87eb8a341040f 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesAction.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesAction.java @@ -24,7 +24,7 @@ public String getModelVersion() { } /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -37,7 +37,7 @@ public RecognizeEntitiesAction setModelVersion(String modelVersion) { } /** - * Get the value of {@code disableServiceLogs}. + * Gets the value of {@code disableServiceLogs}. * * @return The value of {@code disableServiceLogs}. The default value of this property is 'false'. This means, * Text Analytics service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting @@ -48,7 +48,7 @@ public boolean isServiceLogsDisabled() { } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'false'. This means, Text Analytics service logs * your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true, diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesActionResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesActionResult.java index 5b27bd8725f5d..94955eb8275ba 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesActionResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesActionResult.java @@ -22,7 +22,7 @@ public final class RecognizeEntitiesActionResult extends TextAnalyticsActionResu /** * Gets the entities recognition action result. * - * @return the entities recognition action result. + * @return The entities recognition action result. * * @throws TextAnalyticsException if result has {@code isError} equals to true and when a non-error property * was accessed. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesResult.java index ac360e8581233..778201f57b7ce 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeEntitiesResult.java @@ -28,7 +28,7 @@ public RecognizeEntitiesResult(String id, TextDocumentStatistics textDocumentSta } /** - * Get an {@link IterableStream} of {@link CategorizedEntity}. + * Gets an {@link IterableStream} of {@link CategorizedEntity}. * * @return An {@link IterableStream} of {@link CategorizedEntity}. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesAction.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesAction.java index f0d03b53499f7..983ba69d8be8c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesAction.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesAction.java @@ -24,7 +24,7 @@ public String getModelVersion() { } /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -37,7 +37,7 @@ public RecognizeLinkedEntitiesAction setModelVersion(String modelVersion) { } /** - * Get the value of {@code disableServiceLogs}. + * Gets the value of {@code disableServiceLogs}. * * @return The value of {@code disableServiceLogs}. The default value of this property is 'false'. This means, * Text Analytics service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting @@ -48,7 +48,7 @@ public boolean isServiceLogsDisabled() { } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'false'. This means, Text Analytics service logs * your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true, diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesActionResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesActionResult.java index 00374ebe43cb4..d456bb48b84ff 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesActionResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesActionResult.java @@ -22,7 +22,7 @@ public final class RecognizeLinkedEntitiesActionResult extends TextAnalyticsActi /** * Gets the linked entities recognition action result. * - * @return the linked entities recognition action result. + * @return The linked entities recognition action result. * * @throws TextAnalyticsException if result has {@code isError} equals to true and when a non-error property * was accessed. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesResult.java index f8b373dd10a74..bb2447e9b835d 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizeLinkedEntitiesResult.java @@ -28,7 +28,7 @@ public RecognizeLinkedEntitiesResult(String id, TextDocumentStatistics textDocum } /** - * Get an {@link IterableStream} of {@link LinkedEntity}. + * Gets an {@link IterableStream} of {@link LinkedEntity}. * * @return An {@link IterableStream} of {@link LinkedEntity}. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesAction.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesAction.java index 752422d6b93e3..11ea974a7f17f 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesAction.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesAction.java @@ -28,7 +28,7 @@ public String getModelVersion() { } /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -41,7 +41,7 @@ public RecognizePiiEntitiesAction setModelVersion(String modelVersion) { } /** - * Get the value of {@code disableServiceLogs}. + * Gets the value of {@code disableServiceLogs}. * * @return The value of {@code disableServiceLogs}. The default value of this property is 'false'. This means, * Text Analytics service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting @@ -52,7 +52,7 @@ public boolean isServiceLogsDisabled() { } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'true'. This means, Text Analytics service won't * log your input text. Setting this property to 'false', enables logging your input text for 48 hours, @@ -66,7 +66,7 @@ public RecognizePiiEntitiesAction setServiceLogsDisabled(boolean disableServiceL } /** - * Get the value of domainFilter. It filters the response entities to ones only included in the specified domain. + * Gets the value of domainFilter. It filters the response entities to ones only included in the specified domain. * I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. * See https://aka.ms/tanerpii for more information. * @@ -77,7 +77,7 @@ public PiiEntityDomain getDomainFilter() { } /** - * Set the value of domainFilter. It filters the response entities to ones only included in the specified domain. + * Sets the value of domainFilter. It filters the response entities to ones only included in the specified domain. * I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. * See https://aka.ms/tanerpii for more information. * @@ -91,7 +91,7 @@ public RecognizePiiEntitiesAction setDomainFilter(PiiEntityDomain domainFilter) } /** - * Get the value of categoriesFilter. It filters the response entities to ones only included in the specified + * Gets the value of categoriesFilter. It filters the response entities to ones only included in the specified * categories. * * @return The value of categoriesFilter. @@ -101,7 +101,7 @@ public Iterable getCategoriesFilter() { } /** - * Set the value of categoriesFilter. It filters the response entities to ones only included in the specified + * Sets the value of categoriesFilter. It filters the response entities to ones only included in the specified * categories. * * @param categoriesFilter It filters the response entities to ones only included in the specified categories. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesActionResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesActionResult.java index e8c8a61c0925b..57e259a426876 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesActionResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesActionResult.java @@ -22,7 +22,7 @@ public final class RecognizePiiEntitiesActionResult extends TextAnalyticsActionR /** * Gets the PII entities recognition action result. * - * @return the PII entities recognition action result. + * @return The PII entities recognition action result. * * @throws TextAnalyticsException if result has {@code isError} equals to true and when a non-error property * was accessed. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesOptions.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesOptions.java index 43b1272015368..a79395076ef19 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesOptions.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesOptions.java @@ -16,7 +16,7 @@ public final class RecognizePiiEntitiesOptions extends TextAnalyticsRequestOptio private Iterable categoriesFilter; /** - * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". + * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". * If a model-version is not specified, the API will default to the latest, non-preview version. * * @param modelVersion The model version. @@ -30,14 +30,14 @@ public RecognizePiiEntitiesOptions setModelVersion(String modelVersion) { } /** - * Set the value of {@code includeStatistics}. The default value is false by default. + * Sets the value of {@code includeStatistics}. The default value is false by default. * If set to true, indicates that the service should return document and document batch statistics * with the results of the operation. * * @param includeStatistics If a boolean value was specified in the request this field will contain * information about the document payload. * - * @return the {@link RecognizePiiEntitiesOptions} object itself. + * @return The {@link RecognizePiiEntitiesOptions} object itself. */ @Override public RecognizePiiEntitiesOptions setIncludeStatistics(boolean includeStatistics) { @@ -46,13 +46,13 @@ public RecognizePiiEntitiesOptions setIncludeStatistics(boolean includeStatistic } /** - * Set the value of {@code disableServiceLogs}. + * Sets the value of {@code disableServiceLogs}. * * @param disableServiceLogs The default value of this property is 'true'. This means, Text Analytics service * does not log your input text. Setting this property to 'false', enables the service to log your text input for * 48 hours, solely to allow for troubleshooting issues. * - * @return the {@link RecognizePiiEntitiesOptions} object itself. + * @return The {@link RecognizePiiEntitiesOptions} object itself. */ @Override public RecognizePiiEntitiesOptions setServiceLogsDisabled(boolean disableServiceLogs) { @@ -61,7 +61,7 @@ public RecognizePiiEntitiesOptions setServiceLogsDisabled(boolean disableService } /** - * Get the value of domainFilter. It filters the response entities to ones only included in the specified domain. + * Gets the value of domainFilter. It filters the response entities to ones only included in the specified domain. * I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. * See https://aka.ms/tanerpii for more information. * @@ -72,7 +72,7 @@ public PiiEntityDomain getDomainFilter() { } /** - * Set the value of domainFilter. It filters the response entities to ones only included in the specified domain. + * Sets the value of domainFilter. It filters the response entities to ones only included in the specified domain. * I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. * See https://aka.ms/tanerpii for more information. * @@ -86,7 +86,7 @@ public RecognizePiiEntitiesOptions setDomainFilter(PiiEntityDomain domainFilter) } /** - * Get the value of categoriesFilter. It filters the response entities to ones only included in the specified + * Gets the value of categoriesFilter. It filters the response entities to ones only included in the specified * categories. * * @return The value of categoriesFilter. @@ -96,7 +96,7 @@ public Iterable getCategoriesFilter() { } /** - * Set the value of categoriesFilter. It filters the response entities to ones only included in the specified + * Sets the value of categoriesFilter. It filters the response entities to ones only included in the specified * categories. * * @param categoriesFilter It filters the response entities to ones only included in the specified categories. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesResult.java index a27d37d5b7ac4..658b41a771f5c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/RecognizePiiEntitiesResult.java @@ -28,7 +28,7 @@ public RecognizePiiEntitiesResult(String id, TextDocumentStatistics textDocument } /** - * Get an {@link IterableStream} of {@link PiiEntity}. + * Gets an {@link IterableStream} of {@link PiiEntity}. * * @return An {@link IterableStream} of {@link PiiEntity}. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/SentenceOpinion.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/SentenceOpinion.java index 29f85914ce101..b5e7df37cacc2 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/SentenceOpinion.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/SentenceOpinion.java @@ -31,7 +31,7 @@ public void setAssessments(SentenceOpinion sentenceOpinion, IterableStream getOpinions() { } /** - * Get the offset of sentence. The start position for the sentence in a document. + * Gets the offset of sentence. The start position for the sentence in a document. * * @return The offset of sentence. */ @@ -100,7 +100,7 @@ public int getOffset() { } /** - * Get the length of sentence. + * Gets the length of sentence. * * @return The length of sentence. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TargetSentiment.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TargetSentiment.java index 4f8edde42e397..94db5e4f5a40f 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TargetSentiment.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TargetSentiment.java @@ -47,7 +47,7 @@ public void setLength(TargetSentiment targetSentiment, int length) { } /** - * Get the target text property. + * Gets the target text property. * * @return The text value. */ @@ -56,7 +56,7 @@ public String getText() { } /** - * Get the target text sentiment label: POSITIVE, NEGATIVE, MIXED. {@link TextSentiment} has + * Gets the target text sentiment label: POSITIVE, NEGATIVE, MIXED. {@link TextSentiment} has * NEUTRAL sentiment type additionally, but target sentiment can only be POSITIVE, NEGATIVE, or MIXED. * * @return The sentiment value. @@ -66,7 +66,7 @@ public TextSentiment getSentiment() { } /** - * Get the target text offset from the start of document. + * Gets the target text offset from the start of document. * * @return The target text offset from the start of document. */ @@ -75,7 +75,7 @@ public int getOffset() { } /** - * Get the length of target text. + * Gets the length of target text. * * @return The length of target text. */ @@ -84,7 +84,7 @@ public int getLength() { } /** - * Get the confidence score of the sentiment label. All score values sum up to 1, the higher the score, the + * Gets the confidence score of the sentiment label. All score values sum up to 1, the higher the score, the * higher the confidence in the sentiment. AspectSentiment only has positive or negative confidence score value * because there is no neutral sentiment label in the AspectSentiment. * diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActionResult.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActionResult.java index d6733f037ab11..9ddc6e9196ad3 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActionResult.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActionResult.java @@ -44,14 +44,14 @@ public void setIsError(TextAnalyticsActionResult actionResult, boolean isError) /** * Gets the time when the action was completed. * - * @return the time when the action was completed. + * @return The time when the action was completed. */ public OffsetDateTime getCompletedAt() { return completedAt; } /** - * Get the error of action. + * Gets the error of action. * * @return The error of action. */ @@ -60,7 +60,7 @@ public TextAnalyticsError getError() { } /** - * Get the boolean value indicates if the action result is error or not. + * Gets the boolean value indicates if the action result is error or not. * * @return A boolean indicates if the action result is error or not. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActions.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActions.java index e2a584b4ecbf9..875dd9200a068 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActions.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/TextAnalyticsActions.java @@ -23,7 +23,7 @@ public final class TextAnalyticsActions { private Iterable analyzeSentimentActions; /** - * Get the custom name for the actions. + * Gets the custom name for the actions. * * @return the custom name for the actions. */ @@ -32,11 +32,11 @@ public String getDisplayName() { } /** - * Set the custom name for the actions. + * Sets the custom name for the actions. * - * @param displayName the custom name for the actions. + * @param displayName The custom name for the actions. * - * @return the {@link TextAnalyticsActions} object itself. + * @return The {@link TextAnalyticsActions} object itself. */ public TextAnalyticsActions setDisplayName(String displayName) { this.displayName = displayName; @@ -44,20 +44,20 @@ public TextAnalyticsActions setDisplayName(String displayName) { } /** - * Get the list of {@link RecognizeEntitiesAction} to be executed. + * Gets the list of {@link RecognizeEntitiesAction} to be executed. * - * @return the list of {@link RecognizeEntitiesAction} to be executed. + * @return The list of {@link RecognizeEntitiesAction} to be executed. */ public Iterable getRecognizeEntitiesActions() { return this.recognizeEntitiesActions; } /** - * Set the list of {@link RecognizeEntitiesAction} to be executed. + * Sets the list of {@link RecognizeEntitiesAction} to be executed. * - * @param recognizeEntitiesActions the list of {@link RecognizeEntitiesAction} to be executed. + * @param recognizeEntitiesActions The list of {@link RecognizeEntitiesAction} to be executed. * - * @return the {@link TextAnalyticsActions} object itself. + * @return The {@link TextAnalyticsActions} object itself. * * @throws IllegalArgumentException if more than one {@link RecognizeEntitiesAction} action are passed in. * Currently service v3.1 only accepts up to one action per type. @@ -70,20 +70,20 @@ public TextAnalyticsActions setRecognizeEntitiesActions(RecognizeEntitiesAction. } /** - * Get the list of {@link RecognizeLinkedEntitiesAction} to be executed. + * Gets the list of {@link RecognizeLinkedEntitiesAction} to be executed. * - * @return the list of {@link RecognizeLinkedEntitiesAction} to be executed. + * @return The list of {@link RecognizeLinkedEntitiesAction} to be executed. */ public Iterable getRecognizeLinkedEntitiesActions() { return this.recognizeLinkedEntitiesActions; } /** - * Set the list of {@link RecognizeLinkedEntitiesAction} to be executed. + * Sets the list of {@link RecognizeLinkedEntitiesAction} to be executed. * - * @param recognizeLinkedEntitiesActions the list of {@link RecognizeLinkedEntitiesAction} to be executed. + * @param recognizeLinkedEntitiesActions The list of {@link RecognizeLinkedEntitiesAction} to be executed. * - * @return the {@link TextAnalyticsActions} object itself. + * @return The {@link TextAnalyticsActions} object itself. * * @throws IllegalArgumentException if more than one {@link RecognizeLinkedEntitiesAction} action are passed in. * Currently service v3.1 only accepts up to one action per type. @@ -97,20 +97,20 @@ public TextAnalyticsActions setRecognizeLinkedEntitiesActions( } /** - * Get the list of {@link RecognizePiiEntitiesAction} to be executed. + * Gets the list of {@link RecognizePiiEntitiesAction} to be executed. * - * @return the list of {@link RecognizePiiEntitiesAction} to be executed. + * @return The list of {@link RecognizePiiEntitiesAction} to be executed. */ public Iterable getRecognizePiiEntitiesActions() { return this.recognizePiiEntitiesActions; } /** - * Set the list of {@link RecognizePiiEntitiesAction} to be executed. + * Sets the list of {@link RecognizePiiEntitiesAction} to be executed. * - * @param recognizePiiEntitiesActions the list of {@link RecognizePiiEntitiesAction} to be executed. + * @param recognizePiiEntitiesActions The list of {@link RecognizePiiEntitiesAction} to be executed. * - * @return the {@link TextAnalyticsActions} object itself. + * @return The {@link TextAnalyticsActions} object itself. * * @throws IllegalArgumentException if more than one {@link RecognizePiiEntitiesAction} action are passed in. * Currently service v3.1 only accepts up to one action per type. @@ -124,20 +124,20 @@ public TextAnalyticsActions setRecognizePiiEntitiesActions( } /** - * Get the list of {@link ExtractKeyPhrasesAction} to be executed. + * Gets the list of {@link ExtractKeyPhrasesAction} to be executed. * - * @return the list of {@link ExtractKeyPhrasesAction} to be executed. + * @return The list of {@link ExtractKeyPhrasesAction} to be executed. */ public Iterable getExtractKeyPhrasesActions() { return this.extractKeyPhrasesActions; } /** - * Set the list of {@link ExtractKeyPhrasesAction} to be executed. + * Sets the list of {@link ExtractKeyPhrasesAction} to be executed. * - * @param extractKeyPhrasesActions the list of {@link ExtractKeyPhrasesAction} to be executed. + * @param extractKeyPhrasesActions The list of {@link ExtractKeyPhrasesAction} to be executed. * - * @return the {@link TextAnalyticsActions} object itself. + * @return The {@link TextAnalyticsActions} object itself. * * @throws IllegalArgumentException if more than one {@link ExtractKeyPhrasesAction} action are passed in. * Currently service v3.1 only accepts up to one action per type. @@ -150,20 +150,20 @@ public TextAnalyticsActions setExtractKeyPhrasesActions(ExtractKeyPhrasesAction. } /** - * Get the list of {@link AnalyzeSentimentAction} to be executed. + * Gets the list of {@link AnalyzeSentimentAction} to be executed. * - * @return the list of {@link AnalyzeSentimentAction} to be executed. + * @return The list of {@link AnalyzeSentimentAction} to be executed. */ public Iterable getAnalyzeSentimentActions() { return this.analyzeSentimentActions; } /** - * Set the list of {@link AnalyzeSentimentAction} to be executed. + * Sets the list of {@link AnalyzeSentimentAction} to be executed. * - * @param analyzeSentimentActions the list of {@link AnalyzeSentimentAction} to be executed. + * @param analyzeSentimentActions The list of {@link AnalyzeSentimentAction} to be executed. * - * @return the {@link TextAnalyticsActions} object itself. + * @return The {@link TextAnalyticsActions} object itself. * * @throws IllegalArgumentException if more than one {@link AnalyzeSentimentAction} action are passed in. * Currently service v3.1 only accepts up to one action per type. diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeActionsResultPagedFlux.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeActionsResultPagedFlux.java index 5f871c667915c..0e82f5b9fa3e6 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeActionsResultPagedFlux.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeActionsResultPagedFlux.java @@ -20,7 +20,7 @@ public final class AnalyzeActionsResultPagedFlux extends ContinuablePagedFluxCore> { /** - * Create an instance of {@link AnalyzeActionsResultPagedFlux} + * Creates an instance of {@link AnalyzeActionsResultPagedFlux} * * @param pageRetrieverProvider a provider that returns {@link PageRetriever} */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesPagedFlux.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesPagedFlux.java index a833e303a4c11..53d1535294d3a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesPagedFlux.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesPagedFlux.java @@ -19,7 +19,7 @@ public final class AnalyzeHealthcareEntitiesPagedFlux extends ContinuablePagedFluxCore> { /** - * Create an instance of {@link AnalyzeHealthcareEntitiesPagedFlux} + * Creates an instance of {@link AnalyzeHealthcareEntitiesPagedFlux} * * @param pageRetrieverProvider a provider that returns {@link PageRetriever} */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesResultCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesResultCollection.java index d6eb49a5bdf46..751990e49815e 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesResultCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeHealthcareEntitiesResultCollection.java @@ -38,7 +38,7 @@ public void setStatistics( } /** - * Create a {@link AnalyzeHealthcareEntitiesResultCollection} model that maintains a list of + * Creates a {@link AnalyzeHealthcareEntitiesResultCollection} model that maintains a list of * {@link AnalyzeHealthcareEntitiesResult} along with model version and batch's statistics. * * @param documentResults A list of {@link AnalyzeHealthcareEntitiesResult}. @@ -59,7 +59,7 @@ public String getModelVersion() { /** * Gets the healthcare document result statistics properties. * - * @return the healthcare document result statistics properties. + * @return The healthcare document result statistics properties. */ public TextDocumentBatchStatistics getStatistics() { return statistics; diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeSentimentResultCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeSentimentResultCollection.java index f9d4b9f1497aa..1eabe61d2837c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeSentimentResultCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/AnalyzeSentimentResultCollection.java @@ -15,7 +15,7 @@ public class AnalyzeSentimentResultCollection extends IterableStream documen } /** - * Get the model version trained in service for the request. + * Gets the model version trained in service for the request. * * @return The model version trained in service for the request. */ @@ -39,7 +39,7 @@ public String getModelVersion() { } /** - * Get the batch statistics of response. + * Gets the batch statistics of response. * * @return The batch statistics of response. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/DetectLanguageResultCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/DetectLanguageResultCollection.java index 467e201f9ed1b..6ac10fee6e766 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/DetectLanguageResultCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/DetectLanguageResultCollection.java @@ -15,7 +15,7 @@ public class DetectLanguageResultCollection extends IterableStream documentRes } /** - * Get the model version trained in service for the request. + * Gets the model version trained in service for the request. * * @return The model version trained in service for the request. */ @@ -39,7 +39,7 @@ public String getModelVersion() { } /** - * Get the batch statistics of response. + * Gets the batch statistics of response. * * @return The batch statistics of response. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/ExtractKeyPhrasesResultCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/ExtractKeyPhrasesResultCollection.java index 69487ca88948d..d969396b14ad8 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/ExtractKeyPhrasesResultCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/ExtractKeyPhrasesResultCollection.java @@ -15,7 +15,7 @@ public class ExtractKeyPhrasesResultCollection extends IterableStream docume } /** - * Get the model version trained in service for the request. + * Gets the model version trained in service for the request. * * @return The model version trained in service for the request. */ @@ -39,7 +39,7 @@ public String getModelVersion() { } /** - * Get the batch statistics of response. + * Gets the batch statistics of response. * * @return The batch statistics of response. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeEntitiesResultCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeEntitiesResultCollection.java index 0393446f04f6f..7537d58f2a87b 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeEntitiesResultCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeEntitiesResultCollection.java @@ -15,7 +15,7 @@ public class RecognizeEntitiesResultCollection extends IterableStream docum } /** - * Get the model version trained in service for the request. + * Gets the model version trained in service for the request. * * @return The model version trained in service for the request. */ @@ -39,7 +39,7 @@ public String getModelVersion() { } /** - * Get the batch statistics of response. + * Gets the batch statistics of response. * * @return The batch statistics of response. */ diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeLinkedEntitiesResultCollection.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeLinkedEntitiesResultCollection.java index e3bf8d3f8e500..87f6ba08235a7 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeLinkedEntitiesResultCollection.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/util/RecognizeLinkedEntitiesResultCollection.java @@ -15,7 +15,7 @@ public class RecognizeLinkedEntitiesResultCollection extends IterableStream } /** - * Get the model version trained in service for the request. + * Gets the model version trained in service for the request. * * @return The model version trained in service for the request. */ @@ -42,7 +42,7 @@ public String getModelVersion() { } /** - * Get the batch statistics of response. + * Gets the batch statistics of response. * * @return The batch statistics of response. */