public class AnalyzeOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
AnalyzeOptions.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
Boolean |
clean()
Gets the clean.
|
Boolean |
fallbackToRaw()
Gets the fallbackToRaw.
|
Features |
features()
Gets the features.
|
String |
html()
Gets the html.
|
String |
language()
Gets the language.
|
Long |
limitTextCharacters()
Gets the limitTextCharacters.
|
AnalyzeOptions.Builder |
newBuilder()
New builder.
|
Boolean |
returnAnalyzedText()
Gets the returnAnalyzedText.
|
String |
text()
Gets the text.
|
String |
url()
Gets the url.
|
String |
xpath()
Gets the xpath.
|
public AnalyzeOptions.Builder newBuilder()
public Features features()
Specific features to analyze the document for.
public String text()
The plain text to analyze. One of the `text`, `html`, or `url` parameters is required.
public String html()
The HTML file to analyze. One of the `text`, `html`, or `url` parameters is required.
public String url()
The webpage to analyze. One of the `text`, `html`, or `url` parameters is required.
public Boolean clean()
Set this to `false` to disable webpage cleaning. For more information about webpage cleaning, see [Analyzing webpages](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages).
public String 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`.
public Boolean fallbackToRaw()
Whether to use raw HTML content if text cleaning fails.
public Boolean returnAnalyzedText()
Whether or not to return the analyzed text.
public String 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. For more information, see [Language support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support).
public Long limitTextCharacters()
Sets the maximum number of characters that are processed by the service.
Copyright © 2023 IBM Cloud. All rights reserved.