# Search Results/List Sorting Overview The Search API provides sorting functionality, allowing you to customize the order of search results based on any field in the dataset. The sorting function works with search filters to help users quickly find the most relevant content. :::tip \*Tip **Search List Sorting** is a **post\-search sorting** mechanism, meaning it performs a global re\-sorting operation on the retrieved search results. Do not confuse with Customized Sorting rules (see [Configure customized Sorting rules](/docs/85296/1873485#39776d7b)). While both use item field attributes to arrange results in ascending or descending order, Search List Sorting **completely disregards the relevance score** between the item and the user's query. It rearranges the entire returned list based strictly on the specified field values. ::: # Implementation Guide When calling the Search API, use the `sort_by` and `sort_order` parameters to specify sorting syntax. As shown in the example below: ```Bash curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/application_id}/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer API key' \ -d '{ "query": { "text": "query text string", "image_url"："image file" }, "page_number": search page number, "page_size": number of search results per page, "user": { "user_id": user ID }, "filter": search filter conditions, "dataset_id": "target dataset id", "sort_by": pecified sort field, "sort_order": sort order e.g. "asc" or "desc" }' ``` ## Parameter description ### `sort_by` (sort field) * **Parameter description**: specify the field name used for sorting * **Required**: No * **Supported field types**: Support sorting of basic field types: `int32`, `int64`, `float`, `bool`, `string` * **Format requirements**: * The field must exist in the dataset * For nested objects, use dot notation, for example: `"product.price"`, `"user.rating"` ### `sort_order` (sort direction) * **Parameter description**: specify the sorting direction * **Required**: No (default to `desc` if `sort_by` is provided) * **Available values**: * `"desc"`: Descending order (from large to small) * `"asc"`: Ascending order (from small to large) ## Configuration example ### Example 1: sort by price in ascending order ```JSON { "query": { "text": "Sneakers" }, "dataset_id": "106265704", "page_number": 1, "page_size": 20, "sort_by": "price", "sort_order": "asc" } ``` ### Example 2: sort by creation time in descending order ```JSON { "query": { "text": "New Dresses" }, "dataset_id": "106265704", "page_number": 1, "page_size": 20, "sort_by": "create_at", "sort_order": "desc" } ``` ### Example 3: nested field sorting ```JSON { "query": { "text": "Mobile Phones" }, "dataset_id": "106265704", "page_number": 1, "page_size": 20, "sort_by": "product.sales_volume", "sort_order": "desc" } ``` ## Complete request example ```Bash curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/${application_id}/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "query": { "text": "Women Shoes Spring/Summer" }, "dataset_id": "106265704", "page_number": 1, "page_size": 20, "sort_by": "price", "sort_order": "asc", "filter": { "op": "must", "field": "status", "conds": [1] } }' ``` :::tip \*Explanation For complete API usage instructions, see: [API Reference > Search](https://www.volcengine.com/docs/85296/1544974) :::

Viking AI Search