Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(adr-002): Update final name for the ADR and api definition

Browse Source
This commit is contained in:
vuonghoainam 2023-10-06 17:10:56 +07:00
parent 6fc7373fe9
commit 949df52838
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
adr/adr-002-jan-composable-ai.md → adr/adr-002-jan-ai-apps.md
View File

@ -1,7 +1,8 @@
# ADR #002: Jan composable AI # ADR #002: Jan AI apps
## Changelog ## Changelog
- Oct 4th 2023: Initial draft - Oct 4th 2023: Initial draft
- Oct 6th 2023: Update sample API
## Authors ## Authors
- @vuonghoainam - Hiro - @vuonghoainam - Hiro
@ -13,7 +14,7 @@ Proposed
## Context ## Context
### Business context ### Business context
Jan can be a platform and let builders build their own `composable AIs` using existing tools Jan can be a platform and let builders build their own `AI app` using existing tools
- Use-case 1: Medical AI startup uploads "case notes" to Jan, wants to ask it questions (i.e. medical audit) - Use-case 1: Medical AI startup uploads "case notes" to Jan, wants to ask it questions (i.e. medical audit)
- Use-case 2: Legal e-discovery: very large amount of documents (~10-15k pages) are uploaded, data is very private and cannot be leaked - Use-case 2: Legal e-discovery: very large amount of documents (~10-15k pages) are uploaded, data is very private and cannot be leaked
- Use-case 3: Jan wants to use Jan to have a QnA chatbot to answer questions on docs - Use-case 3: Jan wants to use Jan to have a QnA chatbot to answer questions on docs
@ -41,8 +42,14 @@ Jan can be a platform and let builders build their own `composable AIs` using ex
### Component design ### Component design
![Component design](images/adr-002-02.png "Component design") ![Component design](images/adr-002-02.png "Component design")
## API
- `jan.plugin.<plugin_name>.<function_name>(**args)`
- `jan.core.db.sql.command()` -> CRUD/ query
- `jan.plugin.vectra.<function_name>(**args)` -> CRUD/ query for
## Consequences ## Consequences
- Jan user can build their own composable AIs (and buy from others too) in an easy way - Jan user can build their own AI apps (and buy from others too) in an easy way
- Clear design for plugin and Jan platform development - Clear design for plugin and Jan platform development
## Reference ## Reference
- [ADR-003](adr-003-jan-plugins.md)