QueryCollectionResponse.md

SajariAPIClient::QueryCollectionResponse

Properties

Name	Type	Description	Notes
active_promotions	Array<ActivePromotion>	A list of the promotions activated when running the query.	[optional]
aggregate_filters	Hash<String, QueryAggregateResult>	The aggregates run with filters.	[optional]
aggregates	Hash<String, QueryAggregateResult>	The aggregates returned by the query.	[optional]
banners	Array<Banner>	Banners associated with this query.	[optional]
feature_score_weight	Float	The weight applied to the features in the query, used for analyzing the index, neural and feature components for results. For each result: ``` score = max(index_score, neural_score) * (1 - feature_score_weight) + feature_score * feature_score_weight ```	[optional]
pipeline	QueryCollectionResponsePipeline		[optional]
processing_duration	String	The total time taken to perform the query.	[optional]
query_id	String	The query identifier. This uniqely identifies the specific query it was returned on. This is used to link user interactions with a query.	[optional]
redirects	Hash<String, RedirectResult>	A mapping of redirects triggered for all possible variations of the query.	[optional]
results	Array<QueryResult>	The results returned by the query.	[optional]
total_size	String	The total number of results that match the query.	[optional]
variables	Hash<String, Object>	The modified variables returned by the pipeline after it has finished processing.	[optional]

Example

require 'sdk_ruby'

instance = SajariAPIClient::QueryCollectionResponse.new(
  active_promotions: null,
  aggregate_filters: null,
  aggregates: null,
  banners: null,
  feature_score_weight: null,
  pipeline: null,
  processing_duration: null,
  query_id: null,
  redirects: null,
  results: null,
  total_size: null,
  variables: null
)