Skip to content

fix: correct docx hyperlink extraction#30360

Merged
JohnJyong merged 1 commit intolanggenius:mainfrom
yangzq50:fix_docx
Jan 6, 2026
Merged

fix: correct docx hyperlink extraction#30360
JohnJyong merged 1 commit intolanggenius:mainfrom
yangzq50:fix_docx

Conversation

@yangzq50
Copy link
Member

Important

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

Iterate paragraph XML to detect w:hyperlink nodes and resolve external r:id relationships into Markdown links.

Fixes #30359

Screenshots

Before After
... ...

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
Copilot AI review requested due to automatic review settings December 30, 2025 05:13
@yangzq50 yangzq50 requested a review from JohnJyong as a code owner December 30, 2025 05:13
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Dec 30, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @yangzq50, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where hyperlinks in DOCX documents were not being correctly extracted. It introduces enhanced parsing logic to identify and resolve embedded hyperlinks, converting them into a standard Markdown link format. This ensures that all relevant link information is preserved and correctly represented when processing DOCX files.

Highlights

  • DOCX Hyperlink Extraction: Implemented a new mechanism to accurately detect and extract hyperlinks embedded within DOCX documents by iterating through paragraph XML elements and identifying w:hyperlink nodes.
  • Markdown Link Conversion: Resolved external r:id relationships associated with hyperlinks to their target URLs, converting them into standard Markdown link format [link text](URL) for better readability and usability.
  • Dependency Updates: Introduced new imports for qn (qualified name) from docx.oxml.ns and Run from docx.text.run to facilitate direct interaction with DOCX XML elements for precise hyperlink parsing.
  • Regex Refinement: Modified the URL detection regex pattern to specifically target HYPERLINK fields within the document structure, improving the accuracy of hyperlink identification.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors the docx hyperlink extraction to be more robust by parsing the paragraph's underlying XML structure. The changes are a good improvement. I've identified a block of dead code from the previous implementation that should be removed for maintainability. I also suggested a small improvement to handle cases where a hyperlink has no text, to avoid creating empty links in the output Markdown. Additionally, the PR description mentions that tests have been added, but I don't see any tests for the new hyperlink extraction logic in the provided changes. It would be beneficial to add a unit test to cover this new functionality and prevent future regressions.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves hyperlink extraction from DOCX files by iterating through paragraph XML elements to detect w:hyperlink nodes and resolve their external relationship IDs into Markdown-formatted links.

Key Changes:

  • Added XML-based hyperlink extraction that properly resolves relationship IDs to URLs
  • Refactored run processing into a helper function for better code organization
  • Updated imports to include qn and Run from the docx library for XML namespace handling
Comments suppressed due to low confidence (1)

api/core/rag/extractor/word_extractor.py:255

  • The old hyperlink extraction code (lines 234-255) appears to be dead code now that hyperlinks are being extracted using the new XML-based approach (lines 327-357). This code modifies run.text directly but those modifications won't be used since the new iteration through paragraph._element in lines 327-357 doesn't use para.runs anymore. This code should be removed to avoid confusion and improve maintainability.
 hyperlinks_url = None url_pattern = re.compile(r'HYPERLINK\s+"([^"]+)"', re.IGNORECASE) for para in doc.paragraphs: for run in para.runs: if run.text and hyperlinks_url: result = f" [{run.text}]({hyperlinks_url}) " run.text = result hyperlinks_url = None if "HYPERLINK" in run.element.xml: try: xml = ElementTree.XML(run.element.xml) x_child = [c for c in xml.iter() if c is not None] for x in x_child: if x is None: continue if x.tag.endswith("instrText"): if x.text is None: continue for i in url_pattern.findall(x.text): hyperlinks_url = str(i) except Exception: logger.exception("Failed to parse HYPERLINK xml") 

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@yangzq50 yangzq50 force-pushed the fix_docx branch 3 times, most recently from 08c1423 to 1688c68 Compare December 30, 2025 06:38
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Dec 30, 2025
@yangzq50 yangzq50 requested a review from Copilot December 30, 2025 06:38
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@yangzq50 yangzq50 force-pushed the fix_docx branch 2 times, most recently from 0e6c56c to 2940040 Compare December 30, 2025 18:45
Iterate paragraph XML to detect w:hyperlink nodes and resolve external r:id relationships into Markdown links.
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 6, 2026
@JohnJyong JohnJyong merged commit 114a34e into langgenius:main Jan 6, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

3 participants