Search Api : List Search

post https://search-dev.topiq.ai/v1/search/{appId}/list

Path Params

appId

string

required

Body Params

primaryKey

string

Primary key for the documents

query

string

The search query

field

string

the field on which autocompletion perform

appId

string

App Id for the client

facets

object

User-enforced facet fields

attributeList

object

set of attribute list needs to be filtered in the result set

sort

object

describes the default sorting field with Sort order

grouping

object

describes the grouped field with sortable field

pagination

object

categoryFilters

array

FIlter specifically used for ListPageRequest

Category Filter

explicitFilters

array

The filters applied by the user

Explicit Filters

implicitFilters

array

Filters configured by the business people

Implicit Filters

exclusionFilters

array

Filters for fallback mechanism

Exclusion Filters

confidentCategories

array of strings

confident categories for a given search term,which will be used as a fallback mechnism for facets,ranking,etc

confidentCategories

boosts

array of objects

Product list for boosting

Boost

dynamicFacets

array of objects

Facets that are built dynamically built based on the input search term

Dynamic Facets

actions

array of strings

Set of Actions provided in rules (for business config)

Actions

hideProducts

array of strings

Product list for hiding

Hidden Products

sortedBy

array of objects

Contains the order in which the response needs to be sorted.For example price from high to low

Sort Order

urlRedirect

string

Url for Redirect rule

rewrittenQuery

string

Used to rewrite a particular query

message

string

return message when rewrite is needed

abFlags

string

Flags for different version of services

enableRedirects

boolean

Enables the redirects

isRankingOverride

boolean

Used the override the ranking

debugMode

boolean

Enables the debug mode

isFacetOverride

boolean

Used to override the facets

isQpsRanking

boolean

Flag to enable/disable similar queries

dbType

string

Search engine type

authorization

string

Authorization Token

channelName

string

Device Type

traceId

string

Trace id

debugProperties

object

Used for debugging the search flow

recallThresholdCount

int32

describe the the minimum number of results that must be returned in order for the fallback option to be activated

pinItems

object

List of items for pinning

slotActions

array of objects

Slot

useSecondaryAlias

boolean

isCacheEnabled

boolean

Flag to enable/disable cache

enableDynamicFacets

boolean

Flag to enable/disable Dynamic Facets

enableRules

boolean

Flag to enable/disable rules

enableBoosting

boolean

Flag to enable/disable Boosting

enablePersonalisation

boolean

Flag to enable/disable Personalisation

isFilterOverride

boolean

Flag to enable/disable Filter Override

aggregateResults

boolean

Flag to enable/disable Aggregation

isPreview

boolean

Flag to enable/disable Preview Mode

categoryField

string

Describes the category field

userId

string

Id of the user

slots

object

List of items for slots

slotRange

int32

Range of Slot

bannerUrl

string

Url for Banner Page.

textEmbeddings

array of doubles

textEmbeddings

pageTitle

string

title of the listing page

relatedEmbedding

boolean

textEmbeddingRequest

boolean

type

string

Responses

200Successfully retrieved the Hits from Elastic Search

401Unauthorized Request

500Some Failure while retrieving Hits from Elastic Search/Services