com.azure.ai.textanalytics.models

Class TextAnalyticsActions

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsActions

public final class TextAnalyticsActions
extends Object

The TextAnalyticsActions model.

Constructor Summary

Constructors

Constructor and Description
TextAnalyticsActions()

Method Summary

Modifier and Type	Method and Description
Iterable<AnalyzeSentimentAction>	getAnalyzeSentimentActions() Gets the list of AnalyzeSentimentAction to be executed.
String	getDisplayName() Gets the custom name for the actions.
Iterable<ExtractKeyPhrasesAction>	getExtractKeyPhrasesActions() Gets the list of ExtractKeyPhrasesAction to be executed.
Iterable<RecognizeEntitiesAction>	getRecognizeEntitiesActions() Gets the list of RecognizeEntitiesAction to be executed.
Iterable<RecognizeLinkedEntitiesAction>	getRecognizeLinkedEntitiesActions() Gets the list of RecognizeLinkedEntitiesAction to be executed.
Iterable<RecognizePiiEntitiesAction>	getRecognizePiiEntitiesActions() Gets the list of RecognizePiiEntitiesAction to be executed.
TextAnalyticsActions	setAnalyzeSentimentActions(AnalyzeSentimentAction... analyzeSentimentActions) Sets the list of AnalyzeSentimentAction to be executed.
TextAnalyticsActions	setDisplayName(String displayName) Sets the custom name for the actions.
TextAnalyticsActions	setExtractKeyPhrasesActions(ExtractKeyPhrasesAction... extractKeyPhrasesActions) Sets the list of ExtractKeyPhrasesAction to be executed.
TextAnalyticsActions	setRecognizeEntitiesActions(RecognizeEntitiesAction... recognizeEntitiesActions) Sets the list of RecognizeEntitiesAction to be executed.
TextAnalyticsActions	setRecognizeLinkedEntitiesActions(RecognizeLinkedEntitiesAction... recognizeLinkedEntitiesActions) Sets the list of RecognizeLinkedEntitiesAction to be executed.
TextAnalyticsActions	setRecognizePiiEntitiesActions(RecognizePiiEntitiesAction... recognizePiiEntitiesActions) Sets the list of RecognizePiiEntitiesAction to be executed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextAnalyticsActions

public TextAnalyticsActions()

Method Detail

getDisplayName

public String getDisplayName()

Gets the custom name for the actions.

Returns:

the custom name for the actions.

setDisplayName

public TextAnalyticsActions setDisplayName(String displayName)

Sets the custom name for the actions.

Parameters:

displayName - The custom name for the actions.

Returns:

The TextAnalyticsActions object itself.

getRecognizeEntitiesActions

public Iterable<RecognizeEntitiesAction> getRecognizeEntitiesActions()

Gets the list of RecognizeEntitiesAction to be executed.

Returns:

The list of RecognizeEntitiesAction to be executed.

setRecognizeEntitiesActions

public TextAnalyticsActions setRecognizeEntitiesActions(RecognizeEntitiesAction... recognizeEntitiesActions)

Sets the list of RecognizeEntitiesAction to be executed.

Parameters:

recognizeEntitiesActions - The list of RecognizeEntitiesAction to be executed.

Returns:

The TextAnalyticsActions object itself.

Throws:

IllegalArgumentException - if more than one RecognizeEntitiesAction action are passed in. Currently service v3.1 only accepts up to one action per type.

getRecognizeLinkedEntitiesActions

public Iterable<RecognizeLinkedEntitiesAction> getRecognizeLinkedEntitiesActions()

Gets the list of RecognizeLinkedEntitiesAction to be executed.

Returns:

The list of RecognizeLinkedEntitiesAction to be executed.

setRecognizeLinkedEntitiesActions

public TextAnalyticsActions setRecognizeLinkedEntitiesActions(RecognizeLinkedEntitiesAction... recognizeLinkedEntitiesActions)

Sets the list of RecognizeLinkedEntitiesAction to be executed.

Parameters:

recognizeLinkedEntitiesActions - The list of RecognizeLinkedEntitiesAction to be executed.

Returns:

The TextAnalyticsActions object itself.

Throws:

IllegalArgumentException - if more than one RecognizeLinkedEntitiesAction action are passed in. Currently service v3.1 only accepts up to one action per type.

getRecognizePiiEntitiesActions

public Iterable<RecognizePiiEntitiesAction> getRecognizePiiEntitiesActions()

Gets the list of RecognizePiiEntitiesAction to be executed.

Returns:

The list of RecognizePiiEntitiesAction to be executed.

setRecognizePiiEntitiesActions

public TextAnalyticsActions setRecognizePiiEntitiesActions(RecognizePiiEntitiesAction... recognizePiiEntitiesActions)

Sets the list of RecognizePiiEntitiesAction to be executed.

Parameters:

recognizePiiEntitiesActions - The list of RecognizePiiEntitiesAction to be executed.

Returns:

The TextAnalyticsActions object itself.

Throws:

IllegalArgumentException - if more than one RecognizePiiEntitiesAction action are passed in. Currently service v3.1 only accepts up to one action per type.

getExtractKeyPhrasesActions

public Iterable<ExtractKeyPhrasesAction> getExtractKeyPhrasesActions()

Gets the list of ExtractKeyPhrasesAction to be executed.

Returns:

The list of ExtractKeyPhrasesAction to be executed.

setExtractKeyPhrasesActions

public TextAnalyticsActions setExtractKeyPhrasesActions(ExtractKeyPhrasesAction... extractKeyPhrasesActions)

Sets the list of ExtractKeyPhrasesAction to be executed.

Parameters:

extractKeyPhrasesActions - The list of ExtractKeyPhrasesAction to be executed.

Returns:

The TextAnalyticsActions object itself.

Throws:

IllegalArgumentException - if more than one ExtractKeyPhrasesAction action are passed in. Currently service v3.1 only accepts up to one action per type.

getAnalyzeSentimentActions

public Iterable<AnalyzeSentimentAction> getAnalyzeSentimentActions()

Gets the list of AnalyzeSentimentAction to be executed.

Returns:

The list of AnalyzeSentimentAction to be executed.

setAnalyzeSentimentActions

public TextAnalyticsActions setAnalyzeSentimentActions(AnalyzeSentimentAction... analyzeSentimentActions)

Sets the list of AnalyzeSentimentAction to be executed.

Parameters:

analyzeSentimentActions - The list of AnalyzeSentimentAction to be executed.

Returns:

The TextAnalyticsActions object itself.

Throws:

IllegalArgumentException - if more than one AnalyzeSentimentAction action are passed in. Currently service v3.1 only accepts up to one action per type.