feat: enhance annotation API to support optional message_id and content fields

[liugddx]

Close #27401

Important

1. Make sure you have read our contribution guidelines
2. Ensure there is an associated issue and you have been assigned to it
3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

Screenshots

Before	After
...	...

Checklist

• This change requires a documentation update, included: Dify Document
• I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
• I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
• I've updated the documentation accordingly.
• I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

[gemini-code-assist]

Summary of Changes

Hello @liugddx, I'm Gemini Code Assist¹! 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 introduces significant enhancements and refactoring to the annotation creation API. The primary goal is to offer greater flexibility in how annotations are submitted, allowing users to link them directly to existing messages via a message_id and providing a content field as an alternative to the traditional answer field. This also involves adjusting the conditional requirements for other fields like question, ultimately improving the usability and robustness of the annotation system.

Highlights

• Enhanced Annotation API: The annotation API now supports optional message_id and content fields, providing more flexibility for creating and updating annotations.
• Flexible Field Requirements: The question field is now only required when message_id is not provided, and either answer or content must be supplied for an annotation.
• API Endpoint Refactoring: The annotation creation endpoint has been refactored, with its logic consolidated and moved to streamline the API structure.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

1. 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. ↩

[Copilot]

Pull Request Overview

This PR enhances the annotation API to make message_id optional and accept either answer or content fields for annotation content. The changes consolidate annotation creation logic by removing the deprecated endpoint in message.py and routing all annotation creation through annotation.py, while adding flexible field handling in the service layer.

Key changes:

• Updated the annotation service to accept content as an alias for answer and made question derivable from messages
• Modified the API endpoint to accept optional message_id and flexible content fields
• Removed duplicate annotation creation endpoint from message.py

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
api/services/annotation_service.py	Enhanced to support optional message_id, flexible answer/content fields, and automatic question derivation from messages
api/controllers/console/app/message.py	Removed deprecated MessageAnnotationApi endpoint and cleaned up unused imports
api/controllers/console/app/annotation.py	Updated to route annotation creation through the enhanced service method with optional fields

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[gemini-code-assist]

Code Review

This pull request refactors the annotation creation API by moving it to its own dedicated file and enhances it to support an optional message_id and a content field as an alias for answer. The changes are well-structured, and the logic in the service layer correctly handles the new optional parameters. I've identified a couple of high-severity issues: a validation regression for message_id and a bug that prevents using empty strings for answers. Addressing these will make the implementation more robust.