aip-agents-binary 0.5.13__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (279) hide show
  1. aip_agents/__init__.py +65 -0
  2. aip_agents/a2a/__init__.py +19 -0
  3. aip_agents/a2a/server/__init__.py +10 -0
  4. aip_agents/a2a/server/base_executor.py +1086 -0
  5. aip_agents/a2a/server/google_adk_executor.py +198 -0
  6. aip_agents/a2a/server/langflow_executor.py +180 -0
  7. aip_agents/a2a/server/langgraph_executor.py +270 -0
  8. aip_agents/a2a/types.py +232 -0
  9. aip_agents/agent/__init__.py +27 -0
  10. aip_agents/agent/base_agent.py +970 -0
  11. aip_agents/agent/base_langgraph_agent.py +2942 -0
  12. aip_agents/agent/google_adk_agent.py +926 -0
  13. aip_agents/agent/google_adk_constants.py +6 -0
  14. aip_agents/agent/hitl/__init__.py +24 -0
  15. aip_agents/agent/hitl/config.py +28 -0
  16. aip_agents/agent/hitl/langgraph_hitl_mixin.py +515 -0
  17. aip_agents/agent/hitl/manager.py +532 -0
  18. aip_agents/agent/hitl/models.py +18 -0
  19. aip_agents/agent/hitl/prompt/__init__.py +9 -0
  20. aip_agents/agent/hitl/prompt/base.py +42 -0
  21. aip_agents/agent/hitl/prompt/deferred.py +73 -0
  22. aip_agents/agent/hitl/registry.py +149 -0
  23. aip_agents/agent/interface.py +138 -0
  24. aip_agents/agent/interfaces.py +65 -0
  25. aip_agents/agent/langflow_agent.py +464 -0
  26. aip_agents/agent/langgraph_memory_enhancer_agent.py +433 -0
  27. aip_agents/agent/langgraph_react_agent.py +2514 -0
  28. aip_agents/agent/system_instruction_context.py +34 -0
  29. aip_agents/clients/__init__.py +10 -0
  30. aip_agents/clients/langflow/__init__.py +10 -0
  31. aip_agents/clients/langflow/client.py +477 -0
  32. aip_agents/clients/langflow/types.py +18 -0
  33. aip_agents/constants.py +23 -0
  34. aip_agents/credentials/manager.py +132 -0
  35. aip_agents/examples/__init__.py +5 -0
  36. aip_agents/examples/compare_streaming_client.py +783 -0
  37. aip_agents/examples/compare_streaming_server.py +142 -0
  38. aip_agents/examples/demo_memory_recall.py +401 -0
  39. aip_agents/examples/hello_world_a2a_google_adk_client.py +49 -0
  40. aip_agents/examples/hello_world_a2a_google_adk_client_agent.py +48 -0
  41. aip_agents/examples/hello_world_a2a_google_adk_client_streaming.py +60 -0
  42. aip_agents/examples/hello_world_a2a_google_adk_server.py +79 -0
  43. aip_agents/examples/hello_world_a2a_langchain_client.py +39 -0
  44. aip_agents/examples/hello_world_a2a_langchain_client_agent.py +39 -0
  45. aip_agents/examples/hello_world_a2a_langchain_client_lm_invoker.py +37 -0
  46. aip_agents/examples/hello_world_a2a_langchain_client_streaming.py +41 -0
  47. aip_agents/examples/hello_world_a2a_langchain_reference_client_streaming.py +60 -0
  48. aip_agents/examples/hello_world_a2a_langchain_reference_server.py +105 -0
  49. aip_agents/examples/hello_world_a2a_langchain_server.py +79 -0
  50. aip_agents/examples/hello_world_a2a_langchain_server_lm_invoker.py +78 -0
  51. aip_agents/examples/hello_world_a2a_langflow_client.py +83 -0
  52. aip_agents/examples/hello_world_a2a_langflow_server.py +82 -0
  53. aip_agents/examples/hello_world_a2a_langgraph_artifact_client.py +73 -0
  54. aip_agents/examples/hello_world_a2a_langgraph_artifact_client_streaming.py +76 -0
  55. aip_agents/examples/hello_world_a2a_langgraph_artifact_server.py +92 -0
  56. aip_agents/examples/hello_world_a2a_langgraph_client.py +54 -0
  57. aip_agents/examples/hello_world_a2a_langgraph_client_agent.py +54 -0
  58. aip_agents/examples/hello_world_a2a_langgraph_client_agent_lm_invoker.py +32 -0
  59. aip_agents/examples/hello_world_a2a_langgraph_client_streaming.py +50 -0
  60. aip_agents/examples/hello_world_a2a_langgraph_client_streaming_lm_invoker.py +44 -0
  61. aip_agents/examples/hello_world_a2a_langgraph_client_streaming_tool_streaming.py +92 -0
  62. aip_agents/examples/hello_world_a2a_langgraph_server.py +84 -0
  63. aip_agents/examples/hello_world_a2a_langgraph_server_lm_invoker.py +79 -0
  64. aip_agents/examples/hello_world_a2a_langgraph_server_tool_streaming.py +132 -0
  65. aip_agents/examples/hello_world_a2a_mcp_langgraph.py +196 -0
  66. aip_agents/examples/hello_world_a2a_three_level_agent_hierarchy_client.py +244 -0
  67. aip_agents/examples/hello_world_a2a_three_level_agent_hierarchy_server.py +251 -0
  68. aip_agents/examples/hello_world_a2a_with_metadata_langchain_client.py +57 -0
  69. aip_agents/examples/hello_world_a2a_with_metadata_langchain_server_lm_invoker.py +80 -0
  70. aip_agents/examples/hello_world_google_adk.py +41 -0
  71. aip_agents/examples/hello_world_google_adk_mcp_http.py +34 -0
  72. aip_agents/examples/hello_world_google_adk_mcp_http_stream.py +40 -0
  73. aip_agents/examples/hello_world_google_adk_mcp_sse.py +44 -0
  74. aip_agents/examples/hello_world_google_adk_mcp_sse_stream.py +48 -0
  75. aip_agents/examples/hello_world_google_adk_mcp_stdio.py +44 -0
  76. aip_agents/examples/hello_world_google_adk_mcp_stdio_stream.py +48 -0
  77. aip_agents/examples/hello_world_google_adk_stream.py +44 -0
  78. aip_agents/examples/hello_world_langchain.py +28 -0
  79. aip_agents/examples/hello_world_langchain_lm_invoker.py +15 -0
  80. aip_agents/examples/hello_world_langchain_mcp_http.py +34 -0
  81. aip_agents/examples/hello_world_langchain_mcp_http_interactive.py +130 -0
  82. aip_agents/examples/hello_world_langchain_mcp_http_stream.py +42 -0
  83. aip_agents/examples/hello_world_langchain_mcp_multi_server.py +155 -0
  84. aip_agents/examples/hello_world_langchain_mcp_sse.py +34 -0
  85. aip_agents/examples/hello_world_langchain_mcp_sse_stream.py +40 -0
  86. aip_agents/examples/hello_world_langchain_mcp_stdio.py +30 -0
  87. aip_agents/examples/hello_world_langchain_mcp_stdio_stream.py +41 -0
  88. aip_agents/examples/hello_world_langchain_stream.py +36 -0
  89. aip_agents/examples/hello_world_langchain_stream_lm_invoker.py +39 -0
  90. aip_agents/examples/hello_world_langflow_agent.py +163 -0
  91. aip_agents/examples/hello_world_langgraph.py +39 -0
  92. aip_agents/examples/hello_world_langgraph_bosa_twitter.py +41 -0
  93. aip_agents/examples/hello_world_langgraph_mcp_http.py +31 -0
  94. aip_agents/examples/hello_world_langgraph_mcp_http_stream.py +34 -0
  95. aip_agents/examples/hello_world_langgraph_mcp_sse.py +35 -0
  96. aip_agents/examples/hello_world_langgraph_mcp_sse_stream.py +50 -0
  97. aip_agents/examples/hello_world_langgraph_mcp_stdio.py +35 -0
  98. aip_agents/examples/hello_world_langgraph_mcp_stdio_stream.py +50 -0
  99. aip_agents/examples/hello_world_langgraph_stream.py +43 -0
  100. aip_agents/examples/hello_world_langgraph_stream_lm_invoker.py +37 -0
  101. aip_agents/examples/hello_world_model_switch_cli.py +210 -0
  102. aip_agents/examples/hello_world_multi_agent_adk.py +75 -0
  103. aip_agents/examples/hello_world_multi_agent_langchain.py +54 -0
  104. aip_agents/examples/hello_world_multi_agent_langgraph.py +66 -0
  105. aip_agents/examples/hello_world_multi_agent_langgraph_lm_invoker.py +69 -0
  106. aip_agents/examples/hello_world_pii_logger.py +21 -0
  107. aip_agents/examples/hello_world_sentry.py +133 -0
  108. aip_agents/examples/hello_world_step_limits.py +273 -0
  109. aip_agents/examples/hello_world_stock_a2a_server.py +103 -0
  110. aip_agents/examples/hello_world_tool_output_client.py +46 -0
  111. aip_agents/examples/hello_world_tool_output_server.py +114 -0
  112. aip_agents/examples/hitl_demo.py +724 -0
  113. aip_agents/examples/mcp_configs/configs.py +63 -0
  114. aip_agents/examples/mcp_servers/common.py +76 -0
  115. aip_agents/examples/mcp_servers/mcp_name.py +29 -0
  116. aip_agents/examples/mcp_servers/mcp_server_http.py +19 -0
  117. aip_agents/examples/mcp_servers/mcp_server_sse.py +19 -0
  118. aip_agents/examples/mcp_servers/mcp_server_stdio.py +19 -0
  119. aip_agents/examples/mcp_servers/mcp_time.py +10 -0
  120. aip_agents/examples/pii_demo_langgraph_client.py +69 -0
  121. aip_agents/examples/pii_demo_langgraph_server.py +126 -0
  122. aip_agents/examples/pii_demo_multi_agent_client.py +80 -0
  123. aip_agents/examples/pii_demo_multi_agent_server.py +247 -0
  124. aip_agents/examples/todolist_planning_a2a_langchain_client.py +70 -0
  125. aip_agents/examples/todolist_planning_a2a_langgraph_server.py +88 -0
  126. aip_agents/examples/tools/__init__.py +27 -0
  127. aip_agents/examples/tools/adk_arithmetic_tools.py +36 -0
  128. aip_agents/examples/tools/adk_weather_tool.py +60 -0
  129. aip_agents/examples/tools/data_generator_tool.py +103 -0
  130. aip_agents/examples/tools/data_visualization_tool.py +312 -0
  131. aip_agents/examples/tools/image_artifact_tool.py +136 -0
  132. aip_agents/examples/tools/langchain_arithmetic_tools.py +26 -0
  133. aip_agents/examples/tools/langchain_currency_exchange_tool.py +88 -0
  134. aip_agents/examples/tools/langchain_graph_artifact_tool.py +172 -0
  135. aip_agents/examples/tools/langchain_weather_tool.py +48 -0
  136. aip_agents/examples/tools/langgraph_streaming_tool.py +130 -0
  137. aip_agents/examples/tools/mock_retrieval_tool.py +56 -0
  138. aip_agents/examples/tools/pii_demo_tools.py +189 -0
  139. aip_agents/examples/tools/random_chart_tool.py +142 -0
  140. aip_agents/examples/tools/serper_tool.py +202 -0
  141. aip_agents/examples/tools/stock_tools.py +82 -0
  142. aip_agents/examples/tools/table_generator_tool.py +167 -0
  143. aip_agents/examples/tools/time_tool.py +82 -0
  144. aip_agents/examples/tools/weather_forecast_tool.py +38 -0
  145. aip_agents/executor/agent_executor.py +473 -0
  146. aip_agents/executor/base.py +48 -0
  147. aip_agents/mcp/__init__.py +1 -0
  148. aip_agents/mcp/client/__init__.py +14 -0
  149. aip_agents/mcp/client/base_mcp_client.py +369 -0
  150. aip_agents/mcp/client/connection_manager.py +193 -0
  151. aip_agents/mcp/client/google_adk/__init__.py +11 -0
  152. aip_agents/mcp/client/google_adk/client.py +381 -0
  153. aip_agents/mcp/client/langchain/__init__.py +11 -0
  154. aip_agents/mcp/client/langchain/client.py +265 -0
  155. aip_agents/mcp/client/persistent_session.py +359 -0
  156. aip_agents/mcp/client/session_pool.py +351 -0
  157. aip_agents/mcp/client/transports.py +215 -0
  158. aip_agents/mcp/utils/__init__.py +7 -0
  159. aip_agents/mcp/utils/config_validator.py +139 -0
  160. aip_agents/memory/__init__.py +14 -0
  161. aip_agents/memory/adapters/__init__.py +10 -0
  162. aip_agents/memory/adapters/base_adapter.py +717 -0
  163. aip_agents/memory/adapters/mem0.py +84 -0
  164. aip_agents/memory/base.py +84 -0
  165. aip_agents/memory/constants.py +49 -0
  166. aip_agents/memory/factory.py +86 -0
  167. aip_agents/memory/guidance.py +20 -0
  168. aip_agents/memory/simple_memory.py +47 -0
  169. aip_agents/middleware/__init__.py +17 -0
  170. aip_agents/middleware/base.py +88 -0
  171. aip_agents/middleware/manager.py +128 -0
  172. aip_agents/middleware/todolist.py +274 -0
  173. aip_agents/schema/__init__.py +69 -0
  174. aip_agents/schema/a2a.py +56 -0
  175. aip_agents/schema/agent.py +111 -0
  176. aip_agents/schema/hitl.py +157 -0
  177. aip_agents/schema/langgraph.py +37 -0
  178. aip_agents/schema/model_id.py +97 -0
  179. aip_agents/schema/step_limit.py +108 -0
  180. aip_agents/schema/storage.py +40 -0
  181. aip_agents/sentry/__init__.py +11 -0
  182. aip_agents/sentry/sentry.py +151 -0
  183. aip_agents/storage/__init__.py +41 -0
  184. aip_agents/storage/base.py +85 -0
  185. aip_agents/storage/clients/__init__.py +12 -0
  186. aip_agents/storage/clients/minio_client.py +318 -0
  187. aip_agents/storage/config.py +62 -0
  188. aip_agents/storage/providers/__init__.py +15 -0
  189. aip_agents/storage/providers/base.py +106 -0
  190. aip_agents/storage/providers/memory.py +114 -0
  191. aip_agents/storage/providers/object_storage.py +214 -0
  192. aip_agents/tools/__init__.py +6 -0
  193. aip_agents/tools/bosa_tools.py +105 -0
  194. aip_agents/tools/browser_use/__init__.py +82 -0
  195. aip_agents/tools/browser_use/action_parser.py +103 -0
  196. aip_agents/tools/browser_use/browser_use_tool.py +1112 -0
  197. aip_agents/tools/browser_use/llm_config.py +120 -0
  198. aip_agents/tools/browser_use/minio_storage.py +198 -0
  199. aip_agents/tools/browser_use/schemas.py +119 -0
  200. aip_agents/tools/browser_use/session.py +76 -0
  201. aip_agents/tools/browser_use/session_errors.py +132 -0
  202. aip_agents/tools/browser_use/steel_session_recording.py +317 -0
  203. aip_agents/tools/browser_use/streaming.py +813 -0
  204. aip_agents/tools/browser_use/structured_data_parser.py +257 -0
  205. aip_agents/tools/browser_use/structured_data_recovery.py +204 -0
  206. aip_agents/tools/browser_use/types.py +78 -0
  207. aip_agents/tools/code_sandbox/__init__.py +26 -0
  208. aip_agents/tools/code_sandbox/constant.py +13 -0
  209. aip_agents/tools/code_sandbox/e2b_cloud_sandbox_extended.py +257 -0
  210. aip_agents/tools/code_sandbox/e2b_sandbox_tool.py +411 -0
  211. aip_agents/tools/constants.py +165 -0
  212. aip_agents/tools/document_loader/__init__.py +37 -0
  213. aip_agents/tools/document_loader/base_reader.py +262 -0
  214. aip_agents/tools/document_loader/docx_reader_tool.py +53 -0
  215. aip_agents/tools/document_loader/excel_reader_tool.py +160 -0
  216. aip_agents/tools/document_loader/pdf_reader_tool.py +67 -0
  217. aip_agents/tools/document_loader/pdf_splitter.py +169 -0
  218. aip_agents/tools/gl_connector/__init__.py +5 -0
  219. aip_agents/tools/gl_connector/tool.py +351 -0
  220. aip_agents/tools/memory_search/__init__.py +22 -0
  221. aip_agents/tools/memory_search/base.py +200 -0
  222. aip_agents/tools/memory_search/mem0.py +258 -0
  223. aip_agents/tools/memory_search/schema.py +48 -0
  224. aip_agents/tools/memory_search_tool.py +26 -0
  225. aip_agents/tools/tool_config_injector.py +300 -0
  226. aip_agents/tools/web_search/__init__.py +15 -0
  227. aip_agents/tools/web_search/serper_tool.py +187 -0
  228. aip_agents/types/__init__.py +70 -0
  229. aip_agents/types/a2a_events.py +13 -0
  230. aip_agents/utils/__init__.py +79 -0
  231. aip_agents/utils/a2a_connector.py +1757 -0
  232. aip_agents/utils/artifact_helpers.py +502 -0
  233. aip_agents/utils/constants.py +22 -0
  234. aip_agents/utils/datetime/__init__.py +34 -0
  235. aip_agents/utils/datetime/normalization.py +231 -0
  236. aip_agents/utils/datetime/timezone.py +206 -0
  237. aip_agents/utils/env_loader.py +27 -0
  238. aip_agents/utils/event_handler_registry.py +58 -0
  239. aip_agents/utils/file_prompt_utils.py +176 -0
  240. aip_agents/utils/final_response_builder.py +211 -0
  241. aip_agents/utils/formatter_llm_client.py +231 -0
  242. aip_agents/utils/langgraph/__init__.py +19 -0
  243. aip_agents/utils/langgraph/converter.py +128 -0
  244. aip_agents/utils/langgraph/tool_managers/__init__.py +15 -0
  245. aip_agents/utils/langgraph/tool_managers/a2a_tool_manager.py +99 -0
  246. aip_agents/utils/langgraph/tool_managers/base_tool_manager.py +66 -0
  247. aip_agents/utils/langgraph/tool_managers/delegation_tool_manager.py +1071 -0
  248. aip_agents/utils/langgraph/tool_output_management.py +967 -0
  249. aip_agents/utils/logger.py +195 -0
  250. aip_agents/utils/metadata/__init__.py +27 -0
  251. aip_agents/utils/metadata/activity_metadata_helper.py +407 -0
  252. aip_agents/utils/metadata/activity_narrative/__init__.py +35 -0
  253. aip_agents/utils/metadata/activity_narrative/builder.py +817 -0
  254. aip_agents/utils/metadata/activity_narrative/constants.py +51 -0
  255. aip_agents/utils/metadata/activity_narrative/context.py +49 -0
  256. aip_agents/utils/metadata/activity_narrative/formatters.py +230 -0
  257. aip_agents/utils/metadata/activity_narrative/utils.py +35 -0
  258. aip_agents/utils/metadata/schemas/__init__.py +16 -0
  259. aip_agents/utils/metadata/schemas/activity_schema.py +29 -0
  260. aip_agents/utils/metadata/schemas/thinking_schema.py +31 -0
  261. aip_agents/utils/metadata/thinking_metadata_helper.py +38 -0
  262. aip_agents/utils/metadata_helper.py +358 -0
  263. aip_agents/utils/name_preprocessor/__init__.py +17 -0
  264. aip_agents/utils/name_preprocessor/base_name_preprocessor.py +73 -0
  265. aip_agents/utils/name_preprocessor/google_name_preprocessor.py +100 -0
  266. aip_agents/utils/name_preprocessor/name_preprocessor.py +87 -0
  267. aip_agents/utils/name_preprocessor/openai_name_preprocessor.py +48 -0
  268. aip_agents/utils/pii/__init__.py +25 -0
  269. aip_agents/utils/pii/pii_handler.py +397 -0
  270. aip_agents/utils/pii/pii_helper.py +207 -0
  271. aip_agents/utils/pii/uuid_deanonymizer_mapping.py +195 -0
  272. aip_agents/utils/reference_helper.py +273 -0
  273. aip_agents/utils/sse_chunk_transformer.py +831 -0
  274. aip_agents/utils/step_limit_manager.py +265 -0
  275. aip_agents/utils/token_usage_helper.py +156 -0
  276. aip_agents_binary-0.5.13.dist-info/METADATA +690 -0
  277. aip_agents_binary-0.5.13.dist-info/RECORD +279 -0
  278. aip_agents_binary-0.5.13.dist-info/WHEEL +5 -0
  279. aip_agents_binary-0.5.13.dist-info/top_level.txt +1 -0
@@ -0,0 +1,690 @@
1
+ Metadata-Version: 2.4
2
+ Name: aip-agents-binary
3
+ Version: 0.5.13
4
+ Summary: A library for managing agents in Gen AI applications.
5
+ Author-email: Raymond Christopher <raymond.christopher@gdplabs.id>
6
+ Requires-Python: <3.13,>=3.11
7
+ Description-Content-Type: text/markdown
8
+ Requires-Dist: a2a-sdk<0.3.0,>=0.2.4
9
+ Requires-Dist: aiostream<0.7.0,>=0.6.0
10
+ Requires-Dist: authlib<2.0.0,>=1.6.4
11
+ Requires-Dist: bosa-connectors-binary<0.4.0,>=0.3.1
12
+ Requires-Dist: bosa-core-binary[logger,telemetry]<0.10.0,>=0.9.6
13
+ Requires-Dist: colorama<0.5.0,>=0.4.6
14
+ Requires-Dist: deprecated<2.0.0,>=1.2.18
15
+ Requires-Dist: fastapi<0.121.0,>=0.120.0
16
+ Requires-Dist: gllm-core-binary<0.4.0,>=0.3.18
17
+ Requires-Dist: gllm-inference-binary[anthropic,bedrock,google-genai,google-vertexai,openai]<0.6.0,>=0.5.90
18
+ Requires-Dist: gllm-tools-binary<0.2.0,>=0.1.3
19
+ Requires-Dist: google-adk<0.6.0,>=0.5.0
20
+ Requires-Dist: langchain<0.4.0,>=0.3.0
21
+ Requires-Dist: langchain-openai<0.4.0,>=0.3.17
22
+ Requires-Dist: langchain-mcp-adapters<0.1.0,>=0.0.10
23
+ Requires-Dist: langchain-experimental<0.4.0,>=0.3.4
24
+ Requires-Dist: langgraph<0.3.0,>=0.2.16
25
+ Requires-Dist: minio<8.0.0,>=7.2.20
26
+ Requires-Dist: pydantic<3.0.0,>=2.11.7
27
+ Requires-Dist: python-dotenv<2.0.0,>=1.1.0
28
+ Requires-Dist: requests<3.0.0,>=2.32.4
29
+ Requires-Dist: uvicorn<0.35.0,>=0.34.3
30
+ Provides-Extra: memory
31
+ Requires-Dist: gllm-memory-binary[mem0ai]<0.2.0,>=0.1.1; extra == "memory"
32
+ Provides-Extra: privacy
33
+ Requires-Dist: gllm-privacy-binary<0.5.0,>=0.4.7; extra == "privacy"
34
+ Provides-Extra: code-sandbox
35
+ Requires-Dist: e2b<2.0.0,>=1.5.4; extra == "code-sandbox"
36
+ Provides-Extra: browser-use-tool
37
+ Requires-Dist: browser-use==0.5.9; extra == "browser-use-tool"
38
+ Requires-Dist: steel-sdk>=0.7.0; extra == "browser-use-tool"
39
+ Requires-Dist: json-repair>=0.52.3; extra == "browser-use-tool"
40
+ Provides-Extra: document-loader
41
+ Requires-Dist: gllm-docproc-binary[docx,pdf,xlsx]<0.8.0,>=0.7.0; extra == "document-loader"
42
+ Requires-Dist: PyPDF2<4.0.0,>=3.0.0; extra == "document-loader"
43
+ Requires-Dist: unidecode<2.0.0,>=1.3.0; extra == "document-loader"
44
+ Provides-Extra: gl-connector
45
+ Requires-Dist: bosa-connectors-binary<0.4.0,>=0.3.1; extra == "gl-connector"
46
+ Provides-Extra: local
47
+ Requires-Dist: e2b<2.0.0,>=1.5.4; extra == "local"
48
+ Requires-Dist: browser-use==0.5.9; extra == "local"
49
+ Requires-Dist: steel-sdk>=0.7.0; extra == "local"
50
+ Requires-Dist: json-repair>=0.52.3; extra == "local"
51
+ Requires-Dist: PyPDF2<4.0.0,>=3.0.0; extra == "local"
52
+ Requires-Dist: unidecode<2.0.0,>=1.3.0; extra == "local"
53
+ Requires-Dist: bosa-connectors-binary<0.4.0,>=0.3.1; extra == "local"
54
+ Requires-Dist: gllm-docproc-binary[docx,pdf,xlsx]<0.8.0,>=0.7.0; extra == "local"
55
+ Provides-Extra: dev
56
+ Requires-Dist: coverage<8.0.0,>=7.4.4; extra == "dev"
57
+ Requires-Dist: mypy<2.0.0,>=1.15.0; extra == "dev"
58
+ Requires-Dist: pre-commit<4.0.0,>=3.7.0; extra == "dev"
59
+ Requires-Dist: pytest<9.0.0,>=8.1.1; extra == "dev"
60
+ Requires-Dist: pytest-asyncio<0.24.0,>=0.23.6; extra == "dev"
61
+ Requires-Dist: pytest-cov<6.0.0,>=5.0.0; extra == "dev"
62
+ Requires-Dist: pytest-xdist>=3.8.0; extra == "dev"
63
+ Requires-Dist: ruff<0.7.0,>=0.6.7; extra == "dev"
64
+ Requires-Dist: pillow<12.0.0,>=11.3.0; extra == "dev"
65
+
66
+ # AIP Agents
67
+
68
+ ## Description
69
+
70
+ The core agent library for **local execution** in GL AIP (GDP Labs AI Agents Package). `aip-agents` is part of the GL AIP ecosystem:
71
+
72
+ - **`aip-agents`** (this library) — The underlying agent library for local execution
73
+ - **[`ai-agent-platform`](https://github.com/GDP-ADMIN/ai-agent-platform)** — The platform that provides remote server/run capabilities (uses `aip-agents` internally)
74
+ - **[`glaip-sdk`](https://github.com/GDP-ADMIN/glaip-sdk/tree/main/python/glaip-sdk)** — The SDK that end users use to run agents either locally (directly via `aip-agents`) or on the remote server (via `ai-agent-platform`)
75
+
76
+ You can use `aip-agents` directly for local execution, or let `glaip-sdk` manage local vs remote mode for you. See the [GL AIP overview](../glaip-sdk/docs/overview.md) for the full architecture.
77
+
78
+ ## Installation
79
+
80
+ ### Prerequisites
81
+ - Python 3.11 - 3.12 - [Install here](https://www.python.org/downloads/)
82
+ - Pip (if using Pip) - [Install here](https://pip.pypa.io/en/stable/installation/)
83
+ - Poetry 1.8.1+ (if using Poetry) - [Install here](https://python-poetry.org/docs/#installation)
84
+ - Git (if using Git) - [Install here](https://git-scm.com/downloads)
85
+ - For git installation:
86
+ - Access to the [GDP Labs SDK repository](https://github.com/GDP-ADMIN/glaip-sdk)
87
+
88
+ ### 1. Installation from the GDP Labs registry
89
+ This package is published to the internal GDP Labs registry. Ensure your pip/Poetry config includes the registry:
90
+ `https://glsdk.gdplabs.id/gen-ai-internal/simple/`.
91
+
92
+ #### Using pip
93
+ ```bash
94
+ pip install aip-agents
95
+ ```
96
+
97
+ #### Using Poetry
98
+ ```bash
99
+ poetry add aip-agents
100
+ ```
101
+
102
+ ### 2. Development Installation (Git)
103
+ For development purposes, you can install directly from the Git repository:
104
+ ```bash
105
+ poetry add "git+ssh://git@github.com/GDP-ADMIN/glaip-sdk.git#subdirectory=python/aip-agents"
106
+ ```
107
+
108
+ ### 3. Recommended: install via glaip-sdk for local mode
109
+ If you want local + remote compatibility, install the SDK's local extra instead:
110
+ ```bash
111
+ pip install "glaip-sdk[local]"
112
+ ```
113
+
114
+ ### Optional Extras
115
+ ```bash
116
+ pip install "aip-agents[memory]"
117
+ pip install "aip-agents[privacy]"
118
+ ```
119
+
120
+ ## Managing Dependencies
121
+ 1. Go to the `aip-agents` module root, e.g. `cd python/aip-agents`.
122
+ 2. Run `poetry shell` to create a virtual environment.
123
+ 3. Run `poetry install` to install the `aip-agents` requirements (Poetry will generate a local lock file for you if needed; the repository ignores it).
124
+ 4. Run `poetry update` if you change any dependency versions in `pyproject.toml`.
125
+
126
+ ## Contributing
127
+ Please refer to this [Python Style Guide](https://docs.google.com/document/d/1uRggCrHnVfDPBnG641FyQBwUwLoFw0kTzNqRm92vUwM/edit?usp=sharing)
128
+ to get information about code style, documentation standard, and SCA that you need to use when contributing to this project
129
+
130
+ 1. Activate `pre-commit` hooks using `pre-commit install`
131
+ 2. Run `poetry shell` to create a virtual environment.
132
+ 3. Run `poetry install` to install the `aip-agents` requirements (this will also create a local lock file that stays local).
133
+ 4. Run `which python` to get the path to be referenced at Visual Studio Code interpreter path (`Ctrl`+`Shift`+`P` or `Cmd`+`Shift`+`P`)
134
+ 5. Try running the unit test to see if it's working:
135
+ ```bash
136
+ poetry run pytest -s tests/unit_tests/
137
+ ```
138
+
139
+ ## Hello World Examples
140
+
141
+ ### Prerequisites
142
+ - Python 3.11 - 3.12
143
+ - Install the package:
144
+
145
+ ```bash
146
+ pip install aip-agents
147
+ ```
148
+
149
+ - For OpenAI: Set your API key in the environment:
150
+ ```bash
151
+ export OPENAI_API_KEY=your-openai-key
152
+ ```
153
+ - For Google ADK: Set your API key in the environment:
154
+ ```bash
155
+ export GOOGLE_API_KEY=your-google-api-key
156
+ ```
157
+
158
+ ### Run the Hello World Examples
159
+
160
+ The example scripts are located in `aip_agents/examples` in the source repo. You can run them individually or use the `run_all_examples.py` script.
161
+
162
+ **1. Running Individual Examples:**
163
+
164
+ Navigate to the library's root directory (e.g., `python/aip-agents` if you cloned the repository).
165
+
166
+ **LangGraph (OpenAI):**
167
+ ```bash
168
+ python aip_agents/examples/hello_world_langgraph.py
169
+ ```
170
+
171
+ **LangGraph with BOSA Connector (OpenAI):**
172
+ ```bash
173
+ python aip_agents/examples/hello_world_langgraph_bosa_twitter.py
174
+ ```
175
+
176
+ **LangGraph Streaming (OpenAI):**
177
+ ```bash
178
+ python aip_agents/examples/hello_world_langgraph_stream.py
179
+ ```
180
+
181
+ **LangGraph Multi-Agent Coordinator (OpenAI):**
182
+ ```bash
183
+ python aip_agents/examples/hello_world_a2a_multi_agent_coordinator_server.py
184
+ ```
185
+
186
+ **Google ADK:**
187
+ ```bash
188
+ python aip_agents/examples/hello_world_google_adk.py
189
+ ```
190
+
191
+ **Google ADK Streaming:**
192
+ ```bash
193
+ python aip_agents/examples/hello_world_google_adk_stream.py
194
+ ```
195
+
196
+ **LangChain (OpenAI):**
197
+ ```bash
198
+ python aip_agents/examples/hello_world_langchain.py
199
+ ```
200
+
201
+ **LangChain Streaming (OpenAI):**
202
+ ```bash
203
+ python aip_agents/examples/hello_world_langchain_stream.py
204
+ ```
205
+
206
+ **HITL (Human-in-the-Loop) Approval Demo:**
207
+ ```bash
208
+ python aip_agents/examples/hitl_demo.py
209
+ ```
210
+
211
+ **2. Running MCP Examples**
212
+
213
+ ### Prerequisites
214
+
215
+ Ensure you have set the environment variables for API keys:
216
+
217
+ ```bash
218
+ export OPENAI_API_KEY="your-openai-key"
219
+ export GOOGLE_API_KEY="your-google-api-key"
220
+ ```
221
+
222
+ For examples that use stateful MCP tools like browser automation, start the Playwright MCP server in a separate terminal:
223
+
224
+ ```bash
225
+ npx @playwright/mcp@latest --headless --port 8931
226
+ ```
227
+
228
+ **Note:** Use the `--headless` flag to run the server without a visible browser window, which is recommended if the browser is not installed yet to avoid failures. For using an actual (non-headless) browser, refer to the [Playwright MCP documentation](https://github.com/microsoft/playwright-mcp).
229
+
230
+ ### Local MCP Servers
231
+
232
+ For STDIO, SSE, and HTTP transports using local servers, open a terminal in the library root (`python/aip-agents`) and run:
233
+
234
+ - For STDIO:
235
+
236
+ ```bash
237
+ poetry run python aip_agents/examples/mcp_servers/mcp_server_stdio.py
238
+ ```
239
+
240
+ - For SSE:
241
+
242
+ ```bash
243
+ poetry run python aip_agents/examples/mcp_servers/mcp_server_sse.py
244
+ ```
245
+
246
+ - For HTTP:
247
+
248
+ ```bash
249
+ poetry run python aip_agents/examples/mcp_servers/mcp_server_http.py
250
+ ```
251
+
252
+ Note: Start the appropriate server before running the client examples for that transport.
253
+
254
+ ### Running Examples
255
+
256
+ All examples are run from the library root using `poetry run python aip_agents/examples/<file>.py`. Examples support OpenAI for LangGraph/LangChain and Google ADK where specified.
257
+
258
+ #### LangChain Examples
259
+
260
+ ##### STDIO Transport
261
+ - Non-Streaming:
262
+ ```bash
263
+ poetry run python aip_agents/examples/hello_world_langchain_mcp_stdio.py
264
+ ```
265
+ - Streaming:
266
+ ```bash
267
+ poetry run python aip_agents/examples/hello_world_langchain_mcp_stdio_stream.py
268
+ ```
269
+
270
+ ##### SSE Transport
271
+ - Non-Streaming:
272
+ ```bash
273
+ poetry run python aip_agents/examples/hello_world_langchain_mcp_sse.py
274
+ ```
275
+ - Streaming:
276
+ ```bash
277
+ poetry run python aip_agents/examples/hello_world_langchain_mcp_sse_stream.py
278
+ ```
279
+
280
+ ##### HTTP Transport
281
+ - Non-Streaming:
282
+ ```bash
283
+ poetry run python aip_agents/examples/hello_world_langchain_mcp_http.py
284
+ ```
285
+ - Streaming:
286
+ ```bash
287
+ poetry run python aip_agents/examples/hello_world_langchain_mcp_http_stream.py
288
+ ```
289
+
290
+ #### Google ADK Examples
291
+
292
+ ##### STDIO Transport
293
+ - Non-Streaming:
294
+ ```bash
295
+ poetry run python aip_agents/examples/hello_world_google_adk_mcp_stdio.py
296
+ ```
297
+ - Streaming:
298
+ ```bash
299
+ poetry run python aip_agents/examples/hello_world_google_adk_mcp_stdio_stream.py
300
+ ```
301
+
302
+ ##### SSE Transport
303
+ - Non-Streaming:
304
+ ```bash
305
+ poetry run python aip_agents/examples/hello_world_google_adk_mcp_sse.py
306
+ ```
307
+ - Streaming:
308
+ ```bash
309
+ poetry run python aip_agents/examples/hello_world_google_adk_mcp_sse_stream.py
310
+ ```
311
+
312
+ ##### HTTP Transport
313
+ - Non-Streaming:
314
+ ```bash
315
+ poetry run python aip_agents/examples/hello_world_google_adk_mcp_http.py
316
+ ```
317
+ - Streaming:
318
+ ```bash
319
+ poetry run python aip_agents/examples/hello_world_google_adk_mcp_http_stream.py
320
+ ```
321
+
322
+ #### LangGraph Examples (OpenAI)
323
+
324
+ ##### STDIO Transport
325
+ - Non-Streaming:
326
+ ```bash
327
+ poetry run python aip_agents/examples/hello_world_langgraph_mcp_stdio.py
328
+ ```
329
+ - Streaming:
330
+ ```bash
331
+ poetry run python aip_agents/examples/hello_world_langgraph_mcp_stdio_stream.py
332
+ ```
333
+
334
+ ##### SSE Transport
335
+ - Non-Streaming:
336
+ ```bash
337
+ poetry run python aip_agents/examples/hello_world_langgraph_mcp_sse.py
338
+ ```
339
+ - Streaming:
340
+ ```bash
341
+ poetry run python aip_agents/examples/hello_world_langgraph_mcp_sse_stream.py
342
+ ```
343
+
344
+ ##### HTTP Transport
345
+ - Non-Streaming:
346
+ ```bash
347
+ poetry run python aip_agents/examples/hello_world_langgraph_mcp_http.py
348
+ ```
349
+ - Streaming:
350
+ ```bash
351
+ poetry run python aip_agents/examples/hello_world_langgraph_mcp_http_stream.py
352
+ ```
353
+
354
+ ### Multi-Server Example
355
+
356
+ This LangChain example uses multiple MCP servers: Playwright (for browser actions) and a random name generator (SSE transport) with persistent sessions across multiple `arun` calls.
357
+
358
+ 1. Start the Playwright server:
359
+
360
+ ```bash
361
+ npx @playwright/mcp@latest --headless --port 8931
362
+ ```
363
+
364
+ 2. In another terminal, start the Name Generator SSE server:
365
+
366
+ ```bash
367
+ poetry run python aip_agents/examples/mcp_servers/mcp_name.py
368
+ ```
369
+
370
+ 3. Run the multi-server client example:
371
+
372
+ ```bash
373
+ poetry run python aip_agents/examples/hello_world_langchain_mcp_multi_server.py
374
+ ```
375
+ **3. Running Individual A2A Examples:**
376
+
377
+ * Navigate to the library's root directory (e.g., `libs/aip-agents` if you cloned the repository).
378
+ * Open a new terminal and navigate to the `aip_agents/examples` directory to run the A2A server.
379
+
380
+ **LangChain Server:**
381
+ ```bash
382
+ python hello_world_a2a_langchain_server.py
383
+ ```
384
+
385
+ * Open a new terminal and navigate to the `aip_agents/examples` directory to run the A2A client.
386
+
387
+ **LangChain Client:**
388
+ ```bash
389
+ python hello_world_a2a_langchain_client.py
390
+ ```
391
+
392
+ **LangChain Client Integrated with Agent Workflow:**
393
+ ```bash
394
+ python hello_world_a2a_langchain_client_agent.py
395
+ ```
396
+
397
+ **LangChain Client Streaming:**
398
+ ```bash
399
+ python hello_world_a2a_langchain_client_stream.py
400
+ ```
401
+
402
+
403
+ ## Human-in-the-Loop (HITL) Approval
404
+
405
+ AIP Agents supports Human-in-the-Loop approval for tool execution, allowing human operators to review and approve high-risk tool calls before they execute.
406
+
407
+ ### Features
408
+
409
+ - **Configurable Approval Policies**: Set approval requirements per tool with customizable timeouts and behaviors
410
+ - **Interactive CLI Prompts**: Clear, structured prompts showing tool details and context
411
+ - **Structured Logging**: All approval decisions are logged with full metadata
412
+ - **Timeout Handling**: Configurable behavior when approval requests time out
413
+ - **Non-blocking**: Tools without HITL configuration execute normally
414
+
415
+ ### Quick Start
416
+
417
+ Configure HITL for specific tools in your agent:
418
+
419
+ ```python
420
+ from aip_agents.agent import LangGraphReactAgent
421
+ from aip_agents.agent.hitl.config import ToolApprovalConfig
422
+
423
+ # Create agent with tools
424
+ agent = LangGraphReactAgent(
425
+ name="My Agent",
426
+ tools=[send_email_tool, search_tool],
427
+ )
428
+
429
+ # Configure HITL via tool_configs
430
+ agent.tool_configs = {
431
+ "tool_configs": {
432
+ "send_email": {"hitl": {"timeout_seconds": 300}}
433
+ }
434
+ }
435
+ ```
436
+
437
+ When the agent attempts to use the `send_email` tool, it will:
438
+
439
+ 1. Emit a pending approval event via `DeferredPromptHandler`
440
+ 2. Wait for `ApprovalManager.resolve_pending_request()` to be called
441
+ 3. Execute the tool only if approved
442
+ 4. Log the decision for audit purposes
443
+
444
+ ### Configuration Options
445
+
446
+ | Option | Type | Default | Description |
447
+ |--------|------|---------|-------------|
448
+ | `timeout_seconds` | int | 300 | Seconds to wait for operator input |
449
+
450
+ ### Logging
451
+
452
+ All HITL decisions are logged with structured data:
453
+
454
+ ```json
455
+ {
456
+ "event": "hitl_decision",
457
+ "tool": "send_email",
458
+ "decision": "approved",
459
+ "operator_input": "A",
460
+ "latency_ms": 2500,
461
+ "timestamp": "2025-09-25T10:15:00Z"
462
+ }
463
+ ```
464
+
465
+ ### Demo
466
+
467
+ Run the interactive demo to see HITL in action:
468
+
469
+ ```bash
470
+ python aip_agents/examples/hitl_demo.py
471
+ ```
472
+
473
+ ## Architectural Notes
474
+
475
+ ### Memory Features
476
+
477
+ The library supports Mem0 as a memory backend for long-term conversation recall. Key features:
478
+ - Automatic persistence of user-agent interactions via `memory_backend="mem0"`.
479
+ - Semantic search for relevant past conversations.
480
+ - New `built_in_mem0_search` tool for explicit recall by time period (e.g., "yesterday", "last week", "July 2025").
481
+ - Date range parsing for natural language time filters using `dateparser`.
482
+ - Conditional auto-augmentation (disabled by default to reduce noise; enable with `memory_auto_augment=True`).
483
+
484
+ #### Mem0 Date Recall Example
485
+
486
+ Use the coordinator example with memory enabled:
487
+
488
+ ```bash
489
+ poetry run python aip_agents/examples/hello_world_a2a_mem0_coordinator_server.py
490
+ ```
491
+
492
+ In client:
493
+ ```python
494
+ agent = LangGraphAgent(
495
+ name="client",
496
+ instruction="...",
497
+ model="gpt-4o-mini",
498
+ memory_backend="mem0",
499
+ )
500
+ ```
501
+
502
+ Test recall: After some interactions, query "What did we discuss yesterday?" – agent uses tool to filter by created_at.
503
+
504
+ ## Deep Agents Middleware
505
+
506
+ The Deep Agents Middleware system provides composable components for enhancing agent capabilities with planning, context management, and custom lifecycle hooks.
507
+
508
+ ### Quick Start
509
+
510
+ Enable deep agent capabilities with a single parameter:
511
+
512
+ ```python
513
+ from aip_agents.agent.langgraph_react_agent import LangGraphReactAgent
514
+
515
+ # Enable planning + filesystem for complex multi-step tasks
516
+ agent = LangGraphReactAgent(
517
+ name="research_agent",
518
+ model="gpt-4",
519
+ planning=True, # Enables TodoListMiddleware for task decomposition
520
+ tools=[search_tool, calculator_tool],
521
+ )
522
+ ```
523
+
524
+ ### Understanding Planning vs Filesystem
525
+
526
+ **Important**: `planning` and `filesystem` are **completely independent** features:
527
+
528
+ - **`planning=True`**
529
+ - Adds `write_todos` tool for task decomposition
530
+ - Stores todos in **in-memory dictionary** (per thread_id)
531
+ - Does NOT use or require filesystem
532
+ - Perfect for breaking down complex tasks into steps
533
+ - Example: "Research quantum computing" → agent creates 5 subtasks
534
+
535
+ - **`filesystem=True`**
536
+ - Adds file operation tools: `ls`, `read_file`, `write_file`, `edit_file`, `grep`
537
+ - Stores data in **pluggable backend** (default: InMemoryBackend)
538
+ - Does NOT interact with planning/todos
539
+ - Perfect for offloading large tool results to prevent context overflow
540
+ - Example: Web search returns 50KB → agent writes to `/research/results.txt`
541
+
542
+ - **Both together** (`planning=True, filesystem=True`)
543
+ - Agent can plan tasks AND manage large data
544
+ - Todos stored separately in memory, files in backend
545
+ - Most powerful combination for complex research/analysis tasks
546
+
547
+ ### Planning Only
548
+
549
+ For task decomposition without filesystem:
550
+
551
+ ```python
552
+ agent = LangGraphReactAgent(
553
+ name="planner_agent",
554
+ model="gpt-4",
555
+ planning=True,
556
+ tools=[...],
557
+ )
558
+ ```
559
+
560
+ ### Filesystem Only
561
+
562
+ For context offloading without planning:
563
+
564
+ ```python
565
+ agent = LangGraphReactAgent(
566
+ name="data_processor",
567
+ model="gpt-4",
568
+ filesystem=True, # Enables FilesystemMiddleware
569
+ tools=[...],
570
+ )
571
+ ```
572
+
573
+ ### Custom Middleware
574
+
575
+ Create domain-specific middleware by implementing the `AgentMiddleware` protocol:
576
+
577
+ ```python
578
+ from aip_agents.middleware.base import AgentMiddleware, ModelRequest
579
+
580
+ class CustomMiddleware:
581
+ def __init__(self):
582
+ self.tools = [] # Add custom tools here
583
+ self.system_prompt_additions = "Custom instructions..."
584
+
585
+ def before_model(self, state: dict) -> dict:
586
+ # Hook executed before model invocation
587
+ return {}
588
+
589
+ def modify_model_request(self, request: ModelRequest, state: dict) -> ModelRequest:
590
+ # Modify the model request (add tools, adjust params, etc.)
591
+ return request
592
+
593
+ def after_model(self, state: dict) -> dict:
594
+ # Hook executed after model invocation
595
+ return {}
596
+
597
+ # COMPOSITION (not override): Custom middlewares EXTEND built-in middleware
598
+ agent = LangGraphReactAgent(
599
+ name="custom_agent",
600
+ model="gpt-4",
601
+ planning=True, # Adds TodoListMiddleware
602
+ filesystem=True, # Adds FilesystemMiddleware
603
+ middlewares=[CustomMiddleware()], # EXTENDS (doesn't replace) the above
604
+ tools=[...],
605
+ )
606
+ # Result: Agent has ALL THREE middleware active:
607
+ # 1. TodoListMiddleware (from planning=True)
608
+ # 2. FilesystemMiddleware (from filesystem=True)
609
+ # 3. CustomMiddleware (from middlewares parameter)
610
+ ```
611
+
612
+ **Key Points:**
613
+ - ✅ `middlewares` parameter **extends** (never replaces) auto-configured middleware
614
+ - ✅ `planning` and `filesystem` are **independent** - use either, both, or neither
615
+ - ✅ `planning=True` stores todos in **memory** (does NOT require filesystem)
616
+ - ✅ Execution order: built-in middleware (planning, filesystem) → custom middlewares
617
+ - ✅ All hooks from all middleware execute in sequence
618
+
619
+ **Common Combinations:**
620
+ ```python
621
+ # Planning only (no filesystem)
622
+ # → Todos stored in memory, no file operations available
623
+ agent = LangGraphReactAgent(planning=True)
624
+ # → [TodoListMiddleware]
625
+
626
+ # Filesystem only (no planning)
627
+ # → File operations available, no todo planning
628
+ agent = LangGraphReactAgent(filesystem=True)
629
+ # → [FilesystemMiddleware]
630
+
631
+ # Both planning and filesystem
632
+ # → Todos in memory + file operations (most powerful combination)
633
+ agent = LangGraphReactAgent(planning=True, filesystem=True)
634
+ # → [TodoListMiddleware, FilesystemMiddleware]
635
+
636
+ # Custom only (no auto-configuration)
637
+ agent = LangGraphReactAgent(middlewares=[CustomMiddleware()])
638
+ # → [CustomMiddleware]
639
+
640
+ # All together (composition)
641
+ agent = LangGraphReactAgent(
642
+ planning=True,
643
+ filesystem=True,
644
+ middlewares=[CustomMiddleware()]
645
+ )
646
+ # → [TodoListMiddleware, FilesystemMiddleware, CustomMiddleware]
647
+ ```
648
+
649
+ ### Advanced: Custom Storage Backend
650
+
651
+ Provide your own storage backend for filesystem operations:
652
+
653
+ ```python
654
+ from aip_agents.middleware.backends.protocol import BackendProtocol
655
+ from aip_agents.middleware.backends.memory import InMemoryBackend
656
+
657
+ # Use custom backend (e.g., PostgreSQL, S3, Redis)
658
+ custom_backend = MyCustomBackend()
659
+
660
+ agent = LangGraphReactAgent(
661
+ name="agent",
662
+ model="gpt-4",
663
+ filesystem=custom_backend, # Pass BackendProtocol instance
664
+ tools=[...],
665
+ )
666
+ ```
667
+
668
+ ### Benefits
669
+
670
+ - **Context Window Management**: Automatically offload large tool results to files
671
+ - **Task Decomposition**: Break down complex multi-step tasks into trackable todos
672
+ - **Incremental Development**: Add capabilities gradually (filesystem first, then planning)
673
+ - **Zero Breaking Changes**: Existing agents work unchanged (backward compatible)
674
+ - **Extensible**: Compose custom middleware with built-in components
675
+
676
+ For detailed documentation, see `docs/deep_agents_guide.md` (coming soon).
677
+
678
+ ### Agent Interface (`AgentInterface`)
679
+
680
+ The `aip_agents.agent.interface.AgentInterface` class defines a standardized contract for all agent implementations within the AIP Agents ecosystem. It ensures that different agent types (e.g., LangGraph-based, Google ADK-based) expose a consistent set of methods for core operations.
681
+
682
+ Key methods defined by `AgentInterface` typically include:
683
+ - `arun()`: For asynchronous execution of the agent that returns a final consolidated response.
684
+ - `arun_stream()`: For asynchronous execution that streams back partial responses or events from the agent.
685
+
686
+ By adhering to this interface, users can interact with various agents in a uniform way, making it easier to switch between or combine different agent technologies.
687
+
688
+ ### Inversion of Control (IoC) / Dependency Injection (DI)
689
+
690
+ The agent implementations (e.g., `LangGraphAgent`, `GoogleADKAgent`) utilize Dependency Injection. For instance, `LangGraphAgent` accepts an `agent_executor` (like one created by LangGraph's `create_react_agent`) in its constructor. Similarly, `GoogleADKAgent` accepts a native `adk_native_agent`. This allows the core execution logic to be provided externally, promoting flexibility and decoupling the agent wrapper from the specific instantiation details of its underlying engine.