Skip to content

Commit

Permalink
Merge pull request janhq#659 from janhq/docs/add-models-swagger
Browse files Browse the repository at this point in the history
Migrate Model definitions to Swagger/OpenAPI
  • Loading branch information
dan-menlo authored Nov 19, 2023
2 parents b384f58 + 103572f commit bea0678
Show file tree
Hide file tree
Showing 11 changed files with 500 additions and 332 deletions.
6 changes: 3 additions & 3 deletions docs/docs/about/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
title: About Jan
---

Jan is a free, open source alternative to OpenAI's platform that runs on a local folder of open-format files.

We believe in the need for an open source AI ecosystem, and are building the infra and tooling to allow open source AIs to be as usable and comprehensive as proprietary ones.
Jan believes in the need for an open source AI ecosystem, and are building the infra and tooling to allow open source AIs to compete on a level playing field with proprietary ones.

Jan's long-term vision is to build a cognitive framework for future robots, who are practical, useful assistants for humans and businesses in everyday life.

Expand Down Expand Up @@ -89,3 +87,5 @@ Drop us a message in our [Discord](https://discord.gg/af6SaTdzpx) and we'll get
### Careers

Jan has a culture of ownership, independent thought, and lightning fast execution. If you'd like to join us, we have open positions on our [careers page](https://janai.bamboohr.com/careers).

## Footnotes
19 changes: 18 additions & 1 deletion docs/docs/docs/server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
---
title: API Server
---
---

:::warning

This page is under construction.

:::

Jan ships with a built-in API server, that can be used as a drop-in replacement for OpenAI's API.

Jan runs on port `1337` by default, but this can be changed in Settings.

Check out the [API Reference](/api-reference) for more information on the API endpoints.

```
curl https://localhost:1337/v1/chat/completions
```
10 changes: 5 additions & 5 deletions docs/docs/intro/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ title: Introduction
slug: /intro
---

Jan is a ChatGPT-alternative that runs on your own computer.
Jan is a ChatGPT-alternative that runs on your own computer, with a [local API server](/api).

Jan uses [open-source AI models](/guide/models), stores data in [open file formats](/specs/data-structures) and is is highly customizable via [extensions](/guide/extensions).
Jan uses [open-source AI models](/docs/models), stores data in [open file formats](/specs/data-structures), is highly customizable via [extensions](/docs/extensions).

Jan ships with an [OpenAI-compatible API](/api) and a powerful [Assistant framework](/guide/assistants) to create custom AIs.
Jan believes in the need for an open source AI ecosystem. We aim to build infra and tooling to allow open source AIs to compete on a level playing field with proprietary offerings.

## Why Jan?

#### 💻 Own your AI
Jan runs 100% on your own machine, [predictably](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3), privately and even offline. No one else can see your conversations, not even us.

#### 🏗️ Extensions
Jan ships with a powerful [extension framework](/guide/extensions), which allows developers to extend and customize Jan's functionality. In fact, most core modules of Jan are [built as extensions](/specs/architecture) and use the same extensions API.
Jan ships with a powerful [extension framework](/docs/extensions), which allows developers to extend and customize Jan's functionality. In fact, most core modules of Jan are [built as extensions](/specs/architecture) and use the same extensions API.

#### 🗂️ Open File Formats
Jan stores data in a [local folder of non-proprietary files](/specs/data-structures). You're never locked-in and can do what you want with your data with extensions, or even a different app.
Expand All @@ -31,4 +31,4 @@ Minimalism: https://docusaurus.io/docs#design-principles. Not having abstraction
File-based: User should be able to look at a Jan directory and intuit how it works. Transparency. Editing things via a text editor, vs. needing a database tool for SQLite.
Participatory: https://www.getlago.com/blog/the-5-reasons-why-we-chose-open-source -->
Participatory: https://www.getlago.com/blog/the-5-reasons-why-we-chose-open-source -->
6 changes: 6 additions & 0 deletions docs/docs/specs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: Architecture
---

:::warning

This page is still under construction, and should be read as a scratchpad

:::

- Jan is built using modules
- Plugin architecture (on Pluggable-Electron)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/specs/chats.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Chats

:::warning

Draft Specification: functionality has not been implemented yet.
This page is still under construction, and should be read as a scratchpad

:::

Expand Down
8 changes: 6 additions & 2 deletions docs/docs/specs/data-structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: Data Structures
---

:::warning

This page is still under construction, and should be read as a scratchpad

:::


```sh
janroot/
Expand All @@ -18,8 +24,6 @@ janroot/
model.json
```



Jan use the local filesystem for data persistence, similar to VSCode. This allows for composability and tinkerability.

```sh=
Expand Down
Loading

0 comments on commit bea0678

Please sign in to comment.