Init
This commit is contained in:
7
.env.example
Normal file
7
.env.example
Normal file
@@ -0,0 +1,7 @@
|
||||
# OpenRouter API Key (recommended)
|
||||
OPENROUTER_API_KEY=your_openrouter_api_key_here
|
||||
|
||||
# Optional: Other model configurations
|
||||
# OPENAI_API_KEY=your_openai_key
|
||||
# ANTHROPIC_API_KEY=your_anthropic_key
|
||||
# GOOGLE_API_KEY=your_google_key
|
||||
16
.gitignore
vendored
Normal file
16
.gitignore
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
# Python-generated files
|
||||
__pycache__/
|
||||
*.py[oc]
|
||||
build/
|
||||
dist/
|
||||
wheels/
|
||||
*.egg-info
|
||||
|
||||
# Virtual environments
|
||||
.venv
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
|
||||
# Output files
|
||||
*_insights.json
|
||||
1
.python-version
Normal file
1
.python-version
Normal file
@@ -0,0 +1 @@
|
||||
3.12
|
||||
125
CLAUDE.md
Normal file
125
CLAUDE.md
Normal file
@@ -0,0 +1,125 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Project Overview
|
||||
|
||||
`pdf-to-kcf` is a Python CLI tool that uses AI agents to parse PDF documents and extract structured insights. It uses `pydantic-ai` to create an intelligent agent that can autonomously decide how much of a document to analyze, requesting additional pages as needed.
|
||||
|
||||
## Commands
|
||||
|
||||
### Development Setup
|
||||
```bash
|
||||
# Install dependencies
|
||||
uv sync
|
||||
|
||||
# Set up OpenRouter API key
|
||||
cp .env.example .env
|
||||
# Edit .env and add your OPENROUTER_API_KEY
|
||||
|
||||
# Run the CLI tool
|
||||
uv run pdf-to-kcf <pdf-path>
|
||||
|
||||
# Run with options
|
||||
uv run pdf-to-kcf <pdf-path> --output custom_output.json --start-page 2 --model anthropic/claude-3-opus
|
||||
```
|
||||
|
||||
### Running the Tool
|
||||
```bash
|
||||
# Basic usage (uses Claude 3.5 Sonnet via OpenRouter by default)
|
||||
uv run pdf-to-kcf document.pdf
|
||||
|
||||
# Specify custom output file
|
||||
uv run pdf-to-kcf document.pdf -o insights.json
|
||||
|
||||
# Start from a specific page (0-indexed)
|
||||
uv run pdf-to-kcf document.pdf -s 3
|
||||
|
||||
# Use a different AI model from OpenRouter
|
||||
uv run pdf-to-kcf document.pdf -m meta-llama/llama-3.1-70b-instruct
|
||||
uv run pdf-to-kcf document.pdf -m google/gemini-pro-1.5
|
||||
uv run pdf-to-kcf document.pdf -m openai/gpt-4o
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Core Components
|
||||
|
||||
**models.py** - Data structures following the agentic document parsing format specification:
|
||||
- `ContentInsightType`: Enum for insight classification (FACT, OPINION, COMMENT)
|
||||
- `ContentInsightAttribute`: Key-value metadata for insights
|
||||
- `ContentInsight`: A single extracted insight with type, content, and attributes
|
||||
- `PageContentAnalysis`: Agent output containing all insights
|
||||
- `PageContent`: Context passed to the agent (page number, content, total pages)
|
||||
|
||||
**pdf_reader.py** - PDF document handling:
|
||||
- `PDFDocument`: Wrapper class for reading PDF files using pypdf
|
||||
- Provides `get_page_text()` for single page extraction
|
||||
- Provides `get_all_pages()` for full document extraction
|
||||
|
||||
**agent.py** - AI agent implementation:
|
||||
- `DocumentAnalyzer`: Main analyzer using pydantic-ai Agent
|
||||
- Configures the AI model and system prompt
|
||||
- Implements `read_page` tool that allows the agent to request additional pages autonomously
|
||||
- The agent decides when to fetch more pages based on context needs
|
||||
- Agent is instructed to classify insights as facts, opinions, or comments with relevant attributes
|
||||
|
||||
**cli.py** - Command-line interface:
|
||||
- Built with Click framework
|
||||
- Handles PDF loading, analysis orchestration, and JSON output
|
||||
- Provides user feedback during processing
|
||||
|
||||
### Agentic Behavior
|
||||
|
||||
The AI agent is autonomous and can:
|
||||
1. Start analyzing from an initial page
|
||||
2. Determine if more context is needed from other pages
|
||||
3. Use the `read_page` tool to fetch additional pages
|
||||
4. Extract structured insights with proper classification
|
||||
5. Return all insights in the specified JSON format
|
||||
|
||||
### Output Format
|
||||
|
||||
The tool outputs JSON files with the following structure:
|
||||
```json
|
||||
{
|
||||
"insights": [
|
||||
{
|
||||
"type": "fact",
|
||||
"insight": "Summary of the insight",
|
||||
"content": "Original text that was analyzed",
|
||||
"attributes": [
|
||||
{"attribute": "source", "value": "Page 1"},
|
||||
{"attribute": "confidence", "value": "high"}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.12+
|
||||
- OpenRouter API key set as `OPENROUTER_API_KEY` environment variable
|
||||
- Provides access to all major AI models (Claude, GPT-4, Gemini, Llama, etc.)
|
||||
- Get API key at https://openrouter.ai/
|
||||
- Alternatively supports direct provider keys (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.)
|
||||
- Dependencies managed via uv
|
||||
|
||||
## Model Configuration
|
||||
|
||||
The tool is configured to use OpenRouter by default, which provides:
|
||||
- Access to multiple AI providers through a single API
|
||||
- Automatic fallback and load balancing
|
||||
- Competitive pricing
|
||||
- Support for the latest models
|
||||
|
||||
When `OPENROUTER_API_KEY` is set, the agent automatically configures the OpenAI-compatible interface with OpenRouter's base URL. Models should be specified in the format: `<provider>/<model-name>` (e.g., `anthropic/claude-3.5-sonnet`, `openai/gpt-4o`)
|
||||
|
||||
## Format Specification
|
||||
|
||||
The project follows the format defined in `../docs/AGENTIC_DOCUMENT_PARSING_FORMAT.md`, which specifies:
|
||||
- How agents interact with documents
|
||||
- The structure of insights and their attributes
|
||||
- The `read_page` tool interface for autonomous page navigation
|
||||
- Classification system for different insight types
|
||||
675
LICENSE
Normal file
675
LICENSE
Normal file
@@ -0,0 +1,675 @@
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
{one line to give the program's name and a brief idea of what it does.}
|
||||
Copyright (C) {year} {name of author}
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
Copyright (C) 2025 qrk.ng
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
127
QUICKSTART.md
Normal file
127
QUICKSTART.md
Normal file
@@ -0,0 +1,127 @@
|
||||
# Quick Start Guide
|
||||
|
||||
## 1. Get Your OpenRouter API Key
|
||||
|
||||
1. Visit [OpenRouter](https://openrouter.ai/)
|
||||
2. Sign up for a free account
|
||||
3. Go to [Keys](https://openrouter.ai/keys) section
|
||||
4. Create a new API key
|
||||
5. Copy your API key
|
||||
|
||||
## 2. Configure the Tool
|
||||
|
||||
```bash
|
||||
# Copy the environment template
|
||||
cp .env.example .env
|
||||
|
||||
# Edit .env and add your API key
|
||||
echo "OPENROUTER_API_KEY=your_key_here" >> .env
|
||||
```
|
||||
|
||||
Or set it directly in your shell:
|
||||
```bash
|
||||
export OPENROUTER_API_KEY=your_key_here
|
||||
```
|
||||
|
||||
## 3. Run Your First Analysis
|
||||
|
||||
```bash
|
||||
# Basic usage
|
||||
uv run pdf-to-kcf your_document.pdf
|
||||
|
||||
# This will create a file: your_document_insights.json
|
||||
```
|
||||
|
||||
## Example Output
|
||||
|
||||
The tool will generate a JSON file with structured insights like:
|
||||
|
||||
```json
|
||||
{
|
||||
"insights": [
|
||||
{
|
||||
"type": "fact",
|
||||
"insight": "The company revenue increased by 25% in Q4",
|
||||
"content": "According to the financial report, Q4 revenue reached $2.5M, up 25% from Q3...",
|
||||
"attributes": [
|
||||
{"attribute": "source", "value": "Financial Report"},
|
||||
{"attribute": "quarter", "value": "Q4"},
|
||||
{"attribute": "confidence", "value": "high"}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "opinion",
|
||||
"insight": "The author recommends investing in AI infrastructure",
|
||||
"content": "We strongly believe that investing in AI infrastructure is critical...",
|
||||
"attributes": [
|
||||
{"attribute": "sentiment", "value": "positive"},
|
||||
{"attribute": "section", "value": "recommendations"}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Try Different Models
|
||||
|
||||
```bash
|
||||
# Use GPT-4
|
||||
uv run pdf-to-kcf document.pdf -m openai/gpt-4o
|
||||
|
||||
# Use Gemini
|
||||
uv run pdf-to-kcf document.pdf -m google/gemini-pro-1.5
|
||||
|
||||
# Use Llama 3.1
|
||||
uv run pdf-to-kcf document.pdf -m meta-llama/llama-3.1-70b-instruct
|
||||
```
|
||||
|
||||
### Custom Output Location
|
||||
|
||||
```bash
|
||||
uv run pdf-to-kcf document.pdf -o /path/to/output.json
|
||||
```
|
||||
|
||||
### Start from Specific Page
|
||||
|
||||
```bash
|
||||
# Start analysis from page 5 (0-indexed, so this is the 6th page)
|
||||
uv run pdf-to-kcf document.pdf -s 5
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
1. The tool loads your PDF and extracts text
|
||||
2. An AI agent analyzes the content starting from page 0 (or your specified page)
|
||||
3. The agent autonomously decides if it needs to read more pages
|
||||
4. It extracts structured insights classified as facts, opinions, or comments
|
||||
5. Each insight includes the original content and relevant metadata
|
||||
6. Results are saved to a JSON file
|
||||
|
||||
## Pricing
|
||||
|
||||
OpenRouter charges based on the model you use:
|
||||
- Claude 3.5 Sonnet (default): ~$3 per million input tokens
|
||||
- GPT-4o: ~$2.50 per million input tokens
|
||||
- Llama 3.1 70B: ~$0.35 per million input tokens
|
||||
|
||||
Most PDFs will cost just a few cents to analyze.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "No API key found"
|
||||
Make sure you've set `OPENROUTER_API_KEY` in your `.env` file or environment.
|
||||
|
||||
### "Model not found"
|
||||
Check the model name format: `<provider>/<model-name>` (e.g., `anthropic/claude-3.5-sonnet`)
|
||||
See available models at https://openrouter.ai/models
|
||||
|
||||
### "PDF not found"
|
||||
Use the full path to your PDF file, or navigate to the directory containing it first.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Read the full [README.md](README.md) for more details
|
||||
- Check [CLAUDE.md](CLAUDE.md) for architecture details
|
||||
- See [OpenRouter models](https://openrouter.ai/models) for all available models
|
||||
128
README.md
Normal file
128
README.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# pdf-to-kcf
|
||||
|
||||
A Python CLI tool that uses AI agents to parse PDF documents and extract structured insights. Built with `pydantic-ai`, this tool creates an intelligent agent that autonomously analyzes documents, requesting additional pages as needed to form complete insights.
|
||||
|
||||
## Features
|
||||
|
||||
- **Autonomous Document Analysis**: AI agent decides how much of the document to read
|
||||
- **Structured Insight Extraction**: Classifies content as facts, opinions, or comments
|
||||
- **Rich Metadata**: Adds attributes like source, confidence, dates, and more
|
||||
- **Multiple AI Models**: Supports OpenAI and other compatible models
|
||||
- **JSON Output**: Exports insights in a structured, machine-readable format
|
||||
|
||||
## Installation
|
||||
|
||||
This project uses [uv](https://github.com/astral-sh/uv) for dependency management:
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
uv sync
|
||||
```
|
||||
|
||||
## Setup
|
||||
|
||||
1. Copy the environment template:
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
2. Add your OpenRouter API key to `.env`:
|
||||
```bash
|
||||
OPENROUTER_API_KEY=your_openrouter_api_key_here
|
||||
```
|
||||
|
||||
3. Get your API key from [OpenRouter](https://openrouter.ai/) (free tier available)
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Basic usage (uses OpenRouter with Claude 3.5 Sonnet by default)
|
||||
uv run pdf-to-kcf document.pdf
|
||||
|
||||
# Specify custom output file
|
||||
uv run pdf-to-kcf document.pdf -o insights.json
|
||||
|
||||
# Start from a specific page (0-indexed)
|
||||
uv run pdf-to-kcf document.pdf -s 3
|
||||
|
||||
# Use a different AI model from OpenRouter
|
||||
uv run pdf-to-kcf document.pdf -m meta-llama/llama-3.1-70b-instruct
|
||||
uv run pdf-to-kcf document.pdf -m google/gemini-pro-1.5
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
- `--output, -o`: Output JSON file path (default: `<pdf_name>_insights.json`)
|
||||
- `--start-page, -s`: Starting page number, 0-indexed (default: 0)
|
||||
- `--model, -m`: AI model to use via OpenRouter (default: `anthropic/claude-3.5-sonnet`)
|
||||
|
||||
### Available Models
|
||||
|
||||
When using OpenRouter, you can specify any model using the format `<provider>/<model-name>`:
|
||||
- `anthropic/claude-3.5-sonnet` (default, recommended)
|
||||
- `anthropic/claude-3-opus`
|
||||
- `openai/gpt-4o`
|
||||
- `meta-llama/llama-3.1-70b-instruct`
|
||||
- `google/gemini-pro-1.5`
|
||||
- See [OpenRouter models](https://openrouter.ai/models) for full list
|
||||
|
||||
## Output Format
|
||||
|
||||
The tool generates JSON files with structured insights:
|
||||
|
||||
```json
|
||||
{
|
||||
"insights": [
|
||||
{
|
||||
"type": "fact",
|
||||
"insight": "Global temperatures have risen 1.1<EFBFBD>C since pre-industrial times",
|
||||
"content": "According to the IPCC, global temperatures have risen approximately 1.1<EFBFBD>C...",
|
||||
"attributes": [
|
||||
{"attribute": "source", "value": "IPCC Report"},
|
||||
{"attribute": "confidence", "value": "high"},
|
||||
{"attribute": "year", "value": "2023"}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "opinion",
|
||||
"insight": "The author believes immediate action is required",
|
||||
"content": "We must act now to prevent catastrophic consequences...",
|
||||
"attributes": [
|
||||
{"attribute": "sentiment", "value": "urgent"},
|
||||
{"attribute": "section", "value": "conclusion"}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **PDF Loading**: Extracts text content from PDF using pypdf
|
||||
2. **Agent Initialization**: Creates a pydantic-ai agent with the specified model
|
||||
3. **Autonomous Analysis**: Agent analyzes content and can request additional pages
|
||||
4. **Insight Extraction**: Classifies and structures insights with metadata
|
||||
5. **JSON Export**: Saves all insights to a JSON file
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.12 or higher
|
||||
- OpenRouter API key (set as `OPENROUTER_API_KEY` environment variable)
|
||||
- Get your free API key at [OpenRouter](https://openrouter.ai/)
|
||||
- Supports all major AI models (Claude, GPT-4, Gemini, Llama, etc.)
|
||||
- Alternatively, use `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, or other provider keys
|
||||
|
||||
## Architecture
|
||||
|
||||
The tool follows the agentic document parsing format with these core components:
|
||||
|
||||
- **models.py**: Data structures (ContentInsight, PageContentAnalysis, etc.)
|
||||
- **pdf_reader.py**: PDF text extraction (PDFDocument class)
|
||||
- **agent.py**: AI agent with autonomous page reading capability
|
||||
- **cli.py**: Command-line interface
|
||||
|
||||
See `CLAUDE.md` for detailed architecture documentation.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
22
pyproject.toml
Normal file
22
pyproject.toml
Normal file
@@ -0,0 +1,22 @@
|
||||
[project]
|
||||
name = "pdf-to-kcf"
|
||||
version = "0.1.0"
|
||||
description = "CLI tool to parse PDFs and convert them into structured insights using AI"
|
||||
readme = "README.md"
|
||||
authors = [
|
||||
{ name = "neutrino2211", email = "neutrino2211@gmail.com" }
|
||||
]
|
||||
requires-python = ">=3.12"
|
||||
dependencies = [
|
||||
"pydantic-ai>=0.0.14",
|
||||
"pypdf>=4.0.0",
|
||||
"click>=8.1.0",
|
||||
"pydantic>=2.0.0",
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
pdf-to-kcf = "pdf_to_kcf.cli:main"
|
||||
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
21
src/pdf_to_kcf/__init__.py
Normal file
21
src/pdf_to_kcf/__init__.py
Normal file
@@ -0,0 +1,21 @@
|
||||
"""PDF to KCF - CLI tool for parsing PDFs and extracting structured insights."""
|
||||
|
||||
from .models import (
|
||||
ContentInsight,
|
||||
ContentInsightAttribute,
|
||||
ContentInsightType,
|
||||
PageContent,
|
||||
PageContentAnalysis,
|
||||
)
|
||||
from .pdf_reader import PDFDocument
|
||||
from .agent import DocumentAnalyzer
|
||||
|
||||
__all__ = [
|
||||
"ContentInsight",
|
||||
"ContentInsightAttribute",
|
||||
"ContentInsightType",
|
||||
"PageContent",
|
||||
"PageContentAnalysis",
|
||||
"PDFDocument",
|
||||
"DocumentAnalyzer",
|
||||
]
|
||||
156
src/pdf_to_kcf/agent.py
Normal file
156
src/pdf_to_kcf/agent.py
Normal file
@@ -0,0 +1,156 @@
|
||||
"""AI agent for analyzing PDF content and extracting insights."""
|
||||
|
||||
import os
|
||||
from typing import Optional
|
||||
|
||||
from pydantic_ai import Agent, RunContext
|
||||
|
||||
from .models import PageContent, PageContentAnalysis
|
||||
from .pdf_reader import PDFDocument
|
||||
|
||||
|
||||
class DocumentAnalyzer:
|
||||
"""Analyzes PDF documents using an AI agent to extract structured insights."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
pdf_document: PDFDocument,
|
||||
model: str = "anthropic/claude-3.5-sonnet",
|
||||
):
|
||||
"""Initialize the document analyzer.
|
||||
|
||||
Args:
|
||||
pdf_document: The PDF document to analyze
|
||||
model: The AI model to use (default: anthropic/claude-3.5-sonnet via OpenRouter)
|
||||
"""
|
||||
self.pdf_document = pdf_document
|
||||
self.current_page = 0
|
||||
|
||||
# Configure OpenRouter if API key is present
|
||||
if os.getenv("OPENROUTER_API_KEY"):
|
||||
# Set environment variables for OpenAI SDK to use OpenRouter
|
||||
os.environ["OPENAI_API_KEY"] = os.getenv("OPENROUTER_API_KEY") or ""
|
||||
os.environ["OPENAI_BASE_URL"] = "https://openrouter.ai/api/v1"
|
||||
# Use openai: prefix for pydantic-ai to recognize it as OpenAI-compatible
|
||||
model_instance = f"openai:{model}"
|
||||
else:
|
||||
# Use default model configuration
|
||||
model_instance = model
|
||||
|
||||
# Define the agent with tools for reading pages
|
||||
self.agent = Agent(
|
||||
model_instance,
|
||||
output_type=PageContentAnalysis,
|
||||
system_prompt="""You are a document analysis expert. Your task is to analyze document content and extract structured insights.
|
||||
|
||||
For each piece of content you analyze, classify insights into three types:
|
||||
- FACT: Factual statements, data, statistics, or verifiable information
|
||||
- OPINION: Viewpoints, beliefs, recommendations, or subjective statements
|
||||
- COMMENT: Observations, notes, or descriptive information
|
||||
|
||||
For each insight, provide:
|
||||
1. The type (fact, opinion, or comment)
|
||||
2. A clear summary of the insight
|
||||
3. The original content that was analyzed
|
||||
4. Relevant attributes (e.g., source, author, date, confidence, sentiment, section)
|
||||
|
||||
You have access to a read_page tool that allows you to request additional pages if the current page contains incomplete information or if you need more context. Use this tool when:
|
||||
- Information spans multiple pages
|
||||
- You need context from surrounding pages
|
||||
- The current page references content on other pages
|
||||
|
||||
Be thorough but concise in your analysis. Focus on extracting meaningful insights rather than restating obvious information.""",
|
||||
deps_type=PageContent,
|
||||
)
|
||||
|
||||
# Register the read_page tool
|
||||
@self.agent.tool
|
||||
async def read_page(
|
||||
ctx: RunContext[PageContent], page_number: Optional[int] = None
|
||||
) -> str:
|
||||
"""Read a specific page from the document.
|
||||
|
||||
Args:
|
||||
ctx: The run context containing current page information
|
||||
page_number: The page number to read (0-indexed). If not provided, reads the next page.
|
||||
|
||||
Returns:
|
||||
The text content of the requested page
|
||||
"""
|
||||
if page_number is None:
|
||||
page_number = ctx.deps.page_number + 1
|
||||
|
||||
if page_number < 0 or page_number >= self.pdf_document.total_pages:
|
||||
return f"Error: Invalid page number. Document has {self.pdf_document.total_pages} pages (0-indexed)."
|
||||
|
||||
return self.pdf_document.get_page_text(page_number)
|
||||
|
||||
async def analyze_page(self, page: int = 0) -> PageContentAnalysis:
|
||||
"""Analyze the document starting from a specific page.
|
||||
|
||||
Args:
|
||||
page: The page to analyse
|
||||
|
||||
Returns:
|
||||
PageContentAnalysis containing all extracted insights
|
||||
"""
|
||||
initial_content = self.pdf_document.get_page_text(page)
|
||||
|
||||
page_content = PageContent(
|
||||
page_number=page,
|
||||
content=initial_content,
|
||||
total_pages=self.pdf_document.total_pages,
|
||||
)
|
||||
|
||||
result = await self.agent.run(
|
||||
f"Analyze this document page and extract structured insights. "
|
||||
f"This is page {page + 1} of {self.pdf_document.total_pages}. "
|
||||
f"If you need to see more pages to get complete context, use the read_page tool.",
|
||||
deps=page_content,
|
||||
)
|
||||
|
||||
# In pydantic-ai 1.x, extract the output from AgentRunResult
|
||||
return result.output
|
||||
|
||||
async def analyze_pages(
|
||||
self, start_page: int = 0, end_page: int = 0
|
||||
) -> PageContentAnalysis:
|
||||
"""Analyze the document starting from a specific page.
|
||||
|
||||
Args:
|
||||
start_page: The starting page to analyze
|
||||
end_page: The ending page to analyze
|
||||
|
||||
Returns:
|
||||
PageContentAnalysis containing all extracted insights
|
||||
"""
|
||||
analysis = PageContentAnalysis()
|
||||
analysis.insights = []
|
||||
|
||||
for page in range(start_page, end_page + 1):
|
||||
initial_content = self.pdf_document.get_page_text(page)
|
||||
|
||||
page_content = PageContent(
|
||||
page_number=page,
|
||||
content=initial_content,
|
||||
total_pages=self.pdf_document.total_pages,
|
||||
)
|
||||
|
||||
result = None
|
||||
retries = 0
|
||||
while result is None and retries < 3:
|
||||
try:
|
||||
result = await self.agent.run(
|
||||
f"Analyze this document page and extract structured insights. "
|
||||
f"This is page {page + 1} of {self.pdf_document.total_pages}. "
|
||||
f"If you need to see more pages to get complete context, use the read_page tool.",
|
||||
deps=page_content,
|
||||
)
|
||||
|
||||
# In pydantic-ai 1.x, extract the output from AgentRunResult
|
||||
analysis.insights.extend(result.output.insights)
|
||||
except Exception as e:
|
||||
print(f"Error analyzing page {page}: {e}, Retrying...")
|
||||
retries += 1
|
||||
|
||||
return analysis
|
||||
118
src/pdf_to_kcf/cli.py
Normal file
118
src/pdf_to_kcf/cli.py
Normal file
@@ -0,0 +1,118 @@
|
||||
"""CLI interface for pdf-to-kcf tool."""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import click
|
||||
from dotenv import load_dotenv
|
||||
|
||||
from .agent import DocumentAnalyzer
|
||||
from .pdf_reader import PDFDocument
|
||||
|
||||
# Load environment variables from .env file
|
||||
load_dotenv()
|
||||
|
||||
|
||||
@click.command()
|
||||
@click.argument("pdf_path", type=click.Path(exists=True))
|
||||
@click.option(
|
||||
"--output",
|
||||
"-o",
|
||||
type=click.Path(),
|
||||
help="Output JSON file path (default: <pdf_name>_insights.json)",
|
||||
)
|
||||
@click.option(
|
||||
"--start-page",
|
||||
"-s",
|
||||
type=int,
|
||||
default=0,
|
||||
help="Starting page number (0-indexed)",
|
||||
)
|
||||
@click.option(
|
||||
"--end-page",
|
||||
"-e",
|
||||
type=int,
|
||||
default=0,
|
||||
help="Ending page number (0-indexed)",
|
||||
)
|
||||
@click.option(
|
||||
"--page",
|
||||
"-p",
|
||||
type=int,
|
||||
default=0,
|
||||
help="Page number (0-indexed)",
|
||||
)
|
||||
@click.option(
|
||||
"--model",
|
||||
"-m",
|
||||
type=str,
|
||||
default="anthropic/claude-3.5-sonnet",
|
||||
help="AI model to use via OpenRouter (default: anthropic/claude-3.5-sonnet)",
|
||||
)
|
||||
def main(
|
||||
pdf_path: str, output: str, start_page: int, end_page: int, page: int, model: str
|
||||
):
|
||||
"""Parse PDF documents and extract structured insights using AI.
|
||||
|
||||
PDF_PATH: Path to the PDF file to analyze
|
||||
"""
|
||||
try:
|
||||
# Load PDF
|
||||
click.echo(f"Loading PDF: {pdf_path}")
|
||||
pdf_doc = PDFDocument(pdf_path)
|
||||
click.echo(f"Document loaded: {pdf_doc.total_pages} pages")
|
||||
|
||||
# Create analyzer
|
||||
click.echo(f"Initializing analyzer with model: {model}")
|
||||
analyzer = DocumentAnalyzer(pdf_doc, model=model)
|
||||
|
||||
if page > 0:
|
||||
click.echo(f"Starting analysis from page {page + 1}...")
|
||||
analysis = asyncio.run(analyzer.analyze_page(page))
|
||||
elif end_page > 0 and end_page - start_page > 0:
|
||||
click.echo(
|
||||
f"Starting analysis from page {start_page + 1} to {end_page + 1}..."
|
||||
)
|
||||
analysis = asyncio.run(analyzer.analyze_pages(start_page, end_page))
|
||||
else:
|
||||
click.echo(f"Starting analysis from page {start_page + 1}...")
|
||||
analysis = asyncio.run(analyzer.analyze_page(start_page))
|
||||
|
||||
# Determine output path
|
||||
if not output:
|
||||
pdf_name = Path(pdf_path).stem
|
||||
output = f"{pdf_name}_insights.json"
|
||||
|
||||
# Write results
|
||||
output_path = Path(output)
|
||||
with output_path.open("w", encoding="utf-8") as f:
|
||||
json.dump(
|
||||
analysis.model_dump(mode="json"),
|
||||
f,
|
||||
indent=2,
|
||||
ensure_ascii=False,
|
||||
)
|
||||
|
||||
click.echo(f"\nAnalysis complete!")
|
||||
click.echo(f"Found {len(analysis.insights)} insights")
|
||||
click.echo(f"Results written to: {output_path.absolute()}")
|
||||
|
||||
# Print summary
|
||||
if analysis.insights:
|
||||
click.echo("\nInsight summary:")
|
||||
for idx, insight in enumerate(analysis.insights, 1):
|
||||
click.echo(
|
||||
f" {idx}. [{insight.type.value.upper()}] {insight.insight[:80]}..."
|
||||
)
|
||||
|
||||
except FileNotFoundError as e:
|
||||
click.echo(f"Error: {e}", err=True)
|
||||
raise click.Abort()
|
||||
except Exception as e:
|
||||
click.echo(f"Error during analysis: {e}", err=True)
|
||||
raise click.Abort()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
50
src/pdf_to_kcf/models.py
Normal file
50
src/pdf_to_kcf/models.py
Normal file
@@ -0,0 +1,50 @@
|
||||
"""Data models for document parsing following the agentic document parsing format."""
|
||||
|
||||
from enum import Enum
|
||||
from typing import List
|
||||
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
|
||||
class ContentInsightType(str, Enum):
|
||||
"""Classification of the type of insight extracted."""
|
||||
|
||||
COMMENT = "comment"
|
||||
OPINION = "opinion"
|
||||
FACT = "fact"
|
||||
|
||||
|
||||
class ContentInsightAttribute(BaseModel):
|
||||
"""Metadata or attributes associated with an insight."""
|
||||
|
||||
name: str = Field(
|
||||
description="The name of the attribute (e.g., 'author', 'date', 'source')"
|
||||
)
|
||||
value: str = Field(description="The value of the attribute")
|
||||
|
||||
|
||||
class ContentInsight(BaseModel):
|
||||
"""A single insight extracted from the document content."""
|
||||
|
||||
type: ContentInsightType = Field(description="Classification of the insight")
|
||||
insight: str = Field(description="The insight description/summary")
|
||||
content: str = Field(description="The original content that was analyzed")
|
||||
attributes: List[ContentInsightAttribute] = Field(
|
||||
default_factory=list, description="Metadata about the insight"
|
||||
)
|
||||
|
||||
|
||||
class PageContentAnalysis(BaseModel):
|
||||
"""The complete analysis output from the agent."""
|
||||
|
||||
insights: List[ContentInsight] = Field(
|
||||
default_factory=list, description="Array of insights extracted from the content"
|
||||
)
|
||||
|
||||
|
||||
class PageContent(BaseModel):
|
||||
"""Context passed to the agent for each analysis run."""
|
||||
|
||||
page_number: int = Field(description="Current page being analyzed (0-indexed)")
|
||||
content: str = Field(description="The text content of the page")
|
||||
total_pages: int = Field(description="Total number of pages in the document")
|
||||
47
src/pdf_to_kcf/pdf_reader.py
Normal file
47
src/pdf_to_kcf/pdf_reader.py
Normal file
@@ -0,0 +1,47 @@
|
||||
"""PDF reading and text extraction utilities."""
|
||||
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
from pypdf import PdfReader
|
||||
|
||||
|
||||
class PDFDocument:
|
||||
"""Wrapper for PDF document reading."""
|
||||
|
||||
def __init__(self, pdf_path: str):
|
||||
"""Initialize PDF reader with the given path.
|
||||
|
||||
Args:
|
||||
pdf_path: Path to the PDF file
|
||||
"""
|
||||
self.pdf_path = Path(pdf_path)
|
||||
if not self.pdf_path.exists():
|
||||
raise FileNotFoundError(f"PDF file not found: {pdf_path}")
|
||||
|
||||
self.reader = PdfReader(str(self.pdf_path))
|
||||
self.total_pages = len(self.reader.pages)
|
||||
|
||||
def get_page_text(self, page_number: int) -> str:
|
||||
"""Extract text from a specific page.
|
||||
|
||||
Args:
|
||||
page_number: 0-indexed page number
|
||||
|
||||
Returns:
|
||||
Extracted text content from the page
|
||||
"""
|
||||
if page_number < 0 or page_number >= self.total_pages:
|
||||
raise ValueError(
|
||||
f"Invalid page number {page_number}. Document has {self.total_pages} pages."
|
||||
)
|
||||
|
||||
page = self.reader.pages[page_number]
|
||||
return page.extract_text()
|
||||
|
||||
def get_all_pages(self) -> List[str]:
|
||||
"""Extract text from all pages.
|
||||
|
||||
Returns:
|
||||
List of text content for each page
|
||||
"""
|
||||
return [self.get_page_text(i) for i in range(self.total_pages)]
|
||||
0
src/pdf_to_kcf/py.typed
Normal file
0
src/pdf_to_kcf/py.typed
Normal file
Reference in New Issue
Block a user