Skip to content

Commit 7dec3fc

Browse files
committed
Added API endpoints section.
1 parent ea28cbc commit 7dec3fc

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
- [About](#about)
1111
- [Built With](#built-with)
12+
- [API endpoints](#api-endpoints)
1213
- [Usage](#usage)
1314
- [Manual setup](#manual-setup)
1415
- [System Design](#system-design)
@@ -53,6 +54,25 @@ The embedding for each product includes:
5354
- Numpy
5455
- Swagger
5556

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+
5676
### Usage
5777

5878
#### Manual setup
@@ -112,11 +132,6 @@ in the .env file, replace these environment variables with your own values.
112132
<img src="docs/screenshots/screenshot1.JPG" width="800" height="400"><br>
113133
The main Swagger view.
114134
115-
## API Endpoints Overview
116-
This section provides an overview of the available API endpoints for product recommendation and filtering.
117-
118-
119-
120135
<img src="docs/screenshots/screenshot2.JPG" width="800" height="300"><br>
121136
The main endpoint for recommending products and filtering price.
122137

0 commit comments

Comments
 (0)