|
9 | 9 |
|
10 | 10 | - [About](#about)
|
11 | 11 | - [Built With](#built-with)
|
| 12 | +- [API endpoints](#api-endpoints) |
12 | 13 | - [Usage](#usage)
|
13 | 14 | - [Manual setup](#manual-setup)
|
14 | 15 | - [System Design](#system-design)
|
@@ -53,6 +54,25 @@ The embedding for each product includes:
|
53 | 54 | - Numpy
|
54 | 55 | - Swagger
|
55 | 56 |
|
| 57 | +## API Endpoints |
| 58 | + |
| 59 | +These endpoints allow users to retrieve product recommendations based on descriptions or filter products by price range: |
| 60 | + |
| 61 | +**POST /v1/chat/message/** |
| 62 | + - **Description**: Retrieve a product recommendation from a description and/or filter products by a price range. |
| 63 | + - **Request Model**: `CreateChatMessageRequest` |
| 64 | + - **Response Model**: `CreateChatMessageResponse` |
| 65 | + |
| 66 | +**POST /v1/chat/product/description/** |
| 67 | + - **Description**: Recommend other products by a product description. |
| 68 | + - **Request Model**: `CreateChatMessageRequest` |
| 69 | + - **Response Model**: `CreateChatMessageResponse` |
| 70 | + |
| 71 | +**POST /v1/chat/product/price/** |
| 72 | + - **Description**: Filter products by a price range. |
| 73 | + - **Request Model**: `GetProductsInPriceRangeRequest` |
| 74 | + - **Response Model**: `CreateChatMessageResponse` |
| 75 | + |
56 | 76 | ### Usage
|
57 | 77 |
|
58 | 78 | #### Manual setup
|
@@ -112,11 +132,6 @@ in the .env file, replace these environment variables with your own values.
|
112 | 132 | <img src="docs/screenshots/screenshot1.JPG" width="800" height="400"><br>
|
113 | 133 | The main Swagger view.
|
114 | 134 |
|
115 |
| -## API Endpoints Overview |
116 |
| -This section provides an overview of the available API endpoints for product recommendation and filtering. |
117 |
| -
|
118 |
| -
|
119 |
| -
|
120 | 135 | <img src="docs/screenshots/screenshot2.JPG" width="800" height="300"><br>
|
121 | 136 | The main endpoint for recommending products and filtering price.
|
122 | 137 |
|
|
0 commit comments