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

docs: add thread description

Browse Source
This commit is contained in:
hieu-jan 2023-11-23 11:17:26 +09:00
parent f5bb2e51a8
commit 62e8a8253d
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/openapi/jan.yaml
View File

@ -19,7 +19,11 @@ tags:
- name: Messages - name: Messages
description: Operations for individual messages, including creation, retrieval, and modification description: Operations for individual messages, including creation, retrieval, and modification
- name: Threads - name: Threads
description: Manages series of related messages or conversation threads description: |
`Threads` are conversations between an `assistant` and the user:
- Users can tweak `model` params and `assistant` behavior within each thread.
- Users can import and export threads.
- An [OpenAI Thread API](https://platform.openai.com/docs/api-reference/threads) compatible endpoint at `localhost:3000/v1/threads`.
- name: Assistants - name: Assistants
description: Configures and utilizes different AI assistants for varied tasks description: Configures and utilizes different AI assistants for varied tasks
x-tagGroups: x-tagGroups:
@ -637,8 +641,11 @@ x-webhooks:
ThreadObject: ThreadObject:
post: post:
summary: The thread object summary: The thread object
description: description: |
- Each thread folder contains a `thread.json` file, which is a representation of a thread. - Each `thread` folder contains a `thread.json` file, which is a representation of a thread.
- `thread.json` contains metadata and model parameter overrides.
- There are no required fields.
operationId: ThreadObject operationId: ThreadObject
tags: tags:
- Threads - Threads