Query (GroupBy - API - Java 2.6.29 API)

java.lang.Object
- com.groupbyinc.api.Query

public class Query
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

Query()

Constructors
Constructor and Description
`Query()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Query`	`addBias(java.lang.String name, java.lang.String content, com.groupbyinc.api.model.Bias.Strength strength)` `See setBiasing(Biasing).`
`Query`	`addCustomUrlParam(com.groupbyinc.api.model.CustomUrlParam customUrlParam)` `Sets any additional parameters that can be used to trigger rules.`
`Query`	`addCustomUrlParam(java.lang.String key, java.lang.String value)` `Sets any additional parameters that can be used to trigger rules.`
`Query`	`addCustomUrlParamsByString(java.lang.String values)` `Helper method that takes a ~ separated string of additional parameters that can be used to trigger rules.`
`Query`	`addExcludedNavigations(java.lang.String... navigationName)` `Specify which navigations should not be returned.`
`protected Query`	`addField(java.util.List<java.lang.String> fields, java.lang.String... name)`
`Query`	`addFields(java.lang.String... name)` `Specify which fields should be returned on each record that comes back from the engine.`
`Query`	`addIncludedNavigations(java.lang.String... navigationName)` `An array that specifies which navigations should be returned.`
`Query`	`addOrField(java.lang.String... name)` `Specify which fields should be queried with 'OR' instead of the default 'AND'.`
`Query`	`addQueryUrlParams(java.lang.String key)` `See setQueryUrlParams(Map).`
`Query`	`addQueryUrlParams(java.lang.String key, java.lang.String value)` `See setQueryUrlParams(Map).`
`Query`	`addRangeRefinement(java.lang.String navigationName, java.lang.String low, java.lang.String high)` `Add a range refinement.`
`Query`	`addRangeRefinement(java.lang.String navigationName, java.lang.String low, java.lang.String high, boolean exclude)` `Add a range refinement.`
`Query`	`addRefinementsByString(java.lang.String refinementString)` `A helper method to parse and set refinements.`
`Query`	`addValueRefinement(java.lang.String navigationName, java.lang.String value)` `Add a value refinement.`
`Query`	`addValueRefinement(java.lang.String navigationName, java.lang.String value, boolean exclude)` `Add a value refinement.`
`protected static com.groupbyinc.api.request.Biasing`	`convertBiasing(com.groupbyinc.api.model.Biasing biasing)`
`protected static com.groupbyinc.api.request.MatchStrategy`	`convertPartialMatchStrategy(com.groupbyinc.api.model.MatchStrategy strategy)`
`protected static com.groupbyinc.api.request.Sort`	`convertSort(com.groupbyinc.api.model.Sort sort)`
`java.lang.String`	`getArea()`
`com.groupbyinc.api.model.Biasing`	`getBiasing()`
`java.lang.String`	`getBiasingProfile()`
`java.lang.String`	`getBridgeJson(java.lang.String clientKey)` `Used internally by the bridge object to generate the JSON that is sent to the search service.`
`protected java.lang.String`	`getBridgeJsonRefinementSearch(java.lang.String clientKey)`
`java.lang.String`	`getBridgeRefinementsJson(java.lang.String clientKey, java.lang.String navigationName)` `Used internally by the bridge object to generate the JSON that is sent to the search service.`
`java.lang.String`	`getCollection()`
`java.util.List<com.groupbyinc.api.model.CustomUrlParam>`	`getCustomUrlParams()`
`java.lang.String`	`getCustomUrlParamsString()`
`java.util.List<java.lang.String>`	`getExcludeNavigations()`
`java.util.List<java.lang.String>`	`getFields()`
`java.util.List<java.lang.String>`	`getIncludeNavigations()`
`java.lang.String`	`getLanguage()`
`com.groupbyinc.api.model.MatchStrategy`	`getMatchStrategy()`
`java.lang.String`	`getMatchStrategyName()`
`java.util.Map<java.lang.String,com.groupbyinc.api.model.Navigation>`	`getNavigations()`
`java.util.List<java.lang.String>`	`getOrFields()`
`int`	`getPageSize()`
`java.lang.String`	`getQuery()`
`java.util.Map<java.lang.String,java.lang.String>`	`getQueryUrlParams()`
`java.lang.String`	`getRefinementString()`
`java.lang.String`	`getSessionId()`
`int`	`getSkip()`
`java.util.List<com.groupbyinc.api.model.Sort>`	`getSort()`
`java.lang.String`	`getSubCollection()` Deprecated. since 2.0, use getCollection instead.
`java.lang.String`	`getVisitorId()`
`boolean`	`isAutocorrectionDisabled()`
`boolean`	`isBot()`
`boolean`	`isPruneRefinements()`
`boolean`	`isReturnBinary()`
`boolean`	`isWildcardSearchEnabled()`
`Query`	`setArea(java.lang.String area)` `The area you wish to fire against, production, staging, etc...`
`Query`	`setBiasing(com.groupbyinc.api.model.Biasing biasing)` `Add a biasing profile, which is defined at query time.`
`Query`	`setBiasingAugment(boolean augment)` `See setBiasing(Biasing).`
`Query`	`setBiasingProfile(java.lang.String biasingProfile)` `Override the biasing profile used for this query - takes precedence over any biasing profile set in the command center.`
`void`	`setBot(boolean bot)` `Url Parameter to indicate whether this query is bot traffic or not.`
`Query`	`setBringToTop(java.lang.String... bringToTop)` `See setBiasing(Biasing).`
`Query`	`setCollection(java.lang.String collection)` `The collection to use.`
`Query`	`setDisableAutocorrection(boolean disableAutocorrection)` `Specifies whether the auto-correction behavior should be disabled.`
`Query`	`setInfluence(java.lang.Float influence)` `See setBiasing(Biasing).`
`Query`	`setLanguage(java.lang.String language)` `Sets the language filter on the query and restricts the results to a certain language.`
`Query`	`setMatchStrategy(com.groupbyinc.api.model.MatchStrategy matchStrategy)` `A match strategy allows you to explicitly manage recall on a per query basis.`
`Query`	`setMatchStrategyName(java.lang.String matchStrategyName)` `Override the match strategy used for this query - takes precedence over any match strategy set in the command center.`
`Query`	`setPageSize(int pageSize)` `Page size.`
`Query`	`setPinnedRefinements(java.lang.String navigationName, java.util.List<java.lang.String> values)` `By default, the engine will return up to twenty refinements for a navigation.`
`Query`	`setPinnedRefinements(java.lang.String navigationName, java.lang.String... values)` `Add pinned value refinement.`
`Query`	`setPruneRefinements(boolean pruneRefinements)` \| Parameter \| Default State \| \|----\|----\| \|`pruneRefinements` \| `true` \| By default, the engine will only return refinements that make a difference in the returned results.
`Query`	`setQuery(java.lang.String query)` `Set a search string.`
`Query`	`setQueryUrlParams(java.util.Map<java.lang.String,java.lang.String> queryUrlParams)` `Sets the query level url parameters.`
`Query`	`setRestrictNavigation(com.groupbyinc.api.request.RestrictNavigation restrictNavigation)` `Warning This will count as two queries against your search index.`
`Query`	`setRestrictNavigation(java.lang.String name, int count)` `Warning See setRestrictNavigation(RestrictNavigation).`
`Query`	`setRestrictToIds(java.lang.String... restrictToIds)` `See setBiasing(Biasing).`
`Query`	`setReturnBinary(boolean returnBinary)` `Tells the search service to return binary data.`
`Query`	`setSecuredPayload(com.groupbyinc.common.security.AesContent securedPayload)` `Add a secured payload to the query.`
`Query`	`setSessionId(java.lang.String sessionId)` `A unique string identifier of the session that your customer is currently in.`
`Query`	`setSkip(int skip)` `Tell the search service to offset by N records.`
`Query`	`setSort(com.groupbyinc.api.model.Sort... sort)` `Specifies the sort order applied to the fields in the order specified.`
`Query`	`setSubCollection(java.lang.String subCollection)` Deprecated. since 2.0, use setCollection instead.
`Query`	`setVisitorId(java.lang.String visitorId)` `A unique string identifier of an end customer.`
`Query`	`setWildcardSearchEnabled(boolean wildcardSearchEnabled)` `Indicate if the *(star) character in the search string should be treated as a wildcard prefix search.`
`protected java.lang.String[]`	`splitRefinements(java.lang.String refinementString)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Query
```
public Query()
```
- Method Detail
  - getBridgeJson
```
public java.lang.String getBridgeJson(java.lang.String clientKey)
```
    Used internally by the bridge object to generate the JSON that is sent to the search service.
    
    Parameters:
    
    clientKey - The client key used to authenticate this request.
    
    Returns:
    
    A JSON representation of this query object.
  - convertBiasing
```
protected static com.groupbyinc.api.request.Biasing convertBiasing(com.groupbyinc.api.model.Biasing biasing)
```
  - getCustomUrlParams
```
public java.util.List<com.groupbyinc.api.model.CustomUrlParam> getCustomUrlParams()
```
    Returns:
    
    A list of custom url params
  - isWildcardSearchEnabled
```
public boolean isWildcardSearchEnabled()
```
  - convertSort
```
protected static com.groupbyinc.api.request.Sort convertSort(com.groupbyinc.api.model.Sort sort)
```
  - convertPartialMatchStrategy
```
protected static com.groupbyinc.api.request.MatchStrategy convertPartialMatchStrategy(com.groupbyinc.api.model.MatchStrategy strategy)
```
  - setWildcardSearchEnabled
```
public Query setWildcardSearchEnabled(boolean wildcardSearchEnabled)
```
    Indicate if the *(star) character in the search string should be treated as a wildcard prefix search. For example, `sta*` will match `star` and `start`. JSON Reference: { "wildcardSearchEnabled" : true }
    
    Parameters:
    
    wildcardSearchEnabled - true to enable wildcard search, false otherwise.
    
    Returns:
    
    the Query object itself
  - getBridgeRefinementsJson
```
public java.lang.String getBridgeRefinementsJson(java.lang.String clientKey,
                                                 java.lang.String navigationName)
```
    Used internally by the bridge object to generate the JSON that is sent to the search service.
    
    Parameters:
    
    clientKey - The client key used to authenticate this request.
    
    Returns:
    
    A JSON representation of this query object.
  - getQuery
```
public java.lang.String getQuery()
```
    Returns:
    
    The current search string.
  - setQuery
```
public Query setQuery(java.lang.String query)
```
    Set a search string. If query is blank all records are considered. There are some limits enforced on the search string, it: - must not exceed 60 characters - must not exceed 10 terms. If the limits are exceeded, the search string is truncated until all limits are satisfied. For example, the following search string The quick brown fox jumps over the colorful wide bridge into the cold river. will get truncated to: The quick brown fox jumps over the colorful wide bridge The terms `the`, `cold`, and `river` were truncated because the term limit was exceed, and `into` was also removed because the resulting string exceeded the character limit. Stop words are included in the string when determining if limits are exceeded. If there is only one term and it exceeds the character limit, the query will fail. JSON Reference: { "query": "gloves" }
    
    Parameters:
    
    query - The search string to fire against the engine.
  - getSubCollection
```
public java.lang.String getSubCollection()
```
    Deprecated. since 2.0, use getCollection instead.
    
    Returns:
    
    The data collection
  - setSubCollection
```
public Query setSubCollection(java.lang.String subCollection)
```
    Deprecated. since 2.0, use setCollection instead.
    
    Parameters:
    
    subCollection - The string representation of a collection query.
  - getCollection
```
public java.lang.String getCollection()
```
    Returns:
    
    The data collection
  - setCollection
```
public Query setCollection(java.lang.String collection)
```
    The collection to use. If you don't pass this parameter, `default` will be the collection used. This is case sensitive and should be same as your collection name. JSON Reference: { "collection": "FAQs" }
    
    Parameters:
    
    collection - The string representation of a collection query.
  - getArea
```
public java.lang.String getArea()
```
    Returns:
    
    The area name
  - setArea
```
public Query setArea(java.lang.String area)
```
    The area you wish to fire against, production, staging, etc... If not specified, the `Production` area will be used (and if one doesn't exist, an error will be returned). JSON Reference: { "area": "Development" }
    
    Parameters:
    
    area - The area name.
  - getRefinementString
```
public java.lang.String getRefinementString()
```
    Returns:
    
    A string representation of all of the currently set refinements
  - getCustomUrlParamsString
```
public java.lang.String getCustomUrlParamsString()
```
    Returns:
    
    A string representation of all of the currently set custom url parameters
  - getBridgeJsonRefinementSearch
```
protected java.lang.String getBridgeJsonRefinementSearch(java.lang.String clientKey)
```
    Parameters:
    
    clientKey - Your client key
  - addRefinementsByString
```
public Query addRefinementsByString(java.lang.String refinementString)
```
    A helper method to parse and set refinements. If you pass in refinements of the format Brand=Bose~price:20..80 The query object will correctly parse out the refinements.
    
    Parameters:
    
    refinementString - A tilde separated list of refinements
  - splitRefinements
```
protected java.lang.String[] splitRefinements(java.lang.String refinementString)
```
  - addCustomUrlParam
```
public Query addCustomUrlParam(com.groupbyinc.api.model.CustomUrlParam customUrlParam)
```
    Sets any additional parameters that can be used to trigger rules. Takes a CustomUrlParam object.
    
    Parameters:
    
    customUrlParam - The parameter to add
  - addCustomUrlParam
```
public Query addCustomUrlParam(java.lang.String key,
                               java.lang.String value)
```
    Sets any additional parameters that can be used to trigger rules. Takes a name and a value. JSON Reference: Custom URL parameters separated by ~ in the form: { "customUrlParams": [ { "key": "region", "value": "east" } ] }
    
    Parameters:
    
    key - The parameter key
    
    value - The parameter value
  - addCustomUrlParamsByString
```
public Query addCustomUrlParamsByString(java.lang.String values)
```
    Helper method that takes a ~ separated string of additional parameters that can be used to trigger rules. Takes ~ separated name/value list
    
    Parameters:
    
    values - The list of name/values
  - getFields
```
public java.util.List<java.lang.String> getFields()
```
    Returns:
    
    A list of fields that will be returned by the engine.
  - addFields
```
public Query addFields(java.lang.String... name)
```
    Specify which fields should be returned on each record that comes back from the engine. You may specify more than one field, if you specify \\* all fields will be returned. If this parameter is blank, the search service will return an error. If this parameter is omitted, the search service will return only the `title` field. The `title` field is always returned. You can exclude fields from being returned using `-`. Exclusion will take precedence over inclusion. JSON Reference: { "fields": [ "width", "brand", "height" ] } { "fields" : [ "*", "-height", "-price" ] }
    
    Parameters:
    
    name - The case-sensitive name of the attribute to return
  - addField
```
protected Query addField(java.util.List<java.lang.String> fields,
                         java.lang.String... name)
```
  - getOrFields
```
public java.util.List<java.lang.String> getOrFields()
```
    Returns:
    
    A list of the fields that the search service will treat as OR-able.
  - addOrField
```
public Query addOrField(java.lang.String... name)
```
    Specify which fields should be queried with 'OR' instead of the default 'AND'. This behavior is typically defined in command center on a per navigation basis. However, you can set which fields should be treated as an OR field at the query level if desired. As with normal refinement selections, once you have refined, the list of refinements for that selected navigation will no longer be returned. JSON Reference: { "orFields": [ "field1", "field2" ] }
    
    Parameters:
    
    name - The field that should be treated as OR by the search service before being executed.
  - addRangeRefinement
```
public Query addRangeRefinement(java.lang.String navigationName,
                                java.lang.String low,
                                java.lang.String high)
```
    Add a range refinement. Takes a refinement name, a lower and upper bounds.
    
    Parameters:
    
    navigationName - The name of the refinement
    
    low - The low value
    
    high - The high value
  - addRangeRefinement
```
public Query addRangeRefinement(java.lang.String navigationName,
                                java.lang.String low,
                                java.lang.String high,
                                boolean exclude)
```
    Add a range refinement. Takes a refinement name, a lower and upper bounds, and whether or not to exclude this refinement.
    
    Parameters:
    
    navigationName - The name of the refinement
    
    low - The low value
    
    high - The high value
    
    exclude - True if the results should exclude this range refinement, false otherwise
  - addValueRefinement
```
public Query addValueRefinement(java.lang.String navigationName,
                                java.lang.String value)
```
    Add a value refinement. Takes a refinement name and a value.
    
    Parameters:
    
    navigationName - The name of the navigation
    
    value - The refinement value
  - addValueRefinement
```
public Query addValueRefinement(java.lang.String navigationName,
                                java.lang.String value,
                                boolean exclude)
```
    Add a value refinement. Takes a refinement name, a value, and whether or not to exclude this refinement.
    
    Parameters:
    
    navigationName - The name of the navigation
    
    value - The refinement value
    
    exclude - True if the results should exclude this value refinement, false otherwise
  - setPinnedRefinements
```
public Query setPinnedRefinements(java.lang.String navigationName,
                                  java.lang.String... values)
```
    Add pinned value refinement. Takes a refinement name and a set of values.
    
    Parameters:
    
    navigationName - The name of the navigation
    
    values - The refinement values
    
    Returns:
  - setPinnedRefinements
```
public Query setPinnedRefinements(java.lang.String navigationName,
                                  java.util.List<java.lang.String> values)
```
    By default, the engine will return up to twenty refinements for a navigation. These refinements are ordered by either count or value. However, there are cases where the business may require a particular refinement to be always returned at the top of the list regardless of count or value (e.g. a promoted or 'house' brand.) These refinements can be defined as `pinnedRefinements` within the `navigations` array, so that they are always returned at the top of the list in the Search API Response. There is a limit of 20 `pinnedRefinements` per navigation. To define `pinnedRefinements`, you must always include the navigation name within the array, as shown below: JSON Reference: { "navigations": [ {"name": "brand", "pinnedRefinements": ["Apple", "Bose", "Sennheiser"]} ] }
    
    Parameters:
    
    navigationName - The name of the navigation
    
    values - The refinement values
  - getSkip
```
public int getSkip()
```
    Returns:
    
    The number of documents to skip
  - setSkip
```
public Query setSkip(int skip)
```
    Tell the search service to offset by N records. For example, if N is 10, the records returned will start at 11. JSON Reference: { "skip": 400 }
    
    Parameters:
    
    skip - The number of documents to skip
  - getPageSize
```
public int getPageSize()
```
    Returns:
    
    The current page size
  - setPageSize
```
public Query setPageSize(int pageSize)
```
    Page size. Default is 10. JSON Reference: { "pageSize": 8 }
    
    Parameters:
    
    pageSize - The number of records to return with the query.
  - getNavigations
```
public java.util.Map<java.lang.String,com.groupbyinc.api.model.Navigation> getNavigations()
```
    Returns:
    
    A map of the currently set refinements
  - isReturnBinary
```
public boolean isReturnBinary()
```
    Returns:
    
    Is return JSON set to true.
  - setReturnBinary
```
public Query setReturnBinary(boolean returnBinary)
```
    Tells the search service to return binary data. This is enabled by default in the APIs for more efficient transport. To disable this in an API, set this to `false`. JSON Reference: If passed true, informs the search service to return binary data rather than JSON. { "returnBinary": true }
    
    Parameters:
    
    returnBinary - Whether to tell the search service to return binary data rather than JSON.
  - getBiasingProfile
```
public java.lang.String getBiasingProfile()
```
    Returns:
    
    The current biasing profile name.
  - setBiasingProfile
```
public Query setBiasingProfile(java.lang.String biasingProfile)
```
    Override the biasing profile used for this query - takes precedence over any biasing profile set in the command center. JSON Reference: { "biasingProfile": "PopularityBias" }
    
    Parameters:
    
    biasingProfile - The name of the biasing profile
  - getMatchStrategyName
```
public java.lang.String getMatchStrategyName()
```
    Returns:
    
    The current match strategy name.
  - setMatchStrategyName
```
public Query setMatchStrategyName(java.lang.String matchStrategyName)
```
    Override the match strategy used for this query - takes precedence over any match strategy set in the command center. JSON Reference: { "matchStrategyName": "RelaxedMatch" }
    
    Parameters:
    
    matchStrategyName - The name of the match strategy
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns:
    
    The current language filter on the query.
  - setLanguage
```
public Query setLanguage(java.lang.String language)
```
    Sets the language filter on the query and restricts the results to a certain language. If you do not specify a language, english ("lang_en") will be considered the default. An unrecognized language will result in an error. Currently supported languages are: lang_en JSON Reference: { "language": "lang_en" }
    
    Parameters:
    
    language - The value for language restrict
  - isPruneRefinements
```
public boolean isPruneRefinements()
```
    Returns:
    
    Are refinements with zero counts being removed.
  - setPruneRefinements
```
public Query setPruneRefinements(boolean pruneRefinements)
```
    | Parameter | Default State | |----|----| |`pruneRefinements` | `true` | By default, the engine will only return refinements that make a difference in the returned results. This is called pruning. For example, let's say you search for "Nike Red Shoes", and 15 results come back. If we have refinements on Brand and Color, and they show: - `brand: Nike (15)` - `color: red (15)` ... the engine will not show those refinements by default, as they make no difference. However, if you set `pruneRefinements` to `false`, the engine will return navigations even if they make no difference in the returned set of results. JSON Reference: { pruneRefinements: false }
    
    Parameters:
    
    pruneRefinements - true to prune refinements, false other
  - isAutocorrectionDisabled
```
public boolean isAutocorrectionDisabled()
```
    Returns:
    
    Is the auto-correction behavior disabled
  - setDisableAutocorrection
```
public Query setDisableAutocorrection(boolean disableAutocorrection)
```
    Specifies whether the auto-correction behavior should be disabled. By default, when no results are returned for the given query (and there is a did-you-mean available), the first did-you-mean is automatically queried instead. Defaults to false JSON Reference: { "disableAutocorrection": false }
    
    Parameters:
    
    disableAutocorrection - true to disable autocorrection, false otherwise
  - setRestrictNavigation
```
public Query setRestrictNavigation(com.groupbyinc.api.request.RestrictNavigation restrictNavigation)
```
    Warning This will count as two queries against your search index. Typically, this feature is used when you have a large number of navigation items that will overwhelm the end user. It works by using one of the existing navigation items to decide what the query is about and fires a second query to restrict the navigation to the most relevant set of navigation items for this search term. For example, if you pass in a search of `paper` and a restrict navigation of `category:2` The bridge will find the category navigation refinements in the first query and fire a second query for the top 2 most populous categories. Therefore, a search for something generic like "paper" will bring back top category matches like copy paper (1,030), paper pads (567). The bridge will fire off the second query with the search term, plus an OR refinement with the most likely categories. The navigation items in the first query are entirely replaced with the navigation items in the second query, except for the navigation that was used for the restriction so that users still have the ability to navigate by all category types. JSON Reference: { "restrictNavigation": { "name": "category", "count": 2 } }
    
    Parameters:
    
    restrictNavigation - Restriction criteria
    
    Returns:
    
    this query
  - setRestrictNavigation
```
public Query setRestrictNavigation(java.lang.String name,
                                   int count)
```
    Warning See setRestrictNavigation(RestrictNavigation). This is a convenience method.
    
    Parameters:
    
    name - the name of the field should be used in the navigation restriction in the second query.
    
    count - the number of fields matches
    
    Returns:
    
    this query
  - getSort
```
public java.util.List<com.groupbyinc.api.model.Sort> getSort()
```
    Returns:
    
    The current list of sort parameters
  - setSort
```
public Query setSort(com.groupbyinc.api.model.Sort... sort)
```
    Specifies the sort order applied to the fields in the order specified. If no sort criteria are specified, the default is to sort by relevance. There is a special sort field `_relevance`, which also specifies sorting by relevance. It is possible to specify multiple sort criteria. The criteria order matters, as the records will be sorted by the first criteria and then any matches will be tie-broken using the next criteria. Given an example where the sort is specified as `category` then `_relevance`, results will be sorted first by `category` and relevance will only affect the order between records that have the same category. Records can also be sorted by a specific ID as well when you want to return items in a specific order. If a record ID is included as a sort, but that record not a part of the result set, that item will not be included (unlike push to top). There is a limit of 1000 id's that you can sort by. Any ID's beyond this limit will be ignored. ID sort can also be used with other types of sorts. Please note, sorting is based on the actual value in the record. For example, if sorting on `price`, and `price` is a `Range` navigation, the records will be sorted according to the actual price value in the record and not the bucket value. The order field can be set to either `Ascending` or `Descending`. When sorting by relevance, the order is always `Descending`. For any other field, the default order is `Ascending`. JSON Reference: { "sort": { "field": "price", "order": "Descending" } } { "sort": [{ "field": "_relevance" }, { "field": "price", "order": "Descending" }] } { "sort": [{ "field": "brand", "order":"Ascending" }, { "field": "_relevance" }, { "field": "price" }] } { "sort": [{ "type": "ByIds", "ids": ["1234"," 5678"]}] } { "sort": [{ "type": "ByIds", "ids": ["1234"," 5678"]}, { "field": "price", "order": "Descending" }] }
    
    Parameters:
    
    sort - Any number of sort criteria.
  - getMatchStrategy
```
public com.groupbyinc.api.model.MatchStrategy getMatchStrategy()
```
    Returns:
    
    The current match strategy.
  - setMatchStrategy
```
public Query setMatchStrategy(com.groupbyinc.api.model.MatchStrategy matchStrategy)
```
    A match strategy allows you to explicitly manage recall on a per query basis. There must always be one term matching in a query, thus `termsGreaterThan` can only be defined from 1 upwards and `terms` can only be defined from 2 upwards. It is not possible to match more terms than passed into the query. Relative `mustMatch` values can be used in conjunction with `termsGreaterThan`. A `"percentage": true` flag denotes a relative `mustMatch` to the portion of the terms and will always round down (i.e. 50% must match of 3 terms, means that 1 term must match). The following is the default match strategy: ``` { "matchStrategy": { "rules":[{ "terms": 2, "mustMatch": 2 }, { "terms": 3, "mustMatch": 2 }, { "terms": 4, "mustMatch": 3 }, { "terms": 5, "mustMatch": 3 }, { "terms": 6, "mustMatch": 4 }, { "terms": 7, "mustMatch": 4 }, { "terms": 8, "mustMatch": 5 }, { "termsGreaterThan": 8, "mustMatch": 60, "percentage": true }] } } ``` An exact matching strategy would be: ``` { "matchStrategy": { "rules": { "termsGreaterThan": 1, "mustMatch": 100, "percentage": true } } } ``` Please note, it is highly recommended that the highest rule is defined with `termsGreaterThan` and a relative `mustMatch` as that guarantees that the number of matches required grows with the number of terms passed into the query. JSON Reference: { "matchStrategy": { "rules":[{ "terms": 2, "mustMatch": 2 }, { "terms": 3, "mustMatch": 2 }, { "terms": 4, "mustMatch": 3 }, { "terms": 5, "mustMatch": 3 }, { "terms": 6, "mustMatch": 4 }, { "terms": 7, "mustMatch": 4 }, { "terms": 8, "mustMatch": 5 }, { "termsGreaterThan": 8, "mustMatch": 60, "percentage": true }] } } { "matchStrategy": { "rules": { "termsGreaterThan": 1, "mustMatch": 100, "percentage": true } } } { "matchStrategy": { "rules":[{ "terms": 2, "mustMatch": 1 }, { "termsGreaterThan": 2, "mustMatch": 75, "percentage": true }] } }
    
    Parameters:
    
    matchStrategy - A match strategy composed of partial matching rules.
  - getIncludeNavigations
```
public java.util.List<java.lang.String> getIncludeNavigations()
```
    Returns:
    
    A list of navigations that will be included with the response.
  - addIncludedNavigations
```
public Query addIncludedNavigations(java.lang.String... navigationName)
```
    An array that specifies which navigations should be returned. If set, this overrides the navigations defined in Command Center and only returns the navigations specified. If this parameter is blank the Dynamic Navigations from Command Center are returned. The values here must be defined via Command Center or Bulk Upload. If a navigation is specified that has not been defined, it will be ignored. This means, if this parameter uses a `dummy` navigation that is not real, this will both override any Command Center definitions, and will return nothing, as the navigation does not exist. The field name supports two types of wildcard characters: '?' and '\*'. The '?' wildcard will match one character. For example "????_price" will match "sale_price", but not "sales_price". The '\*' wildcard will match any number of characters. For example, a name of "\*_price" will match both "sale_price and "sales_price", but not "sale_prices". JSON Reference: { "includedNavigations": [ "width", "brand", "categories.categories.value" ] }
    
    Parameters:
    
    navigationName - The case-sensitive name of the navigation to return
  - getExcludeNavigations
```
public java.util.List<java.lang.String> getExcludeNavigations()
```
    Returns:
    
    A list of navigations that will be excluded from the response.
  - addExcludedNavigations
```
public Query addExcludedNavigations(java.lang.String... navigationName)
```
    Specify which navigations should not be returned. If set, this forces the response to exclude certain navigations defined in Command Center. If this parameter is blank all navigations in Command Center are returned. If a navigation name is specified that does not exist, it will be ignored. If "includedNavigations" are specified, then all "excludedNavigations" are ignored. Please see the documentation on "includedNavigations" for details on wildcard characters in the field name. JSON Reference: { "excludedNavigations": [ "width", "brand", "categories.categories.value" ] }
    
    Parameters:
    
    navigationName - The case-sensitive name of the navigation to exclude
  - getQueryUrlParams
```
public java.util.Map<java.lang.String,java.lang.String> getQueryUrlParams()
```
    Returns:
    
    The query level url-parameters.
  - setQueryUrlParams
```
public Query setQueryUrlParams(java.util.Map<java.lang.String,java.lang.String> queryUrlParams)
```
    Sets the query level url parameters. These will be used in the future to enable and disable features, such as disabling Navigations in the response.
    
    Parameters:
    
    queryUrlParams - The map of query level url parameters
  - addQueryUrlParams
```
public Query addQueryUrlParams(java.lang.String key)
```
    See setQueryUrlParams(Map). This is a convenience method for when you have no value for the url parameter.
    
    Parameters:
    
    key - The key of the url parameter
  - addQueryUrlParams
```
public Query addQueryUrlParams(java.lang.String key,
                               java.lang.String value)
```
    See setQueryUrlParams(Map).
    
    Parameters:
    
    key - The key of the url parameter
    
    value - The value of the url parameter
  - setBringToTop
```
public Query setBringToTop(java.lang.String... bringToTop)
```
    See setBiasing(Biasing). This is a convenience method to set which products should be brought to the top of the result set.
    
    Parameters:
    
    bringToTop - Up to 300 of product IDs to bring to the top of the result set.
  - setRestrictToIds
```
public Query setRestrictToIds(java.lang.String... restrictToIds)
```
    See setBiasing(Biasing). This is a convenience method to set the list of products IDs that will be used for `restrictToIds`.
    
    Parameters:
    
    restrictToIds - Up to 300 of product IDs that will be used to restrict the result set. You can use this to specify against which set of records any additional query or refinement actions should be taken.
  - setBiasingAugment
```
public Query setBiasingAugment(boolean augment)
```
    See setBiasing(Biasing). This is a convenience method to set the biasing augment status.
    
    Parameters:
    
    augment - True to replace the biases defined in Command Center, false to augment.
  - setInfluence
```
public Query setInfluence(java.lang.Float influence)
```
    See setBiasing(Biasing). This is a convenience method to set the biasing influence.
    
    Parameters:
    
    influence - The influence
  - addBias
```
public Query addBias(java.lang.String name,
                     java.lang.String content,
                     com.groupbyinc.api.model.Bias.Strength strength)
```
    See setBiasing(Biasing). This is a convenience method to add an individual bias.
    
    Parameters:
    
    name - The name of the field to bias on
    
    content - The value to bias
    
    strength - The strength of the bias. Legal values are: "Absolute_Increase", "Strong_Increase", "Medium_Increase", "Weak_Increase", "Leave_Unchanged", "Weak_Decrease", "Medium_Decrease", "Strong_Decrease", "Absolute_Decrease".
  - getSessionId
```
public java.lang.String getSessionId()
```
    Returns:
    
    The session ID
  - setSessionId
```
public Query setSessionId(java.lang.String sessionId)
```
    A unique string identifier of the session that your customer is currently in. The sessionID should be a unique value for a given user that persists for them as long as that user is active on the site for that session. We define a session as the time that you would consider a duration of an A/B test. In future, A/B testing tools within our solution will leverage the session ID to group customers into different experiences. Ensuring that session ID is persistent throughout a measure of time will help ensure that the customer experience is consistent as they shop and browse your site. Therefore, the sessionID should update only if the user is inactive for some period - we recommend keeping this in alignment for what you consider a shopping session for your customers. For example, you can align this to the timeout of items stored in the shopping cart. Session ID should not change when the user logs in and can be used to track a user changing from anonymous to logged in. Session ID must also be consistent between the Search and Recommendations APIs to ensure correct monitoring of conversion metrics. |@warn | Sending raw session IDs is a security risk. Encrypt or hash session IDs prior to transmission.
    
    Parameters:
    
    sessionId - The session ID
  - getVisitorId
```
public java.lang.String getVisitorId()
```
    Returns:
    
    The user ID
  - setVisitorId
```
public Query setVisitorId(java.lang.String visitorId)
```
    A unique string identifier of an end customer. Anonymous users (not logged in) should have a visitorID that is a randomly generated v4 UUID. This visitorID should stay with the anonymous user for as long as possible or until they log in. When a user logs in, their visitorID change to a known globally unique identifier for that customer. Visitor ID should remain the same for a particular customer over different sessions. Also, it must be consistent between the Search and Recommendations APIs to ensure correct monitoring of conversion metrics. |@warn | Sending raw session IDs is a security risk. Encrypt or hash session IDs prior to transmission.
    
    Parameters:
    
    visitorId - The visitor ID
  - getBiasing
```
public com.groupbyinc.api.model.Biasing getBiasing()
```
    Returns:
    
    The biasing
  - setBiasing
```
public Query setBiasing(com.groupbyinc.api.model.Biasing biasing)
```
    Add a biasing profile, which is defined at query time. Possible settings include: - `bringToTop`: A list of product IDs to bring to the top of the result set. This list will ensure that the products are included in the result set and appear in the order defined. - `restrictToIds`: A list of product IDs that will be used as the subset on which any subsequent refinements, search, sort, and/or bias will be conducted on. For example, you can pass in a list of IDs within which to search. The list is not order sensitive. Records will only return if their ID is defined in this list *and* exist in the queried result set. This operation has a 1000 ID limit. - `influence`: The influence to apply to query-time biases and biases set in Command Center. If this field is not defined, then the influence of the biasing profile defined in Command Center will take effect. If an influence is not defined in Command Center, then the influence will default to 5. - `augmentBiases`: If true, the biases defined here will augment biasing profiles defined in Command Center. Otherwise, the biases will override the ones defined in command Center. By default, this is set to false. - `biases`: A list of biases, which either override or augment biasing profiles defined in Command Center. See the documentation for `addBias` for more information. - `numericBoosts`: A list of numeric boosts, which will override or augment biasing profiles defined in Command Center. |@tip | #### When to use it | | `restrictToIds` is especially useful when you need to request a subset of your records due to information from a 3rd party source. | All the typical search operations: search, navigation, biasing, sort, and so on - can be conducted on this set. |@warn | When both `bringToTop` and `restrctToIds` are used, the ids specified in `bringToTop` will be first, | followed by the ids in the second set, with any subsequent biasing, sort, refinements, and query operations applied to them. JSON Reference: { "biasing": { "bringToTop": ["productId1","productId3","productId2"], "restrictToIds": ["productId1","productId3","productId2"], "influence": 5.0, "augmentBiases": false, "biases": [ {"name":"brand", "content":"Brand A", "strength":"Medium_Increase"}, {"name":"brand", "content":"Brand B", "strength":"Strong_Increase"}, {"name":"material", "content":"Material A", "strength":"Strong_Decrease"} ], "numericBoosts": [ {"name":"size", "strength":10, "inverted":false}, {"name":"price", "strength":0.001, "inverted":true} ] }}
    
    Parameters:
    
    biasing - The biasing parameters
  - setSecuredPayload
```
public Query setSecuredPayload(com.groupbyinc.common.security.AesContent securedPayload)
```
    Add a secured payload to the query. JSON Reference: { "securedPayload": { "cipherText":"", "initialValue":"", "messageAuthenticationCode":"" } }
    
    Parameters:
    
    securedPayload - The secured payload received at login
  - isBot
```
public boolean isBot()
```
  - setBot
```
public void setBot(boolean bot)
```
    Url Parameter to indicate whether this query is bot traffic or not.
    
    Parameters:
    
    bot - True if this query is from a bot

Class Query

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Query

Method Detail

getBridgeJson

convertBiasing

getCustomUrlParams

isWildcardSearchEnabled

convertSort

convertPartialMatchStrategy

setWildcardSearchEnabled

getBridgeRefinementsJson

getQuery

setQuery

getSubCollection

setSubCollection

getCollection

setCollection

getArea

setArea

getRefinementString

getCustomUrlParamsString

getBridgeJsonRefinementSearch

addRefinementsByString

splitRefinements

addCustomUrlParam

addCustomUrlParam

addCustomUrlParamsByString

getFields

addFields

addField

getOrFields

addOrField

addRangeRefinement

addRangeRefinement

addValueRefinement

addValueRefinement

setPinnedRefinements

setPinnedRefinements

getSkip

setSkip

getPageSize

setPageSize

getNavigations

isReturnBinary

setReturnBinary

getBiasingProfile

setBiasingProfile

getMatchStrategyName

setMatchStrategyName

getLanguage

setLanguage

isPruneRefinements

setPruneRefinements

isAutocorrectionDisabled

setDisableAutocorrection

setRestrictNavigation

setRestrictNavigation

getSort

setSort

getMatchStrategy

setMatchStrategy

getIncludeNavigations

addIncludedNavigations

getExcludeNavigations

addExcludedNavigations

getQueryUrlParams

setQueryUrlParams

addQueryUrlParams

addQueryUrlParams

setBringToTop

setRestrictToIds

setBiasingAugment

setInfluence

addBias

getSessionId

setSessionId