fix(adr-002): Update final name for the ADR and api definition
This commit is contained in:
parent
6fc7373fe9
commit
949df52838
@ -1,7 +1,8 @@
|
||||
# ADR #002: Jan composable AI
|
||||
# ADR #002: Jan AI apps
|
||||
|
||||
## Changelog
|
||||
- Oct 4th 2023: Initial draft
|
||||
- Oct 6th 2023: Update sample API
|
||||
|
||||
## Authors
|
||||
- @vuonghoainam - Hiro
|
||||
@ -13,7 +14,7 @@ Proposed
|
||||
## 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 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
|
||||
@ -41,8 +42,14 @@ Jan can be a platform and let builders build their own `composable AIs` using ex
|
||||
### 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
|
||||
- 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
|
||||
|
||||
## Reference
|
||||
- [ADR-003](adr-003-jan-plugins.md)
|
||||
Loading…
x
Reference in New Issue
Block a user