feat: use llamacloud pipeline in TS

thucpn commented 4 weeks ago

Summary by CodeRabbit

New Features
- Introduced a LlamaCloud pipeline for secure data ingestion and private file uploads.
- Enhanced document handling with new functions for storing and processing files.
- Streamlined the upload process for different index types.
Bug Fixes
- Improved error handling for missing API keys in configuration functions.
Documentation
- Updated documentation strings for environment variables for clarity and generality.
Chores
- Added new dependencies to improve project capabilities.
- Updated existing libraries to incorporate bug fixes and performance improvements.

changeset-bot[bot] commented 4 weeks ago

🦋 Changeset detected

Latest commit: 228ae883199d1af9aed4c2a51a4930304b605318

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ------------ | ----- | | create-llama | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai[bot] commented 4 weeks ago

Walkthrough

This update enhances the LlamaCloud pipeline for data ingestion in TypeScript applications, focusing on improved document handling, private file uploads, and modularity. Key changes include refined file upload processes, extended metadata management, and the introduction of new dependencies to facilitate these improvements. Overall, these modifications streamline operations, bolster security, and elevate the functionality and usability of the system.

Changes

Files	Change Summary
.changeset/violet-islands-collect.md	Introduces "create-llama" patch focused on private file uploads and data ingestion improvements.
helpers/env-variables.ts	Updates documentation for `LLAMA_CLOUD_ORGANIZATION_ID`, removing "Python only" restriction.
templates/components/llamaindex/typescript/documents/helper.ts	Renames `loadDocuments` to `storeAndParseFile`, adding logic for private document handling and modifying metadata.
templates/components/llamaindex/typescript/documents/pipeline.ts	Simplifies `runPipeline` function by removing conditional logic for `LlamaCloudIndex`, enforcing a single processing path.
templates/components/llamaindex/typescript/documents/upload.ts	Modifies `uploadDocument` to include `filename` parameter, enabling direct uploads to LlamaCloud for relevant indexes.
templates/components/llamaindex/typescript/streaming/events.ts	Introduces `downloadFilesFromNodes` function for improved modularity while removing direct usage of `LLamaCloudFileService`.
templates/components/vectordbs/typescript/llamacloud/generate.ts	Replaces `LlamaCloudIndex` with `LLamaCloudFileService` in `loadAndIndex`, shifting to document-by-document processing.
templates/types/streaming/express/package.json	Adds `@llamaindex/cloud` dependency to enhance project capabilities.
templates/types/streaming/express/src/controllers/chat-config.controller.ts	Introduces validation for `LLAMA_CLOUD_API_KEY` in the configuration function, enhancing robustness.
templates/types/streaming/nextjs/app/api/chat/config/llamacloud/route.ts	Adds validation for `LLAMA_CLOUD_API_KEY` in the `GET` function to ensure proper configuration before execution.
templates/types/streaming/nextjs/package.json	Adds `@llamaindex/cloud` dependency for the Next.js project to extend functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UploadService
    participant LlamaCloudFileService

    User->>UploadService: Upload file (filename, raw data)
    UploadService->>LlamaCloudFileService: Upload file to LlamaCloud
    LlamaCloudFileService-->>UploadService: Confirmation of upload
    UploadService-->>User: Upload successful message

🐰 In the garden of code, we hop and play,
With LlamaCloud's magic, we brighten the day!
Files float in safely, metadata in tow,
A swift little dance as we watch the data grow!
Hooray for the changes, a cheer from us all,
For every new feature, we hop and we crawl! 🌼✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

thucpn commented 4 weeks ago

Note: upgrade LITS to use LlamaCloudFileService. Update LITS will also fix E2E is running fail in express

run-llama / create-llama