TextAnalytics Interface

Package:

com.microsoft.azure.cognitiveservices.language.textanalytics

public interface TextAnalytics

An instance of this class provides access to all the operations defined in TextAnalytics.

Method Summary

Modifier and Type	Method and Description
TextAnalyticsDetectLanguageDefinitionStages.WithExecute	detectLanguage() The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.
LanguageBatchResult	detectLanguage(DetectLanguageOptionalParameter detectLanguageOptionalParameter) The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.
Observable<LanguageBatchResult>	detectLanguageAsync(DetectLanguageOptionalParameter detectLanguageOptionalParameter) The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.
TextAnalyticsEntitiesDefinitionStages.WithExecute	entities() The API returns a list of recognized entities in a given document. To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.
EntitiesBatchResult	entities(EntitiesOptionalParameter entitiesOptionalParameter) The API returns a list of recognized entities in a given document. To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.
Observable<EntitiesBatchResult>	entitiesAsync(EntitiesOptionalParameter entitiesOptionalParameter) The API returns a list of recognized entities in a given document. To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.
TextAnalyticsKeyPhrasesDefinitionStages.WithExecute	keyPhrases() The API returns a list of strings denoting the key talking points in the input text. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by key phrase extraction.
KeyPhraseBatchResult	keyPhrases(KeyPhrasesOptionalParameter keyPhrasesOptionalParameter) The API returns a list of strings denoting the key talking points in the input text. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by key phrase extraction.
Observable<KeyPhraseBatchResult>	keyPhrasesAsync(KeyPhrasesOptionalParameter keyPhrasesOptionalParameter) The API returns a list of strings denoting the key talking points in the input text. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by key phrase extraction.
TextAnalyticsSentimentDefinitionStages.WithExecute	sentiment() The API returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by sentiment analysis.
SentimentBatchResult	sentiment(SentimentOptionalParameter sentimentOptionalParameter) The API returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by sentiment analysis.
Observable<SentimentBatchResult>	sentimentAsync(SentimentOptionalParameter sentimentOptionalParameter) The API returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by sentiment analysis.

Method Details

detectLanguage

public TextAnalyticsDetectLanguageDefinitionStages.WithExecute detectLanguage()

The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.

Returns:

the first stage of the detectLanguage call

detectLanguage

public LanguageBatchResult detectLanguage(DetectLanguageOptionalParameter detectLanguageOptionalParameter)

The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.

Parameters:

detectLanguageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the LanguageBatchResult object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

detectLanguageAsync

public Observable detectLanguageAsync(DetectLanguageOptionalParameter detectLanguageOptionalParameter)

The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.

Parameters:

detectLanguageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the LanguageBatchResult object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

entities

public TextAnalyticsEntitiesDefinitionStages.WithExecute entities()

The API returns a list of recognized entities in a given document. To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.

Returns:

the first stage of the entities call

entities

public EntitiesBatchResult entities(EntitiesOptionalParameter entitiesOptionalParameter)

The API returns a list of recognized entities in a given document. To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.

Parameters:

entitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the EntitiesBatchResult object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

entitiesAsync

public Observable entitiesAsync(EntitiesOptionalParameter entitiesOptionalParameter)

The API returns a list of recognized entities in a given document. To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.

Parameters:

entitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the EntitiesBatchResult object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

keyPhrases

public TextAnalyticsKeyPhrasesDefinitionStages.WithExecute keyPhrases()

The API returns a list of strings denoting the key talking points in the input text. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by key phrase extraction.

Returns:

the first stage of the keyPhrases call

keyPhrases

public KeyPhraseBatchResult keyPhrases(KeyPhrasesOptionalParameter keyPhrasesOptionalParameter)

The API returns a list of strings denoting the key talking points in the input text. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by key phrase extraction.

Parameters:

keyPhrasesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the KeyPhraseBatchResult object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

keyPhrasesAsync

public Observable keyPhrasesAsync(KeyPhrasesOptionalParameter keyPhrasesOptionalParameter)

The API returns a list of strings denoting the key talking points in the input text. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by key phrase extraction.

Parameters:

keyPhrasesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the KeyPhraseBatchResult object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

sentiment

public TextAnalyticsSentimentDefinitionStages.WithExecute sentiment()

The API returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by sentiment analysis.

Returns:

the first stage of the sentiment call

sentiment

public SentimentBatchResult sentiment(SentimentOptionalParameter sentimentOptionalParameter)

The API returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by sentiment analysis.

Parameters:

sentimentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the SentimentBatchResult object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

sentimentAsync

public Observable sentimentAsync(SentimentOptionalParameter sentimentOptionalParameter)

The API returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by sentiment analysis.

Parameters:

sentimentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the SentimentBatchResult object

Throws:

IllegalArgumentException - thrown if parameters fail the validation