com.ibm.watson.developer_cloud.discovery.v1.model

Class QueryEntitiesOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.discovery.v1.model.QueryEntitiesOptions

All Implemented Interfaces:

ObjectModel

public class QueryEntitiesOptions
extends GenericModel

The queryEntities options.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	collectionId() Gets the collectionId.
QueryEntitiesContext	context() Gets the context.
java.lang.Long	count() Gets the count.
QueryEntitiesEntity	entity() Gets the entity.
java.lang.String	environmentId() Gets the environmentId.
java.lang.Long	evidenceCount() Gets the evidenceCount.
java.lang.String	feature() Gets the feature.
QueryEntitiesOptions.Builder	newBuilder() New builder.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public QueryEntitiesOptions.Builder newBuilder()

New builder.

Returns:

a QueryEntitiesOptions builder

environmentId

public java.lang.String environmentId()

Gets the environmentId. The ID of the environment.

Returns:

the environmentId

collectionId

public java.lang.String collectionId()

Gets the collectionId. The ID of the collection.

Returns:

the collectionId

feature

public java.lang.String feature()

Gets the feature. The entity query feature to perform. Supported features are `disambiguate` and `similar_entities`.

Returns:

the feature

entity

public QueryEntitiesEntity entity()

Gets the entity. A text string that appears within the entity text field.

Returns:

the entity

context

public QueryEntitiesContext context()

Gets the context. Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`.

Returns:

the context

count

public java.lang.Long count()

Gets the count. The number of results to return. The default is `10`. The maximum is `1000`.

Returns:

the count

evidenceCount

public java.lang.Long evidenceCount()

Gets the evidenceCount. The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items per query is 10,000.

Returns:

the evidenceCount