Metadata-Version: 2.4
Name: fred-capability-documents
Version: 4.4.3
Summary: Fred agent capabilities over the Knowledge Flow document ports: summarize, similarity, label search, extract, verbatim read.
Author-email: Thales <noreply@thalesgroup.com>
License: Apache-2.0
Project-URL: Homepage, https://site.fredlab.dev
Project-URL: Repository, https://github.com/ThalesGroup/fred
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Requires-Python: <3.13,>=3.12
Description-Content-Type: text/markdown
Requires-Dist: fred-core>=4.4.3
Requires-Dist: fred-sdk[agents]>=4.4.3
Requires-Dist: pydantic<3.0.0,>=2.7.0
Requires-Dist: langchain-core>=0.3.0
Provides-Extra: dev
Requires-Dist: bandit>=1.8.6; extra == "dev"
Requires-Dist: basedpyright==1.31.0; extra == "dev"
Requires-Dist: detect-secrets>=1.5.0; extra == "dev"
Requires-Dist: pytest>=8.4.2; extra == "dev"
Requires-Dist: pytest-asyncio>=1.2.0; extra == "dev"
Requires-Dist: pytest-cov>=6.2.1; extra == "dev"
Requires-Dist: pytest-socket>=0.7.0; extra == "dev"
Requires-Dist: ruff<0.16,>=0.15.22; extra == "dev"

# fred-capability-documents

Fred agent capabilities over the Knowledge Flow document ports. One package,
one `fred.capabilities` entry point per capability, each admin-gated and
independently grantable by a team admin.

## Capabilities

- **`document_summarize`** — on-demand summary of one document
  (`RuntimeServices.document_summarize`).
- **`document_similarity`** — targeted document-to-document comparison
  (`RuntimeServices.document_similarity`).
- **`document_label_search`** — exhaustive, paginated resolution of a
  business label to documents (`RuntimeServices.document_tree`).
- **`document_verbatim`** — verbatim, paginated read of one document
  (`RuntimeServices.document_markdown`).
- **`document_extract`** — exhaustive extraction from one document
  (`RuntimeServices.document_extraction`).

`document_read_common.py` holds what the reading pair and the error shaping
share. The capabilities reach the platform only through the typed fred-sdk
ports — no URL, credential or client lives here.

## Registration

Installing this package *is* the registration: the fred-agents pod
auto-discovers each capability at boot via the `fred.capabilities` entry
points declared in `pyproject.toml`. Nothing else to wire.

Authoring guide: `docs/swift/capabilities/AUTHORING.md`.
