Verba — RAG 知识库工具中文文档

Getting Started with Verba

You have three deployment options for Verba:

• Install via pip

pip install goldenverba

• Build from Source

git clone https://github.com/weaviate/Verba

pip install -e .

• Use Docker for Deployment

Prerequisites: If you're not using Docker, ensure that you have Python >=3.10.0,<3.13.0 installed on your system.

git clone https://github.com/weaviate/Verba

docker compose --env-file <your-env-file> up -d --build

If you're unfamiliar with Python and Virtual Environments, please read the python tutorial guidelines.

How to deploy with pip

Python >=3.10.0

1. (Very Important) Initialize a new Python Environment

python3 -m virtualenv venv
source venv/bin/activate

1. Install Verba

pip install goldenverba

1. Launch Verba

verba start

You can specify the --port and --host via flags

1. Access Verba

Visit localhost:8000

1. (Optional)Create .env file and add environment variables

How to build from Source

1. Clone the Verba repos

git clone https://github.com/weaviate/Verba.git

1. Initialize a new Python Environment

python3 -m virtualenv venv
source venv/bin/activate

1. Install Verba

pip install -e .

1. Launch Verba

verba start

You can specify the --port and --host via flags

1. Access Verba

Visit localhost:8000

1. (Optional) Create .env file and add environment variables

How to install Verba with Docker

Docker is a set of platform-as-a-service products that use OS-level virtualization to deliver software in packages called containers. To get started with deploying Verba using Docker, follow the steps below. If you need more detailed instructions on Docker usage, check out the Docker Curriculum.

You can use docker pull semitechnologies/verba to pull the latest Verba Docker Image. Please note, that by pulling directly from Docker Hub you're only able to install the vanilla Verba version that does not include packages e.g HuggingFace. If you want to use Docker and HuggingFace please follow the steps below.

To build the image yourself, you can clone the Verba repository and run docker build -t verba . inside the Verba directory.

0. Clone the Verba repos Ensure you have Git installed on your system. Then, open a terminal or command prompt and run the following command to clone the Verba repository:

git clone https://github.com/weaviate/Verba.git

1. Set necessary environment variables 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

2. Adjust the docker-compose file 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. You can also uncomment the ollama service to use Ollama within the same docker compose.

Please make sure to only add environment variables that you really need.

2. Deploy using Docker 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:

docker compose up -d

docker compose --env-file goldenverba/.env up -d --build

This command will download the necessary Docker images, create containers, and start Verba. 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.

1. Access Verba

• You can access your local Weaviate instance at localhost:8080

• You can access the Verba frontend at localhost:8000

If you want your Docker Instance to install a specific version of Verba you can edit the Dockerfile and change the installation line.

RUN pip install -e '.'

Select your Deployment

The first screen you'll see is the deployment screen. Here you can select between Local, Docker, Weaviate Cloud, or Custom deployment. The Local deployment is using Weaviate Embedded under the hood, which initializes a Weaviate instance behind the scenes. The Docker deployment is using a separate Weaviate instance that is running inside the same Docker network. The Weaviate Cloud deployment is using a Weaviate instance that is hosted on Weaviate Cloud Services (WCS). The Custom deployment allows you to specify your own Weaviate instance URL, PORT, and API key.

You can skip this part by setting the DEFAULT_DEPLOYMENT environment variable to Local, Docker, Weaviate, or Custom.

API Keys and Environment Variables

You can set all API keys in the Verba frontend, but to make your life easier, we can also prepare a .env file in which Verba will automatically look for the keys. Create a .env in the same directory you want to start Verba in. You can find an .env.example file in the goldenverba directory.

Make sure to only set environment variables you intend to use, environment variables with missing or incorrect values may lead to errors.

Below is a comprehensive list of the API keys and variables you may require:

FAQ

• Can I use pre-existing data from my Weaviate instance?

• No, unfortunatley not. Verba requires the data to be in a specific format to work. And as of now, this is only possible by importing data through the Verba UI.

• Is Verba Multi-Lingual?

• This depends on your choosen Embedding and Generation Model whether they support multi-lingual data.

• Can I use my Ollama Server with the Verba Docker?

• Yes, you can! Make sure the URL is set to: OLLAMA_URL=http://host.docker.internal:11434
• If you're running on Linux, you might need to get the IP Gateway of the Ollama server: OLLAMA_URL="http://YOUR-IP-OF-OLLAMA:11434"

• How to clear Weaviate Embedded Storage?

• You'll find the stored data here: ~/.local/share/weaviate

• How can I specify the port?

• You can use the port and host flag verba start --port 9000 --host 0.0.0.0

• Can multiple users use Verba at the same time? How about role based access?

• Verba is designed and optimized for single user usage only. There are no plans on supporting multiple users or role based access in the near future.

• Does Verba offer a API endpoint to use externally?

• No, right now Verba does not offer any useful API endpoints to interact with the application. The current FastAPI setup is optimized for the internal communication between the frontend and backend. It is not recommended to use it as a API endpoint. There are plans to add user-friendly

• How to connect to your custom OpenAI Server?

• Set your custom OpenAI API Key and URL in the .env file, this will allow Verba to start up and retrieve the models from your custom OpenAI Server. OPENAI_BASE_URL is set to https://api.openai.com/v1 by default.
• You can also set a different endpoint for your embeddings by configuring the OPENAI_EMBED_API_KEY and OPENAI_EMBED_BASE_URL environment variables and setting OPENAI_CUSTOM_EMBED=true. For more details, see OpenAI Embeddings.

• How to upload custom JSON files to Verba?
• Right now Verba does not support custom JSON structure. Instead the whole JSON will simply be dumped into the content field of the Verba document. You can read more about the Verba JSON Structure in the Technical Documentation here.