Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Supports automatic calling of APIs conforming to the OpenAPI specification. #548

Merged
merged 19 commits into from May 15, 2024

Conversation

yiyiyi0817
Copy link
Member

Description

This PR introduces a significant feature enhancement to the CAMEL project by enabling automatic calling of APIs that comply with the OpenAPI Specification (OAS). This update adds support for Klarna, Coursera, and Speak APIs, broadening the scope of external integrations available within the CAMEL ecosystem.

To facilitate these integrations, the project now includes a generic function that dynamically handles requests to any API defined by an OpenAPI spec. This means contributors can easily extend the project's capabilities by integrating with various services that expose their APIs with an OpenAPI document.

Motivation and Context

The OpenAPI Specification offers a widely adopted standard for describing RESTful APIs, making it easier to integrate disparate systems.

Types of changes

  • New feature (non-breaking change which adds core functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Implemented Tasks

  • Generic OpenAPI Integration Function:
    A new utility function has been introduced, capable of dynamically generating requests to APIs based on their OpenAPI specifications, along with schemas required by OpenAI. Please note, the current version does not support APIs requiring security authentication.

  • Klarna API Integration:
    Implemented integration with Klarna's payment API, enabling users to search goods.

  • Coursera API Integration:
    Added support for accessing Coursera's educational content API, allowing users to retrieve course information, enrollments, and other educational resources.

  • Speak API Integration:
    Incorporated the Speak API for advanced natural language processing, offering capabilities such as translation, language explaination.

Checklist

Go over all the following points, and put an x in all the boxes that apply.

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

Copy link

coderabbitai bot commented May 7, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@yiyiyi0817 yiyiyi0817 self-assigned this May 7, 2024
@yiyiyi0817 yiyiyi0817 added this to the Sprint 2 milestone May 7, 2024
@yiyiyi0817 yiyiyi0817 modified the milestones: Sprint 2, Sprint 3 May 7, 2024
@yiyiyi0817 yiyiyi0817 added enhancement New feature or request API Modifies the API FunctionCall labels May 7, 2024
@Wendong-Fan Wendong-Fan modified the milestones: Sprint 3, Sprint 2 May 7, 2024
@Wendong-Fan Wendong-Fan requested a review from a team May 7, 2024 06:58
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @yiyiyi0817's great contribution and sorry for the late review, left some comments

camel/types/enums.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Show resolved Hide resolved
Copy link
Member Author

@yiyiyi0817 yiyiyi0817 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for your review. Some reply.

camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
@Wendong-Fan Wendong-Fan requested a review from a team May 12, 2024 05:55
@Wendong-Fan
Copy link
Member

Hey @yiyiyi0817 , thanks for your reply, please feel free to update the code based on our discussion above, then it LGTM!

Copy link
Member

@zechengz zechengz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments

camel/functions/open_api_specs/Coursera/__init__.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
camel/functions/open_api_function.py Outdated Show resolved Hide resolved
test/functions/test_open_api_function.py Outdated Show resolved Hide resolved
test/functions/test_open_api_function.py Show resolved Hide resolved
test/functions/test_open_api_function.py Show resolved Hide resolved
test/functions/test_open_api_function.py Show resolved Hide resolved
Copy link
Member Author

@yiyiyi0817 yiyiyi0817 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for review. leave a little explanation.

test/functions/test_open_api_function.py Outdated Show resolved Hide resolved
test/functions/test_open_api_function.py Show resolved Hide resolved
test/functions/test_open_api_function.py Show resolved Hide resolved
test/functions/test_open_api_function.py Show resolved Hide resolved
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @yiyiyi0817 ! LGTM

@Wendong-Fan Wendong-Fan merged commit b924c99 into master May 15, 2024
6 checks passed
@Wendong-Fan Wendong-Fan deleted the openapi_function branch May 15, 2024 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Modifies the API enhancement New feature or request FunctionCall
Projects
Status: Merged or Closed
Development

Successfully merging this pull request may close these issues.

[Feature Request] Function call for api [Roadmap] Add support for tools and APIs
3 participants