langchain-foxnose 0.1.0__tar.gz

langchain_foxnose-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ruff
+      - run: ruff check src/ tests/
+      - run: ruff format --check src/ tests/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[test]"
+      - name: Run tests with coverage
+        run: pytest tests/ --ignore=tests/integration --cov=langchain_foxnose --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          fail_ci_if_error: false

langchain_foxnose-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

langchain_foxnose-0.1.0/.gitignore

@@ -0,0 +1,31 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+dist/
+build/
+*.egg-info/
+*.egg
+.eggs/
+*.whl
+.tox/
+.nox/
+.coverage
+.coverage.*
+htmlcov/
+.cache/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.log
+.env
+.venv/
+venv/
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+.claude/
+site/

langchain_foxnose-0.1.0/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

langchain_foxnose-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing to langchain-foxnose
+
+Thank you for your interest in contributing! This guide will help you get started.
+
+## Development Setup
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/FoxNoseTech/langchain-foxnose.git
+cd langchain-foxnose
+```
+
+2. Create a virtual environment and install dependencies:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[test,lint,docs]"
+```
+
+## Running Tests
+
+```bash
+# All tests
+pytest tests/ --cov=langchain_foxnose
+
+# Unit tests only
+pytest tests/ --ignore=tests/integration
+
+# Specific test file
+pytest tests/test_search_builder.py
+```
+
+## Linting & Formatting
+
+```bash
+# Check
+ruff check src/ tests/
+ruff format --check src/ tests/
+
+# Auto-fix
+ruff check --fix src/ tests/
+ruff format src/ tests/
+```
+
+## Building Documentation
+
+```bash
+mkdocs serve   # Local preview at http://127.0.0.1:8000
+mkdocs build   # Build static site
+```
+
+## Pull Request Process
+
+1. Fork the repository and create a feature branch.
+2. Write tests for any new functionality.
+3. Ensure all tests pass and linting is clean.
+4. Submit a pull request with a clear description of your changes.
+
+## Code Style
+
+- Follow existing patterns in the codebase.
+- Use type annotations for all public APIs.
+- Write Google-style docstrings for public classes and functions.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.

langchain_foxnose-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024-2026 FoxNose
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

langchain_foxnose-0.1.0/Makefile

@@ -0,0 +1,25 @@
+.PHONY: install test lint format docs clean
+
+install:
+	pip install -e ".[test,lint,docs]"
+
+test:
+	pytest tests/ --cov=langchain_foxnose --cov-report=term-missing
+
+lint:
+	ruff check src/ tests/
+	ruff format --check src/ tests/
+
+format:
+	ruff check --fix src/ tests/
+	ruff format src/ tests/
+
+docs:
+	mkdocs build --strict
+
+docs-serve:
+	mkdocs serve
+
+clean:
+	rm -rf dist/ build/ *.egg-info/ .pytest_cache/ .coverage htmlcov/ site/ .ruff_cache/
+	find . -type d -name __pycache__ -exec rm -rf {} +

langchain_foxnose-0.1.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: langchain-foxnose
+Version: 0.1.0
+Summary: LangChain integration for FoxNose - the knowledge layer for RAG and AI agents
+Project-URL: Homepage, https://foxnose.net?utm_source=github&utm_medium=repository&utm_campaign=langchain-foxnose
+Project-URL: Documentation, https://langchain-foxnose.readthedocs.io
+Project-URL: FoxNose Docs, https://foxnose.net/docs?utm_source=github&utm_medium=repository&utm_campaign=langchain-foxnose
+Project-URL: Source, https://github.com/FoxNoseTech/langchain-foxnose
+Author: FoxNose
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ai,embeddings,foxnose,knowledge-base,langchain,rag,retriever,vector-search
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: foxnose-sdk>=0.2.0
+Requires-Dist: langchain-core<1.0,>=0.3.0
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
+Provides-Extra: lint
+Requires-Dist: ruff>=0.4; extra == 'lint'
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
+Requires-Dist: pytest-cov>=4.1; extra == 'test'
+Requires-Dist: pytest>=8.2; extra == 'test'
+Description-Content-Type: text/markdown
+
+# langchain-foxnose
+
+[![PyPI version](https://img.shields.io/pypi/v/langchain-foxnose.svg)](https://pypi.org/project/langchain-foxnose/)
+[![Python](https://img.shields.io/pypi/pyversions/langchain-foxnose.svg)](https://pypi.org/project/langchain-foxnose/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![CI](https://github.com/FoxNoseTech/langchain-foxnose/actions/workflows/ci.yml/badge.svg)](https://github.com/FoxNoseTech/langchain-foxnose/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/FoxNoseTech/langchain-foxnose/branch/main/graph/badge.svg)](https://codecov.io/gh/FoxNoseTech/langchain-foxnose)
+
+LangChain integration for [FoxNose](https://foxnose.net?utm_source=github&utm_medium=repository&utm_campaign=langchain-foxnose) — the serverless knowledge platform purpose-built as the knowledge layer for RAG and AI agents.
+
+## Installation
+
+```bash
+pip install langchain-foxnose
+```
+
+## Quick Start
+
+```python
+from foxnose_sdk.flux import FluxClient
+from foxnose_sdk.auth import SimpleKeyAuth
+from langchain_foxnose import FoxNoseRetriever
+
+# Create a FoxNose Flux client
+client = FluxClient(
+    base_url="https://<env_key>.fxns.io",
+    api_prefix="my_api",
+    auth=SimpleKeyAuth("YOUR_PUBLIC_KEY", "YOUR_SECRET_KEY"),
+)
+
+# Create the retriever
+retriever = FoxNoseRetriever(
+    client=client,
+    folder_path="knowledge-base",
+    page_content_field="body",
+    search_mode="hybrid",
+    top_k=5,
+)
+
+# Use it
+docs = retriever.invoke("How do I reset my password?")
+for doc in docs:
+    print(doc.page_content)
+    print(doc.metadata)
+```
+
+## Features
+
+- **All search modes**: text, vector, hybrid, and vector-boosted search
+- **Flexible content mapping**: single field, multiple fields, or custom mapper function
+- **Metadata control**: whitelist, blacklist, or include system metadata
+- **Native async**: uses `AsyncFluxClient` for true async when available
+- **Structured filtering**: pass FoxNose `where` filters for precise retrieval
+- **Full configuration**: search fields, thresholds, hybrid weights, sort, and more
+
+## Search Modes
+
+```python
+# Pure vector (semantic) search
+retriever = FoxNoseRetriever(
+    client=client,
+    folder_path="articles",
+    page_content_field="body",
+    search_mode="vector",
+)
+
+# Hybrid search (text + vector)
+retriever = FoxNoseRetriever(
+    client=client,
+    folder_path="articles",
+    page_content_field="body",
+    search_mode="hybrid",
+    hybrid_config={"vector_weight": 0.6, "text_weight": 0.4},
+)
+
+# Text search with vector boost
+retriever = FoxNoseRetriever(
+    client=client,
+    folder_path="articles",
+    page_content_field="body",
+    search_mode="vector_boosted",
+    vector_boost_config={"boost_factor": 1.3},
+)
+```
+
+## Filtered Retrieval
+
+```python
+retriever = FoxNoseRetriever(
+    client=client,
+    folder_path="articles",
+    page_content_field="body",
+    where={
+        "$": {
+            "all_of": [
+                {"status__eq": "published"},
+                {"category__in": ["tech", "science"]},
+            ]
+        }
+    },
+)
+```
+
+## Async Usage
+
+```python
+from foxnose_sdk.flux import AsyncFluxClient
+
+async_client = AsyncFluxClient(
+    base_url="https://<env_key>.fxns.io",
+    api_prefix="my_api",
+    auth=SimpleKeyAuth("YOUR_PUBLIC_KEY", "YOUR_SECRET_KEY"),
+)
+
+retriever = FoxNoseRetriever(
+    async_client=async_client,
+    folder_path="knowledge-base",
+    page_content_field="body",
+)
+
+docs = await retriever.ainvoke("search query")
+```
+
+## Documentation
+
+- [Getting Started](https://langchain-foxnose.readthedocs.io/getting-started/)
+- [Configuration](https://langchain-foxnose.readthedocs.io/configuration/)
+- [Examples](https://langchain-foxnose.readthedocs.io/examples/)
+- [API Reference](https://langchain-foxnose.readthedocs.io/api-reference/)
+- [FoxNose Documentation](https://foxnose.net/docs?utm_source=github&utm_medium=repository&utm_campaign=langchain-foxnose)
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE) for details.