search

run-llama / create-llama

The easiest way to get started with LlamaIndex
MIT License
631 stars 74 forks source link

feat: add DuckDuckGo search tool #133

Closed leehuwuj closed 3 weeks ago

leehuwuj commented 4 weeks ago

Summary by CodeRabbit

changeset-bot[bot] commented 4 weeks ago

🦋 Changeset detected

Latest commit: bdaf2c63d93a031791b7af546f20626559c6f709

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

The changes introduce a DuckDuckGo search tool for both Python and TypeScript environments, enabling efficient web searches. This new feature includes the necessary dependencies and metadata to support multiple frameworks like FastAPI, Next.js, and Express. The search functionality is implemented through the duck-duck-scrape library, making it well-integrated and accessible within different project setups.

Changes

File/Path Change Summary
.changeset/clever-pens-mix.md Summary of all introduced changes
helpers/tools.ts Added DuckDuckGo Search tool with specifications, dependencies, supported frameworks, and environmental variables.
.../typescript/agent/tools/duckduckgo.ts Defined the DuckDuckGo search functionality, including parameters for query and region, and added necessary imports and class implementation.
.../python/agent/tools/duckduckgo.py Introduced duckduckgo_search function for DuckDuckGo queries along with get_tools to list available tools.
.../typescript/agent/tools/index.ts Added import statements and a factory entry for creating DuckDuckGoSearchTool using defined parameters.
.../streaming/express/package.json Added duck-duck-scrape: ^2.2.5 dependency for Express project.
.../streaming/nextjs/package.json Added duck-duck-scrape: ^2.2.5 dependency for Next.js project.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DuckDuckGoSearchTool
    participant DuckDuckGoAPI

    User->>DuckDuckGoSearchTool: Query DuckDuckGo
    DuckDuckGoSearchTool->>DuckDuckGoAPI: Send search request
    DuckDuckGoAPI-->>DuckDuckGoSearchTool: Return search results
    DuckDuckGoSearchTool-->>User: Display search results

Poem

In fields of code, a bunny hops, Bringing tools with clever crops, DuckDuckGo joins the dance, Enhancing searches at a glance. Through Python, TypeScript too, The web unfolds, all bright and true.

[!WARNING]

Review ran into problems

Problems (1) * Git: Failed to clone repository. Please contact CodeRabbit support.

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