com.ibm.watson.discovery.v2.model

Class QueryNoticesOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryNoticesOptions

All Implemented Interfaces:

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

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

The queryNotices options.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	count
protected java.lang.String	filter
protected java.lang.String	naturalLanguageQuery
protected java.lang.Long	offset
protected java.lang.String	projectId
protected java.lang.String	query

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryNoticesOptions(QueryNoticesOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	count() Gets the count.
java.lang.String	filter() Gets the filter.
java.lang.String	naturalLanguageQuery() Gets the naturalLanguageQuery.
QueryNoticesOptions.Builder	newBuilder() New builder.
java.lang.Long	offset() Gets the offset.
java.lang.String	projectId() Gets the projectId.
java.lang.String	query() Gets the query.

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

Field Detail

projectId

protected java.lang.String projectId

filter

protected java.lang.String filter

query

protected java.lang.String query

naturalLanguageQuery

protected java.lang.String naturalLanguageQuery

count

protected java.lang.Long count

offset

protected java.lang.Long offset

Constructor Detail

QueryNoticesOptions

protected QueryNoticesOptions(QueryNoticesOptions.Builder builder)

Method Detail

newBuilder

public QueryNoticesOptions.Builder newBuilder()

New builder.

Returns:

a QueryNoticesOptions builder

projectId

public java.lang.String projectId()

Gets the projectId.

The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Returns:

the projectId

filter

public java.lang.String filter()

Gets the filter.

A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.

Returns:

the filter

query

public java.lang.String query()

Gets the query.

A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.

Returns:

the query

naturalLanguageQuery

public java.lang.String naturalLanguageQuery()

Gets the naturalLanguageQuery.

A natural language query that returns relevant documents by utilizing training data and natural language understanding.

Returns:

the naturalLanguageQuery

count

public java.lang.Long count()

Gets the count.

Number of results to return. The maximum for the **count** and **offset** values together in any one query is **10000**.

Returns:

the count

offset

public java.lang.Long offset()

Gets the offset.

The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the **count** and **offset** values together in any one query is **10000**.

Returns:

the offset