-
Notifications
You must be signed in to change notification settings - Fork 634
feat(go): improved tool interrupts API to be more ergonomic #4112
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @apascal07, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on refining the Go API for tool interrupts, making it more intuitive and robust for developers. It introduces a generic tool definition, provides type-safe utilities for managing tool execution flow after interruptions, and standardizes internal data conversions. These changes aim to streamline the development of applications that require interactive or conditional tool execution within generative AI workflows. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a significant and well-executed improvement to the tool interrupts API, making it more ergonomic and type-safe. The changes include a major refactoring of the tool definition, the addition of several convenient helper functions, comprehensive new tests, and a new sample to demonstrate the feature. Overall, the code quality is high. I've identified a couple of minor issues related to API design that could lead to inconsistencies or potential runtime errors, and I've provided suggestions to address them.
This PR introduces a new strongly-typed API for tool interrupts in Genkit Go, enabling human-in-the-loop workflows with better type safety and ergonomics.
New APIs
Triggering Interrupts
ai.InterruptWith[T](ctx, meta)- Interrupt tool execution with typed metadata:Handling Interrupts
ai.InterruptAs[T](part)- Extract typed metadata from an interrupt:Resuming Interrupted Tools
Given a tool defined as:
ai.ToolDef[In, Out].RestartWith(part, opts...)- Re-execute tool with optional modifications:ai.ToolDef[In, Out].RespondWith(part, output, opts...)- Provide output directly without re-running:Tool Context Helpers
ai.ToolContext.IsResumed()- Check if tool is being restarted after interrupt:ai.OriginalInputAs[T](ctx)- Access original input whenWithReplaceInputwas used:Deprecated APIs
tool.Respond(part, output, opts)tool.RespondWith(part, output, opts...)tool.Restart(part, opts)tool.RestartWith(part, opts...)Key Improvements
RestartWith/RespondWithreturn errors instead of silently returning nil on invalid inputWithNewInput[In]andWithResumedMetadata[In]provide a cleaner API than struct-based optionsSample
See
samples/intermediate-interrupts/for a complete example demonstrating a payment agent with:WithNewInput)RespondWith)Checklist (if applicable):