docs(discoveryengine): Add Cancel Operation Sample #13330
Conversation
There was a problem hiding this comment.
Hello @holtskinner, 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!
Summary of Changes
This pull request adds a new sample, cancel_operation_sample.py, to the Discovery Engine documentation. This sample demonstrates how to cancel a long-running operation using the Discovery Engine API. The pull request also includes an update to operations_sample_test.py to include a test case for the new sample, and updates the requirements.txt file to use a newer version of the google-cloud-discoveryengine package.
Highlights
- New Sample: Adds a new sample,
cancel_operation_sample.py, demonstrating how to cancel a long-running operation. - Test Case: Includes a test case for the new sample in
operations_sample_test.py. - Dependency Update: Updates the
google-cloud-discoveryenginedependency inrequirements.txtfrom version 0.13.4 to 0.13.8.
Changelog
- discoveryengine/cancel_operation_sample.py
- Added a new sample demonstrating how to cancel a long-running operation using the Discovery Engine API.
- The sample defines a function
cancel_operation_samplethat takes the operation name as input and cancels the operation.
- discoveryengine/operations_sample_test.py
- Added a test case for the
cancel_operation_samplefunction. - The test case attempts to cancel an operation and catches a
NotFoundexception if the operation does not exist.
- Added a test case for the
- discoveryengine/requirements.txt
- Updated the
google-cloud-discoveryenginedependency from version 0.13.4 to 0.13.8.
- Updated the
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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.
A task begins to run,
But needs to be undone.
Cancel the request,
Put the process to rest,
No longer 'neath the sun.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request adds a sample for canceling operations in the Discovery Engine. The code includes the sample function and a corresponding test case. Overall, the changes seem reasonable, but there are a few points to consider.
Summary of Findings
- Missing error handling: The
cancel_operation_samplefunction doesn't handle potential exceptions during thecancel_operationcall. It's important to add error handling to ensure the sample is robust. - Incomplete TODO: The TODO comment in
cancel_operation_sample.pyindicates that theoperation_namevariable needs to be uncommented and populated. The test case uses a hardcoded value, but the sample itself relies on user input. It would be better to provide a more complete example or guide the user on how to obtain theoperation_name. - Test case exception handling: The test case uses a broad
except NotFoundblock. It might be beneficial to add more specific exception handling or assertions to ensure the test is verifying the correct behavior.
Merge Readiness
The pull request is not quite ready for merging. The missing error handling in the sample function and the incomplete TODO need to be addressed. Additionally, the test case could benefit from more specific exception handling. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
|
Here is the summary of changes. You are about to add 1 region tag.
This comment is generated by snippet-bot.
|
Description
https://cloud.google.com/generative-ai-app-builder/docs/long-running-operations