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

Convert example copilot to new api #30

Merged
merged 4 commits into from
Jan 22, 2025
Merged

Convert example copilot to new api #30

merged 4 commits into from
Jan 22, 2025

Conversation

mnicstruwig
Copy link
Collaborator

@mnicstruwig mnicstruwig commented Jan 16, 2025

This PR converts the example copilot to the new copilot protocol that will soon be launched to the OpenBB Workspace / App. This is a substantial breaking change in the protocol, but makes custom copilots dramatically more powerful and flexible.

This PR also adds a migration guide in the docs folder that provides a guide and assistance in migrating to the new protocol, and updates the README of the project to reflect the new protocol.

All other custom copilots have been moved to a WIP folder, and will be updated in time as we evaluate their ability to be ported to the new protocol (which now requires function calling in order to retrieve data from the OpenBB app).

@mnicstruwig mnicstruwig self-assigned this Jan 16, 2025
@mnicstruwig mnicstruwig marked this pull request as ready for review January 16, 2025 17:29
@mnicstruwig mnicstruwig changed the title convert example copilot to new api Convert example copilot to new api Jan 16, 2025
Copy link
Contributor

@montezdesousa montezdesousa left a comment

Choose a reason for hiding this comment

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

Tested running it in the FE and worked first time without issues!

Left a few comments on the readme

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/migration-guide.md Outdated Show resolved Hide resolved
)


class Undefined:
Copy link

Choose a reason for hiding this comment

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

Just curious, what's this for? 😂

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's a good question! There is a comment in the code about it:

Screenshot 2025-01-22 at 09 02 49

@mnicstruwig mnicstruwig merged commit 465cf7a into main Jan 22, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants