# Interface IQuery

## Index

### Properties

- actionsHistory
- allowQueriesWithoutKeywords
- aq
- categoryFacets
- childField
- commerce
- context
- cq
- debug
- dq
- enableCollaborativeRating
- enableDidYouMean
- enableQuerySyntax
- excerptLength
- facetOptions
- facets
- fieldsToExclude
- fieldsToInclude
- filterField
- filterFieldRange
- firstResult
- format
- groupBy
- lowercaseOperators
- lq
- maximumAge
- numberOfResults
- parentField
- partialMatch
- partialMatchKeywords
- partialMatchThreshold
- pipeline
- q
- queryFunctions
- questionMark
- rankingFunctions
- recommendation
- retrieveFirstSentences
- searchHub
- sortCriteria
- tab
- userActions
- wildcards

## Properties

### Optional actionsHistory

actionsHistory: string

- Defined in rest/Query.ts :268

### Optional allowQueriesWithoutKeywords

allowQueriesWithoutKeywords: boolean

- Defined in rest/Query.ts :282

### Optional aq

aq: string

- Defined in rest/Query.ts :74

### Optional categoryFacets

categoryFacets: ICategoryFacetRequest[]

- Defined in rest/Query.ts :228

### Optional childField

childField: string

- Defined in rest/Query.ts :254

### Optional commerce

commerce: ICommerceRequest

- Defined in rest/Query.ts :306

### Optional context

context: Context

- Defined in rest/Query.ts :262

### Optional cq

cq: string

- Defined in rest/Query.ts :82

### Optional debug

debug: boolean

- Defined in rest/Query.ts :238

### Optional dq

dq: string

- Defined in rest/Query.ts :96

### Optional enableCollaborativeRating

enableCollaborativeRating: boolean

- Defined in rest/Query.ts :250

### Optional enableDidYouMean

enableDidYouMean: boolean

- Defined in rest/Query.ts :212

### Optional enableQuerySyntax

enableQuerySyntax: boolean

- Defined in rest/Query.ts :245

### Optional excerptLength

excerptLength: number

- Defined in rest/Query.ts :202

### Optional facetOptions

facetOptions: IFacetOptions

- Defined in rest/Query.ts :292

### Optional facets

facets: IFacetRequest[]

- Defined in rest/Query.ts :287

### Optional fieldsToExclude

fieldsToExclude: string[]

- Defined in rest/Query.ts :196

### Optional fieldsToInclude

fieldsToInclude: string[]

- Defined in rest/Query.ts :190

### Optional filterField

filterField: string

- Defined in rest/Query.ts :180

### Optional filterFieldRange

filterFieldRange: number

- Defined in rest/Query.ts :184

### Optional firstResult

firstResult: number

- Defined in rest/Query.ts :158

### Optional format

format: ResponseFormat

- Defined in rest/Query.ts :311

### Optional groupBy

groupBy: IGroupByRequest[]

- Defined in rest/Query.ts :224

### Optional lowercaseOperators

lowercaseOperators: boolean

- Defined in rest/Query.ts :133

### Optional lq

lq: string

- Defined in rest/Query.ts :90

### Optional maximumAge

maximumAge: number

- Defined in rest/Query.ts :117

### Optional numberOfResults

numberOfResults: number

- Defined in rest/Query.ts :163

### Optional parentField

parentField: string

- Defined in rest/Query.ts :258

### Optional partialMatch

partialMatch: boolean

- Defined in rest/Query.ts :140

### Optional partialMatchKeywords

partialMatchKeywords: number

- Defined in rest/Query.ts :147

### Optional partialMatchThreshold

partialMatchThreshold: string

- Defined in rest/Query.ts :153

### Optional pipeline

pipeline: string

- Defined in rest/Query.ts :111

### q

q: string

- Defined in rest/Query.ts :68

### Optional queryFunctions

queryFunctions: IQueryFunction[]

- Defined in rest/Query.ts :216

### Optional questionMark

questionMark: boolean

- Defined in rest/Query.ts :129

### Optional rankingFunctions

rankingFunctions: IRankingFunction[]

- Defined in rest/Query.ts :220

### Optional recommendation

recommendation: string

- Defined in rest/Query.ts :273

### Optional retrieveFirstSentences

retrieveFirstSentences: boolean

- Defined in rest/Query.ts :207

### Optional searchHub

searchHub: string

- Defined in rest/Query.ts :101

### Optional sortCriteria

sortCriteria: string

- Defined in rest/Query.ts :173

### Optional tab

tab: string

- Defined in rest/Query.ts :105

### Optional userActions

userActions: IUserActionsRequest

- Defined in rest/Query.ts :302

### Optional wildcards

wildcards: boolean

- Defined in rest/Query.ts :124

### Hierarchy

- IQuery