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

Class DefaultQueryParams

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.discovery.v2.model.DefaultQueryParams
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class DefaultQueryParams
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Default query parameters for this project.

  • Method Details

    • newBuilder

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

    • collectionIds

      public List<String> collectionIds()
      Gets the collectionIds.

      An array of collection identifiers to query. If empty or omitted all collections in the project are queried.

      Returns:
      the collectionIds

    • passages

      public DefaultQueryParamsPassages passages()
      Gets the passages.

      Default settings configuration for passage search options.

      Returns:
      the passages

    • tableResults

      public DefaultQueryParamsTableResults tableResults()
      Gets the tableResults.

      Default project query settings for table results.

      Returns:
      the tableResults

    • aggregation

      public String aggregation()
      Gets the aggregation.

      A string representing the default aggregation query for the project.

      Returns:
      the aggregation

    • suggestedRefinements

      public DefaultQueryParamsSuggestedRefinements suggestedRefinements()
      Gets the suggestedRefinements.

      Object that contains suggested refinement settings. Available with Premium plans only.

      Returns:
      the suggestedRefinements

    • spellingSuggestions

      public Boolean spellingSuggestions()
      Gets the spellingSuggestions.

      When `true`, a spelling suggestions for the query are returned by default.

      Returns:
      the spellingSuggestions

    • highlight

      public Boolean highlight()
      Gets the highlight.

      When `true`, a highlights for the query are returned by default.

      Returns:
      the highlight

    • count

      public Long count()
      Gets the count.

      The number of document results returned by default.

      Returns:
      the count

    • sort

      public String sort()
      Gets the sort.

      A comma separated list of document fields to sort results by default.

      Returns:
      the sort

    • xReturn

      public List<String> xReturn()
      Gets the xReturn.

      An array of field names to return in document results if present by default.

      Returns:
      the xReturn