mirror of
https://github.com/zebrajr/privateGPT.git
synced 2025-12-06 00:19:52 +01:00
4523a30c8f
* docs: add missing configurations * docs: change HF embeddings by ollama * docs: add disclaimer about Gradio UI * docs: improve readability in concepts * docs: reorder `Fully Local Setups` * docs: improve setup instructions * docs: prevent have duplicate documentation and use table to show different options * docs: rename privateGpt to PrivateGPT * docs: update ui image * docs: remove useless header * docs: convert to alerts ingestion disclaimers * docs: add UI alternatives * docs: reference UI alternatives in disclaimers * docs: fix table * chore: update doc preview version * chore: add permissions * chore: remove useless line * docs: fixes ...
34 lines
1.0 KiB
Plaintext
34 lines
1.0 KiB
Plaintext
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 a `local` setup.
|
|
|
|
Get started by understanding the [Main Concepts and Installation](/installation) and then dive into the [API Reference](/api-reference).
|
|
|
|
## Frequently Visited Resources
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Main Concepts"
|
|
icon="fa-solid fa-lines-leaning"
|
|
href="/installation"
|
|
/>
|
|
<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>
|
|
|
|
<br /> |