You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[💖 Open Source Contribution](#open-source-contribution)
44
44
45
-
## 🎯 What Is Verba?
45
+
## What Is Verba?
46
46
Verba is more than just a tool—it's a personal assistant for querying and interacting with your data, **either locally or deployed via cloud**. Have questions about your documents? Need to cross-reference multiple data points? Want to gain insights from your existing knowledge base? Verba empowers you with the combined capabilities of Weaviate's context-aware database and the analytical power of Large Language Models (LLMs). Interact with your data through an intuitive chat interface that refines search results by using the ongoing conversation context to deliver even more accurate and relevant information.
47
47
48
48
49
49
50
-
### ⚙️ Under the Hood
50
+
### Under the Hood
51
51
Verba is engineered with Weaviate's cutting-edge Generative Search technology at its core, extracting relevant context from your pool of documents to resolve queries with precision. By utilizing the power of Large Language Models, Verba doesn't just search for answers—it understands and provides responses that are contextually rich and informed by the content of your documents, all through an intuitive user interface designed for simplicity and efficiency.
52
52
53
-
### 💡 Effortless Data Import with Weaviate
53
+
### Effortless Data Import with Weaviate
54
54
Verba offers seamless data import functionality through its frontend, supporting a diverse range of file types including `.txt`, `.md`, `.pdf` and more. Before feeding your data into Weaviate, Verba handles chunking and vectorization to optimize it for search and retrieval. Together with collaborative partners we support popular libraries such as [HuggingFace](https://github.com/huggingface), [Haystack](https://github.com/deepset-ai/haystack), [Unstructured](https://github.com/Unstructured-IO/unstructured) and many more!
55
55
56
56
57
57
58
-
### 💥 Advanced Query Resolution with Hybrid Search
58
+
### Advanced Query Resolution with Hybrid Search
59
59
Experience the hybrid search capabilities of Weaviate within Verba, which merges vector and lexical search methodologies for even greater precision. This dual approach not only navigates through your documents to pinpoint exact matches but also understands the nuance of context, enabling the Large Language Models to craft responses that are both comprehensive and contextually aware. It's an advanced technique that redefines document retrieval, providing you with precisely what you need, when you need it.
60
60
61
-
### 🔥 Accelerate Queries with Semantic Cache
61
+
### Accelerate Queries with Semantic Cache
62
62
Verba enhances search efficiency with Weaviate's Semantic Cache, a sophisticated system that retains the essence of your queries, results, and dialogues. This proactive feature means that Verba anticipates your needs, using cached data to expedite future inquiries. With semantic matching, it quickly determines if your question has been asked before, delivering instant results, and even suggests auto-completions based on historical interactions, streamlining your search experience to be faster and more intuitive.
63
63
64
64
---
65
65
66
-
# ✨ Getting Started with Verba
66
+
# Getting Started with Verba
67
67
68
68
Starting your Verba journey is super easy, with multiple deployment options tailored to your preferences. Follow these simple steps to get Verba up and running:
69
69
@@ -81,7 +81,7 @@ pip install -e .
81
81
82
82
**Prerequisites**: If you're not using Docker, ensure that you have `Python >=3.10.0` installed on your system.
83
83
84
-
# 🐍 Installing Python and Setting Up a Virtual Environment
84
+
# Installing Python and Setting Up a Virtual Environment
85
85
Before you can use Verba, you'll need to ensure that `Python >=3.10.0` is installed on your system and that you can create a virtual environment for a safer and cleaner project setup.
86
86
87
87
## Installing Python
@@ -137,7 +137,7 @@ Once your virtual environment is activated, you'll see its name in the terminal
137
137
138
138
> Remember to deactivate the virtual environment when you're done working with Verba by simply running deactivate in the terminal.
139
139
140
-
# 📦 Choosing the Right Verba Installation Package
140
+
# Choosing the Right Verba Installation Package
141
141
Verba comes in several installation packages, each tailored for specific use cases and environments. Choose the package that aligns with your requirements:
142
142
143
143
## Default Package
@@ -167,7 +167,7 @@ pip install goldenverba[dev]
167
167
168
168
> Keep in mind that this version is intended for development purposes and may contain experimental features.
169
169
170
-
# 🚀 Quickstart: Deploy with pip
170
+
# Quickstart: Deploy with pip
171
171
172
172
1.**Initialize a new Python Environment**
173
173
```
@@ -191,7 +191,7 @@ Visit localhost:8000
191
191
192
192
5.**Create .env file and add environment variables**
193
193
194
-
# 🛠️ Quickstart: Build from Source
194
+
# Quickstart: Build from Source
195
195
196
196
1.**Clone the Verba repos**
197
197
```
@@ -220,9 +220,10 @@ Visit localhost:8000
220
220
221
221
6.**Create .env file and add environment variables**
222
222
223
-
# 🔑 API Keys
223
+
# API Keys
224
224
225
225
Before diving into Verba's capabilities, you'll need to configure access to various components depending on your chosen technologies, such as OpenAI, Cohere, and HuggingFace. Start by obtaining the necessary API keys and setting them up through a `.env` file based on our provided [example](./goldenverba/.env.example) , or by declaring them as environment variables on your system. If you're building from source or using Docker, make sure your `.env` file is within the goldenverba directory.
226
+
Please make sure to only include environment variables you really need.
226
227
227
228
Below is a comprehensive list of the API keys and variables you may require:
228
229
@@ -340,7 +341,7 @@ Once configured, you can monitor your Verba installation's health and status via
340
341
341
342
342
343
343
-
# 🐳 Quickstart: Deploy with Docker
344
+
# Quickstart: Deploy with Docker
344
345
345
346
Docker is a set of platform-as-a-service products that use OS-level virtualization to deliver software in packages called containers. Containers are isolated from one another and bundle their own software, libraries, and configuration files; they can communicate with each other through well-defined channels. All containers are run by a single operating system kernel and are thus more lightweight than virtual machines. Docker provides an additional layer of abstraction and automation of operating-system-level virtualization on Windows and Linux.
346
347
@@ -357,7 +358,15 @@ Ensure you have Git installed on your system. Then, open a terminal or command p
357
358
git clone https://github.com/weaviate/Verba.git
358
359
```
359
360
360
-
1.**Deploy using Docker**
361
+
1.**Set neccessary environment variables**
362
+
Make sure to set your required environment variables in the ```.env``` file. You can read more about how to set them up in the [API Keys Section](#api-keys)
363
+
364
+
2.**Adjust the docker-compose file**
365
+
You can use the ```docker-compose.yml``` to add required environment variables under the ```verba``` service and can also adjust the Weaviate Docker settings to enable Authentification or change other settings of your database instance. You can read more about the Weaviate configuration in our [docker-compose documentation](https://weaviate.io/developers/weaviate/installation/docker-compose)
366
+
367
+
> Please make sure to only add environment variables that you really need. If have no authentifcation enabled in your Weaviate Cluster, make sure to not include the ```WEAVIATE_API_KEY_VERBA``` enviroment variable
368
+
369
+
2.**Deploy using Docker**
361
370
With Docker installed and the Verba repository cloned, navigate to the directory containing the Docker Compose file in your terminal or command prompt. Run the following command to start the Verba application in detached mode, which allows it to run in the background:
362
371
363
372
```
@@ -367,7 +376,21 @@ docker compose up -d
367
376
This command will download the necessary Docker images, create containers, and start Verba.
368
377
Remember, Docker must be installed on your system to use this method. For installation instructions and more details about Docker, visit the official Docker documentation.
369
378
370
-
## 💾 Importing Your Data into Verba
379
+
4.**Access Verba**
380
+
381
+
- You can access your local Weaviate instance at ```localhost:8080```
382
+
383
+
- You can access the Verba frontend at ```localhost:8000```
384
+
385
+
386
+
If you want your Docker Instance to install a specific version of Verba (as described in the [package section](#choosing-the-right-verba-installation-package)) you can edit the ```Dockerfile``` and change the installation line.
387
+
388
+
```
389
+
RUN pip install -e '.'
390
+
```
391
+
392
+
393
+
## Importing Your Data into Verba
371
394
372
395
With Verba configured, you're ready to import your data and start exploring. Follow these simple steps to get your data into Verba:
373
396
@@ -401,14 +424,14 @@ With Verba configured, you're ready to import your data and start exploring. Fol
401
424
402
425
Now your data is ready to be used within Verba, enabling you to leverage its powerful search and retrieval capabilities.
403
426
404
-
## 💰 Large Language Model (LLM) Costs
427
+
## Large Language Model (LLM) Costs
405
428
406
429
Verba utilizes LLM models through APIs. Be advised that the usage costs for these models will be billed to the API access key you provide. Primarily, costs are incurred during data embedding and answer generation processes.
407
430
408
-
## 💖 Open Source Contribution
431
+
## Open Source Contribution
409
432
410
433
Your contributions are always welcome! Feel free to contribute ideas, feedback, or create issues and bug reports if you find any! Before contributing, please read the [Contribution Guide](./CONTRIBUTING.md). Visit our [Weaviate Community Forum](https://forum.weaviate.io/) if you need any help!
411
434
412
-
### 🛠️ Project Architecture
435
+
### Project Architecture
413
436
You can learn more about Verba's architecture and implementation in its [technical documentation](./TECHNICAL.md) and [frontend documentation](./FRONTEND.md). It's recommended to read them before making any contributions.
0 commit comments