-
Notifications
You must be signed in to change notification settings - Fork 8
添加智能体提示词替换说明文档 #46
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?
添加智能体提示词替换说明文档 #46
Conversation
Summary of ChangesHello @wtqn0206, 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! 此拉取请求的主要目的是通过添加关于智能体提示词替换功能的详细文档,来增强现有 WebSocket 协议的说明。这有助于开发者理解如何利用 Highlights
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
本次 PR 添加了关于智能体提示词替换功能的说明文档。整体内容清晰,但存在一些可以改进的地方以提高文档的准确性和可读性。主要问题包括:新功能的标题和描述存在误导性,参数规则的描述不够精确,以及示例代码中包含了不应出现的字段。我已经针对这些问题提出了具体的修改建议。
docs/xrobot/platform/websocket.md
Outdated
| ##### 5. 智能体提示词替换 消息 | ||
| 用于设备端向服务器告知检测到唤醒词。 |
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.
此处的标题和描述存在误导性。标题“5. 智能体提示词替换 消息”暗示这是一个新的消息类型,但实际上它是对 hello 消息的扩展。同时,描述“用于设备端向服务器告知检测到唤醒词”是错误的,似乎是从上一节复制而来。建议修改标题和描述,以准确说明该功能是通过 hello 消息传递参数来替换提示词中的占位符。
| ##### 5. 智能体提示词替换 消息 | |
| 用于设备端向服务器告知检测到唤醒词。 | |
| ##### 5. Hello 消息扩展:智能体提示词替换 | |
| 此功能通过在 `hello` 消息中添加 `agent_params` 字段,允许设备端在建立连接时传递动态参数,用于替换智能体系统提示词中的占位符。 |
docs/xrobot/platform/websocket.md
Outdated
| ##### 5. 智能体提示词替换 消息 | ||
| 用于设备端向服务器告知检测到唤醒词。 | ||
| ###### 参数规则: | ||
| - key: 只能英文(小写)、并且是 snake_case 的命名风格,不能出现数字和非英文的字符,最长50字符,超过50将丢弃当前参数 |
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.
|
/review |
|
/review |
|
/review |
Review SummaryClear usage example, but missing critical documentation: Critical Issues:
Impact: Implementations risk resource exhaustion and security vulnerabilities. Add constraint specifications and security requirements before merge. |
增加 智能体提示词替换说明文档