com.ibm.watson.natural_language_understanding.v1.model.AnalyzeOptions Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2017, 2022.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.ibm.watson.natural_language_understanding.v1.model;
import com.ibm.cloud.sdk.core.service.model.GenericModel;
/** The analyze options. */
public class AnalyzeOptions extends GenericModel {
protected Features features;
protected String text;
protected String html;
protected String url;
protected Boolean clean;
protected String xpath;
protected Boolean fallbackToRaw;
protected Boolean returnAnalyzedText;
protected String language;
protected Long limitTextCharacters;
/** Builder. */
public static class Builder {
private Features features;
private String text;
private String html;
private String url;
private Boolean clean;
private String xpath;
private Boolean fallbackToRaw;
private Boolean returnAnalyzedText;
private String language;
private Long limitTextCharacters;
private Builder(AnalyzeOptions analyzeOptions) {
this.features = analyzeOptions.features;
this.text = analyzeOptions.text;
this.html = analyzeOptions.html;
this.url = analyzeOptions.url;
this.clean = analyzeOptions.clean;
this.xpath = analyzeOptions.xpath;
this.fallbackToRaw = analyzeOptions.fallbackToRaw;
this.returnAnalyzedText = analyzeOptions.returnAnalyzedText;
this.language = analyzeOptions.language;
this.limitTextCharacters = analyzeOptions.limitTextCharacters;
}
/** Instantiates a new builder. */
public Builder() {}
/**
* Instantiates a new builder with required properties.
*
* @param features the features
*/
public Builder(Features features) {
this.features = features;
}
/**
* Builds a AnalyzeOptions.
*
* @return the new AnalyzeOptions instance
*/
public AnalyzeOptions build() {
return new AnalyzeOptions(this);
}
/**
* Set the features.
*
* @param features the features
* @return the AnalyzeOptions builder
*/
public Builder features(Features features) {
this.features = features;
return this;
}
/**
* Set the text.
*
* @param text the text
* @return the AnalyzeOptions builder
*/
public Builder text(String text) {
this.text = text;
return this;
}
/**
* Set the html.
*
* @param html the html
* @return the AnalyzeOptions builder
*/
public Builder html(String html) {
this.html = html;
return this;
}
/**
* Set the url.
*
* @param url the url
* @return the AnalyzeOptions builder
*/
public Builder url(String url) {
this.url = url;
return this;
}
/**
* Set the clean.
*
* @param clean the clean
* @return the AnalyzeOptions builder
*/
public Builder clean(Boolean clean) {
this.clean = clean;
return this;
}
/**
* Set the xpath.
*
* @param xpath the xpath
* @return the AnalyzeOptions builder
*/
public Builder xpath(String xpath) {
this.xpath = xpath;
return this;
}
/**
* Set the fallbackToRaw.
*
* @param fallbackToRaw the fallbackToRaw
* @return the AnalyzeOptions builder
*/
public Builder fallbackToRaw(Boolean fallbackToRaw) {
this.fallbackToRaw = fallbackToRaw;
return this;
}
/**
* Set the returnAnalyzedText.
*
* @param returnAnalyzedText the returnAnalyzedText
* @return the AnalyzeOptions builder
*/
public Builder returnAnalyzedText(Boolean returnAnalyzedText) {
this.returnAnalyzedText = returnAnalyzedText;
return this;
}
/**
* Set the language.
*
* @param language the language
* @return the AnalyzeOptions builder
*/
public Builder language(String language) {
this.language = language;
return this;
}
/**
* Set the limitTextCharacters.
*
* @param limitTextCharacters the limitTextCharacters
* @return the AnalyzeOptions builder
*/
public Builder limitTextCharacters(long limitTextCharacters) {
this.limitTextCharacters = limitTextCharacters;
return this;
}
}
protected AnalyzeOptions() {}
protected AnalyzeOptions(Builder builder) {
com.ibm.cloud.sdk.core.util.Validator.notNull(builder.features, "features cannot be null");
features = builder.features;
text = builder.text;
html = builder.html;
url = builder.url;
clean = builder.clean;
xpath = builder.xpath;
fallbackToRaw = builder.fallbackToRaw;
returnAnalyzedText = builder.returnAnalyzedText;
language = builder.language;
limitTextCharacters = builder.limitTextCharacters;
}
/**
* New builder.
*
* @return a AnalyzeOptions builder
*/
public Builder newBuilder() {
return new Builder(this);
}
/**
* Gets the features.
*
* Specific features to analyze the document for.
*
* @return the features
*/
public Features features() {
return features;
}
/**
* Gets the text.
*
*
The plain text to analyze. One of the `text`, `html`, or `url` parameters is required.
*
* @return the text
*/
public String text() {
return text;
}
/**
* Gets the html.
*
*
The HTML file to analyze. One of the `text`, `html`, or `url` parameters is required.
*
* @return the html
*/
public String html() {
return html;
}
/**
* Gets the url.
*
*
The webpage to analyze. One of the `text`, `html`, or `url` parameters is required.
*
* @return the url
*/
public String url() {
return url;
}
/**
* Gets the 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).
*
* @return the clean
*/
public Boolean clean() {
return clean;
}
/**
* 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`.
*
* @return the xpath
*/
public String xpath() {
return xpath;
}
/**
* Gets the fallbackToRaw.
*
*
Whether to use raw HTML content if text cleaning fails.
*
* @return the fallbackToRaw
*/
public Boolean fallbackToRaw() {
return fallbackToRaw;
}
/**
* Gets the returnAnalyzedText.
*
*
Whether or not to return the analyzed text.
*
* @return the returnAnalyzedText
*/
public Boolean returnAnalyzedText() {
return returnAnalyzedText;
}
/**
* 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. For
* more information, see [Language
* support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support).
*
* @return the language
*/
public String language() {
return language;
}
/**
* Gets the limitTextCharacters.
*
*
Sets the maximum number of characters that are processed by the service.
*
* @return the limitTextCharacters
*/
public Long limitTextCharacters() {
return limitTextCharacters;
}
}