doc(rag): Add tika reader docs

[guanxuc]

AgentScope-Java Version

1.0.8

Description

doc(rag): Add tika reader docs

Checklist

Please check the following items before code is ready to be reviewed.

• Code has been formatted with mvn spotless:apply
• All tests are passing (mvn test)
• Javadoc comments are complete and follow project conventions
• Related documentation has been updated (e.g. links, examples, etc.)
• Code is ready for review

[gemini-code-assist]

Summary of Changes

Hello @guanxuc, I'm Gemini Code Assist¹! 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 enhances the modularity of the rag-simple extension by converting its external library dependencies into optional components. This change allows users to selectively include only the required libraries for their specific Retrieval Augmented Generation (RAG) use cases, thereby reducing the overall dependency footprint and improving flexibility.

Highlights

• Dependency Optionality: The rag-simple module's external dependencies, including agentscope-core, openai-java, qdrant-client, and various document processing libraries, have been marked as optional in pom.xml to reduce the default dependency footprint.
• Javadoc Enhancement: Javadoc comments have been added to the TikaReader class, providing a clear description of its functionality, supported formats, and an example usage.
• Documentation Update: The installation guides (both English and Chinese versions) have been updated to include Apache Tika Core and Parsers as optional dependencies for document processing.

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. ↩

[gemini-code-assist]

Code Review

This pull request refactors the agentscope-extensions-rag-simple module to make its dependencies optional. This is a good architectural improvement that prevents bloating projects with unused transitive dependencies. The changes in pom.xml correctly use <optional>true</optional> and <scope>provided</scope> for this purpose. The documentation has been updated to reflect these changes, and a helpful Javadoc has been added to TikaReader. I've suggested a minor formatting improvement in the markdown documentation files to enhance readability.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!