search

dimagi / open-chat-studio

A web based platform for building Chatbots backed by Large Language Models
BSD 3-Clause "New" or "Revised" License
16 stars 7 forks source link

Custom Actions: call outs to external APIs #811

Closed snopoke closed 2 weeks ago

snopoke commented 3 weeks ago

Description

This adds a 'custom actions' feature to OCS. A "custom action" represents an external API. When a bot is configured with a custom action the bot will have additional tools which will allow it to make HTTP requests to the external API.

User Impact

Users can configure bots with custom actions.

Demo

Custom Actions Demo 🤖 - Watch Video

Docs

TODO

snopoke commented 3 weeks ago

@coderabbit review

coderabbitai[bot] commented 3 weeks ago

Walkthrough

This pull request introduces significant enhancements to the Django application by adding a new custom_actions field to both the OpenAiAssistant and Experiment models, facilitating a ManyToMany relationship with the CustomAction model. The OpenAiAssistantForm is updated to include a ModelMultipleChoiceField for custom_actions, which is populated based on the user's team. Additionally, the ExperimentForm is modified to incorporate the new field, ensuring that it can handle multiple custom actions during form submissions.

A migration file is included to create the necessary database structure for the CustomAction model, which encompasses various fields such as name, description, and api_schema. The CustomAction model is further supported by a dedicated form class and validation logic to ensure the integrity of the API schema provided. The changes also extend to the URL routing and views, enabling CRUD operations for custom actions, and enhancing the user interface through updated templates.

Overall, these modifications enhance the application's capability to manage custom actions in conjunction with experiments and assistants, promoting a more flexible interaction model.

Possibly related PRs

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 , 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 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
snopoke commented 3 weeks ago

@coderabbit review

snopoke commented 3 weeks ago

@coderabbit review

codecov-commenter commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 77.77778% with 186 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
apps/custom_actions/utils.py 48.33% 31 Missing :warning:
apps/chat/agent/openapi_tool.py 80.89% 30 Missing :warning:
apps/custom_actions/fields.py 36.17% 30 Missing :warning:
apps/custom_actions/forms.py 71.64% 19 Missing :warning:
apps/custom_actions/models.py 82.75% 15 Missing :warning:
apps/custom_actions/views.py 75.43% 14 Missing :warning:
apps/utils/ip_resolver.py 57.69% 11 Missing :warning:
apps/utils/urlvalidate.py 70.58% 10 Missing :warning:
apps/assistants/forms.py 25.00% 9 Missing :warning:
apps/service_providers/models.py 56.25% 7 Missing :warning:
... and 3 more
Additional details and impacted files

:loudspeaker: Thoughts on this report? Let us know!

snopoke commented 3 weeks ago

@coderabbit resolve