langchain/docs
Jan Heimes ef365543cb
community: add Needle retriever and document loader integration (#28157)
- [x] **PR title**: "community: add Needle retriever and document loader
integration"
- Where "package" is whichever of langchain, community, core, etc. is
being modified. Use "docs: ..." for purely docs changes, "infra: ..."
for CI changes.
  - Example: "community: add foobar LLM"

- [x] **PR message**: ***Delete this entire checklist*** and replace
with
- **Description:** This PR adds a new integration for Needle, which
includes:
- **NeedleRetriever**: A retriever for fetching documents from Needle
collections.
- **NeedleLoader**: A document loader for managing and loading documents
into Needle collections.
      - Example notebooks demonstrating usage have been added in:
        - `docs/docs/integrations/retrievers/needle.ipynb`
        - `docs/docs/integrations/document_loaders/needle.ipynb`.
- **Dependencies:** The `needle-python` package is required as an
external dependency for accessing Needle's API. It has been added to the
extended testing dependencies list.
- **Twitter handle:** Feel free to mention me if this PR gets announced:
[needlexai](https://x.com/NeedlexAI).

- [x] **Add tests and docs**: If you're adding a new integration, please
include
1. Unit tests have been added for both `NeedleRetriever` and
`NeedleLoader` in `libs/community/tests/unit_tests`. These tests mock
API calls to avoid relying on network access.
2. Example notebooks have been added to `docs/docs/integrations/`,
showcasing both retriever and loader functionality.

- [x] **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/
  - `make format`: Passed
  - `make lint`: Passed
- `make test`: Passed (requires `needle-python` to be installed locally;
this package is not added to LangChain dependencies).

Additional guidelines:
- [x] Optional dependencies are imported only within functions.
- [x] No dependencies have been added to pyproject.toml files except for
those required for unit tests.
- [x] The PR does not touch more than one package.
- [x] Changes are fully backwards compatible.
- [x] Community additions are not re-imported into LangChain core.

If no one reviews your PR within a few days, please @-mention one of
baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
2024-12-03 22:06:25 +00:00
..
api_reference infra: more rst (#28305) 2024-11-22 17:50:42 -08:00
cassettes docs: update tutorials (#28219) 2024-11-26 10:43:12 -05:00
data docs: 👥 Update LangChain people data (#27022) 2024-10-08 17:09:07 +00:00
docs community: add Needle retriever and document loader integration (#28157) 2024-12-03 22:06:25 +00:00
scripts docs: update tutorials (#28219) 2024-11-26 10:43:12 -05:00
src docs: Add ChatDatabricks to llm models (#28398) 2024-12-02 13:19:30 -05:00
static docs: new stack diagram (#27972) 2024-11-07 22:46:56 +00:00
.gitignore infra: cleanup docs build (#21134) 2024-05-01 17:34:05 -07:00
.yarnrc.yml docs[minor]: Add thumbs up/down to all docs pages (#18526) 2024-03-04 15:14:28 -08:00
babel.config.js Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
docusaurus.config.js docs: throw on broken anchors (#27773) 2024-11-13 14:29:27 -05:00
ignore-step.sh docs: ignore case production fork master (#27971) 2024-11-07 13:55:21 -08:00
Makefile docs: efficient rebuild (#28195) 2024-11-18 22:09:16 +00:00
package.json docs: add discussions with giscus (#27172) 2024-10-11 15:14:45 -07:00
README.md docs: reorganize contributing docs (#27649) 2024-10-25 22:41:54 +00:00
sidebars.js docs: reorg sidebar (#27978) 2024-11-15 14:28:18 -08:00
vercel_requirements.txt docs: add api referencs to langgraph (#26877) 2024-09-26 15:21:10 -04:00
vercel.json docs: update tutorials (#28219) 2024-11-26 10:43:12 -05:00
yarn.lock docs: add discussions with giscus (#27172) 2024-10-11 15:14:45 -07:00

LangChain Documentation

For more information on contributing to our documentation, see the Documentation Contributing Guide