From 83d10df78d9ed774e87075ce7c6b80c9bff6c0a5 Mon Sep 17 00:00:00 2001 From: Will Higgins <163115784+hicgboss@users.noreply.github.com> Date: Tue, 28 May 2024 07:39:29 +1000 Subject: [PATCH] community[patch]: Update firecrawl api key name (#22183) Change 'FIREWALL' to 'FIRECRAWL' as I believe this may have been in error. Other docs refer to 'FIRECRAWL_API_KEY'. Thank you for contributing to LangChain! - [ ] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" - [ ] **PR message**: ***Delete this entire checklist*** and replace with - **Description:** a description of the change - **Issue:** the issue # it fixes, if applicable - **Dependencies:** any dependencies required for this change - **Twitter handle:** if your PR gets announced, and you'd like a mention, we'll gladly shout you out! - [ ] **Add tests and docs**: If you're adding a new integration, please include 1. a test for the integration, preferably unit tests that do not rely on network access, 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. - [ ] **Lint and test**: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ Additional guidelines: - Make sure optional dependencies are imported within a function. - Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. - Most PRs should not touch more than one package. - Changes should be backwards compatible. - If you are adding something to community, do not re-import it in langchain. If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17. --------- Co-authored-by: Bagatur --- .../langchain_community/document_loaders/firecrawl.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libs/community/langchain_community/document_loaders/firecrawl.py b/libs/community/langchain_community/document_loaders/firecrawl.py index ad09f532311..da87466d3de 100644 --- a/libs/community/langchain_community/document_loaders/firecrawl.py +++ b/libs/community/langchain_community/document_loaders/firecrawl.py @@ -25,7 +25,7 @@ class FireCrawlLoader(BaseLoader): Args: url: The url to be crawled. api_key: The Firecrawl API key. If not specified will be read from env var - FIREWALL_API_KEY. Get an API key + FIRECRAWL_API_KEY. Get an API key mode: The mode to run the loader in. Default is "crawl". Options include "scrape" (single url) and "crawl" (all accessible sub pages). @@ -44,7 +44,7 @@ class FireCrawlLoader(BaseLoader): raise ValueError( f"Unrecognized mode '{mode}'. Expected one of 'crawl', 'scrape'." ) - api_key = api_key or get_from_env("api_key", "FIREWALL_API_KEY") + api_key = api_key or get_from_env("api_key", "FIRECRAWL_API_KEY") self.firecrawl = FirecrawlApp(api_key=api_key) self.url = url self.mode = mode