Skip to content
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.

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

Python: Improve/Simplify the Assistant Agents #10666

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

moonbox3
Copy link
Contributor

@moonbox3 moonbox3 commented Feb 25, 2025

Motivation and Context

The current abstractions we have around the Semantic Kernel Assistant Agents are considered to be "fully-wrapped." This is beneficial in that SK provides a tight/complete abstraction over the agent; however, it doesn't scale well when new features are added to the underlying APIs (OpenAI) - it requires updates from SK to make each and every update. It also adds a lot more complexity in terms of needing to handle everything in SK, requires more code coverage, and chances for bugs to surface due to these complexities.

NOTE: this update is breaking. We're moving to simplify the abstractions/APIs before we move Assistant Agents from experimental to GA.

Similar to how the AzureAIAgent was created, we're moving to a "less-wrapped" abstraction around the OpenAI Assistant v2 APIs. We do have some "convenience methods" on the Agents, via class methods, to configure things like the code interpreter tool and resource, file search tool and resource, the clients required to interact with the Assistants, as well as being able to easily configure structured outputs, similar to how it is done with a ChatCompletion (either provide the Pydantic model or the Python class).

To work with Assistant Agents now, it's as simple as:

from semantic_kernel.agents.open_ai import AzureAssistantAgent
from semantic_kernel.functions import kernel_function

class MenuPlugin:
   # Plugin code here using the @kernel_function decorator

# Create the client using Azure OpenAI resources and configuration
client, model = AzureAssistantAgent.setup_resources()

# Create the assistant definition
definition = await client.beta.assistants.create(
    model=model,
    instructions="Answer questions about the menu.",
    name="Host",
)

agent = AzureAssistantAgent(
    client=client,
    definition=definition,
    plugins=[MenuPlugin()],  # The plugins can be passed in as a list to the constructor
)

# Note: plugins can also be configured on the Kernel and passed in as a parameter to the OpenAIAssistantAgent

# Define a thread and invoke the agent with the user input
thread = await agent.client.beta.threads.create()

I will create a migration guide (issue) showing what needs to be updated from the previous usage to this new pattern.

Description

This PR provides the new abstractions for the AzureAssistantAgent/OpenAIAssistantAgent classes.

Samples will be updated accordingly to show new patterns.

Contribution Checklist

@moonbox3 moonbox3 added python Pull requests for the Python Semantic Kernel PR: breaking change Pull requests that introduce breaking changes experimental Associated with an experimental feature agents labels Feb 25, 2025
@moonbox3 moonbox3 self-assigned this Feb 25, 2025
@moonbox3 moonbox3 requested a review from a team as a code owner February 25, 2025 02:08
@moonbox3 moonbox3 requested a review from Copilot February 25, 2025 02:09
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 58 out of 58 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

python/samples/concepts/agents/assistant_agent/assistant_agent_streaming.py:54

  • The 'MenuPlugin' is referenced but not defined or imported; please ensure it is properly defined or imported in this file.
plugins=[MenuPlugin()]

if self.plugins:
for plugin in self.plugins:
name = self._get_plugin_name(plugin)
self.kernel.add_plugin(plugin, plugin_name=name)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to check if a plugin already exists?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to document that if providing plugins via the constructor, they will take precedence over any existing plugins (with the same name) that are contained in the kernel (if passed in).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agents experimental Associated with an experimental feature PR: breaking change Pull requests that introduce breaking changes python Pull requests for the Python Semantic Kernel
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Python: Simplify the AzureAssistantAgent/OpenAIAssistantAgent
2 participants