Skip to content

Document and code comment are inconsistent for is_final_response() usage #4016

@tosi29

Description

@tosi29

Describe the bug

According to document,

Use is_final_response(): Rely on this helper method in your application/UI layer to identify complete, user-facing text responses. Avoid manually replicating its logic.

The document recommends to use is_final_response() method.

However, according to comment,

NOTE: This method is ONLY for use by Agent Development Kit.

This implies the method is internal and should not be used by application developers.

It looks inconsistent.
It is unclear whether this method is intended to be a public API for developers or strictly for internal use within the ADK.

To Reproduce
N/A

Expected behavior
Please clarify the intended usage of is_final_response().
If it is for public use (as per docs), the code comment "ONLY for use by Agent Development Kit" should be removed or rephrased.

Screenshots
N/A

Desktop (please complete the following information):
N/A

Model Information:
N/A

Additional context
N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation[Component] This issue is related to documentation, it will be transferred to adk-docs

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions