Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.brave_search`.BraveSearchLoader

class langchain_community.document_loaders.brave_search.BraveSearchLoader(query: str, api_key: str, search_kwargs: Optional[dict] = None)

  Load with Brave Search engine.

  Initializes the BraveLoader.

  Parameters

    - query (str) – The query to search for.

    - api_key (str) – The API key to use.

    - search_kwargs (Optional[dict]) – The search kwargs to use.

  Methods

  `__init__`(query, api_key[, search_kwargs]) | Initializes the BraveLoader.
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `lazy_load`() | A lazy loader for Documents.
  `load`() | Load data into Document objects.
  `load_and_split`([text_splitter]) | Load Documents and split into chunks.

  __init__(query: str, api_key: str, search_kwargs: Optional[dict] = None)

    Initializes the BraveLoader.

    Parameters

      - query (str) – The query to search for.

      - api_key (str) – The API key to use.

      - search_kwargs (Optional[dict]) – The search kwargs to use.

  async alazy_load() → AsyncIterator[Document]

    A lazy loader for Documents.

    Return type

      AsyncIterator[Document]

  async aload() → List[Document]

    Load data into Document objects.

    Return type

      List[Document]

  lazy_load() → Iterator[Document]

    A lazy loader for Documents.

    Return type

      Iterator[Document]

  load() → List[Document]

    Load data into Document objects.

    Return type

      List[Document]

  load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]

    Load Documents and split into chunks. Chunks are returned as Documents.

    Do not override this method. It should be considered to be deprecated!

    Parameters

      text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

    Returns

      List of Documents.

    Return type

      List[Document]

# Examples using BraveSearchLoader

- Brave Search

- brave_search.md