com.ibm.watson.discovery.v2.model

Class QueryLargeSimilar

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryLargeSimilar

All Implemented Interfaces:

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

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

Finds results from documents that are similar to documents of interest. Use this parameter to add a *More like these* function to your search. You can include this parameter with or without a **query**, **filter** or **natural_language_query** parameter.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
List<String>	documentIds() Gets the documentIds.
Boolean	enabled() Gets the enabled.
List<String>	fields() Gets the fields.
QueryLargeSimilar.Builder	newBuilder() New builder.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public QueryLargeSimilar.Builder newBuilder()

New builder.

Returns:

a QueryLargeSimilar builder

enabled

public Boolean enabled()

Gets the enabled.

When `true`, includes documents in the query results that are similar to documents you specify.

Returns:

the enabled

documentIds

public List<String> documentIds()

Gets the documentIds.

The list of documents of interest. Required if **enabled** is `true`.

Returns:

the documentIds

fields

public List<String> fields()

Gets the fields.

Looks for similarities in the specified subset of fields in the documents. If not specified, all of the document fields are used.

Returns:

the fields