search

run-llama / create-llama

The easiest way to get started with LlamaIndex
MIT License
718 stars 86 forks source link

feat: Add OpenAPI Action tool #103

Closed leehuwuj closed 2 months ago

leehuwuj commented 2 months ago

Example config: Simple:

local:
  openapi_action.OpenAPIActionToolSpec:
    openapi_uri: https://gist.githubusercontent.com/leehuwuj/81cfbeee90731e679eafd26ba4de11bd/raw/dbb0dddab349c48ebc53f50bf82955e454137f81/hackernews_openapi.yaml

Add authentication:

local:
  openapi_action.OpenAPIActionToolSpec:
    openapi_uri: https://gist.githubusercontent.com/leehuwuj/81cfbeee90731e679eafd26ba4de11bd/raw/dbb0dddab349c48ebc53f50bf82955e454137f81/hackernews_openapi.yaml
    domain_headers:
      hacker-news.firebaseio.com:
        Accept: application/json
        Authentication: "Your authentication params here"
llamahub:

Summary by CodeRabbit

changeset-bot[bot] commented 2 months ago

🦋 Changeset detected

Latest commit: 099f626586156c9999732e33fc73c1a848ec560e

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 2 months ago

[!WARNING]

Rate Limit Exceeded

@leehuwuj has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 52 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between d8bc271a218649923c1903c9447dce8bb6ef5c65 and 099f626586156c9999732e33fc73c1a848ec560e.

Walkthrough

The changes introduce three new tools—OpenAPI, HTTP Request, and OpenAPI action—into the supportedTools array within helpers/tools.ts. These tools enable interaction with OpenAPI schemas and HTTP requests. Additionally, caching is implemented in load_tools using cachetools in __init__.py, and a new OpenAPIActionToolSpec class is added in openapi_action.py to parse OpenAPI specs and make requests.

Changes

Files/Paths Change Summary
helpers/tools.ts Added three new tools: "OpenAPI", "HTTP Request", and "OpenAPI action" with their specifications and environment variables.
.../python/agent/tools/__init__.py Introduced json and cachetools imports, and added a @cached decorator to the load_tools method in ToolFactory class.
.../python/agent/tools/openapi_action.py Added a new OpenAPIActionToolSpec class with methods to load OpenAPI specs from URIs.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant ToolFactory
    participant OpenAPIActionToolSpec
    participant HTTPRequestTool

    User->>ToolFactory: Request to load tools
    ToolFactory->>OpenAPIActionToolSpec: Load OpenAPI spec
    OpenAPIActionToolSpec->>HTTPRequestTool: Make HTTP request
    HTTPRequestTool->>OpenAPIActionToolSpec: Return response
    OpenAPIActionToolSpec->>ToolFactory: Return loaded tool
    ToolFactory->>User: Return tools

Poem

In the land of code where tools do thrive,
OpenAPI and HTTP now arrive.
With specs and requests, they dance in glee,
A cached embrace for efficiency.
The rabbit cheers this grand debut,
For agents now, much more they do! 🐇✨

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.