38 lines
1.3 KiB
Plaintext
38 lines
1.3 KiB
Plaintext
## Introduction 👋
|
|
|
|
PrivateGPT provides an **API** containing all the building blocks required to
|
|
build **private, context-aware AI applications**.
|
|
The API follows and extends OpenAI API standard, and supports both normal and streaming responses.
|
|
That means that, if you can use OpenAI API in one of your tools, you can use your own PrivateGPT API instead,
|
|
with no code changes, **and for free** if you are running privateGPT in `local` mode.
|
|
|
|
Looking for the installation quickstart? [Quickstart installation guide for Linux and macOS](/overview/welcome/quickstart).
|
|
|
|
Do you want to install it on Windows? Or do you want to take full advantage of your hardware for better performances?
|
|
The installation guide will help you in the [Installation section](/installation).
|
|
|
|
|
|
## Frequently Visited Resources
|
|
|
|
<Cards>
|
|
<Card
|
|
title="API Reference"
|
|
icon="fa-solid fa-code"
|
|
href="/api-reference"
|
|
/>
|
|
<Card
|
|
title="Twitter"
|
|
icon="fa-brands fa-twitter"
|
|
href="https://twitter.com/PrivateGPT_AI"
|
|
/>
|
|
<Card
|
|
title="Discord Server"
|
|
icon="fa-brands fa-discord"
|
|
href="https://discord.gg/bK6mRVpErU"
|
|
/>
|
|
</Cards>
|
|
|
|
<Callout intent = "info">
|
|
A working **Gradio UI client** is provided to test the API, together with a set of useful tools such as bulk
|
|
model download script, ingestion script, documents folder watch, etc.
|
|
</Callout> |