Manual Rank API
-
The Manual Rank (mRank) API enables prioritized placement of specific documents in search results, overriding default relevancy scoring. This enterprise feature requires proper configuration of both ranking rules and search parameters.
-
Adding rank requires additional sorting tweaks to be done for sort search parameters.
Component Purpose Ranking Rules Defines priority documents Sort Parameters Enforces ranking in queries Please contact [email protected] to know more.
Ranking Documents using Queriesmrank/tagREST-JSON API
https://localhost:8443/rest/v2/api/mrank/tag
MethodPOST
Media TypeREST-JSON API
application/jsonHeadersSB-PKEY
LmfxTTDSeYxHTntJMHuhwRrGVICMaVN/wl/zPuQ3LtQDNRMnng5GpKIkgt0q1rCC/h6wDA==Document SyntaxREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "search ai", "url": "https://www.searchblox.com/products", "rank": 3 }
Document DescriptionJSON Attribute Description apikey The API key is accessible in the SearchBlox Admin Console. It is also present in the config.xml file. colname Name of the collection. queryTag Search query which user types to get the specific document(s) in the search page. url Document URL which the user gets on the search page for a specific search term. rank Rank is the position of the document where it shows up on the search page. Response CodesResponse Code Message 601 Invalid API Key 501 Collection not found 7002 URL not found 7003 Document not found 8001 Document rank update failed 8002 Query cannot be empty 8003 Ranking should be greater than 0 Ranking Status using Queries/Document URLmrank/docREST-JSON API
https://localhost:8443/rest/v2/api/mrank/doc
MethodPOST
Media TypeREST-JSON API
application/jsonHeadersSB-PKEY
LmfxTTDSeYxHTntJMHuhwRrGVICMaVN/wl/zPuQ3LtQDNRMnng5GpKIkgt0q1rCC/h6wDA==mRank Status using Queries/Document URLREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "search ai", "url": "https://www.searchblox.com/products/" }
mRank Status using QueriesREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "search ai", }
mRank Status using Document URLREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "url": "https://www.searchblox.com/products/" }
Document DescriptionJSON Attribute Description apikey API key accessible in the SearchBlox Admin Console. It is also present in the config.xml file. colname Name of the Collection. queryTag Search query which user types to get the specific document(s) in the search page. url Document URL which the user gets on the search page for a specific search term. Response CodesJSON
Response Code Message 601 Invalid API Key 501 Collection not found Clear Search RankingClearing mRank will remove the queries associated with documents along with its search rank defined.
tag/clearREST-JSON API
https://localhost:8443/rest/v2/api/tag/clear
MethodPOST
Media TypeREST-JSON API
application/jsonHeadersSB-PKEY
LmfxTTDSeYxHTntJMHuhwRrGVICMaVN/wl/zPuQ3LtQDNRMnng5GpKIkgt0q1rCC/h6wDA==Clear mRank using Specific DocumentREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "search ai", "url": "https://www.searchblox.com/producs" }
Clear mRank using Multiple DocumentsREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "search ai", "url":[ "https://www.searchblox.com", "https://www.searchblox.com/products" ] }
Clear mRank on all DocumentsREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "search ai" }
Clear mRank using Specific DocumentREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "*", "url":"https://www.searchblox.com" }
Clear mRank using Multiple DocumentsREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "search ai", "url":[ "https://www.searchblox.com", "https://www.searchblox.com/products" ] }
Clear mRank for all DocumentsREST-JSON API
{ "apikey": "0C407E013424736A16149636A45030DD", "colname": "HTTPCollection", "queryTag": "*" }
Document DescriptionJSON Attribute Description apikey API key accessible in the SearchBlox Admin Console. It is also present in the config.xml file. colname Search query which user types to get the specific document(s) in the search page. queryTag Search query which user types to get the specific document(s) in the search page. url Document URL, which the user gets on the search page for a specific search term. Response CodesResponse Code Message 600 Invalid API Key 501 Collection not found 8002 Query can not be empty
Updated 26 days ago