com.ibm.watson.discovery.v1.model

Class QueryRelationsOptions

java.lang.Object

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

com.ibm.watson.discovery.v1.model.QueryRelationsOptions

All Implemented Interfaces:

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

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

The queryRelations options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryRelationsOptions.Builder Builder.
static interface	QueryRelationsOptions.Sort The sorting method for the relationships, can be `score` or `frequency`.

Method Summary

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.
java.util.List<QueryRelationsEntity>	entities() Gets the entities.
java.lang.String	environmentId() Gets the environmentId.
java.lang.Long	evidenceCount() Gets the evidenceCount.
QueryRelationsFilter	filter() Gets the filter.
QueryRelationsOptions.Builder	newBuilder() New builder.
java.lang.String	sort() Gets the sort.

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

Method Detail

newBuilder

public QueryRelationsOptions.Builder newBuilder()

New builder.

Returns:

a QueryRelationsOptions 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

entities

public java.util.List<QueryRelationsEntity> entities()

Gets the entities. An array of entities to find relationships for.

Returns:

the entities

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

sort

public java.lang.String sort()

Gets the sort. The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times each entity is identified. The default is `score`. This parameter cannot be used in the same query as the **bias** parameter.

Returns:

the sort

filter

public QueryRelationsFilter filter()

Gets the filter.

Returns:

the filter

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