feat: Support need_play_prologue and prologue_content in ChatUpdateEventData

[ranlychan]

Add support to the following params in streaming chat event update data, changes have been verified to be valid:

• data.need_play_prologue
• data.prologue_content

Reference doc: https://www.coze.cn/open/docs/developer_guides/streaming_chat_event

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Walkthrough

Two new fields, needPlayPrologue (Boolean) and prologueContent (String), were added to the ChatUpdateEventData class. Both fields are annotated for JSON serialization, enabling the model to represent whether a prologue should be played and its content.

Changes

File(s)	Change Summary
api/src/main/java/com/coze/openapi/client/websocket/event/model/ChatUpdateEventData.java	Added needPlayPrologue (Boolean) and prologueContent (String) fields with JSON annotations

Poem

In the chat, a prologue may now appear,
With fields so new, intentions are clear.
Should we play it? The flag will say—
And content awaits to brighten the way.
A hop, a skip, new stories begin,
With rabbits and code, let updates hop in!

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

api/src/main/java/com/coze/openapi/client/websocket/event/model/ChatUpdateEventData.java (1)

28-32: Consider using the primitive boolean instead of Boolean unless null carries semantics

If needPlayPrologue can only be true or false, switching to the primitive avoids boxing overhead and eliminates the potential NullPointerException risk when the field is accessed before deserialization populates it.

-  private Boolean needPlayPrologue;
+  private boolean needPlayPrologue;

Keep it as Boolean only if the tri-state (true / false / null) is required to distinguish “unset” from explicit values.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b243e69 and 9559f6a.

📒 Files selected for processing (1)

• api/src/main/java/com/coze/openapi/client/websocket/event/model/ChatUpdateEventData.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: test (Java 8 on macOS)
• GitHub Check: test (Java 17 on macOS)
• GitHub Check: test (Java 11 on macOS)
• GitHub Check: test (Java 17 on Windows)
• GitHub Check: test (Java 11 on Windows)
• GitHub Check: test (Java 17 on Ubuntu)
• GitHub Check: test (Java 11 on Ubuntu)