com.ibm.watson.natural_language_understanding.v1.model.EntitiesOptions Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2017, 2020.
*
* 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;
/**
* Identifies people, cities, organizations, and other entities in the content. For more
* information, see [Entity types and
* subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types).
*
* Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian,
* Spanish, Swedish. Arabic, Chinese, and Dutch are supported only through custom models.
*/
public class EntitiesOptions extends GenericModel {
protected Long limit;
protected Boolean mentions;
protected String model;
protected Boolean sentiment;
protected Boolean emotion;
/** Builder. */
public static class Builder {
private Long limit;
private Boolean mentions;
private String model;
private Boolean sentiment;
private Boolean emotion;
private Builder(EntitiesOptions entitiesOptions) {
this.limit = entitiesOptions.limit;
this.mentions = entitiesOptions.mentions;
this.model = entitiesOptions.model;
this.sentiment = entitiesOptions.sentiment;
this.emotion = entitiesOptions.emotion;
}
/** Instantiates a new builder. */
public Builder() {}
/**
* Builds a EntitiesOptions.
*
* @return the new EntitiesOptions instance
*/
public EntitiesOptions build() {
return new EntitiesOptions(this);
}
/**
* Set the limit.
*
* @param limit the limit
* @return the EntitiesOptions builder
*/
public Builder limit(long limit) {
this.limit = limit;
return this;
}
/**
* Set the mentions.
*
* @param mentions the mentions
* @return the EntitiesOptions builder
*/
public Builder mentions(Boolean mentions) {
this.mentions = mentions;
return this;
}
/**
* Set the model.
*
* @param model the model
* @return the EntitiesOptions builder
*/
public Builder model(String model) {
this.model = model;
return this;
}
/**
* Set the sentiment.
*
* @param sentiment the sentiment
* @return the EntitiesOptions builder
*/
public Builder sentiment(Boolean sentiment) {
this.sentiment = sentiment;
return this;
}
/**
* Set the emotion.
*
* @param emotion the emotion
* @return the EntitiesOptions builder
*/
public Builder emotion(Boolean emotion) {
this.emotion = emotion;
return this;
}
}
protected EntitiesOptions(Builder builder) {
limit = builder.limit;
mentions = builder.mentions;
model = builder.model;
sentiment = builder.sentiment;
emotion = builder.emotion;
}
/**
* New builder.
*
* @return a EntitiesOptions builder
*/
public Builder newBuilder() {
return new Builder(this);
}
/**
* Gets the limit.
*
*
Maximum number of entities to return.
*
* @return the limit
*/
public Long limit() {
return limit;
}
/**
* Gets the mentions.
*
*
Set this to `true` to return locations of entity mentions.
*
* @return the mentions
*/
public Boolean mentions() {
return mentions;
}
/**
* Gets the model.
*
*
Enter a [custom
* model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing)
* ID to override the standard entity detection model.
*
* @return the model
*/
public String model() {
return model;
}
/**
* Gets the sentiment.
*
*
Set this to `true` to return sentiment information for detected entities.
*
* @return the sentiment
*/
public Boolean sentiment() {
return sentiment;
}
/**
* Gets the emotion.
*
*
Set this to `true` to analyze emotion for detected keywords.
*
* @return the emotion
*/
public Boolean emotion() {
return emotion;
}
}