Skip to content

Python: Make response overview examples runnable #9617

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.

Sign up for GitHub

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

Open
BlueRaddish wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Python: Make response overview examples runnable #9617

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions python/packages/core/agent_framework/_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3084,7 +3084,7 @@ class ChatResponse(SerializationMixin, Generic[ResponseModelT]):
Examples:
.. code-block:: python

from agent_framework import ChatResponse, Message
from agent_framework import ChatResponse, ChatResponseUpdate, Content, Message

# Create a response with messages
msg = Message("assistant", ["The weather is sunny."])
Expand All @@ -3096,7 +3096,14 @@ class ChatResponse(SerializationMixin, Generic[ResponseModelT]):
print(response.text) # "The weather is sunny."

# Combine streaming updates
updates = [...] # List of ChatResponseUpdate objects
updates = [
ChatResponseUpdate(
contents=[Content.from_text("The weather is sunny.")],
role="assistant",
finish_reason="stop",
model="gpt-4",
)
]
response = ChatResponse.from_updates(updates)

# Serialization - to_dict and from_dict
Expand Down Expand Up @@ -3572,7 +3579,7 @@ class AgentResponse(SerializationMixin, Generic[ResponseModelT]):
Examples:
.. code-block:: python

from agent_framework import AgentResponse, Message
from agent_framework import AgentResponse, AgentResponseUpdate, Content, Message

# Create agent response
msg = Message("assistant", ["Task completed successfully."])
Expand All @@ -3584,7 +3591,13 @@ class AgentResponse(SerializationMixin, Generic[ResponseModelT]):
print(len(user_requests)) # 0

# Combine streaming updates
updates = [...] # List of AgentResponseUpdate objects
updates = [
AgentResponseUpdate(
contents=[Content.from_text("Task completed successfully.")],
role="assistant",
response_id="run_123",
)
]
response = AgentResponse.from_updates(updates)

# Serialization - to_dict and from_dict
Expand Down
Loading