|
1 | | -# <img src="https://avatars.githubusercontent.com/u/30185530?s=200&v=4" alt="OpenMined" width="32" align="center"> Syft Space Server |
| 1 | +# <a href="https://github.com/OpenMined"><img src="https://avatars.githubusercontent.com/u/30185530?s=200&v=4" alt="OpenMined" width="32" align="center"></a> Syft Space Server |
2 | 2 |
|
3 | 3 | [](https://www.python.org/downloads/) |
4 | 4 | [](https://nodejs.org/) |
|
8 | 8 | [](https://github.com/astral-sh/uv) |
9 | 9 | [](https://bun.sh/) |
10 | 10 |
|
11 | | -A friendly platform for building AI-powered search and question-answering tools. Connect your documents to language models and query them through simple API endpoints. |
| 11 | +A space where you can turn data and models into shareable workflows — exposing them through secure endpoints under your own rules for privacy, payments, and human oversight. |
12 | 12 |
|
13 | 13 | ## What This Project Does |
14 | 14 |
|
15 | | -Syft Space Server helps you create **RAG (Retrieval-Augmented Generation) endpoints**. In plain terms, it lets you: |
| 15 | +Syft Space Server lets you create **secure, shareable AI endpoints**. In plain terms, it helps you: |
16 | 16 |
|
17 | | -- **Upload documents** to a searchable database |
18 | | -- **Connect language models** (like OpenAI-compatible APIs) |
19 | | -- **Create endpoints** that combine your documents with AI to answer questions |
| 17 | +- **Connect your data** to searchable vector databases |
| 18 | +- **Integrate language models** (OpenAI-compatible APIs) |
| 19 | +- **Build endpoints** that combine data and models into queryable workflows |
| 20 | +- **Set your own rules** for access control, rate limiting, and usage tracking |
20 | 21 |
|
21 | | -Think of it as a bridge between your data and AI models, wrapped in an easy-to-use interface. |
| 22 | +Think of it as your personal control plane for AI workflows — you decide who can access what, under what terms. |
22 | 23 |
|
23 | 24 | ## Why You Might Want to Use It |
24 | 25 |
|
25 | | -- **Build AI search tools** without managing complex infrastructure |
26 | | -- **Self-host your data** instead of sending everything to third-party services |
27 | | -- **Create custom Q&A bots** trained on your own documents |
28 | | -- **Experiment with RAG** using a visual interface |
| 26 | +- **Own your data** — self-host instead of sending everything to third parties |
| 27 | +- **Control access** — define policies for privacy, payments, and oversight |
| 28 | +- **Share securely** — expose endpoints without exposing raw data |
| 29 | +- **Stay flexible** — works with your existing models and databases |
| 30 | + |
| 31 | +## Prerequisites |
| 32 | + |
| 33 | +- **Docker** (recommended) - [Install Docker](https://docs.docker.com/get-docker/) |
| 34 | + |
| 35 | +Or for running from source: |
| 36 | +- **Python 3.10+** - [Download Python](https://www.python.org/downloads/) |
| 37 | +- **Bun** - [Install Bun](https://bun.sh/) |
29 | 38 |
|
30 | 39 | ## Quick Start |
31 | 40 |
|
@@ -107,7 +116,7 @@ bun dev |
107 | 116 | ``` |
108 | 117 |
|
109 | 118 | The frontend development server runs at [http://localhost:5173](http://localhost:5173). |
110 | | -For detailed reference to frontend and developement instructions, see [`frontend/README.md`](frontend/README.md). |
| 119 | +For detailed reference to frontend and development instructions, see [`frontend/README.md`](frontend/README.md). |
111 | 120 |
|
112 | 121 | ## Configuration |
113 | 122 |
|
|
0 commit comments