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

docs: change endpoint port

Browse Source
This commit is contained in:
hieu-jan 2023-11-23 13:53:23 +09:00
parent 0d3ec62b34
commit 53245faa54
3 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/specs/messages.md
View File

@ -13,7 +13,7 @@ This is currently under development.
`Messages` capture a conversation's content. This can include the content from LLM responses and other metadata from [chat completions](/specs/chats). `Messages` capture a conversation's content. This can include the content from LLM responses and other metadata from [chat completions](/specs/chats).
- Users and assistants can send multimedia messages. - Users and assistants can send multimedia messages.
- An [OpenAI Message API](https://platform.openai.com/docs/api-reference/messages) compatible endpoint at `localhost:3000/v1/messages`. - An [OpenAI Message API](https://platform.openai.com/docs/api-reference/messages) compatible endpoint at `localhost:1337/v1/messages`.
## Folder Structure ## Folder Structure
@ -104,12 +104,8 @@ See [Jan Messages API](https://jan.ai/api-reference#tag/Messages)
- Example request - Example request
```shell ```shell
curl -X POST {JAN_URL}/v1/threads/{thread_id}/messages \ curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id} \
-H "Content-Type: application/json" \ -H "Content-Type: application/json"
-d '{
"role": "user",
"content": "How does AI work? Explain it in simple terms."
}'
``` ```
- Example response - Example response
@ -259,4 +255,4 @@ See [Jan Messages API](https://jan.ai/api-reference#tag/Messages)
"created_at": 1699061776, "created_at": 1699061776,
"message_id": "msg_abc123" "message_id": "msg_abc123"
} }
``` --> ``` -->

2
docs/docs/specs/threads.md
View File

@ -224,4 +224,4 @@ See [Jan Threads API](https://jan.ai/api-reference#tag/Threads)
### List `Thread.Messages` ### List `Thread.Messages`
-> Can achieve this goal by calling `Get Thread` API --> -> Can achieve this goal by calling `Get Thread` API -->

2
docs/openapi/jan.yaml
View File

@ -23,7 +23,7 @@ tags:
`Threads` are conversations between an `assistant` and the user: `Threads` are conversations between an `assistant` and the user:
- Users can tweak `model` params and `assistant` behavior within each thread. - Users can tweak `model` params and `assistant` behavior within each thread.
- Users can import and export threads. - 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`. - An [OpenAI Thread API](https://platform.openai.com/docs/api-reference/threads) compatible endpoint at `localhost:1337/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: