TextAnalyticsAPI Interface

Package:

com.microsoft.azure.cognitiveservices.language.textanalytics

public interface TextAnalyticsAPI

The interface for TextAnalyticsAPI class.

Method Summary

Modifier and Type	Method and Description
String	acceptLanguage() Gets Gets or sets the preferred language for the response..
AzureRegions	azureRegion() Gets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.
boolean	generateClientRequestId() Gets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..
AzureClient	getAzureClient() Gets the AzureClient used for long running operations.
int	longRunningOperationRetryTimeout() Gets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..
RestClient	restClient() Gets the REST client.
TextAnalytics	textAnalytics() Gets the TextAnalytics object to access its operations.
String	userAgent() Gets the User-Agent header for the client.
TextAnalyticsAPI	withAcceptLanguage(String acceptLanguage) Sets Gets or sets the preferred language for the response..
TextAnalyticsAPI	withAzureRegion(AzureRegions azureRegion) Sets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.
TextAnalyticsAPI	withGenerateClientRequestId(boolean generateClientRequestId) Sets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..
TextAnalyticsAPI	withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout) Sets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Method Details

acceptLanguage

public String acceptLanguage()

Gets Gets or sets the preferred language for the response..

Returns:

the acceptLanguage value.

azureRegion

public AzureRegions azureRegion()

Gets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.

Returns:

the azureRegion value.

generateClientRequestId

public boolean generateClientRequestId()

Gets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..

Returns:

the generateClientRequestId value.

getAzureClient

public AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

Returns:

the azure client;

longRunningOperationRetryTimeout

public int longRunningOperationRetryTimeout()

Gets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Returns:

the longRunningOperationRetryTimeout value.

restClient

public RestClient restClient()

Gets the REST client.

Returns:

the RestClient object.

textAnalytics

public TextAnalytics textAnalytics()

Gets the TextAnalytics object to access its operations.

Returns:

the TextAnalytics object.

userAgent

public String userAgent()

Gets the User-Agent header for the client.

Returns:

the user agent string.

withAcceptLanguage

public TextAnalyticsAPI withAcceptLanguage(String acceptLanguage)

Sets Gets or sets the preferred language for the response..

Parameters:

acceptLanguage - the acceptLanguage value.

Returns:

the service client itself

withAzureRegion

public TextAnalyticsAPI withAzureRegion(AzureRegions azureRegion)

Sets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.

Parameters:

azureRegion - the azureRegion value.

Returns:

the service client itself

withGenerateClientRequestId

public TextAnalyticsAPI withGenerateClientRequestId(boolean generateClientRequestId)

Sets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..

Parameters:

generateClientRequestId - the generateClientRequestId value.

Returns:

the service client itself

withLongRunningOperationRetryTimeout

public TextAnalyticsAPI withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

Sets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Parameters:

longRunningOperationRetryTimeout - the longRunningOperationRetryTimeout value.

Returns:

the service client itself