TypeError: __init__() got an unexpected keyword argument 'annotations'

[Ethan-han921]

When I try to run ChatDev with the following command:

python3 run.py --task "[make a simple Snake Game game]" --name "[Snake_Game]"

I get this error:

Traceback (most recent call last):

  ...
TypeError: __init__() got an unexpected keyword argument 'annotations'

After this, the execution stops with:

tenacity.RetryError: RetryError[<Future at ... state=finished raised TypeError>]

[NA-Wen]

Can you provide more details about the traceback ? You can paste the full error information here.

[netzulo]

got the "same" error but with a personal prompt, the problem is about new versions of chatgpt library, they add annotations field to chats

I bypassed the error with this little change @NA-Wen at file ChatDev/camel/agents/chat_agent.py

- meta_dict=dict(), **dict(choice.message))
+ meta_dict=dict(), **{k: v for k, v in dict(choice.message).items() if k != 'annotations'})

output (not completed, just lose some lanes in vscode terminal, so long...) i let you traces when got the "error output"

**ChatDev Starts** (20251026150040)

**Timestamp**: 20251026150040

**config_path**: /home/ntz/development/github/ChatDev/CompanyConfig/Netzulo/ChatChainConfig.json

**config_phase_path**: /home/ntz/development/github/ChatDev/CompanyConfig/Netzulo/PhaseConfig.json

**config_role_path**: /home/ntz/development/github/ChatDev/CompanyConfig/Netzulo/RoleConfig.json

**task_prompt**: Create a browser-based multiplayer strategy game similar to Travian. The game should be set in classical antiquity where players start with a small undeveloped village and must build and expand their realm. Include three playable tribes: Romans (strong but expensive troops, can upgrade buildings and resource fields simultaneously), Gauls (fast defensive troops and merchants), and Teutons (aggressive playstyle with cheap troops). Players should manage four resources: wood, clay, iron, and crop. The village should have 18 resource fields surrounding a village center with 22 building slots. Include buildings like main building, warehouses, granaries, barracks, stable, marketplace, academy, and walls. Players should be able to train different military units (infantry, cavalry, siege engines), attack and defend villages, raid for resources, and trade with other players. Include a hero system where heroes gain experience and can equip items. Add alliance system for cooperation between players. The game should be real-time with persistent gameplay where actions continue even when players are offline.

**project_name**: Travian-Clone-Game-Development

**Log File**: /home/ntz/development/github/ChatDev/WareHouse/Travian-Clone-Game-Development_Notvian-Travian_20251026150040.log

**ChatDevConfig**:
ChatEnvConfig.with_memory: False
ChatEnvConfig.clear_structure: True
ChatEnvConfig.git_management: False
ChatEnvConfig.gui_design: True
ChatEnvConfig.incremental_develop: False
ChatEnvConfig.background_prompt: ChatDev is a software company powered by multiple intelligent agents, such as chief executive officer, chief human resources officer, chief product officer, chief technology officer, etc, with a multi-agent organizational structure and the mission of 'changing the digital world through programming'.


**ChatGPTConfig**:
ChatGPTConfig(temperature=0.2, top_p=1.0, n=1, stream=False, stop=None, max_tokens=None, presence_penalty=0.0, frequency_penalty=0.0, logit_bias={}, user='')



System: **[chatting]**

| Parameter | Value |
| --- | --- |
| **task_prompt** | Create a browser-based multiplayer strategy game similar to Travian. The game should be set in classical antiquity where players start with a small undeveloped village and must build and expand their realm. Include three playable tribes: Romans (strong but expensive troops, can upgrade buildings and resource fields simultaneously), Gauls (fast defensive troops and merchants), and Teutons (aggressive playstyle with cheap troops). Players should manage four resources: wood, clay, iron, and crop. The village should have 18 resource fields surrounding a village center with 22 building slots. Include buildings like main building, warehouses, granaries, barracks, stable, marketplace, academy, and walls. Players should be able to train different military units (infantry, cavalry, siege engines), attack and defend villages, raid for resources, and trade with other players. Include a hero system where heroes gain experience and can equip items. Add alliance system for cooperation between players. The game should be real-time with persistent gameplay where actions continue even when players are offline. |
| **need_reflect** | True |
| **assistant_role_name** | Chief Product Officer |
| **user_role_name** | Chief Executive Officer |
| **phase_prompt** | ChatDev has made products in the following form before: Image: can present information in line chart, bar chart, flow chart, cloud chart, Gantt chart, etc. Document: can present information via .docx files. PowerPoint: can present information via .pptx files. Excel: can present information via .xlsx files. PDF: can present information via .pdf files. Website: can present personal resume, tutorial, products, or ideas, via .html files. Application: can implement visualized game, software, tool, etc, via python. Dashboard: can display a panel visualizing real-time information. Mind Map: can represent ideas, with related concepts arranged around a core concept. As the {assistant_role}, to satisfy the new user's demand and the product should be realizable, you should keep discussing with me to decide which product modality do we want the product to be? Note that we must ONLY discuss the product modality and do not discuss anything else! Once we all have expressed our opinion(s) and agree with the results of the discussion unanimously, any of us must actively terminate the discussion by replying with only one line, which starts with a single word , followed by our final product modality without any other words, e.g., " PowerPoint". |
| **phase_name** | DemandAnalysis |
| **assistant_role_prompt** | {chatdev_prompt} You are Chief Product Officer. we are both working at ChatDev. We share a common interest in collaborating to successfully complete a task assigned by a new customer. You are responsible for all product-related matters in ChatDev. Usually includes product design, product strategy, product vision, product innovation, project management and product marketing. Here is a new customer's task: {task}. To complete the task, you must write a response that appropriately solves the requested instruction based on your expertise and customer's needs. |
| **user_role_prompt** | {chatdev_prompt} You are Chief Executive Officer. Now, we are both working at ChatDev and we share a common interest in collaborating to successfully complete a task assigned by a new customer. Your main responsibilities include being an active decision-maker on users' demands and other key policy issues, leader, manager, and executor. Your decision-making role involves high-level decisions about policy and strategy; and your communicator role can involve speaking to the organization's management and employees. Here is a new customer's task: {task}. To complete the task, I will give you one or more instructions, and you must help me to write a specific solution that appropriately solves the requested instruction based on your expertise and my needs. |
| **chat_turn_limit** | 10 |
| **placeholders** | {} |
| **memory** | No existed memory |
| **model_type** | ModelType.GPT_4O_MINI |

System: **[RolePlaying]**

| Parameter | Value |
| --- | --- |
| **assistant_role_name** | Chief Product Officer |
| **user_role_name** | Chief Executive Officer |
| **assistant_role_prompt** | {chatdev_prompt} You are Chief Product Officer. we are both working at ChatDev. We share a common interest in collaborating to successfully complete a task assigned by a new customer. You are responsible for all product-related matters in ChatDev. Usually includes product design, product strategy, product vision, product innovation, project management and product marketing. Here is a new customer's task: {task}. To complete the task, you must write a response that appropriately solves the requested instruction based on your expertise and customer's needs. |
| **user_role_prompt** | {chatdev_prompt} You are Chief Executive Officer. Now, we are both working at ChatDev and we share a common interest in collaborating to successfully complete a task assigned by a new customer. Your main responsibilities include being an active decision-maker on users' demands and other key policy issues, leader, manager, and executor. Your decision-making role involves high-level decisions about policy and strategy; and your communicator role can involve speaking to the organization's management and employees. Here is a new customer's task: {task}. To complete the task, I will give you one or more instructions, and you must help me to write a specific solution that appropriately solves the requested instruction based on your expertise and my needs. |
| **task_prompt** | Create a browser-based multiplayer strategy game similar to Travian. The game should be set in classical antiquity where players start with a small undeveloped village and must build and expand their realm. Include three playable tribes: Romans (strong but expensive troops, can upgrade buildings and resource fields simultaneously), Gauls (fast defensive troops and merchants), and Teutons (aggressive playstyle with cheap troops). Players should manage four resources: wood, clay, iron, and crop. The village should have 18 resource fields surrounding a village center with 22 building slots. Include buildings like main building, warehouses, granaries, barracks, stable, marketplace, academy, and walls. Players should be able to train different military units (infantry, cavalry, siege engines), attack and defend villages, raid for resources, and trade with other players. Include a hero system where heroes gain experience and can equip items. Add alliance system for cooperation between players. The game should be real-time with persistent gameplay where actions continue even when players are offline. |
| **with_task_specify** | False |
| **memory** | No existed memory |
| **model_type** | ModelType.GPT_4O_MINI |
| **background_prompt** | ChatDev is a software company powered by multiple intelligent agents, such as chief executive officer, chief human resources officer, chief product officer, chief technology officer, etc, with a multi-agent organizational structure and the mission of 'changing the digital world through programming'. |

Chief Executive Officer: **[Start Chat]**

[ChatDev is a software company powered by multiple intelligent agents, such as chief executive officer, chief human resources officer, chief product officer, chief technology officer, etc, with a multi-agent organizational structure and the mission of 'changing the digital world through programming'.
You are Chief Product Officer. we are both working at ChatDev. We share a common interest in collaborating to successfully complete a task assigned by a new customer.
You are responsible for all product-related matters in ChatDev. Usually includes product design, product strategy, product vision, product innovation, project management and product marketing.
Here is a new customer's task: Create a browser-based multiplayer strategy game similar to Travian. The game should be set in classical antiquity where players start with a small undeveloped village and must build and expand their realm. Include three playable tribes: Romans (strong but expensive troops, can upgrade buildings and resource fields simultaneously), Gauls (fast defensive troops and merchants), and Teutons (aggressive playstyle with cheap troops). Players should manage four resources: wood, clay, iron, and crop. The village should have 18 resource fields surrounding a village center with 22 building slots. Include buildings like main building, warehouses, granaries, barracks, stable, marketplace, academy, and walls. Players should be able to train different military units (infantry, cavalry, siege engines), attack and defend villages, raid for resources, and trade with other players. Include a hero system where heroes gain experience and can equip items. Add alliance system for cooperation between players. The game should be real-time with persistent gameplay where actions continue even when players are offline..
To complete the task, you must write a response that appropriately solves the requested instruction based on your expertise and customer's needs.]

ChatDev has made products in the following form before:

Image: can present information in line chart, bar chart, flow chart, cloud chart, Gantt chart, etc.

Document: can present information via .docx files.

PowerPoint: can present information via .pptx files.

Excel: can present information via .xlsx files.

PDF: can present information via .pdf files.

Website: can present personal resume, tutorial, products, or ideas, via .html files.

Application: can implement visualized game, software, tool, etc, via python.

Dashboard: can display a panel visualizing real-time information.

Mind Map: can represent ideas, with related concepts arranged around a core concept.

As the Chief Product Officer, to satisfy the new user's demand and the product should be realizable, you should keep discussing with me to decide which product modality do we want the product to be?

Note that we must ONLY discuss the product modality and do not discuss anything else! Once we all have expressed our opinion(s) and agree with the results of the discussion unanimously, any of us must actively terminate the discussion by replying with only one line, which starts with a single word <INFO>, followed by our final product modality without any other words, e.g., "<INFO> PowerPoint".

**[OpenAI_Usage_Info Receive]**
prompt_tokens: 625
completion_tokens: 70
total_tokens: 695
cost: $0.000136


**[OpenAI_Usage_Info Receive]**
prompt_tokens: 889
completion_tokens: 59
total_tokens: 948
cost: $0.000169


**[OpenAI_Usage_Info Receive]**
prompt_tokens: 1153
completion_tokens: 50
total_tokens: 1203
cost: $0.000203


**[OpenAI_Usage_Info Receive]**
prompt_tokens: 1417
completion_tokens: 49
total_tokens: 1466
cost: $0.000242


**[OpenAI_Usage_Info Receive]**
prompt_tokens: 1681
completion_tokens: 55
total_tokens: 1736
cost: $0.000285


Traceback (most recent call last):
  File "/home/ntz/development/github/ChatDev/ChatDev_env/lib/python3.9/site-packages/tenacity/__init__.py", line 382, in __call__
    result = fn(*args, **kwargs)
  File "/home/ntz/development/github/ChatDev/camel/utils.py", line 160, in wrapper
    return func(self, *args, **kwargs)
  File "/home/ntz/development/github/ChatDev/camel/agents/chat_agent.py", line 243, in step
    output_messages = [
  File "/home/ntz/development/github/ChatDev/camel/agents/chat_agent.py", line 244, in <listcomp>
    ChatMessage(role_name=self.role_name, role_type=self.role_type,
TypeError: __init__() got an unexpected keyword argument 'annotations'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/ntz/development/github/ChatDev/run.py", line 136, in <module>
    chat_chain.execute_chain()
  File "/home/ntz/development/github/ChatDev/chatdev/chat_chain.py", line 168, in execute_chain
    self.execute_step(phase_item)
  File "/home/ntz/development/github/ChatDev/chatdev/chat_chain.py", line 138, in execute_step
    self.chat_env = self.phases[phase].execute(self.chat_env,
  File "/home/ntz/development/github/ChatDev/chatdev/phase.py", line 295, in execute
    self.chatting(chat_env=chat_env,
  File "/home/ntz/development/github/ChatDev/chatdev/utils.py", line 79, in wrapper
    return func(*args, **kwargs)
  File "/home/ntz/development/github/ChatDev/chatdev/phase.py", line 133, in chatting
    assistant_response, user_response = role_play_session.step(input_user_msg, chat_turn_limit == 1)
  File "/home/ntz/development/github/ChatDev/camel/agents/role_playing.py", line 247, in step
    assistant_response = self.assistant_agent.step(user_msg_rst)
  File "/home/ntz/development/github/ChatDev/ChatDev_env/lib/python3.9/site-packages/tenacity/__init__.py", line 289, in wrapped_f
    return self(f, *args, **kw)
  File "/home/ntz/development/github/ChatDev/ChatDev_env/lib/python3.9/site-packages/tenacity/__init__.py", line 379, in __call__
    do = self.iter(retry_state=retry_state)
  File "/home/ntz/development/github/ChatDev/ChatDev_env/lib/python3.9/site-packages/tenacity/__init__.py", line 326, in iter
    raise retry_exc from fut.exception()
tenacity.RetryError: RetryError[<Future at 0x7c0b004cefa0 state=finished raised TypeError>]

[NA-Wen]

Good catch and Thanks for the investigation from @netzulo! The error indeed comes from a mismatch between the latest OpenAI SDK and ChatDev’s internal ChatMessage class.

As a quick fix, you can simply filter out the annotations parameter when initializing ChatMessage like in @netzulo 's response.

[netzulo]

i can make a PR if you want it @NA-Wen but i think this error deserve a better fix with a real investigation