feat: add DuckDuckGo search tool

[leehuwuj]

Summary by CodeRabbit

• New Features

  • Introduced DuckDuckGo search functionality in Python and TypeScript.

• Dependencies

  • Added duck-duck-scrape dependency to projects using Express and Next.js.

[changeset-bot]

🦋 Changeset detected

Latest commit: bdaf2c6

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]

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

Loading

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
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9c9decb and 2e73069.

Files selected for processing (2)

• .changeset/clever-pens-mix.md (1 hunks)
• helpers/tools.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• .changeset/clever-pens-mix.md

[coderabbitai]

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2e73069 and e3d271d.

Files selected for processing (6)

• .changeset/clever-pens-mix.md (1 hunks)
• helpers/tools.ts (1 hunks)
• templates/components/engines/typescript/agent/tools/duckduckgo.ts (1 hunks)
• templates/components/engines/typescript/agent/tools/index.ts (2 hunks)
• templates/types/streaming/express/package.json (1 hunks)
• templates/types/streaming/nextjs/package.json (1 hunks)

Files skipped from review due to trivial changes (2)

• templates/types/streaming/express/package.json
• templates/types/streaming/nextjs/package.json

Files skipped from review as they are similar to previous changes (2)

• .changeset/clever-pens-mix.md
• helpers/tools.ts

Additional comments not posted (4)

templates/components/engines/typescript/agent/tools/duckduckgo.ts (3)

1-3: Imports are correctly defined and relevant to the functionalities provided by the file.

---

5-12: The type definitions for DuckDuckGoParameter and DuckDuckGoToolParams are clear and well-documented.

---

35-39: Type definition for DuckDuckGoSearchResult is concise and matches the expected output structure of the DuckDuckGo API.

templates/components/engines/typescript/agent/tools/index.ts (1)

3-3: The import statement for DuckDuckGoSearchTool and DuckDuckGoToolParams is correctly placed and syntactically correct.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e3d271d and bdaf2c6.

Files selected for processing (4)

• helpers/tools.ts (1 hunks)
• templates/components/engines/python/agent/tools/duckduckgo.py (1 hunks)
• templates/components/engines/typescript/agent/tools/duckduckgo.ts (1 hunks)
• templates/components/engines/typescript/agent/tools/index.ts (2 hunks)

Files not reviewed due to errors (1)

• helpers/tools.ts (no review received)

Files skipped from review as they are similar to previous changes (2)

• templates/components/engines/typescript/agent/tools/duckduckgo.ts
• templates/components/engines/typescript/agent/tools/index.ts

Additional comments not posted (4)

templates/components/engines/python/agent/tools/duckduckgo.py (4)

4-15: The function parameters and the docstring are well-defined and provide clear documentation for the users.

---

16-22: Exception handling for the module import is robust and provides clear instructions for resolution.

---

24-32: The main logic for performing the search is correctly implemented and handles the results appropriately.

---

35-36: The get_tools function correctly wraps the duckduckgo_search function for use, ensuring it integrates well with the tool framework.