Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747)

* [BREAKING] Rename ChatAgent -> Agent, ChatMessage -> Message, ChatClientProtocol -> SupportsChatGetResponse

Simplify the public API by removing redundant 'Chat' prefix from core types:
- ChatAgent -> Agent
- RawChatAgent -> RawAgent
- ChatMessage -> Message
- ChatClientProtocol -> SupportsChatGetResponse

Also renamed internal WorkflowMessage (was Message in _runner_context) to avoid collision.

No backward compatibility aliases - this is a clean breaking change.

* [BREAKING] Rename Agent chat_client parameter to client

* Fix rebase issues: WorkflowMessage references and broken markdown links

* Fix formatting and lint issues from code quality checks

* Fix import ordering in workflow sample files

* fixed rebase

* Fix test failures: use WorkflowMessage and A2AMessage after ChatMessage→Message rename

- Replace Message(data=..., source_id=...) with WorkflowMessage(...) in workflow tests
- Fix isinstance check in A2A agent to use A2AMessage instead of Message
- Fix import in test_workflow_observability.py (Message→WorkflowMessage)

* Fix lint, fmt, and sample errors after ChatMessage→Message rename

- Auto-fix 70+ ruff lint issues across samples (ChatMessage→Message refs)
- Fix HostedVectorStoreContent→Content.from_hosted_vector_store in file search sample
- Fix _normalize_messages→normalize_messages in custom agent sample
- Fix context.terminate→raise MiddlewareTermination in middleware samples
- Fix with_update_hook→with_transform_hook in override middleware sample
- Add TOptions_co import back to custom_chat_client sample
- Add noqa for FastAPI File() default in chatkit sample
- Fix B023 loop variable capture in weather agent sample

* fix: update Agent constructor calls from chat_client to client in declaration-only tool tests

* fix: add register_cleanup to devui lazy-loading proxy and type stub

* fixed tests and updated new pieces

* fix agui typevar

* fix merge errors

* fix merge conflicts

* fiux merge

* Remove unused links

---------

Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
This commit is contained in:
Eduard van Valkenburg
2026-02-11 00:04:32 +01:00
committed by GitHub
Unverified
parent a4c9e43afb
commit 0521f5bed8
418 changed files with 5385 additions and 5389 deletions
@@ -76,7 +76,7 @@ export function RunWorkflowButton({
// Analyze input requirements
const inputAnalysis = useMemo(() => {
// Check if this is a ChatMessage schema (for AgentExecutor workflows)
// Check if this is a Message schema (for AgentExecutor workflows)
const isChatMessage = isChatMessageSchema(inputSchema);
if (!inputSchema)
@@ -115,7 +115,7 @@ export function getFieldColumnSpan(
}
// ============================================================================
// ChatMessage Pattern Detection (exported for reuse)
// Message Pattern Detection (exported for reuse)
// ============================================================================
export function detectChatMessagePattern(
@@ -436,7 +436,7 @@ export function SchemaFormRenderer({
(name) => !hideFields.includes(name)
);
// Detect ChatMessage pattern
// Detect Message pattern
const isChatMessageLike = detectChatMessagePattern(schema, requiredFields);
// Separate required and optional fields
@@ -449,7 +449,7 @@ export function SchemaFormRenderer({
(name) => !requiredFields.includes(name)
);
// For ChatMessage: prioritize text/message/content
// For Message: prioritize text/message/content
const sortedOptionalFields = isChatMessageLike
? [...optionalFieldNames].sort((a, b) => {
const priority = (name: string) =>
@@ -48,7 +48,7 @@ export function WorkflowInputForm({
const requiredFields = inputSchema.required || [];
const isSimpleInput = inputSchema.type === "string" && !inputSchema.enum;
// Detect ChatMessage-like pattern for auto-filling role
// Detect Message-like pattern for auto-filling role
const isChatMessageLike = detectChatMessagePattern(inputSchema, requiredFields);
// Validation: check if required fields are filled
@@ -82,7 +82,7 @@ export function WorkflowInputForm({
}
});
// Auto-fill role="user" for ChatMessage-like inputs
// Auto-fill role="user" for Message-like inputs
if (isChatMessageLike && !initialData["role"]) {
initialData["role"] = "user";
}
@@ -1340,7 +1340,7 @@ function TraceTreeNode({ node, depth = 0 }: { node: TraceNode; depth?: number })
{/* Operation badge */}
<span className={`text-xs px-1.5 py-0.5 rounded font-medium ${getOperationColor(operationName)}`}>
{operationName.replace("ChatAgent.", "").replace("invoke_agent ", "")}
{operationName.replace("Agent.", "").replace("invoke_agent ", "")}
</span>
{/* Duration */}
@@ -223,7 +223,7 @@ export interface AgentResponseUpdate {
// Agent run response (final)
export interface AgentResponse {
messages: ChatMessage[];
messages: Message[];
response_id?: string;
created_at?: CreatedAtT;
usage_details?: UsageDetails;
@@ -232,7 +232,7 @@ export interface AgentResponse {
}
// Chat message
export interface ChatMessage {
export interface Message {
contents: Content[];
role?: Role;
author_name?: string;
@@ -185,7 +185,7 @@ export interface MetaResponse {
}
// Chat message types matching Agent Framework
export interface ChatMessage {
export interface Message {
id: string;
role: "user" | "assistant" | "system" | "tool";
contents: import("./agent-framework").Content[];
@@ -212,7 +212,7 @@ export interface AppState {
}
export interface ChatState {
messages: ChatMessage[];
messages: Message[];
isStreaming: boolean;
// streamEvents removed - use OpenAI events directly instead
}
@@ -15,8 +15,8 @@ import type { Workflow } from "@/types/workflow";
import { getTypedWorkflow } from "@/types/workflow";
/**
* Detects if a JSON schema represents a ChatMessage input type.
* ChatMessage schemas typically have:
* Detects if a JSON schema represents a Message input type.
* Message schemas typically have:
* - type: "object"
* - properties with "text" (required string) and "role" (optional string)
*
@@ -24,7 +24,7 @@ import { getTypedWorkflow } from "@/types/workflow";
* component for workflows that start with an AgentExecutor.
*
* @param schema - The JSON schema to check
* @returns true if the schema represents a ChatMessage-like input
* @returns true if the schema represents a Message-like input
*/
export function isChatMessageSchema(schema: JSONSchemaProperty | undefined): boolean {
if (!schema) return false;
@@ -37,13 +37,13 @@ export function isChatMessageSchema(schema: JSONSchemaProperty | undefined): boo
const props = schema.properties;
// ChatMessage has "text" property (the main content)
// Message has "text" property (the main content)
const hasText = "text" in props && props.text?.type === "string";
// ChatMessage has "role" property (user, assistant, system)
// Message has "role" property (user, assistant, system)
const hasRole = "role" in props && props.role?.type === "string";
// If it has both text and role, it's likely a ChatMessage
// If it has both text and role, it's likely a Message
if (hasText && hasRole) {
return true;
}