Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.55 KB

QueryCollectionRequest.md

File metadata and controls

22 lines (16 loc) · 1.55 KB

SajariAPIClient::QueryCollectionRequest

Properties

Name Type Description Notes
pipeline QueryCollectionRequestPipeline [optional]
tracking QueryCollectionRequestTracking [optional]
variables Hash<String, Object> The initial values for the variables the pipeline operates on and transforms throughout its steps. The most important variable is `q` which is the query the user entered, for example: ```json { &quot;q&quot;: &quot;search terms&quot; } ``` To paginate through results, set the variables `page` and `resultsPerPage`, for example: ```json { &quot;q&quot;: &quot;search terms&quot;, &quot;page&quot;: 5, &quot;resultsPerPage&quot;: 20 } ``` To sort results, set the variable `sort` to the name of one of your collection's schema fields, for example: ```json { &quot;q&quot;: &quot;search terms&quot;, &quot;sort&quot;: &quot;name&quot; } ``` To sort in reverse, prefix the schema field with a minus sign `-`, for example: ```json { &quot;q&quot;: &quot;search terms&quot;, &quot;sort&quot;: &quot;-name&quot; } ```

Example

require 'sdk_ruby'

instance = SajariAPIClient::QueryCollectionRequest.new(
  pipeline: null,
  tracking: null,
  variables: null
)