Skip to content

added new cookbook - #36

Merged
srikanth-malyala merged 2 commits into
mainfrom
ai_agent
Feb 18, 2025
Merged

added new cookbook#36
srikanth-malyala merged 2 commits into
mainfrom
ai_agent

Conversation

@NVJKKartik

@NVJKKartik NVJKKartik commented Feb 18, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Pull Request

Description

Describe the changes in this pull request:

  • What feature/bug does this PR address?
  • Provide any relevant links or screenshots.

Checklist

  • Code compiles correctly.
  • Created/updated tests.
  • Linting and formatting applied.
  • Documentation updated.

Related Issues

Closes #<issue_number>

Summary by CodeRabbit

  • Documentation

    • Introduced a comprehensive guide on building, evaluating, and refining Retrieval-Augmented Generation (RAG) applications using Langchain—with step-by-step instructions, code examples, and best practices.

  • New Features

    • Updated resource listings to provide easy access to the new guide for developers seeking enhanced RAG application strategies.

@coderabbitai

coderabbitai Bot commented Feb 18, 2025 •
edited
Loading

Copy link
Copy Markdown

Walkthrough

A new documentation file has been added to the cookbook detailing the process for building and incrementally improving RAG applications using Langchain. The guide includes dependency installation, configuration of OpenAI’s API, integration of the FutureAGI SDK for evaluation, code examples for data loading and document retrieval, and an analysis of evaluation metrics. Additionally, the configuration file mint.json has been updated to include a reference to this new guide within the "Cookbooks" section.

Changes

File(s) Change Summary
cookbook/.../How-to-build-and-incrementally-improve-RAG-applications-in-Langchain.mdx New guide file added covering dependency installation, API configuration, integration with FutureAGI SDK, code examples, and evaluation methods.
mint.json Updated to add a new page entry for the RAG applications guide under the "Cookbooks" group.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RAG_App as RAG Application
    participant Langchain
    participant Eval as FutureAGI Evaluator

    User->>RAG_App: Send query/request
    RAG_App->>Langchain: Load data & generate embeddings
    Langchain-->>RAG_App: Retrieved documents & processed texts
    RAG_App->>RAG_App: Aggregate results and perform text-splitting
    RAG_App->>Eval: Submit evaluation metrics (context relevance, retrieval, etc.)
    Eval-->>RAG_App: Return evaluation feedback
    RAG_App-->>User: Return final response with evaluation insights
Loading

Poem

Hopping through lines of vibrant code,
I found a guide where secrets are bestowed.
Langchain’s magic and RAG unite,
With FutureAGI shining bright.
I am a rabbit dancing on a byte,
Celebrating new steps in our code flight!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between a1e94ed and 701af51.

📒 Files selected for processing (2)
  • cookbook/cookbook5/How-to-build-and-incrementally-improve-RAG-applications-in-Langchain.mdx (1 hunks)
  • mint.json (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@srikanth-malyala
srikanth-malyala merged commit a5b6735 into main Feb 18, 2025
@NVJKKartik
NVJKKartik deleted the ai_agent branch April 22, 2025 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@srikanth-malyala srikanth-malyala srikanth-malyala approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@NVJKKartik @srikanth-malyala