Smart Ranking Setup Guide

this guide is designed to help you implement and understand the smart ranking feature of nochannel search smart ranking is an advanced search functionality that dynamically adjusts the order of search results to provide the most relevant products to your customers it uses machine learning techniques, specifically learning to rank (ltr), to analyze user behavior and improve search results over time the smart ranking service in nochannel search consists of several key components api key authentication for secure access to the system index creation and management to organize your product data data capture for smart ranking the api should be set up for the front end learning to rank (ltr) the core of the smart ranking functionality query pipelines for advanced search processing this guide will walk you through the process of setting up these components, from generating your api key to monitoring your smart ranking performance by following these steps, you'll be able to enhance your ecommerce platform's search capabilities, potentially increasing customer satisfaction and conversions remember, while this guide provides the basic setup, smart ranking is an ongoing process that continually learns and improves based on user interactions regular monitoring and optimization will help you get the most out of this powerful feature let's start setting up smart ranking for your nochannel commerce platform! 1\ generating an api key first, you need to create an api key to access nochannel's features option a through the nochannel commerce portal log in to the nochannel commerce portal click on your username and select " details " scroll to the " api key " section and click " generate key " provide a name for your key and set an expiration date click " generate key " again copy and securely store the key that appears option b using the api obtain a tenant id and session id use these to make an api call to generate a new api key store the returned apikey and apikeyid securely remember your api key is crucial for accessing nochannel features keep it safe and never share it publicly for a detailed overview, go to our api key https //docs nochannel io/api key guide 2\ creating an index an index is where your searchable data will be stored 1\ use your api key to send a post request to create a new index post https //api upstartcommerce com/v1/search/index/your index name 2\ define the index settings and mappings in your request body { "data" { "settings" { "index" { "final pipeline" "search pipeline" } }, "mappings" { "properties" { "name" { "type" "text" }, "type" { "type" "keyword" }, "size" { "type" "keyword" }, "color" { "type" "keyword" } } }, "aliases" { "sample alias1" {} } } } 3\ adding items to the index populate your index with product data 1\ prepare your product information in json format 2\ use the bulk api to add multiple products at once post https //api upstartcommerce com/v1/search/index/bulk { "data" \[ { "index" { " index" "your index name" } }, { "name" "red dress", "type" "dress", "size" "m", "color" "red" }, { "index" { " index" "your index name" } }, "name" "black t shirt", "type" "t shirt", "size" "l", "color" "black" } ] } 4\ setting up data capture data capture is crucial for smart ranking as it provides the necessary user behavior data to set it up 1\ implement event tracking on your website for session events (when users start browsing) navigation events (user movement through the site) search events (user queries and results) cart events (cart creation and modifications) promotion events (application of promotions) order events (final purchase details) 2\ use the nochannel api to send these events post https //api upstartcommerce com/v1/data capture/capture 3\ ensure each event includes necessary details like session id, timestamp, and relevant action information for a comprehensive guide on implementing data capture, refer to the data capture flow document , which provides detailed information on event structures and api calls the ltr feature engineering service runs every 5 days, using the past 90 days of data collected by the data capture api