Siarhei Siniak
d0ffbeef0f
1. rename basic package name; 2. rewrite requirements into docs/readme.md;
35 lines
801 B
Markdown
35 lines
801 B
Markdown
# Requirements
|
|
|
|
1. FastAPI Microservice // Caching service
|
|
|
|
1.1. endpoints
|
|
1.1.1 POST:/payload `payload_create`
|
|
1.1.2. GET:/payload/<payload_id>/ `payload_read`
|
|
1.2. tech specs
|
|
1.2.1. fastapi for rest api
|
|
1.2.2. sqlite/postgresql for DB that caches LLM replies;
|
|
1.2.3. LLM transform can be stubbed (idk, maybe try to find something simple);
|
|
1.2.4. docker-compose for services
|
|
1.2.5. add pytest based tests;
|
|
1.2.6. add some linters for code style, and type checking;
|
|
|
|
# Schemas
|
|
```yaml
|
|
endpoints:
|
|
payload:
|
|
create:
|
|
request:
|
|
list_1: list[str]
|
|
list_2: list[str]
|
|
response:
|
|
payload:
|
|
id: int
|
|
output: list[str]
|
|
read:
|
|
request:
|
|
id: int
|
|
response:
|
|
id: int
|
|
output: list[str]
|
|
```
|