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

docs: enhance content

Browse Source
This commit is contained in:
hieu-jan 2024-02-16 07:30:39 +07:00
parent e7722e4159
commit 8f07ee3aa9
4 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/guides/05-using-server/01-start-server.md
View File

@ -12,6 +12,8 @@ keywords:
conversational AI, conversational AI,
no-subscription fee, no-subscription fee,
large language model, large language model,
local server,
api server,
] ]
--- ---
@ -23,9 +25,9 @@ Navigate by clicking the `Local API Server` icon on the left side of your screen
<br></br> <br></br>
![01-local-api-view](./assets/01-local-api-view.png) ![01-local-api-view](./assets/01-local-api-view.gif)
## Choose your model ## Choosing a Model
On the top right of your screen under `Model Settings`, set the LLM that your local server will be running. You can choose from any of the models already installed, or pick a new model by clicking `Explore the Hub`. On the top right of your screen under `Model Settings`, set the LLM that your local server will be running. You can choose from any of the models already installed, or pick a new model by clicking `Explore the Hub`.
@ -33,9 +35,9 @@ On the top right of your screen under `Model Settings`, set the LLM that your lo
![01-choose-model](./assets/01-choose-model.png) ![01-choose-model](./assets/01-choose-model.png)
## Set your Server Options ## Server Options
On the left side of your screen you can set custom server options. On the left side of your screen, you can set custom server options.
<br></br> <br></br>
@ -49,9 +51,9 @@ You can make the local server more accessible by clicking on the address and cho
### Port ### Port
Jan runs on port `1337` by default, but this can be changed. Jan runs on port `1337` by default. You can change the port to any other port number if needed.
### CORS ### Cross-Origin Resource Sharing (CORS)
Cross-Origin Resource Sharing (CORS) manages resource access on the local server from external domains. Enabled for security by default, it can be disabled if needed. Cross-Origin Resource Sharing (CORS) manages resource access on the local server from external domains. Enabled for security by default, it can be disabled if needed.

4
docs/docs/guides/05-using-server/02-using-server.md
View File

@ -11,6 +11,8 @@ keywords:
conversational AI, conversational AI,
no-subscription fee, no-subscription fee,
large language model, large language model,
local server,
api server,
] ]
--- ---
@ -40,7 +42,7 @@ With your local server running, you can click the `Try it out` button on the top
Use the API endpoints, request and response body examples as models for your own application. Use the API endpoints, request and response body examples as models for your own application.
### Curl request example ### cURL Request Example
Here's an example curl request with a local server running `tinyllama-1.1b`: Here's an example curl request with a local server running `tinyllama-1.1b`:

BIN
docs/docs/guides/05-using-server/assets/01-local-api-view.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.2 MiB

BIN
docs/docs/guides/05-using-server/assets/01-local-api-view.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 26 KiB