Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe changes update documentation to clarify that users can choose between Unstructured.io and LlamaIndex (LlamaCloud) as ETL services for file processing. Both the README and user documentation now describe setup instructions and differences for each option, replacing the previous single-service approach. Changes
Sequence Diagram(s)sequenceDiagram
User->>Documentation: Reads setup instructions
Documentation-->>User: Presents ETL service options (Unstructured or LlamaIndex)
User->>ETL Service: Registers and obtains API key (chooses one)
User->>System: Configures chosen ETL service for file processing
Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (1)
137-139: Consider hyperlinking ETL service names for clarityTo mirror the detailed links provided in the MDX docs, you could convert “Unstructured.io” and “LlamaIndex API key” into clickable links. This helps users jump directly to the correct platforms when setting up their keys.
Example diff:
- - **File Processing ETL Service** (choose one): - - Unstructured.io API key (free tier available, supports 34+ formats) - - LlamaIndex API key (enhanced parsing, supports 50+ formats) + - **File Processing ETL Service** (choose one): + - [Unstructured.io](https://platform.unstructured.io/) API key (free tier available, supports 34+ formats) + - [LlamaCloud (LlamaIndex)](https://cloud.llamaindex.ai/) API key (enhanced parsing, supports 50+ formats)surfsense_web/content/docs/index.mdx (1)
70-88: Fix heading typo and improve consistency of service links
- The heading “## File Upload’s” should be “## File Uploads” (remove the misplaced apostrophe).
- Align Option titles and links to the external platforms rather than GitHub repos.
- Ensure users see exactly where to obtain their API keys.
Proposed diff:
- ## File Upload's + ## File Uploads - SurfSense supports two ETL (Extract, Transform, Load) services for converting files to LLM-friendly formats: + SurfSense supports two ETL (Extract, Transform, Load) services for converting files to LLM-friendly formats: ### Option 1: Unstructured -Files are converted using [Unstructured](https://github.com/Unstructured-IO/unstructured) +Files are converted using [Unstructured.io](https://platform.unstructured.io/) 1. Get an Unstructured.io API key from [Unstructured Platform](https://platform.unstructured.io/) You should be able to generate API keys once registered  ### Option 2: LlamaIndex (LlamaCloud) -Files are converted using [LlamaIndex](https://www.llamaindex.ai/) which offers 50+ file format support. +Files are converted using [LlamaCloud (LlamaIndex)](https://cloud.llamaindex.ai/) which offers 50+ file format support. 1. Get a LlamaCloud API key from [LlamaCloud](https://cloud.llamaindex.ai/) 2. Sign up for a LlamaCloud account to access their parsing services 3. LlamaCloud provides enhanced parsing capabilities for complex documents **Note**: You only need to set up one of these services. LlamaCloud offers broader file format support, while Unstructured provides a generous free tier.
Motivation and Context
You guys need to stop spamming unstructured sales teams so they can relax. My bad I forgot to update in Docs that we also have LlamaCloud option.
Changes Overview
Screenshots
API Changes
Types of changes
Testing
Checklist:
Summary by CodeRabbit