Skip to content

Commit

Permalink
docs: add thread description
Browse files Browse the repository at this point in the history
  • Loading branch information
0xHieu01 committed Nov 23, 2023
1 parent f5bb2e5 commit 62e8a82
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/openapi/jan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ tags:
- name: Messages
description: Operations for individual messages, including creation, retrieval, and modification
- 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
description: Configures and utilizes different AI assistants for varied tasks
x-tagGroups:
Expand Down Expand Up @@ -637,8 +641,11 @@ x-webhooks:
ThreadObject:
post:
summary: The thread object
description:
- Each thread folder contains a `thread.json` file, which is a representation of a thread.
description: |
- 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
tags:
- Threads
Expand Down

0 comments on commit 62e8a82

Please sign in to comment.