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

feat: Add SEO header tag with OpenAI GPT-4

Browse Source
This commit is contained in:
hiro 2024-03-19 00:15:30 +07:00 committed by hiro
parent d1a17f0986
commit 4a267ff35b
18 changed files with 324 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx
View File

@ -5,6 +5,21 @@ slug: /postmortems/january-10-2024-bitdefender-false-positive-flag
tags: [Postmortem] tags: [Postmortem]
--- ---
<head>
<title>Jan 10, 2024 Incident Postmortem - Bitdefender False Positive Flag on Jan AI Resolved</title>
<meta charSet="utf-8" />
<meta name="description" content="Comprehensive postmortem on the Jan AI v0.4.4 Bitdefender false positive incident on January 10, 2024. Learn about the investigation, solutions, and preventive measures." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, postmortem, incident, flagging issue" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/blog/postmortems/january-10-2024-bitdefender-false-positive-flag/" />
<meta property="og:title" content="Bitdefender False Positive Flag on Jan AI Resolved - Jan 10, 2024 Incident Postmortem" />
<meta property="og:description" content="Comprehensive postmortem on the Jan AI v0.4.4 Bitdefender false positive incident on January 10, 2024. Learn about the investigation, solutions, and preventive measures." />
<meta property="og:url" content="https://jan.ai/blog/postmortems/january-10-2024-bitdefender-false-positive-flag/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
Following the recent incident related to Jan version 0.4.4 triggering Bitdefender on Windows with Gen:Variant.Tedy.258323 on January 10, 2024, we wanted to provide a comprehensive postmortem and outline the necessary follow-up actions. Following the recent incident related to Jan version 0.4.4 triggering Bitdefender on Windows with Gen:Variant.Tedy.258323 on January 10, 2024, we wanted to provide a comprehensive postmortem and outline the necessary follow-up actions.
## Incident Overview ## Incident Overview

14
docs/docs/developer/01-overview/01-architecture.md
View File

@ -15,6 +15,20 @@ keywords:
] ]
--- ---
<head>
<title>Jan AI Architecture - Modular and Extensible Framework</title>
<meta charSet="utf-8" />
<meta name="description" content="Discover the modular architecture of Jan, a ChatGPT alternative that runs on your own computer. Learn about Jan's local API server, Desktop UI, and the Nitro inference engine." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, modular architecture, Extensions API" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/architecture/" />
<meta property="og:title" content="Jan AI Architecture - Modular and Extensible Framework" />
<meta property="og:description" content="Discover the modular architecture of Jan, a ChatGPT alternative that runs on your own computer. Learn about Jan's local API server, Desktop UI, and the Nitro inference engine." />
<meta property="og:url" content="https://jan.ai/developer/architecture/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::warning :::warning
This page is still under construction, and should be read as a scratchpad This page is still under construction, and should be read as a scratchpad

14
docs/docs/developer/01-overview/02-file-based.md
View File

@ -15,6 +15,20 @@ keywords:
] ]
--- ---
<head>
<title>Jan AI File-based Data Persistence Approach</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how Jan, a ChatGPT alternative, leverages a local filesystem for data persistence, promoting composability and tinkerability similar to VSCode." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, file-based data storage, data persistence" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/file-based/" />
<meta property="og:title" content="Jan AI File-based Data Persistence Approach" />
<meta property="og:description" content="Learn how Jan, a ChatGPT alternative, leverages a local filesystem for data persistence, promoting composability and tinkerability similar to VSCode." />
<meta property="og:url" content="https://jan.ai/developer/file-based/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::warning :::warning
This page is still under construction, and should be read as a scratchpad This page is still under construction, and should be read as a scratchpad

14
docs/docs/developer/01-overview/03-user-interface.md
View File

@ -15,6 +15,20 @@ keywords:
] ]
--- ---
<head>
<title>Jan AI User Interface - Customizable UI Kit</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore Jan's UI Kit for customizing the user interface to fit your brand and style. Learn how to personalize your application with Jan's flexible UI components." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, UI Kit, customizable UI" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/ui/" />
<meta property="og:title" content="Jan AI User Interface - Customizable UI Kit" />
<meta property="og:description" content="Explore Jan's UI Kit for customizing the user interface to fit your brand and style. Learn how to personalize your application with Jan's flexible UI components." />
<meta property="og:url" content="https://jan.ai/developer/ui/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::warning :::warning
This page is still under construction, and should be read as a scratchpad This page is still under construction, and should be read as a scratchpad

14
docs/docs/developer/01-overview/04-install-and-prerequisites.md
View File

@ -18,6 +18,20 @@ keywords:
] ]
--- ---
<head>
<title>Jan AI Installation and Setup Guide - Developer Prerequisites</title>
<meta charSet="utf-8" />
<meta name="description" content="Comprehensive guide to installing and setting up Jan for development. Covers hardware, system requirements, and step-by-step instructions for developers." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, installation, prerequisites, developer setup" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/prereq/" />
<meta property="og:title" content="Jan AI Installation and Setup Guide - Developer Prerequisites" />
<meta property="og:description" content="Comprehensive guide to installing and setting up Jan for development. Covers hardware, system requirements, and step-by-step instructions for developers." />
<meta property="og:url" content="https://jan.ai/developer/prereq/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
## Requirements ## Requirements
### Hardware Requirements ### Hardware Requirements

14
docs/docs/developer/01-overview/README.md
View File

@ -15,6 +15,20 @@ keywords:
] ]
--- ---
<head>
<title>Jan AI Developer Documentation - Building Extensions and SDK Overview</title>
<meta charSet="utf-8" />
<meta name="description" content="Guide for developers on building extensions on top of the Jan Framework. Learn about Jan's extensible framework for AI applications, available on all platforms." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, extensible framework, SDK, building extensions" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/" />
<meta property="og:title" content="Jan AI Developer Documentation - Building Extensions and SDK Overview" />
<meta property="og:description" content="Guide for developers on building extensions on top of the Jan Framework. Learn about Jan's extensible framework for AI applications, available on all platforms." />
<meta property="og:url" content="https://jan.ai/developer/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
The following docs are aimed at developers who want to build extensions on top of the Jan Framework. The following docs are aimed at developers who want to build extensions on top of the Jan Framework.
:::tip :::tip

20
docs/docs/developer/04-build-extension/01-your-first-extension.md
View File

@ -17,6 +17,20 @@ keywords:
] ]
--- ---
<head>
<title>Building Your First Jan AI Extension - Quick Start Guide</title>
<meta charSet="utf-8" />
<meta name="description" content="Step-by-step guide on how to build your first extension for Jan AI. Learn how to use the extension template and integrate your custom functionality into Jan." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, quick start, build extension" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/build-extension/your-first-extension/" />
<meta property="og:title" content="Building Your First Jan AI Extension - Quick Start Guide" />
<meta property="og:description" content="Step-by-step guide on how to build your first extension for Jan AI. Learn how to use the extension template and integrate your custom functionality into Jan." />
<meta property="og:url" content="https://jan.ai/developer/build-extension/your-first-extension/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
:::caution :::caution
This is currently under development. This is currently under development.
::: :::
@ -76,13 +90,13 @@ There are a few things to keep in mind when writing your extension code:
In `index.ts`, you will see that the extension function will return a `Promise<any>`. In `index.ts`, you will see that the extension function will return a `Promise<any>`.
```typescript ```typescript
import { core } from "@janhq/core"; import { core } from '@janhq/core'
function onStart(): Promise<any> { function onStart(): Promise<any> {
return core.invokePluginFunc(MODULE_PATH, "run", 0); return core.invokePluginFunc(MODULE_PATH, 'run', 0)
} }
``` ```
For more information about the Jan Extension Core module, see the [documentation](https://github.com/janhq/jan/blob/main/core/README.md). For more information about the Jan Extension Core module, see the [documentation](https://github.com/janhq/jan/blob/main/core/README.md).
Now, go ahead and start customizing your extension! Happy coding! Now, go ahead and start customizing your extension! Happy coding!

16
docs/docs/guides/error-codes/permission-denied.mdx
View File

@ -17,7 +17,21 @@ keywords:
] ]
--- ---
When running Jan, you might encounter the following error message: <head>
<title>Resolving "Permission Denied" Error in Jan AI</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how to resolve the 'Permission Denied' error encountered while running Jan AI by changing ownership of the `~/.npm` directory to the current user." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, permission denied" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/troubleshooting/permission-denied" />
<meta property="og:title" content="Resolving 'Permission Denied' Error in Jan AI" />
<meta property="og:description" content="Learn how to resolve the 'Permission Denied' error encountered while running Jan AI by changing ownership of the `~/.npm` directory to the current user." />
<meta property="og:url" content="https://jan.ai/troubleshooting/permission-denied" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
When you run Jan, you may encounter the following error:
``` ```
Uncaught (in promise) Error: Error invoking layout-480796bff433a3a3.js:538 remote method 'installExtension': Uncaught (in promise) Error: Error invoking layout-480796bff433a3a3.js:538 remote method 'installExtension':

13
docs/docs/guides/extensions/setup-ext.mdx
View File

@ -16,6 +16,19 @@ keywords:
] ]
--- ---
<head>
<title>Configuring Extension Settings in Jan AI - User Guide</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how to configure settings for default extensions in Jan AI, including how to enable/disable extensions and modify their configurations." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, extension settings" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/using-extensions/extension-settings/" />
<meta property="og:title" content="Configuring Extension Settings in Jan AI - User Guide" />
<meta property="og:description" content="Learn how to configure settings for default extensions in Jan AI, including how to enable/disable extensions and modify their configurations." />
<meta property="og:url" content="https://jan.ai/guides/using-extensions/extension-settings/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
The current Jan Desktop Client has some default extensions built on top of this framework to enhance the user experience. In this guide, we will show you the list of default extensions and how to configure extension settings. The current Jan Desktop Client has some default extensions built on top of this framework to enhance the user experience. In this guide, we will show you the list of default extensions and how to configure extension settings.

33
docs/docs/hardware/community.md
View File

@ -1,12 +1,36 @@
--- ---
title: Hardware Examples title: Hardware Examples
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
]
--- ---
<head>
<title>Hardware Examples</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Add your own hardware examples to this page by creating a new file in the `docs/docs/hardware/examples` directory." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/hardware-examples" />
<meta property="og:title" content="Hardware Examples" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Add your own hardware examples to this page by creating a new file in the `docs/docs/hardware/examples` directory." />
<meta property="og:url" content="https://jan.ai/guides/hardware-examples" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-hardware-examples.png" />
</head>
## Add your own example ## Add your own example
Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory. Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory.
```shell ```shell
docs docs
@ -18,9 +42,10 @@ docs
// highlight-next-line // highlight-next-line
└── <YOUR_BUILD_HERE>.md └── <YOUR_BUILD_HERE>.md
``` ```
### File and Title Convention ### File and Title Convention
We use a specific naming convention for the file name. We use a specific naming convention for the file name.
```shell ```shell
# Filename # Filename
@ -52,4 +77,4 @@ You are allowed to include affiliate links in your example.
## Longer-Term ## Longer-Term
We will likely build a simple web app to make it easier to add your own examples, sort and retrieve. We will likely build a simple web app to make it easier to add your own examples, sort and retrieve.

14
docs/docs/hardware/concepts/gpu-and-vram.md
View File

@ -2,6 +2,20 @@
title: GPUs and VRAM title: GPUs and VRAM
--- ---
<head>
<title>Understanding GPUs and VRAM for AI and Gaming</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore the world of GPUs and VRAM, learn their importance in gaming, AI, machine learning, and more. Understand how to connect a GPU to a motherboard and choose the right graphics card for your needs." />
<meta name="keywords" content="GPU, VRAM, graphics card, gaming, AI, machine learning, CUDA, NVIDIA, AMD, PCIe, VRAM vs RAM, choosing GPU" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/gpus-and-vram" />
<meta property="og:title" content="Understanding GPUs and VRAM for AI and Gaming" />
<meta property="og:description" content="Explore the world of GPUs and VRAM, learn their importance in gaming, AI, machine learning, and more. Understand how to connect a GPU to a motherboard and choose the right graphics card for your needs." />
<meta property="og:url" content="https://jan.ai/guides/gpus-and-vram" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
## What Is a GPU? ## What Is a GPU?
A Graphics Card, or GPU (Graphics Processing Unit), is a fundamental component in modern computing. Think of it as the powerhouse behind rendering the stunning visuals you see on your screen. Similar to the motherboard in your computer, the graphics card is a printed circuit board. However, it's not just a passive piece of hardware; it's a sophisticated device equipped with essential components like fans, onboard RAM, a dedicated memory controller, BIOS, and various other features. If you want to learn more about GPUs then read here to [Understand the architecture of a GPU.](https://medium.com/codex/understanding-the-architecture-of-a-gpu-d5d2d2e8978b) A Graphics Card, or GPU (Graphics Processing Unit), is a fundamental component in modern computing. Think of it as the powerhouse behind rendering the stunning visuals you see on your screen. Similar to the motherboard in your computer, the graphics card is a printed circuit board. However, it's not just a passive piece of hardware; it's a sophisticated device equipped with essential components like fans, onboard RAM, a dedicated memory controller, BIOS, and various other features. If you want to learn more about GPUs then read here to [Understand the architecture of a GPU.](https://medium.com/codex/understanding-the-architecture-of-a-gpu-d5d2d2e8978b)

14
docs/docs/hardware/recommendations/by-budget.md
View File

@ -2,6 +2,20 @@
title: Recommended AI Hardware by Budget title: Recommended AI Hardware by Budget
--- ---
<head>
<title>Recommended AI Hardware Builds by Budget</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore recommended AI hardware builds for entry-level, mid-range, and high-end budgets. Find the perfect balance of performance and cost for your AI and machine learning projects." />
<meta name="keywords" content="AI hardware, budget PC build, entry-level AI PC, mid-range AI PC, high-end AI PC, GPU for AI, AI PC build, machine learning hardware" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/recommended-ai-hardware-by-budget" />
<meta property="og:title" content="Recommended AI Hardware Builds by Budget" />
<meta property="og:description" content="Explore recommended AI hardware builds for entry-level, mid-range, and high-end budgets. Find the perfect balance of performance and cost for your AI and machine learning projects." />
<meta property="og:url" content="https://jan.ai/guides/recommended-ai-hardware-by-budget" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>
> :warning: **Warning:** Do your own research before any purchase. Jan is not liable for compatibility, performance or other issues. Products can become outdated quickly. > :warning: **Warning:** Do your own research before any purchase. Jan is not liable for compatibility, performance or other issues. Products can become outdated quickly.
## Entry-level PC Build at $1000 ## Entry-level PC Build at $1000

14
docs/docs/hardware/recommendations/by-hardware.md
View File

@ -2,6 +2,20 @@
title: Selecting AI Hardware title: Selecting AI Hardware
--- ---
<head>
<title>Selecting AI Hardware</title>
<meta charset="utf-8" />
<meta name="description" content="Guidance on selecting optimal AI hardware, including GPUs, CPUs, RAM, and motherboards for running Large Language Models (LLMs) efficiently. Explore factors like VRAM, CUDA compatibility, and unified memory architecture to build a powerful AI setup." />
<meta name="keywords" content="AI hardware, GPU for LLM, CPU for AI, RAM for machine learning, motherboard for AI, CUDA, VRAM, Unified Memory Architecture, M1, M2 Pro/Max, VRAM calculation" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/selecting-ai-hardware" />
<meta property="og:title" content="Selecting AI Hardware" />
<meta property="og:description" content="Guidance on selecting optimal AI hardware, including GPUs, CPUs, RAM, and motherboards for running Large Language Models (LLMs) efficiently. Explore factors like VRAM, CUDA compatibility, and unified memory architecture to build a powerful AI setup." />
<meta property="og:url" content="https://jan.ai/guides/selecting-ai-hardware" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-ai-hardware.png" />
</head>
When selecting a GPU for LLMs, remember that it's not just about the GPU itself. Consider the synergy with other components in your PC: When selecting a GPU for LLMs, remember that it's not just about the GPU itself. Consider the synergy with other components in your PC:
- **CPU**: To ensure efficient processing, pair your GPU with a powerful CPU. LLMs benefit from fast processors, so having a capable CPU is essential. - **CPU**: To ensure efficient processing, pair your GPU with a powerful CPU. LLMs benefit from fast processors, so having a capable CPU is essential.

14
docs/docs/hardware/recommendations/by-model.md
View File

@ -2,6 +2,20 @@
title: Recommended AI Hardware by Model title: Recommended AI Hardware by Model
--- ---
<head>
<title>Recommended AI Hardware by Model</title>
<meta charset="utf-8" />
<meta name="description" content="Explore the recommended AI hardware specifications for running Codellama models efficiently. Find RAM and VRAM requirements for different parameter sizes and quantization formats, along with minimum recommended GPUs." />
<meta name="keywords" content="Codellama, AI hardware, recommended hardware, system requirements, RAM requirements, VRAM requirements, GPU recommendations, GPTQ, GGML, GGUF, parameter models, quantization formats" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/recommended-ai-hardware-by-model" />
<meta property="og:title" content="Recommended AI Hardware by Model" />
<meta property="og:description" content="Explore the recommended AI hardware specifications for running Codellama models efficiently. Find RAM and VRAM requirements for different parameter sizes and quantization formats, along with minimum recommended GPUs." />
<meta property="og:url" content="https://jan.ai/recommended-ai-hardware-by-model" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-recommended-hardware.png" />
</head>
## Codellama 34b ## Codellama 34b
### System Requirements: ### System Requirements:

14
docs/docs/hardware/recommendations/by-usecase.md
View File

@ -2,6 +2,20 @@
title: Recommended AI Hardware by Use Case title: Recommended AI Hardware by Use Case
--- ---
<head>
<title>Recommended AI Hardware by Model</title>
<meta charset="utf-8" />
<meta name="description" content="Explore hardware requirements for running Codellama 34b models effectively. Find system, RAM, and VRAM requirements along with GPU recommendations tailored for optimal performance or budget-friendly setups." />
<meta name="keywords" content="AI hardware, Codellama 34b, system requirements, RAM requirements, VRAM requirements, GPU recommendations, optimal performance, budget-friendly setup" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/recommended-ai-hardware-by-model" />
<meta property="og:title" content="Recommended AI Hardware by Model" />
<meta property="og:description" content="Explore hardware requirements for running Codellama 34b models effectively. Find system, RAM, and VRAM requirements along with GPU recommendations tailored for optimal performance or budget-friendly setups." />
<meta property="og:url" content="https://jan.ai/guides/recommended-ai-hardware-by-model" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-ai-hardware-model.png" />
</head>
## Which AI Hardware to Choose Based on Your Use Case ## Which AI Hardware to Choose Based on Your Use Case
Artificial intelligence (AI) is rapidly changing the world, and AI hardware is becoming increasingly important for businesses and individuals alike. Choosing the right hardware for your AI needs is crucial to get the best performance and results. Here are some tips for selecting AI hardware based on your specific use case and requirements. Artificial intelligence (AI) is rapidly changing the world, and AI hardware is becoming increasingly important for businesses and individuals alike. Choosing the right hardware for your AI needs is crucial to get the best performance and results. Here are some tips for selecting AI hardware based on your specific use case and requirements.

18
docs/docs/privacy/privacy.md
View File

@ -1,3 +1,21 @@
---
title: Privacy - Jan
---
<head>
<title>Privacy Policy - Jan</title>
<meta charset="utf-8" />
<meta name="description" content="Learn about Jan's commitment to privacy and how your personal information is handled when using our mobile application. Understand our data collection, sharing, and security measures." />
<meta name="keywords" content="Jan AI, Jan, privacy policy, data collection, data usage, data sharing, data security, user choices, contact us" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/privacy-policy" />
<meta property="og:title" content="Privacy Policy - Jan" />
<meta property="og:description" content="Learn about Jan's commitment to privacy and how your personal information is handled when using our mobile application. Understand our data collection, sharing, and security measures." />
<meta property="og:url" content="https://jan.ai/privacy-policy" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-privacy-policy.png" />
</head>
# Privacy Policy # Privacy Policy
Jan is committed to protecting your privacy and ensuring that your personal information is handled in a safe and responsible way. This policy outlines how we collect, store, and use your personal information when you use our mobile application. Jan is committed to protecting your privacy and ensuring that your personal information is handled in a safe and responsible way. This policy outlines how we collect, store, and use your personal information when you use our mobile application.

18
docs/docs/support/support.md
View File

@ -1,3 +1,21 @@
---
title: Support - Jan
---
<head>
<title>Support - Jan</title>
<meta charset="utf-8" />
<meta name="description" content="Find support options for Jan, including bug reporting, discussion forums, business inquiries, and job applications. Connect with us through GitHub, Discord, or email." />
<meta name="keywords" content="Jan AI, Jan, support, bug reporting, GitHub, Discord, business inquiries, job applications, contact us" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/support" />
<meta property="og:title" content="Support - Jan" />
<meta property="og:description" content="Find support options for Jan, including bug reporting, discussion forums, business inquiries, and job applications. Connect with us through GitHub, Discord, or email." />
<meta property="og:url" content="https://jan.ai/support" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-support.png" />
</head>
# Support # Support
- Bugs & requests: file a GitHub ticket [here](https://github.com/janhq/jan/issues) - Bugs & requests: file a GitHub ticket [here](https://github.com/janhq/jan/issues)

64
docs/docs/template/QA_script.md vendored
View File

@ -1,5 +1,25 @@
---
title: Jan version release template
---
<head>
<title>Release Version QA Script template</title>
<meta charset="utf-8" />
<meta name="description" content="Quality Assurance script for testing the release version template of Jan. This script covers installation, update, uninstallation, overview, thread functionalities, Hub features, system monitor, settings, and local API server usage." />
<meta name="keywords" content="QA script, release version,template, Jan, installation, update, uninstallation, overview, thread, Hub, system monitor, settings, local API server" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/qa-scripts/release-template" />
<meta property="og:title" content="Release Version QA Script - template" />
<meta property="og:description" content="Quality Assurance script for testing the release version template of Jan. This script covers installation, update, uninstallation, overview, thread functionalities, Hub features, system monitor, settings, and local API server usage." />
<meta property="og:url" content="https://jan.ai/qa-scripts/release-template" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-qa-script.png" />
</head>
# Regression test # Regression test
# [Release Version] QA Script
**Release Version:** v0.4.7 **Release Version:** v0.4.7
**Operating System:** MacOS **Operating System:** MacOS
@ -26,7 +46,6 @@
- [ ] :key::warning: Check that the uninstallation process removes the app successfully from the system. - [ ] :key::warning: Check that the uninstallation process removes the app successfully from the system.
- [ ] Clean the Jan root directory and open the app to check if it creates all the necessary folders, especially models and extensions. - [ ] Clean the Jan root directory and open the app to check if it creates all the necessary folders, especially models and extensions.
## B. Overview ## B. Overview
### 1. Shortcut key, memory usage / CPU usage ### 1. Shortcut key, memory usage / CPU usage
@ -71,10 +90,18 @@
- [ ] :key: Ensure that users switch between threads with different models, the app can handle it. - [ ] :key: Ensure that users switch between threads with different models, the app can handle it.
### 3. Model dropdown ### 3. Model dropdown
- [ ] :key: Model list should highlight recommended based on user RAM - [ ] :key: Model list should highlight recommended based on user RAM
- [ ] Model size should display (for both installed and imported models) - [ ] Model size should display (for both installed and imported models)
### 4. Users can click on a history thread ### 4. Users can click on a history thread
# <<<<<<< HEAD
- [ ] Test the ability to click on any thread in the history panel.
- [ ] :key: Verify that clicking a thread brings up the past conversation in the main chat window.
- [ ] :key: Ensure that the selected thread is highlighted or otherwise indicated in the history panel.
> > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4)
- [ ] Confirm that the chat window displays the entire conversation from the selected history thread without any missing messages. - [ ] Confirm that the chat window displays the entire conversation from the selected history thread without any missing messages.
- [ ] :key: Check the performance and accuracy of the history feature when dealing with a large number of threads. - [ ] :key: Check the performance and accuracy of the history feature when dealing with a large number of threads.
- [ ] Validate that historical threads reflect the exact state of the chat at that time, including settings. - [ ] Validate that historical threads reflect the exact state of the chat at that time, including settings.
@ -82,12 +109,16 @@
- [ ] Confirm that changing the title of the thread updates correctly. - [ ] Confirm that changing the title of the thread updates correctly.
### 5. Users can config instructions for the assistant. ### 5. Users can config instructions for the assistant.
# <<<<<<< HEAD
- [ ] Ensure there is a clear interface to input or change instructions for the assistant.
> > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4)
- [ ] Test if the instructions set by the user are being followed by the assistant in subsequent conversations. - [ ] Test if the instructions set by the user are being followed by the assistant in subsequent conversations.
- [ ] :key: Validate that changes to instructions are updated in real time and do not require a restart of the application or session. - [ ] :key: Validate that changes to instructions are updated in real time and do not require a restart of the application or session.
- [ ] :key: Check for the ability to reset instructions to default or clear them completely. - [ ] :key: Check for the ability to reset instructions to default or clear them completely.
- [ ] :key: RAG - Users can import documents and the system should process queries about the uploaded file, providing accurate and appropriate responses in the conversation thread. - [ ] :key: RAG - Users can import documents and the system should process queries about the uploaded file, providing accurate and appropriate responses in the conversation thread.
## D. Hub ## D. Hub
### 1. Users can discover recommended models (Jan ships with a few preconfigured model.json files) ### 1. Users can discover recommended models (Jan ships with a few preconfigured model.json files)
@ -117,13 +148,14 @@
### 5. Users can use the model as they want ### 5. Users can use the model as they want
- [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does. - [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does.
- [ ] Check if starting another model stops the other model entirely. - [ ] Check if starting another model stops the other model entirely.
- [x] :rocket: Check the `Explore models` navigate correctly to the model panel. - [x] :rocket: Check the `Explore models` navigate correctly to the model panel.
- [ ] :key: Check when deleting a model it will delete all the files on the user's computer. - [ ] :key: Check when deleting a model it will delete all the files on the user's computer.
- [ ] :warning:The recommended tags should present right for the user's hardware. - [ ] :warning:The recommended tags should present right for the user's hardware.
### 6. Users can Integrate With a Remote Server ### 6. Users can Integrate With a Remote Server
- [ ] :key: Import openAI GPT model https://jan.ai/guides/using-models/integrate-with-remote-server/ and the model displayed in Hub / Thread dropdown - [ ] :key: Import openAI GPT model https://jan.ai/guides/using-models/integrate-with-remote-server/ and the model displayed in Hub / Thread dropdown
- [ ] Users can use the remote model properly - [ ] Users can use the remote model properly
@ -175,6 +207,27 @@
- [ ] :key: Test the `Experimental Mode` toggle to confirm it enables or disables experimental features as intended. - [ ] :key: Test the `Experimental Mode` toggle to confirm it enables or disables experimental features as intended.
- [ ] :key: Check the functionality of `Open App Directory` to ensure it opens the correct folder in the system file explorer. - [ ] :key: Check the functionality of `Open App Directory` to ensure it opens the correct folder in the system file explorer.
<<<<<<< HEAD
=======
- [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed.
- [ ] Test the application's stability when experimental features are enabled.
### 4. Users can add custom plugins via manual installation [TBU]
- [ ] Verify that the `Manual Installation` option is clearly visible and accessible in the `Extensions` section.
- [ ] Test the functionality of the `Select` button within the `Manual Installation` area.
- [ ] :warning: Check that the file picker dialog allows for the correct plugin file types (e.g., .tgz).
- [ ] :key: Validate that the selected plugin file installs correctly and the plugin becomes functional.
- [ ] Ensure that there is a progress indicator or confirmation message once the installation is complete.
- [ ] Confirm that if the installation is interrupted or fails, the user is given a clear error message.
- [ ] :key: Test that the application prevents the installation of incompatible or corrupt plugin files.
- [ ] :key: Check that the user can uninstall or disable custom plugins as easily as pre-installed ones.
- [ ] Verify that the application's performance remains stable after the installation of custom plugins.
### 5. Advanced Settings
- [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562)
> > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4)
- [ ] Users can move **Jan data folder** - [ ] Users can move **Jan data folder**
- [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed. - [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed.
- [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562) - [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562)
@ -184,9 +237,10 @@
## G. Local API server ## G. Local API server
### 1. Local Server Usage with Server Options ### 1. Local Server Usage with Server Options
- [ ] :key: Explore API Reference: Swagger API for sending/receiving requests - [ ] :key: Explore API Reference: Swagger API for sending/receiving requests
- [ ] Use default server option - [ ] Use default server option
- [ ] Configure and use custom server options - [ ] Configure and use custom server options
- [ ] Test starting/stopping the local API server with different Model/Model settings - [ ] Test starting/stopping the local API server with different Model/Model settings
- [ ] Server logs captured with correct Server Options provided - [ ] Server logs captured with correct Server Options provided
- [ ] Verify functionality of Open logs/Clear feature - [ ] Verify functionality of Open logs/Clear feature