Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ for another doctype, feel free to open a PR with the description and role of you
## Cozy doctypes

- [io.cozy.accounts](io.cozy.accounts.md): Konnector accounts
- [io.cozy.ai.chat.assistants] (io.cozy.ai.chat.assistants.md): AI assistants for chat
- [io.cozy.ai.chat.conversations](io.cozy.ai.chat.conversations.md): Chat conversations with an assistant (AI)
- [io.cozy.apps](io.cozy.apps.md): Apps installed in the Cozy
- [io.cozy.apps.suggestions](io.cozy.apps.suggestions.md): Suggestions for apps that the user might find useful
Expand Down
43 changes: 43 additions & 0 deletions docs/io.cozy.ai.chat.assistants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[Table of contents](README.md#table-of-contents)

# Chat assistants with an AI

Cf [the stack documentation for AI](https://docs.cozy.io/en/cozy-stack/ai/).

## `io.cozy.ai.chat.assistants`

The `io.cozy.ai.chat.assistants` doctype is used to keep configuration of an assistant (AI).

- `name`: {array} The name of assistant
- `prompt`: {string?} What does this assistant do? How should it behave? What should it avoid doing?
- `isCustomModel`: {boolean} Is the selected model custom or not?
- `icon`: {string?} The avatar of assistant

### Example


```json
{
"_id": "e21dce8058b9013d800a18c04daba326",
"_rev": "1-23456",
"cozyMetadata": {
"createdAt": "2024-09-24T13:24:07.576Z",
"createdOn": "http://cozy.localhost:8080/",
"doctypeVersion": "1",
"metadataVersion": 1,
"updatedAt": "2024-09-24T13:24:07.576Z"
},
"name": "My assistant",
"prompt": "This is my assistant",
"isCustomModel": false,
"icon": "[encoded base64 string of the content of the icon or svg binary]",
"relationships": {
"provider": {
"data": {
"_type": "io.cozy.accounts",
"_id": "e21dce8058b9013d800a18c04daba322"
}
}
}
}
```
1 change: 1 addition & 0 deletions toc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
- README: ./docs/README.md
- Accounts: ./docs/io.cozy.accounts.md
- AI: ./docs/io.cozy.ai.chat.conversations.md
- Assistants: ./docs/io.cozy.ai.chat.assistants.md
- Apps: ./docs/io.cozy.apps.md
- App suggestions: ./docs/io.cozy.apps.suggestions.md
- Banking doctypes: ./docs/io.cozy.bank.md
Expand Down