-
Notifications
You must be signed in to change notification settings - Fork 2k
chore(doc): Fix example typo in 9.2 Basic Execution #995
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
Message Ids dont match in the example
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.
Summary of Changes
Hello @spricet, 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 addresses a minor documentation error by correcting a messageId within a JSON example in the docs/specification.md file. The change ensures the example accurately reflects consistent message IDs, improving the clarity and correctness of the "9.2 Basic Execution" section.
Highlights
- Documentation Fix: Corrected an inconsistent messageId in a JSON example located in docs/specification.md, specifically within the "9.2 Basic Execution" section, to resolve a typo and ensure example accuracy.
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 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
-
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.
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 aims to fix a typo in an example within the specification documentation. However, the change introduces an incorrect behavior in the example by making the request and response messageId
s identical. According to the protocol specification, each message should have a unique messageId
generated by its sender. I've added a comment to correct this.
@@ -1315,7 +1315,7 @@ _If the task were longer-running, the server might initially respond with `statu | |||
"jsonrpc": "2.0", | |||
"id": 1, | |||
"result": { | |||
"messageId": "363422be-b0f9-4692-a24d-278670e7c7f1", | |||
"messageId": "9229e770-767c-417b-a0b0-f0741243c589", |
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.
This change makes the messageId
in the agent's response identical to the user's request messageId
. This is incorrect according to the protocol specification.
The Message
object's messageId
field should be a unique identifier generated by the sender. In this scenario, the agent is the sender of the response message and should therefore generate its own unique messageId
.
The previous value (363422be-b0f9-4692-a24d-278670e7c7f1
) correctly demonstrated this behavior by being different from the request's ID. Using the same ID is misleading for developers implementing the protocol. Please use a different UUID for the response.
"messageId": "9229e770-767c-417b-a0b0-f0741243c589", | |
"messageId": "363422be-b0f9-4692-a24d-278670e7c7f1", |
good to know! thanks! |
The previous example is then confusing. It uses the message Id provided by the user |
@spricet The previous example responds with a Task which contains a history of messages sent by the user. In this case the messageId should match the one sent by the user because it is a copy of that same message. |
Message Ids dont match in the example
Description
Message Ids dont match in the example. Just a small typo.
CONTRIBUTING
Guide.nox -s format
from the repository root to format)Fixes #994 🦕