com.ibm.watson.natural_language_understanding.v1.model

Class AnalyzeOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.natural_language_understanding.v1.model.AnalyzeOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class AnalyzeOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The analyze options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalyzeOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	clean
protected java.lang.Boolean	fallbackToRaw
protected Features	features
protected java.lang.String	html
protected java.lang.String	language
protected java.lang.Long	limitTextCharacters
protected java.lang.Boolean	returnAnalyzedText
protected java.lang.String	text
protected java.lang.String	url
protected java.lang.String	xpath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnalyzeOptions(AnalyzeOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	clean() Gets the clean.
java.lang.Boolean	fallbackToRaw() Gets the fallbackToRaw.
Features	features() Gets the features.
java.lang.String	html() Gets the html.
java.lang.String	language() Gets the language.
java.lang.Long	limitTextCharacters() Gets the limitTextCharacters.
AnalyzeOptions.Builder	newBuilder() New builder.
java.lang.Boolean	returnAnalyzedText() Gets the returnAnalyzedText.
java.lang.String	text() Gets the text.
java.lang.String	url() Gets the url.
java.lang.String	xpath() Gets the xpath.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

features

protected Features features

text

protected java.lang.String text

html

protected java.lang.String html

url

protected java.lang.String url

clean

protected java.lang.Boolean clean

xpath

protected java.lang.String xpath

fallbackToRaw

protected java.lang.Boolean fallbackToRaw

returnAnalyzedText

protected java.lang.Boolean returnAnalyzedText

language

protected java.lang.String language

limitTextCharacters

protected java.lang.Long limitTextCharacters

Constructor Detail

AnalyzeOptions

protected AnalyzeOptions(AnalyzeOptions.Builder builder)

Method Detail

newBuilder

public AnalyzeOptions.Builder newBuilder()

New builder.

Returns:

a AnalyzeOptions builder

features

public Features features()

Gets the features.

Specific features to analyze the document for.

Returns:

the features

text

public java.lang.String text()

Gets the text.

The plain text to analyze. One of the `text`, `html`, or `url` parameters is required.

Returns:

the text

html

public java.lang.String html()

Gets the html.

The HTML file to analyze. One of the `text`, `html`, or `url` parameters is required.

Returns:

the html

url

public java.lang.String url()

Gets the url.

The webpage to analyze. One of the `text`, `html`, or `url` parameters is required.

Returns:

the url

clean

public java.lang.Boolean clean()

Gets the clean.

Set this to `false` to disable webpage cleaning. To learn more about webpage cleaning, see the [Analyzing webpages](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages) documentation.

Returns:

the clean

xpath

public java.lang.String xpath()

Gets the xpath.

An [XPath query](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages#xpath) to perform on `html` or `url` input. Results of the query will be appended to the cleaned webpage text before it is analyzed. To analyze only the results of the XPath query, set the `clean` parameter to `false`.

Returns:

the xpath

fallbackToRaw

public java.lang.Boolean fallbackToRaw()

Gets the fallbackToRaw.

Whether to use raw HTML content if text cleaning fails.

Returns:

the fallbackToRaw

returnAnalyzedText

public java.lang.Boolean returnAnalyzedText()

Gets the returnAnalyzedText.

Whether or not to return the analyzed text.

Returns:

the returnAnalyzedText

language

public java.lang.String language()

Gets the language.

ISO 639-1 code that specifies the language of your text. This overrides automatic language detection. Language support differs depending on the features you include in your analysis. See [Language support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support) for more information.

Returns:

the language

limitTextCharacters

public java.lang.Long limitTextCharacters()

Gets the limitTextCharacters.

Sets the maximum number of characters that are processed by the service.

Returns:

the limitTextCharacters