Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring PDF loaders: 02 PyMuPDF #29063

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

pprados
Copy link
Contributor

@pprados pprados commented Jan 7, 2025

  • Refactoring PDF loaders step 2: "community: Refactoring PDF loaders to standardize approaches"

  • Description: Update PyMuPDFParser/Loader

  • Twitter handle: pprados

This is one part of a larger Pull Request (PR) that is too large to be submitted all at once.
This specific part focuses to prepare the update of all parsers.

For more details, see PR 28970.

@eyurtsev it's the continuation of PDFLoader modifications.

Copy link

vercel bot commented Jan 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
langchain ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 7, 2025 4:18pm

@pprados pprados marked this pull request as ready for review January 7, 2025 09:16
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. community Related to langchain-community Ɑ: doc loader Related to document loader module (not documentation) labels Jan 7, 2025
@pprados
Copy link
Contributor Author

pprados commented Jan 7, 2025

@eyurtsev I rebase the code with master ;-)

Copy link
Collaborator

@eyurtsev eyurtsev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great will take a look in the AM

@pprados pprados mentioned this pull request Jan 8, 2025
2 tasks
Copy link
Collaborator

@eyurtsev eyurtsev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left two major comment, a few stylistic comments and some nits.

Let's tackle the two major comments:

  1. Define the standardized structure of metadata
  2. Create a dedicated ImageParser which is a blob parser

@@ -46,6 +58,119 @@
"JBIG2Decode",
]

logger = logging.getLogger(__name__)

_format_image_str = "\n\n{image_text}\n\n"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could we capitalize global constants

https://google.github.io/styleguide/pyguide.html#316-naming



def purge_metadata(metadata: dict[str, Any]) -> dict[str, Any]:
"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: https://google.github.io/styleguide/pyguide.html#383-functions-and-methods

We don't enforce this right now, but we try to have the first description on the first line (i.e., no new line)

for k, v in metadata.items():
if type(v) not in [str, int]:
v = str(v)
if k.startswith("/"):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bug? The file path could be an absolute path on the local machine -- this looks like an error right now?

_delim = ["\n\n\n", "\n\n"] # To insert images or table in the middle of the page.


def __merge_text_and_extras(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Maybe improve the name so it's a bit more distinct from the _ name? We typically don't use __ in the code

"""
Purge metadata from unwanted keys and normalize key names.
Args:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MAJOR:

  1. Could you describe what the wanted keys are and how they will be standardized / normalized? (And why?)

This feels like a big decision if the metadata is to be standardized across all PDF parsers?


MINOR

  1. The function documentation makes it sound like it's mutating the original metadata (which I think it's not doing). A better name like "create_standardized_metadata" or "standardize metadata" and a doc-string that indicates that it's creating a standardized metadata dict from the given will help here

return _convert_images_to_text


_prompt_images_to_description = PromptTemplate.from_template(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better to use a string here since .format() isn't used in a useful way

else:
yield ""

_convert_images_to_text.creator = ( # type: ignore[attr-defined]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's avoid assigning attributes to functions


def _get_page_content(self, doc: fitz.Document, page: fitz.Page, blob: Blob) -> str:
self.extract_tables_settings = {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how were these chosen is it possible to add a comment?

def convert_images_to_description(
model: BaseChatModel,
*,
prompt: BasePromptTemplate = _prompt_images_to_description,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
prompt: BasePromptTemplate = _prompt_images_to_description,
prompt: str = _prompt_images_to_description,

@@ -78,6 +203,192 @@ def extract_from_images_with_rapidocr(
return text


# Type to change the function to convert images to text.
CONVERT_IMAGE_TO_TEXT = Optional[Callable[[Iterable[np.ndarray]], Iterator[str]]]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MAJOR:

Why not use an ImageBlobParser w/ the regular Blob to Document interface. it'll allow reusing the image logic for images that do not originate from pdfs (e.g., to re-use for a web crawler)


A PDF parser doesn't would accept a parser as part of the initializer

class PDFParser(...):
   def __Init__(self, ...  *, ..., image_blob_parser: Optional[BlobParser] = None):
      pass

If the image_pdf_parser is provided, then it'll be used for OCR purposes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Related to langchain-community Ɑ: doc loader Related to document loader module (not documentation) size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

2 participants