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

Feature Request: Support for OpenAI Assistant API #151

Open
MyunghoBae opened this issue Aug 14, 2024 · 1 comment
Open

Feature Request: Support for OpenAI Assistant API #151

MyunghoBae opened this issue Aug 14, 2024 · 1 comment

Comments

@MyunghoBae
Copy link

Dear anc95,,

I hope this message finds you well. I'm writing to propose an exciting enhancement to your code review library: integration with the OpenAI Assistant API.

Currently, your library provides valuable code review functionality using the Chat API, which has been incredibly useful for developers. However, integrating the Assistant API could significantly expand and improve the code review capabilities of your library. Here's why this integration would be beneficial:

  1. Customized Code Review Assistants: The Assistant API allows for creating specialized assistants with specific instructions and knowledge bases. This could enable the creation of language-specific or framework-specific code review assistants.

  2. File Handling Capabilities: The Assistant API's ability to work with uploaded files could allow for more comprehensive code reviews, potentially analyzing entire projects or multiple files simultaneously.

  3. Persistent Conversation Threads: The thread feature of the Assistant API could enable more context-aware and continuous code review sessions, maintaining the context of previous discussions and recommendations.

  4. Enhanced Interactivity: The function calling feature could allow for more dynamic interactions, such as running automated tests or style checks as part of the review process.

  5. Improved Code Suggestions: With the ability to provide more context and maintain conversation history, the Assistant API could offer more accurate and contextually relevant code improvement suggestions.

Implementing support for the Assistant API would greatly enhance your library's capabilities, offering users more advanced and tailored code review experiences. This could lead to:

  • More comprehensive and insightful code reviews
  • Increased adoption among development teams working on complex projects
  • The ability to create custom code review workflows and specialized assistants

I understand that implementing new features requires careful consideration and resources. If there's any way I can contribute to this effort or provide more information, please let me know.

Thank you for your time and consideration. I'm excited about the potential of this integration and look forward to your thoughts on this proposal.

@anc95
Copy link
Owner

anc95 commented Aug 19, 2024

Thanks for your thoughtful proposal! The assistant API could indeed be a game-changer for code reviewing. However, I'm not quite sure about how to integrate it. Let me break it down into points:

Code Review Assistants

Maintaining the assistant could be a bit tricky. If we do it, it might lack flexibility and customization might be tough. But if users do it, they would need to create an assistant locally via code and then share the ID with our bot. I'm unsure about what would be the best way to go about this.

File Handling

Yes. this will be an essential benefits

Persistent Conversations

Implementing this might be challenging as the GitHub agent is stateless. We don't have a place to store the thread ID and to continue the conversation. For instance, each PR could be one thread and a new push could carry on the conversation in the same thread.

Interactivity

This point raises the same concerns as the first one. Customization might prove to be a tough nut to crack in GitHub action.

Code Suggestions

Totally agree with you here.

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

No branches or pull requests

2 participants