Package com.ibm.watson.discovery.v2.model

Class QueryCollectionNoticesOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.discovery.v2.model.QueryCollectionNoticesOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class QueryCollectionNoticesOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
The queryCollectionNotices options.

  • Method Details

    • newBuilder

      public QueryCollectionNoticesOptions.Builder newBuilder()
      New builder.
      Returns:
      a QueryCollectionNoticesOptions builder

    • projectId

      public 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

    • collectionId

      public String collectionId()
      Gets the collectionId.

      The ID of the collection.

      Returns:
      the collectionId

    • filter

      public 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 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 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 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 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