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

create assistant subcommand #29

Open
divanvisagie opened this issue Jun 9, 2024 · 0 comments
Open

create assistant subcommand #29

divanvisagie opened this issue Jun 9, 2024 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@divanvisagie
Copy link
Owner

Context and Overview

OpenAI has introduced the Assistants API, which allows building AI assistants within applications. This API supports various features like instructions, models, tools, and files to respond to user queries. Specifically, it includes the following tools:

  • Code Interpreter
  • File Search
  • Function Calling

More details can be found in the documentation here.

Proposed Enhancement

Introduce an assistant subcommand to make use of OpenAI's Assistants API features directly from Chat Gipity. This subcommand will enable users to:

  • Leverage instructions and models for tailored responses.
  • Utilize the tools provided by the Assistants API.

Subcommand Usage

The assistant subcommand will support various functionalities available in the Assistants API, such as:

  1. Code Interpreter:
    cgip assistant code "Explain this Python code: print('Hello, World!')"
  2. File Search:
    cgip assistant file-search "Find details in project.txt"
  3. Function Calling:
    cgip assistant function "Call the summarization function on this text"

Features and Benefits

  • Enhanced Capabilities: Provide users with access to advanced AI-powered functionalities directly from the command line.
  • Simplified Integration: Allows users to easily incorporate OpenAI Assistant features without needing to build from scratch.
  • Versatility: Supports various tools and capabilities of the Assistants API, making it a comprehensive addition to the existing Chat Gipity commands.

Implementation Plan

  1. Implement the assistant subcommand:

    • Add parsing and subcommands for code, file-search, and function integrations using the Assistants API.
    • Ensure the command follows a consistent structure with existing commands.
  2. Documentation Update:

    • Update the README file to include usage instructions and examples for the assistant subcommand.
    • Provide detailed descriptions of capabilities and how users can utilize each tool.

Example Usage

  1. Code Interpreter:

    cgip assistant code "Explain this Rust code: fn main() { println!('Hello, World!'); }"
    • Expected to return an explanation of the provided code.
  2. File Search:

    cgip assistant file-search "Search for the term 'API key' in config.txt"
    • Expected to return relevant details from the specified file.
  3. Function Calling:

    cgip assistant function "Call the summarize_text function on this input 'OpenAI is developing robust AI applications.'"
    • Expected to return the result from the function call.

Expected Outcome

  • Seamless integration of OpenAI Assistants API features within Chat Gipity.
  • Users can leverage advanced tools and functionalities provided by the Assistants API directly from the command line, enhancing productivity and efficiency.

Action Items:

  • Develop the assistant subcommand.
  • Implement support for code, file-search, and function subcommands.
  • Update project documentation to include new features and usage instructions.
@divanvisagie divanvisagie added enhancement New feature or request help wanted Extra attention is needed labels Jun 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant