> For the complete documentation index, see [llms.txt](https://qyverlabs.gitbook.io/qyverlabs-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://qyverlabs.gitbook.io/qyverlabs-docs/readme.md).

# Welcome

**Qyver** is a Python framework designed for AI Engineers developing high-performance search and recommendation applications that integrate both structured and unstructured data.

#### **Why Qyver?**

Enhance vector search relevance by encoding metadata alongside unstructured data into vectors. Learn more at Why Qyver.

#### **What is Qyver?**

A framework and self-hostable REST API server that seamlessly connects your data, vector database, and backend services.

#### **How does it work?**

Build custom data and query embedding models using pre-trained encoders from **sentence-transformers**, **open-clip**, and custom encoders for numbers, timestamps, and categorical data. Explore concepts and use cases for examples.

If you find Qyver useful, give us a [⭐](mailto:undefined)!

<figure><img src="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2FMwiknnMTbhuJfX6TweFC%2Fqyverlabsgraph.png?alt=media&amp;token=fcff170b-1329-4af1-a6b5-14c95c6edaf8" alt=""><figcaption></figcaption></figure>

### Getting Started

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td>Why Qyver?</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2FdHGMej45YX8hhipEYEUd%2Fwhywyver.png?alt=media&amp;token=e4336de9-ad94-45ee-a82f-d67a56eba57e">whywyver.png</a></td></tr><tr><td><strong>Setup Qyver</strong></td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2Fbuw6SNBL6eVT9y4YLM9d%2Fsetupqyver.png?alt=media&amp;token=9b844d18-173f-4225-afc0-03d3461a6244">setupqyver.png</a></td></tr><tr><td><strong>Basic Building Blocks</strong></td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2Fosk6SIpLQxfgVhYPmEbN%2Fbbb.png?alt=media&amp;token=e369dca5-7673-460a-9e45-639add945d55">bbb.png</a></td></tr></tbody></table>

### Run In Production

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Overview</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2Fgxfm5iPojYFpI35IsAN2%2Fov.png?alt=media&amp;token=90fe8655-5228-40e7-a2ad-04b4ce361236">ov.png</a></td><td></td><td></td></tr><tr><td>Setup a Server</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2FrRKiI0CH1KUjCk5W7YQz%2Fsetupase.png?alt=media&amp;token=fe40d865-8b4d-4925-ac4b-ad65b2fb06dd">setupase.png</a></td><td></td><td></td></tr><tr><td>Configuring your app</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2Fatvdqr103EtehujkhFWL%2Fconfiguringapp.png?alt=media&amp;token=a2dc7a02-cdea-4de4-a644-e314593976a8">configuringapp.png</a></td><td></td><td></td></tr><tr><td>Interacting via API</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2FwmtEGDObQJAthW6XljYu%2Finteractingviaapi.png?alt=media&amp;token=11fc69a8-cf8f-4bc4-a06e-dbe3ea353ee2">interactingviaapi.png</a></td><td></td><td></td></tr><tr><td>Supported Vector DBs</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2F7FzkTprQwRTJJdJz4ScO%2Fvectordb.png?alt=media&amp;token=693558b5-d485-4d37-867c-c67e39af3826">vectordb.png</a></td><td></td><td></td></tr><tr><td>Multiple Embeddings</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2F0VhpDBxDeeZJ7qH2OgSm%2FMultipleEmbed.png?alt=media&amp;token=2280a13e-6d9f-42fe-a9a6-0d43ec3d74ae">MultipleEmbed.png</a></td><td></td><td></td></tr><tr><td>Dynamic Parameters</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2FaW0m32L1hDb4m0cvMejn%2Fdynamicparameters.png?alt=media&amp;token=138f36f2-ff2b-4f7f-9e33-dd1a4a72fe18">dynamicparameters.png</a></td><td></td><td></td></tr><tr><td>Changelog</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2FyiirTL8MG2uhhiAedhrt%2Fchangelog.png?alt=media&amp;token=346cc849-57a4-435a-90be-bfe11370c9a0">changelog.png</a></td><td></td><td></td></tr><tr><td>Framework Overview</td><td><a href="https://3582402547-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa1WA83Ym6zkEykb98MkK%2Fuploads%2F44kN0yLXkmN9s3Uun3ze%2Fframeworkoverview.png?alt=media&amp;token=d5201eb2-00ea-4227-8e23-b48b855032f7">frameworkoverview.png</a></td><td></td><td></td></tr></tbody></table>
