langchain.utilities.brave_search.BraveSearchWrapper¶

class langchain.utilities.brave_search.BraveSearchWrapper(*, api_key: str, search_kwargs: dict = None, base_url: str = 'https://api.search.brave.com/res/v1/web/search')[source]¶

Bases: BaseModel

Wrapper around the Brave search engine.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param api_key: str [Required]¶

The API key to use for the Brave search engine.

param base_url = 'https://api.search.brave.com/res/v1/web/search'¶

The base URL for the Brave search engine.

param search_kwargs: dict [Optional]¶

Additional keyword arguments to pass to the search request.

download_documents(query: str) → List[Document][source]¶

Query the Brave search engine and return the results as a list of Documents.

Parameters

query – The query to search for.

Returns: The results as a list of Documents.

run(query: str) → str[source]¶

Query the Brave search engine and return the results as a JSON string.

Parameters

query – The query to search for.

Returns: The results as a JSON string.