Browser Search Engine Integration

HridaAI allows you to integrate directly into your web browser. This tutorial will guide you through the process of setting up HridaAI as a custom search engine, enabling you to execute queries easily from your browser's address bar.

Setting Up HridaAI as a Search Engine

Prerequisites

Before you begin, ensure that:

• You have Chrome or another supported browser installed.
• The HRIDAAI_URL environment variable is set correctly, either using Docker environment variables or in the .env file as specified in the Getting Started guide.

Step 1: Set the HRIDAAI_URL Environment Variable

Setting the HRIDAAI_URL environment variable ensures your browser knows where to direct queries.

Using Docker Environment Variables

If you are running HridaAI using Docker, you can set the environment variable in your docker run command:

docker run -d \
  -p 3000:8080 \
  --add-host=host.docker.internal:host-gateway \
  -v hrida-ai:/app/backend/data \
  --name hrida-ai \
  --restart always \
  -e HRIDAAI_URL="https://<your-hrida-ai-url>" \
  ghcr.io/hrida-ai/hrida-ai-studio:main

Alternatively, you can add the variable to your .env file:

HRIDAAI_URL=https://<your-hrida-ai-url>

Step 2: Add HridaAI as a Custom Search Engine

For Chrome

1. Open Chrome and navigate to Settings.

2. Select Search engine from the sidebar, then click on Manage search engines.

3. Click Add to create a new search engine.

4. Fill in the details as follows:

   • Search engine: HridaAI Search

   • Keyword: hridaai (or any keyword you prefer)

   • URL with %s in place of query:

     https://<your-hrida-ai-url>/?q=%s

5. Click Add to save the configuration.

For Firefox

1. Go to HridaAI in Firefox.
2. Expand the address bar by clicking on it.
3. Click the plus icon that is enclosed in a green circle at the bottom of the expanded address bar. This adds HridaAI's search to the search engines in your preferences.

Alternatively:

1. Go to HridaAI in Firefox.
2. Right-click on the address bar.
3. Select "Add HridaAI" (or similar) from the context menu.

Optional: Using Specific Models

If you wish to utilize a specific model for your search, modify the URL format to include the model ID:

https://<your-hrida-ai-url>/?models=<model_id>&q=%s

note

Note: The model ID will need to be URL-encoded. Special characters like spaces or slashes need to be encoded (e.g., my model becomes my%20model).

Example Usage

Once the search engine is set up, you can perform searches directly from the address bar. Simply type your chosen keyword followed by your query:

hridaai your search query

This command will redirect you to the HridaAI interface with your search results.

Troubleshooting

If you encounter any issues, check the following:

• Ensure the HRIDAAI_URL is correctly configured and points to a valid HridaAI instance.
• Double-check that the search engine URL format is correctly entered in your browser settings.
• Confirm your internet connection is active and that the HridaAI service is running smoothly.