Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs:update brave readme #29

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions tools/brave/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
## Overview

**Brave** is a privacy-focused tool powered by the BraveSearch engine, offering unbiased, independent, and fast search results through its own index.

In **Dify** , Brave provides secure and accurate search functionality with optional JSON output, which allows structured data exchange. This is particularly useful for LLM applications, as JSON enables clear hierarchical organization of search results, making it easier for models to process, extract key information, and deliver more accurate, contextually relevant responses—all while ensuring user privacy and data security.

## Configuration

To start using **Brave**, follow these steps:

1. **Install the Brave Tool** Open the Plugin Marketplace, search for the Brave tool, and install it to integrate it with your application.

2. **Get a Brave API Key** Visit the Brave platform, create a new API Key, and ensure your account has the necessary permissions to access its features.

3. **Authorize Brave** In Dify, go to **Plugins > Brave > Authorize**. Enter your API Key to activate the tool.

![](./_assets/brave-01.png)

## Tool Features

The **Brave** plugin includes the following action:

### BraveSearch

Perform a secure and privacy-focused search using the BraveSearch engine.

**Input Variables:**

* **Query String (Required):** Provide the text input for the search query. This determines the focus of the search results.
* **Result Count:** Specify the number of search results to return. Adjust this value to control the breadth of the output.
* **Ensure ASCII:** Select whether to ensure ASCII encoding for the search query (`True` or `False`).

![](./_assets/brave-02.png)

## Usage

Brave can seamlessly integrate Chatflow / Workflow Apps and Agent Apps.

### Chatflow / Workflow Apps

1. Add the Brave node to your Chatflow or Workflow pipeline.
2. Configure the "BraveSearch" action by specifying the query string and optional parameters (e.g., result count, ASCII encoding).
3. Run the pipeline to retrieve secure and accurate search results.

![](./_assets/brave-03.png)

### Agent Apps

1. Add the Brave tool to your Agent application.
2. Input the search query via the chatbox.
3. The tool processes your query and returns the corresponding search results.

![](./_assets/brave-04.png)

## Use Cases

* **Privacy-First Web Search:** Perform web searches without compromising privacy or sharing personal data.
* **Content Discovery:** Quickly retrieve unbiased and relevant information on specific topics.
* **Research Assistance:** Gather accurate and fast results for academic or professional projects.
* **Independent Results:** Access search results free from algorithmic bias or external influence.

With **Brave**, you can ensure secure, unbiased, and efficient search functionality integrated directly into your workflows and applications.
Binary file added tools/brave/_assets/brave-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/brave/_assets/brave-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/brave/_assets/brave-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/brave/_assets/brave-04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/brave/_assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion tools/brave/_assets/icon.svg

This file was deleted.

Loading