Semantic Kernel HandsOff orchestration

[Timsal123]

I have created two files test.py and ai_agents.py
i have invoke orchestration logic in test.py like below
if parsed_response["proceed"]=="true":
agents, handoffs = get_agents(kernel)
handoff_orchestration = HandoffOrchestration(
members=agents,
handoffs=handoffs,
agent_response_callback=agent_response_callback
)
orchestration_input = ChatMessageContent(
role=AuthorRole.USER,
content=f"""{json.dumps(parsed_response["category"])} """)
runtime = InProcessRuntime()
runtime.start()
print(handoff_orchestration) //Code works correctly till here
orchestration_result = await handoff_orchestration.invoke(orchestration_input,runtime=runtime)
value = await orchestration_result.get()
print(value)
await runtime.stop_when_idle()
return {"status": "success", "result": value}

ai_agents.py file
from semantic_kernel.functions import kernel_function
from semantic_kernel import Kernel
from semantic_kernel.agents import Agent, ChatCompletionAgent, HandoffOrchestration, OrchestrationHandoffs
from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion,AzureChatCompletion
from semantic_kernel.contents import AuthorRole, ChatMessageContent
from config.logs import AzureMonitorConfig
class CreditCardPlugin:
@kernel_function(name="block_credit_card", description="Block a credit card")
async def block_credit_card(card_details: str = "") -> str:
print(f" Blocking credit card: {card_details}")
return f"Credit card has been blocked successfully. Details: {card_details}"

@kernel_function(name="unblock_credit_card", description="Unblock a credit card")
async def unblock_credit_card(self,card_details: str = "") -> str:
    print(f" Unblocking credit card:{card_details}")
    return f" Credit card has been unblocked successfully. Details:"

class CustomerServiceAgent:

@kernel_function(name="update_customer_info", description="Update customer information")

async def update_customer_info(self, update_details: str = "") -> str:

print(f"Updating customer info: {update_details}")

return f" Your customer information has been updated successfully. Details: {update_details}"

class RefundPlugin:
@kernel_function(name="process_refund", description="Process a refund request")
async def process_refund(self, refund_details: str = "") -> str:
print(f" Processing refund: {refund_details}")
return f" Your refund request has been processed successfully. Details: {refund_details}"

def get_agents(kernel:Kernel) -> tuple[list[Agent], OrchestrationHandoffs]:
"""Return a list of agents that will participate in the Handoff orchestration and the handoff relationships.

Feel free to add or remove agents and handoff connections.
"""


support_agent = ChatCompletionAgent(
    kernel=kernel,
    name="CustomerSupportAgent",
    description="A customer support agent that answers issues.",
    instructions="Handle customer requests."
)

refund_agent = ChatCompletionAgent(
    kernel=kernel,
    name="RefundAgent",
    description="A customer support agent that handles refunds.",
    instructions="Handle refund requests.",
    plugins=[RefundPlugin()]    
)

credit_card_agent = ChatCompletionAgent(
    kernel=kernel,
    name="CreditCardAgent",
    description="A customer support agent that blocks/unblocks credit cards.",
    instructions="Handle card block/unlock requests.",
    plugins=[CreditCardPlugin()]
)

# Define the handoff relationships between agents
handoffs = (
    OrchestrationHandoffs()
    .add_many(
        source_agent=support_agent.name,
        target_agents={
            refund_agent.name: "Transfer to this agent if the issue is refund related",
            credit_card_agent.name: "Transfer to this agent if the issue is credit card block/unblock related related"
        },
    )
    .add(
        source_agent=refund_agent.name,
        target_agent=support_agent.name,
        description="Transfer to this agent if the issue is not refund related",
    )
    .add(
        source_agent=credit_card_agent.name,
        target_agent=support_agent.name,
        description="Transfer to this agent if the issue is not credit card related",
    )
)
return [support_agent, refund_agent, credit_card_agent], handoffs

def agent_response_callback(message: ChatMessageContent) -> None:
"""Observer function to print the messages from the agents."""
print(f"{message.name}: {message.content}")
return f"{message.name}: {message.content}"

It was working fine but after sometime it started giving error like
lambda agent=agent, handoff_connections=handoff_connections: HandoffAgentActor( # type: ignore[misc]
_deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
rv = reductor(4)
^^^^^^^^^^^
TypeError: cannot pickle '_thread.RLock' object

This error is constantly coming and is it a bug in latest semantic kernel version?
I am working with latest 1.33.0 version of semantic kernel , Please provide some inputs or if any package is missing?

[TaoChenOSU]

Hi!

Could you provide the full stack trace?

It'd also be nice if you can reformat your question so that the code is easier to read.

Usually, when you see the TypeError: cannot pickle '_thread.RLock' object error, it means some object is not serializable. We can assist you further if you provide the full stack trace.

[Timsal123]

Yeah Sure,
Issue : while trying to implement handOffs orchestartion using semantic kernel in python it worked fine for some time , correctly orchestration between agents but later i started getting error like the trace below. I have made no change to the code but getting similar error , so i tried again with a different file and implemented same approach again it also worked fine for some time and later again started giving similar issue as mentioned below , not able to understand where exactly serializatiom issue is occuring. error start coming when i invoke the orchestration.
Traceback (most recent call last):
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\opentelemetry\trace_init_.py", line 589, in use_span
yield span
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\opentelemetry\sdk\trace_init_.py", line 1105, in start_as_current_span
yield span
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\runtime\core\telemetry\tracing.py", line 102, in trace_block
yield span
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\runtime\in_process\in_process_runtime.py", line 262, in send_message
return await future
^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\runtime\in_process\in_process_runtime.py", line 366, in _process_send
recipient_agent = await self._get_agent(recipient)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\runtime\in_process\in_process_runtime.py", line 803, in _get_agent
agent = await self._invoke_agent_factory(agent_factory, agent_id)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\runtime\in_process\in_process_runtime.py", line 781, in _invoke_agent_factory
return cast(T, await agent)
^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\runtime\in_process\in_process_runtime.py", line 744, in factory_wrapper
maybe_agent_instance = agent_factory()
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\orchestration\handoffs.py", line 486, in
lambda agent=agent, handoff_connections=handoff_connections: HandoffAgentActor( # type: ignore[misc]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\agents\orchestration\handoffs.py", line 174, in init
self._kernel = agent.kernel.clone()
^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\semantic_kernel\kernel.py", line 541, in clone
plugins=deepcopy(self.plugins),
^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 231, in _deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 153, in deepcopy
y = copier(memo)
^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\pydantic\main.py", line 777, in deepcopy
_object_setattr(m, 'dict', deepcopy(self.dict, memo=memo))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 231, in _deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 231, in _deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 153, in deepcopy
y = copier(memo)
^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\site-packages\pydantic\main.py", line 777, in deepcopy
_object_setattr(m, 'dict', deepcopy(self.dict, memo=memo))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 231, in _deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 172, in deepcopy
y = _reconstruct(x, memo, *rv)
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 271, in _reconstruct
state = deepcopy(state, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 231, in _deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 172, in deepcopy
y = _reconstruct(x, memo, *rv)
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 271, in _reconstruct
state = deepcopy(state, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 211, in _deepcopy_tuple
y = [deepcopy(a, memo) for a in x]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 211, in
y = [deepcopy(a, memo) for a in x]
^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 231, in _deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 172, in deepcopy
y = _reconstruct(x, memo, *rv)
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 271, in _reconstruct
state = deepcopy(state, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 146, in deepcopy
y = copier(x, memo)
^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 231, in _deepcopy_dict
y[deepcopy(key, memo)] = deepcopy(value, memo)
^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\TIMSALRIZVI\AppData\Local\Programs\Python\Python311\Lib\copy.py", line 161, in deepcopy
rv = reductor(4)
^^^^^^^^^^^
TypeError: cannot pickle '_thread.RLock' object
main_1.txt
ai_agents_1.txt