lionagi 0.5.4__py3-none-any.whl → 0.6.0__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (428) hide show
  1. lionagi/__init__.py +16 -24
  2. lionagi/{core/_class_registry.py → _class_registry.py} +51 -10
  3. lionagi/_errors.py +35 -0
  4. lionagi/libs/__init__.py +3 -0
  5. lionagi/libs/compress/__init__.py +3 -0
  6. lionagi/libs/compress/models.py +6 -2
  7. lionagi/libs/compress/utils.py +4 -16
  8. lionagi/libs/file/__init__.py +3 -0
  9. lionagi/libs/file/chunk.py +4 -0
  10. lionagi/libs/file/file_ops.py +4 -0
  11. lionagi/libs/file/params.py +4 -41
  12. lionagi/libs/file/process.py +4 -0
  13. lionagi/libs/file/save.py +5 -1
  14. lionagi/libs/{parse/flatten → nested}/flatten.py +4 -0
  15. lionagi/libs/{parse/nested → nested}/nfilter.py +4 -0
  16. lionagi/libs/{parse/nested → nested}/nget.py +6 -1
  17. lionagi/libs/{parse/nested → nested}/ninsert.py +5 -1
  18. lionagi/libs/{parse/nested → nested}/nmerge.py +4 -0
  19. lionagi/libs/{parse/nested → nested}/npop.py +5 -2
  20. lionagi/libs/{parse/nested → nested}/nset.py +6 -1
  21. lionagi/libs/{parse/flatten → nested}/unflatten.py +4 -0
  22. lionagi/libs/{parse/nested → nested}/utils.py +5 -1
  23. lionagi/libs/package/__init__.py +3 -0
  24. lionagi/libs/package/imports.py +6 -2
  25. lionagi/libs/package/management.py +7 -3
  26. lionagi/libs/package/params.py +4 -0
  27. lionagi/libs/package/system.py +4 -0
  28. lionagi/libs/parse.py +30 -0
  29. lionagi/libs/{parse/json → schema}/as_readable.py +10 -4
  30. lionagi/libs/{parse/string_parse/code_block.py → schema/extract_code_block.py} +4 -0
  31. lionagi/libs/{parse/string_parse/docstring.py → schema/extract_docstring.py} +4 -0
  32. lionagi/libs/{parse/string_parse/function_.py → schema/function_to_schema.py} +21 -9
  33. lionagi/libs/{parse/json/schema.py → schema/json_schema.py} +5 -1
  34. lionagi/libs/validate/common_field_validators.py +170 -0
  35. lionagi/libs/{parse/validate/keys.py → validate/fuzzy_match_keys.py} +42 -8
  36. lionagi/libs/{parse/validate/mapping.py → validate/fuzzy_validate_mapping.py} +41 -6
  37. lionagi/libs/{string_similarity/algorithms.py → validate/string_similarity.py} +115 -1
  38. lionagi/libs/{parse/validate/boolean.py → validate/validate_boolean.py} +42 -3
  39. lionagi/operations/__init__.py +13 -3
  40. lionagi/operations/brainstorm/__init__.py +3 -3
  41. lionagi/operations/brainstorm/brainstorm.py +33 -19
  42. lionagi/operations/brainstorm/prompt.py +4 -0
  43. lionagi/operations/plan/__init__.py +4 -0
  44. lionagi/operations/plan/plan.py +16 -13
  45. lionagi/operations/plan/prompt.py +4 -0
  46. lionagi/operations/select/__init__.py +4 -0
  47. lionagi/operations/select/prompt.py +4 -0
  48. lionagi/operations/select/select.py +1 -1
  49. lionagi/operations/select/utils.py +4 -4
  50. lionagi/{strategies → operations/strategies}/base.py +6 -2
  51. lionagi/{strategies → operations/strategies}/concurrent.py +8 -5
  52. lionagi/{strategies → operations/strategies}/concurrent_chunk.py +6 -3
  53. lionagi/{strategies → operations/strategies}/concurrent_sequential_chunk.py +8 -4
  54. lionagi/{strategies → operations/strategies}/params.py +10 -6
  55. lionagi/{strategies → operations/strategies}/sequential.py +6 -2
  56. lionagi/{strategies → operations/strategies}/sequential_chunk.py +7 -3
  57. lionagi/{strategies → operations/strategies}/sequential_concurrent_chunk.py +9 -4
  58. lionagi/{strategies → operations/strategies}/utils.py +6 -3
  59. lionagi/{core/models/__init__.py → operations/types.py} +3 -1
  60. lionagi/operations/utils.py +6 -3
  61. lionagi/operatives/action/function_calling.py +136 -0
  62. lionagi/operatives/action/manager.py +239 -0
  63. lionagi/operatives/action/request_response_model.py +90 -0
  64. lionagi/operatives/action/tool.py +141 -0
  65. lionagi/{protocols/operatives/action.py → operatives/action/utils.py} +52 -90
  66. lionagi/{core → operatives}/forms/base.py +9 -4
  67. lionagi/{core → operatives}/forms/form.py +8 -13
  68. lionagi/{core → operatives}/forms/report.py +5 -3
  69. lionagi/operatives/instruct/base.py +79 -0
  70. lionagi/operatives/instruct/instruct.py +105 -0
  71. lionagi/operatives/instruct/instruct_collection.py +52 -0
  72. lionagi/operatives/instruct/node.py +13 -0
  73. lionagi/{protocols/operatives → operatives/instruct}/prompts.py +0 -34
  74. lionagi/{protocols/operatives → operatives/instruct}/reason.py +14 -7
  75. lionagi/{integrations/anthropic_/version.py → operatives/manager.py} +5 -1
  76. lionagi/operatives/models/field_model.py +194 -0
  77. lionagi/operatives/models/model_params.py +307 -0
  78. lionagi/{core → operatives}/models/note.py +20 -28
  79. lionagi/{core → operatives}/models/operable_model.py +153 -71
  80. lionagi/{core → operatives}/models/schema_model.py +4 -3
  81. lionagi/{protocols/operatives → operatives}/operative.py +10 -7
  82. lionagi/{protocols/operatives → operatives}/step.py +67 -26
  83. lionagi/operatives/types.py +69 -0
  84. lionagi/protocols/_adapter.py +224 -0
  85. lionagi/protocols/_concepts.py +94 -0
  86. lionagi/protocols/generic/element.py +460 -0
  87. lionagi/protocols/generic/event.py +177 -0
  88. lionagi/protocols/generic/log.py +237 -0
  89. lionagi/{core → protocols}/generic/pile.py +172 -131
  90. lionagi/protocols/generic/processor.py +316 -0
  91. lionagi/protocols/generic/progression.py +500 -0
  92. lionagi/protocols/graph/edge.py +166 -0
  93. lionagi/protocols/graph/graph.py +290 -0
  94. lionagi/protocols/graph/node.py +109 -0
  95. lionagi/protocols/mail/exchange.py +116 -0
  96. lionagi/protocols/mail/mail.py +25 -0
  97. lionagi/protocols/mail/mailbox.py +47 -0
  98. lionagi/protocols/mail/manager.py +168 -0
  99. lionagi/protocols/mail/package.py +55 -0
  100. lionagi/protocols/messages/action_request.py +165 -0
  101. lionagi/protocols/messages/action_response.py +132 -0
  102. lionagi/{core/communication → protocols/messages}/assistant_response.py +65 -79
  103. lionagi/protocols/messages/base.py +73 -0
  104. lionagi/protocols/messages/instruction.py +582 -0
  105. lionagi/protocols/messages/manager.py +429 -0
  106. lionagi/protocols/messages/message.py +216 -0
  107. lionagi/protocols/messages/system.py +115 -0
  108. lionagi/protocols/messages/templates/assistant_response.jinja2 +6 -0
  109. lionagi/{core/communication → protocols/messages}/templates/instruction_message.jinja2 +2 -2
  110. lionagi/protocols/types.py +96 -0
  111. lionagi/service/__init__.py +10 -12
  112. lionagi/service/endpoints/base.py +517 -0
  113. lionagi/service/endpoints/chat_completion.py +102 -0
  114. lionagi/service/endpoints/match_endpoint.py +60 -0
  115. lionagi/service/endpoints/rate_limited_processor.py +145 -0
  116. lionagi/service/endpoints/token_calculator.py +209 -0
  117. lionagi/service/imodel.py +264 -92
  118. lionagi/service/manager.py +45 -0
  119. lionagi/service/providers/anthropic_/messages.py +64 -0
  120. lionagi/service/providers/groq_/chat_completions.py +56 -0
  121. lionagi/service/providers/openai_/chat_completions.py +62 -0
  122. lionagi/service/providers/openrouter_/chat_completions.py +62 -0
  123. lionagi/service/providers/perplexity_/__init__.py +3 -0
  124. lionagi/service/providers/perplexity_/chat_completions.py +40 -0
  125. lionagi/session/__init__.py +3 -0
  126. lionagi/session/branch.py +1287 -0
  127. lionagi/session/session.py +296 -0
  128. lionagi/settings.py +62 -118
  129. lionagi/utils.py +2386 -0
  130. lionagi/version.py +1 -1
  131. {lionagi-0.5.4.dist-info → lionagi-0.6.0.dist-info}/METADATA +7 -6
  132. lionagi-0.6.0.dist-info/RECORD +160 -0
  133. lionagi/core/action/action_manager.py +0 -287
  134. lionagi/core/action/base.py +0 -109
  135. lionagi/core/action/function_calling.py +0 -153
  136. lionagi/core/action/tool.py +0 -202
  137. lionagi/core/action/types.py +0 -16
  138. lionagi/core/communication/action_request.py +0 -163
  139. lionagi/core/communication/action_response.py +0 -149
  140. lionagi/core/communication/base_mail.py +0 -49
  141. lionagi/core/communication/instruction.py +0 -376
  142. lionagi/core/communication/message.py +0 -286
  143. lionagi/core/communication/message_manager.py +0 -530
  144. lionagi/core/communication/system.py +0 -116
  145. lionagi/core/communication/templates/assistant_response.jinja2 +0 -2
  146. lionagi/core/communication/types.py +0 -27
  147. lionagi/core/communication/utils.py +0 -254
  148. lionagi/core/forms/types.py +0 -13
  149. lionagi/core/generic/component.py +0 -422
  150. lionagi/core/generic/edge.py +0 -163
  151. lionagi/core/generic/element.py +0 -199
  152. lionagi/core/generic/graph.py +0 -377
  153. lionagi/core/generic/log.py +0 -151
  154. lionagi/core/generic/log_manager.py +0 -320
  155. lionagi/core/generic/node.py +0 -11
  156. lionagi/core/generic/progression.py +0 -395
  157. lionagi/core/generic/types.py +0 -23
  158. lionagi/core/generic/utils.py +0 -53
  159. lionagi/core/models/base.py +0 -28
  160. lionagi/core/models/field_model.py +0 -145
  161. lionagi/core/models/model_params.py +0 -194
  162. lionagi/core/models/types.py +0 -19
  163. lionagi/core/session/branch.py +0 -130
  164. lionagi/core/session/branch_mixins.py +0 -544
  165. lionagi/core/session/session.py +0 -163
  166. lionagi/core/session/types.py +0 -8
  167. lionagi/core/typing/__init__.py +0 -9
  168. lionagi/core/typing/_concepts.py +0 -173
  169. lionagi/core/typing/_id.py +0 -104
  170. lionagi/core/typing/_pydantic.py +0 -33
  171. lionagi/core/typing/_typing.py +0 -54
  172. lionagi/integrations/__init__.py +0 -0
  173. lionagi/integrations/_services.py +0 -17
  174. lionagi/integrations/anthropic_/AnthropicModel.py +0 -273
  175. lionagi/integrations/anthropic_/AnthropicService.py +0 -117
  176. lionagi/integrations/anthropic_/anthropic_max_output_token_data.yaml +0 -7
  177. lionagi/integrations/anthropic_/anthropic_price_data.yaml +0 -14
  178. lionagi/integrations/anthropic_/api_endpoints/api_request.py +0 -277
  179. lionagi/integrations/anthropic_/api_endpoints/data_models.py +0 -40
  180. lionagi/integrations/anthropic_/api_endpoints/match_response.py +0 -119
  181. lionagi/integrations/anthropic_/api_endpoints/messages/request/message_models.py +0 -14
  182. lionagi/integrations/anthropic_/api_endpoints/messages/request/request_body.py +0 -74
  183. lionagi/integrations/anthropic_/api_endpoints/messages/response/__init__.py +0 -0
  184. lionagi/integrations/anthropic_/api_endpoints/messages/response/content_models.py +0 -32
  185. lionagi/integrations/anthropic_/api_endpoints/messages/response/response_body.py +0 -101
  186. lionagi/integrations/anthropic_/api_endpoints/messages/response/usage_models.py +0 -25
  187. lionagi/integrations/groq_/GroqModel.py +0 -325
  188. lionagi/integrations/groq_/GroqService.py +0 -151
  189. lionagi/integrations/groq_/api_endpoints/__init__.py +0 -0
  190. lionagi/integrations/groq_/api_endpoints/data_models.py +0 -187
  191. lionagi/integrations/groq_/api_endpoints/groq_request.py +0 -288
  192. lionagi/integrations/groq_/api_endpoints/match_response.py +0 -106
  193. lionagi/integrations/groq_/api_endpoints/response_utils.py +0 -105
  194. lionagi/integrations/groq_/groq_max_output_token_data.yaml +0 -21
  195. lionagi/integrations/groq_/groq_price_data.yaml +0 -58
  196. lionagi/integrations/groq_/groq_rate_limits.yaml +0 -105
  197. lionagi/integrations/groq_/version.py +0 -5
  198. lionagi/integrations/litellm_/imodel.py +0 -71
  199. lionagi/integrations/ollama_/OllamaModel.py +0 -244
  200. lionagi/integrations/ollama_/OllamaService.py +0 -142
  201. lionagi/integrations/ollama_/api_endpoints/api_request.py +0 -179
  202. lionagi/integrations/ollama_/api_endpoints/chat_completion/message_models.py +0 -31
  203. lionagi/integrations/ollama_/api_endpoints/chat_completion/request_body.py +0 -46
  204. lionagi/integrations/ollama_/api_endpoints/chat_completion/response_body.py +0 -67
  205. lionagi/integrations/ollama_/api_endpoints/chat_completion/tool_models.py +0 -49
  206. lionagi/integrations/ollama_/api_endpoints/completion/__init__.py +0 -0
  207. lionagi/integrations/ollama_/api_endpoints/completion/request_body.py +0 -72
  208. lionagi/integrations/ollama_/api_endpoints/completion/response_body.py +0 -59
  209. lionagi/integrations/ollama_/api_endpoints/data_models.py +0 -15
  210. lionagi/integrations/ollama_/api_endpoints/embedding/__init__.py +0 -0
  211. lionagi/integrations/ollama_/api_endpoints/embedding/request_body.py +0 -33
  212. lionagi/integrations/ollama_/api_endpoints/embedding/response_body.py +0 -29
  213. lionagi/integrations/ollama_/api_endpoints/match_data_model.py +0 -62
  214. lionagi/integrations/ollama_/api_endpoints/match_response.py +0 -190
  215. lionagi/integrations/ollama_/api_endpoints/model/copy_model.py +0 -13
  216. lionagi/integrations/ollama_/api_endpoints/model/create_model.py +0 -28
  217. lionagi/integrations/ollama_/api_endpoints/model/delete_model.py +0 -11
  218. lionagi/integrations/ollama_/api_endpoints/model/list_model.py +0 -60
  219. lionagi/integrations/ollama_/api_endpoints/model/pull_model.py +0 -34
  220. lionagi/integrations/ollama_/api_endpoints/model/push_model.py +0 -35
  221. lionagi/integrations/ollama_/api_endpoints/model/show_model.py +0 -36
  222. lionagi/integrations/ollama_/api_endpoints/option_models.py +0 -68
  223. lionagi/integrations/openai_/OpenAIModel.py +0 -423
  224. lionagi/integrations/openai_/OpenAIService.py +0 -426
  225. lionagi/integrations/openai_/__init__.py +0 -0
  226. lionagi/integrations/openai_/api_endpoints/__init__.py +0 -3
  227. lionagi/integrations/openai_/api_endpoints/api_request.py +0 -277
  228. lionagi/integrations/openai_/api_endpoints/audio/__init__.py +0 -9
  229. lionagi/integrations/openai_/api_endpoints/audio/speech_models.py +0 -34
  230. lionagi/integrations/openai_/api_endpoints/audio/transcription_models.py +0 -136
  231. lionagi/integrations/openai_/api_endpoints/audio/translation_models.py +0 -41
  232. lionagi/integrations/openai_/api_endpoints/audio/types.py +0 -41
  233. lionagi/integrations/openai_/api_endpoints/batch/__init__.py +0 -17
  234. lionagi/integrations/openai_/api_endpoints/batch/batch_models.py +0 -146
  235. lionagi/integrations/openai_/api_endpoints/batch/cancel_batch.py +0 -7
  236. lionagi/integrations/openai_/api_endpoints/batch/create_batch.py +0 -26
  237. lionagi/integrations/openai_/api_endpoints/batch/list_batch.py +0 -37
  238. lionagi/integrations/openai_/api_endpoints/batch/request_object_models.py +0 -65
  239. lionagi/integrations/openai_/api_endpoints/batch/retrieve_batch.py +0 -7
  240. lionagi/integrations/openai_/api_endpoints/batch/types.py +0 -4
  241. lionagi/integrations/openai_/api_endpoints/chat_completions/__init__.py +0 -1
  242. lionagi/integrations/openai_/api_endpoints/chat_completions/request/__init__.py +0 -39
  243. lionagi/integrations/openai_/api_endpoints/chat_completions/request/message_models.py +0 -121
  244. lionagi/integrations/openai_/api_endpoints/chat_completions/request/request_body.py +0 -221
  245. lionagi/integrations/openai_/api_endpoints/chat_completions/request/response_format.py +0 -71
  246. lionagi/integrations/openai_/api_endpoints/chat_completions/request/stream_options.py +0 -14
  247. lionagi/integrations/openai_/api_endpoints/chat_completions/request/tool_choice_models.py +0 -17
  248. lionagi/integrations/openai_/api_endpoints/chat_completions/request/tool_models.py +0 -54
  249. lionagi/integrations/openai_/api_endpoints/chat_completions/request/types.py +0 -18
  250. lionagi/integrations/openai_/api_endpoints/chat_completions/response/__init__.py +0 -0
  251. lionagi/integrations/openai_/api_endpoints/chat_completions/response/choice_models.py +0 -62
  252. lionagi/integrations/openai_/api_endpoints/chat_completions/response/function_models.py +0 -16
  253. lionagi/integrations/openai_/api_endpoints/chat_completions/response/log_prob_models.py +0 -47
  254. lionagi/integrations/openai_/api_endpoints/chat_completions/response/message_models.py +0 -25
  255. lionagi/integrations/openai_/api_endpoints/chat_completions/response/response_body.py +0 -99
  256. lionagi/integrations/openai_/api_endpoints/chat_completions/response/types.py +0 -8
  257. lionagi/integrations/openai_/api_endpoints/chat_completions/response/usage_models.py +0 -24
  258. lionagi/integrations/openai_/api_endpoints/chat_completions/util.py +0 -46
  259. lionagi/integrations/openai_/api_endpoints/data_models.py +0 -23
  260. lionagi/integrations/openai_/api_endpoints/embeddings/__init__.py +0 -3
  261. lionagi/integrations/openai_/api_endpoints/embeddings/request_body.py +0 -79
  262. lionagi/integrations/openai_/api_endpoints/embeddings/response_body.py +0 -67
  263. lionagi/integrations/openai_/api_endpoints/files/__init__.py +0 -11
  264. lionagi/integrations/openai_/api_endpoints/files/delete_file.py +0 -20
  265. lionagi/integrations/openai_/api_endpoints/files/file_models.py +0 -56
  266. lionagi/integrations/openai_/api_endpoints/files/list_files.py +0 -27
  267. lionagi/integrations/openai_/api_endpoints/files/retrieve_file.py +0 -9
  268. lionagi/integrations/openai_/api_endpoints/files/upload_file.py +0 -38
  269. lionagi/integrations/openai_/api_endpoints/fine_tuning/__init__.py +0 -37
  270. lionagi/integrations/openai_/api_endpoints/fine_tuning/cancel_jobs.py +0 -9
  271. lionagi/integrations/openai_/api_endpoints/fine_tuning/create_jobs.py +0 -133
  272. lionagi/integrations/openai_/api_endpoints/fine_tuning/fine_tuning_job_checkpoint_models.py +0 -58
  273. lionagi/integrations/openai_/api_endpoints/fine_tuning/fine_tuning_job_event_models.py +0 -31
  274. lionagi/integrations/openai_/api_endpoints/fine_tuning/fine_tuning_job_models.py +0 -140
  275. lionagi/integrations/openai_/api_endpoints/fine_tuning/list_fine_tuning_checkpoints.py +0 -51
  276. lionagi/integrations/openai_/api_endpoints/fine_tuning/list_fine_tuning_events.py +0 -42
  277. lionagi/integrations/openai_/api_endpoints/fine_tuning/list_fine_tuning_jobs.py +0 -31
  278. lionagi/integrations/openai_/api_endpoints/fine_tuning/retrieve_jobs.py +0 -9
  279. lionagi/integrations/openai_/api_endpoints/fine_tuning/training_format.py +0 -30
  280. lionagi/integrations/openai_/api_endpoints/images/__init__.py +0 -9
  281. lionagi/integrations/openai_/api_endpoints/images/image_edit_models.py +0 -69
  282. lionagi/integrations/openai_/api_endpoints/images/image_models.py +0 -56
  283. lionagi/integrations/openai_/api_endpoints/images/image_variation_models.py +0 -56
  284. lionagi/integrations/openai_/api_endpoints/images/response_body.py +0 -30
  285. lionagi/integrations/openai_/api_endpoints/match_data_model.py +0 -197
  286. lionagi/integrations/openai_/api_endpoints/match_response.py +0 -336
  287. lionagi/integrations/openai_/api_endpoints/models/__init__.py +0 -7
  288. lionagi/integrations/openai_/api_endpoints/models/delete_fine_tuned_model.py +0 -17
  289. lionagi/integrations/openai_/api_endpoints/models/models_models.py +0 -31
  290. lionagi/integrations/openai_/api_endpoints/models/retrieve_model.py +0 -9
  291. lionagi/integrations/openai_/api_endpoints/moderations/__init__.py +0 -3
  292. lionagi/integrations/openai_/api_endpoints/moderations/request_body.py +0 -20
  293. lionagi/integrations/openai_/api_endpoints/moderations/response_body.py +0 -139
  294. lionagi/integrations/openai_/api_endpoints/uploads/__init__.py +0 -19
  295. lionagi/integrations/openai_/api_endpoints/uploads/add_upload_part.py +0 -11
  296. lionagi/integrations/openai_/api_endpoints/uploads/cancel_upload.py +0 -7
  297. lionagi/integrations/openai_/api_endpoints/uploads/complete_upload.py +0 -18
  298. lionagi/integrations/openai_/api_endpoints/uploads/create_upload.py +0 -17
  299. lionagi/integrations/openai_/api_endpoints/uploads/uploads_models.py +0 -52
  300. lionagi/integrations/openai_/image_token_calculator/__init__.py +0 -0
  301. lionagi/integrations/openai_/image_token_calculator/image_token_calculator.py +0 -98
  302. lionagi/integrations/openai_/image_token_calculator/openai_image_token_data.yaml +0 -15
  303. lionagi/integrations/openai_/openai_max_output_token_data.yaml +0 -12
  304. lionagi/integrations/openai_/openai_price_data.yaml +0 -26
  305. lionagi/integrations/openai_/version.py +0 -1
  306. lionagi/integrations/pandas_/__init__.py +0 -24
  307. lionagi/integrations/pandas_/extend_df.py +0 -61
  308. lionagi/integrations/pandas_/read.py +0 -103
  309. lionagi/integrations/pandas_/remove_rows.py +0 -61
  310. lionagi/integrations/pandas_/replace_keywords.py +0 -65
  311. lionagi/integrations/pandas_/save.py +0 -131
  312. lionagi/integrations/pandas_/search_keywords.py +0 -69
  313. lionagi/integrations/pandas_/to_df.py +0 -196
  314. lionagi/integrations/pandas_/update_cells.py +0 -54
  315. lionagi/integrations/perplexity_/PerplexityModel.py +0 -274
  316. lionagi/integrations/perplexity_/PerplexityService.py +0 -113
  317. lionagi/integrations/perplexity_/api_endpoints/__init__.py +0 -0
  318. lionagi/integrations/perplexity_/api_endpoints/api_request.py +0 -171
  319. lionagi/integrations/perplexity_/api_endpoints/chat_completions/__init__.py +0 -0
  320. lionagi/integrations/perplexity_/api_endpoints/chat_completions/request/__init__.py +0 -0
  321. lionagi/integrations/perplexity_/api_endpoints/chat_completions/request/request_body.py +0 -121
  322. lionagi/integrations/perplexity_/api_endpoints/chat_completions/response/__init__.py +0 -0
  323. lionagi/integrations/perplexity_/api_endpoints/chat_completions/response/response_body.py +0 -146
  324. lionagi/integrations/perplexity_/api_endpoints/data_models.py +0 -63
  325. lionagi/integrations/perplexity_/api_endpoints/match_response.py +0 -26
  326. lionagi/integrations/perplexity_/perplexity_max_output_token_data.yaml +0 -3
  327. lionagi/integrations/perplexity_/perplexity_price_data.yaml +0 -10
  328. lionagi/integrations/perplexity_/version.py +0 -1
  329. lionagi/integrations/pydantic_/__init__.py +0 -8
  330. lionagi/integrations/pydantic_/break_down_annotation.py +0 -81
  331. lionagi/integrations/pydantic_/new_model.py +0 -208
  332. lionagi/libs/constants.py +0 -98
  333. lionagi/libs/file/path.py +0 -301
  334. lionagi/libs/file/types.py +0 -22
  335. lionagi/libs/func/__init__.py +0 -0
  336. lionagi/libs/func/async_calls/__init__.py +0 -24
  337. lionagi/libs/func/async_calls/alcall.py +0 -210
  338. lionagi/libs/func/async_calls/bcall.py +0 -130
  339. lionagi/libs/func/async_calls/mcall.py +0 -134
  340. lionagi/libs/func/async_calls/pcall.py +0 -149
  341. lionagi/libs/func/async_calls/rcall.py +0 -217
  342. lionagi/libs/func/async_calls/tcall.py +0 -114
  343. lionagi/libs/func/async_calls/ucall.py +0 -85
  344. lionagi/libs/func/decorators.py +0 -277
  345. lionagi/libs/func/lcall.py +0 -57
  346. lionagi/libs/func/params.py +0 -64
  347. lionagi/libs/func/throttle.py +0 -119
  348. lionagi/libs/func/types.py +0 -39
  349. lionagi/libs/func/utils.py +0 -96
  350. lionagi/libs/package/types.py +0 -26
  351. lionagi/libs/parse/__init__.py +0 -1
  352. lionagi/libs/parse/flatten/__init__.py +0 -9
  353. lionagi/libs/parse/flatten/params.py +0 -52
  354. lionagi/libs/parse/json/__init__.py +0 -27
  355. lionagi/libs/parse/json/extract.py +0 -102
  356. lionagi/libs/parse/json/parse.py +0 -179
  357. lionagi/libs/parse/json/to_json.py +0 -71
  358. lionagi/libs/parse/nested/__init__.py +0 -33
  359. lionagi/libs/parse/nested/to_flat_list.py +0 -64
  360. lionagi/libs/parse/params.py +0 -0
  361. lionagi/libs/parse/string_parse/__init__.py +0 -11
  362. lionagi/libs/parse/type_convert/__init__.py +0 -19
  363. lionagi/libs/parse/type_convert/params.py +0 -145
  364. lionagi/libs/parse/type_convert/to_dict.py +0 -333
  365. lionagi/libs/parse/type_convert/to_list.py +0 -186
  366. lionagi/libs/parse/type_convert/to_num.py +0 -358
  367. lionagi/libs/parse/type_convert/to_str.py +0 -195
  368. lionagi/libs/parse/types.py +0 -9
  369. lionagi/libs/parse/validate/__init__.py +0 -14
  370. lionagi/libs/parse/validate/params.py +0 -62
  371. lionagi/libs/parse/xml/__init__.py +0 -10
  372. lionagi/libs/parse/xml/convert.py +0 -56
  373. lionagi/libs/parse/xml/parser.py +0 -93
  374. lionagi/libs/string_similarity/__init__.py +0 -32
  375. lionagi/libs/string_similarity/matcher.py +0 -102
  376. lionagi/libs/string_similarity/utils.py +0 -15
  377. lionagi/libs/utils.py +0 -266
  378. lionagi/protocols/adapters/__init__.py +0 -0
  379. lionagi/protocols/adapters/adapter.py +0 -79
  380. lionagi/protocols/adapters/json_adapter.py +0 -43
  381. lionagi/protocols/adapters/pandas_adapter.py +0 -96
  382. lionagi/protocols/configs/__init__.py +0 -0
  383. lionagi/protocols/configs/branch_config.py +0 -86
  384. lionagi/protocols/configs/id_config.py +0 -15
  385. lionagi/protocols/configs/imodel_config.py +0 -73
  386. lionagi/protocols/configs/log_config.py +0 -93
  387. lionagi/protocols/configs/retry_config.py +0 -29
  388. lionagi/protocols/configs/types.py +0 -15
  389. lionagi/protocols/operatives/instruct.py +0 -194
  390. lionagi/protocols/operatives/types.py +0 -19
  391. lionagi/protocols/registries/_component_registry.py +0 -23
  392. lionagi/protocols/registries/_pile_registry.py +0 -30
  393. lionagi/service/complete_request_info.py +0 -11
  394. lionagi/service/rate_limiter.py +0 -108
  395. lionagi/service/service.py +0 -41
  396. lionagi/service/service_match_util.py +0 -131
  397. lionagi/service/service_util.py +0 -72
  398. lionagi/service/token_calculator.py +0 -51
  399. lionagi/strategies/__init__.py +0 -0
  400. lionagi/strategies/types.py +0 -21
  401. lionagi-0.5.4.dist-info/RECORD +0 -374
  402. /lionagi/{core → libs/nested}/__init__.py +0 -0
  403. /lionagi/{core/action → libs/schema}/__init__.py +0 -0
  404. /lionagi/{core/communication → libs/validate}/__init__.py +0 -0
  405. /lionagi/{core/forms → operations/strategies}/__init__.py +0 -0
  406. /lionagi/{core/generic → operatives}/__init__.py +0 -0
  407. /lionagi/{core/session → operatives/action}/__init__.py +0 -0
  408. /lionagi/{integrations/anthropic_ → operatives/forms}/__init__.py +0 -0
  409. /lionagi/{core → operatives}/forms/utils.py +0 -0
  410. /lionagi/{integrations/anthropic_/api_endpoints → operatives/instruct}/__init__.py +0 -0
  411. /lionagi/{integrations/anthropic_/api_endpoints/messages → operatives/models}/__init__.py +0 -0
  412. /lionagi/{integrations/anthropic_/api_endpoints/messages/request → protocols/generic}/__init__.py +0 -0
  413. /lionagi/{integrations/groq_ → protocols/graph}/__init__.py +0 -0
  414. /lionagi/{integrations/litellm_ → protocols/mail}/__init__.py +0 -0
  415. /lionagi/{integrations/ollama_ → protocols/messages}/__init__.py +0 -0
  416. /lionagi/{core/communication → protocols/messages}/templates/README.md +0 -0
  417. /lionagi/{core/communication → protocols/messages}/templates/action_request.jinja2 +0 -0
  418. /lionagi/{core/communication → protocols/messages}/templates/action_response.jinja2 +0 -0
  419. /lionagi/{core/communication → protocols/messages}/templates/system_message.jinja2 +0 -0
  420. /lionagi/{core/communication → protocols/messages}/templates/tool_schemas.jinja2 +0 -0
  421. /lionagi/{integrations/ollama_/api_endpoints → service/endpoints}/__init__.py +0 -0
  422. /lionagi/{integrations/ollama_/api_endpoints/chat_completion → service/providers}/__init__.py +0 -0
  423. /lionagi/{integrations/ollama_/api_endpoints/model → service/providers/anthropic_}/__init__.py +0 -0
  424. /lionagi/{integrations/perplexity_ → service/providers/groq_}/__init__.py +0 -0
  425. /lionagi/{protocols/operatives → service/providers/openai_}/__init__.py +0 -0
  426. /lionagi/{protocols/registries → service/providers/openrouter_}/__init__.py +0 -0
  427. {lionagi-0.5.4.dist-info → lionagi-0.6.0.dist-info}/WHEEL +0 -0
  428. {lionagi-0.5.4.dist-info → lionagi-0.6.0.dist-info}/licenses/LICENSE +0 -0
@@ -1,49 +0,0 @@
1
- # Copyright (c) 2023 - 2024, HaiyangLi <quantocean.li at gmail dot com>
2
- #
3
- # SPDX-License-Identifier: Apache-2.0
4
-
5
- from lionagi.core.generic.types import Element
6
- from lionagi.core.typing import ID, Any, Communicatable, Field, field_validator
7
-
8
- from .utils import validate_sender_recipient
9
-
10
-
11
- class BaseMail(Element, Communicatable):
12
- """
13
- Base class for mail-like communication in the LION system.
14
-
15
- This class provides the foundation for all message-based communication,
16
- implementing sender and recipient functionality with proper validation.
17
- It inherits from Element for core functionality and Communicatable for
18
- communication capabilities.
19
-
20
- Attributes:
21
- sender (ID.SenderRecipient): The ID of the sender node or role.
22
- Can be a specific node ID or one of: "system", "user", "assistant", "N/A"
23
- recipient (ID.SenderRecipient): The ID of the recipient node or role.
24
- Can be a specific node ID or one of: "system", "user", "assistant", "N/A"
25
-
26
- Example:
27
- >>> mail = BaseMail(sender="user", recipient="assistant")
28
- >>> print(mail.sender)
29
- 'user'
30
- >>> print(mail.recipient)
31
- 'assistant'
32
- """
33
-
34
- sender: ID.SenderRecipient = Field(
35
- default="N/A",
36
- title="Sender",
37
- description="The ID of the sender node or a role.",
38
- )
39
-
40
- recipient: ID.SenderRecipient = Field(
41
- default="N/A",
42
- title="Recipient",
43
- description="The ID of the recipient node or a role.",
44
- )
45
-
46
- @field_validator("sender", "recipient", mode="before")
47
- @classmethod
48
- def _validate_sender_recipient(cls, value: Any) -> ID.SenderRecipient:
49
- return validate_sender_recipient(value)
@@ -1,376 +0,0 @@
1
- # Copyright (c) 2023 - 2024, HaiyangLi <quantocean.li at gmail dot com>
2
- #
3
- # SPDX-License-Identifier: Apache-2.0
4
-
5
- from lionagi.core.generic.log import Log
6
- from lionagi.core.typing import (
7
- ID,
8
- Any,
9
- BaseModel,
10
- JsonValue,
11
- Literal,
12
- override,
13
- )
14
- from lionagi.integrations.pydantic_ import break_down_pydantic_annotation
15
- from lionagi.libs.parse import to_str
16
- from lionagi.libs.utils import copy
17
-
18
- from .message import MessageFlag, MessageRole, RoledMessage
19
- from .utils import (
20
- format_image_content,
21
- format_text_content,
22
- prepare_instruction_content,
23
- prepare_request_response_format,
24
- )
25
-
26
-
27
- class Instruction(RoledMessage):
28
- """
29
- Represents an instruction message in the system.
30
-
31
- This class encapsulates various components of an instruction, including
32
- the main instruction content, guidance, context, and request fields.
33
- It supports both text and image content, and can handle structured
34
- request specifications through Pydantic models.
35
-
36
- Attributes:
37
- instruction: The main instruction content
38
- context: Additional context information
39
- guidance: Optional guidance for instruction execution
40
- images: Optional list of images
41
- request_fields: Fields requested in the response
42
- plain_content: Plain text content
43
- image_detail: Level of detail for images
44
- request_model: Optional Pydantic model for structured requests
45
- tool_schemas: Optional tool schemas
46
- """
47
-
48
- @override
49
- def __init__(
50
- self,
51
- instruction: JsonValue | MessageFlag,
52
- context: JsonValue | MessageFlag = None,
53
- guidance: JsonValue | MessageFlag = None,
54
- images: list | MessageFlag = None,
55
- sender: ID.Ref | MessageFlag = None,
56
- recipient: ID.Ref | MessageFlag = None,
57
- request_fields: JsonValue | MessageFlag = None,
58
- plain_content: JsonValue | MessageFlag = None,
59
- image_detail: Literal["low", "high", "auto"] | MessageFlag = None,
60
- request_model: BaseModel | type[BaseModel] | MessageFlag = None,
61
- tool_schemas: dict | None = None,
62
- protected_init_params: dict | None = None,
63
- ) -> None:
64
- """
65
- Initialize an Instruction instance.
66
-
67
- Args:
68
- instruction: The main instruction content
69
- context: Additional context for the instruction
70
- guidance: Guidance information
71
- images: List of images
72
- sender: The sender of the instruction
73
- recipient: The recipient of the instruction
74
- request_fields: Fields requested in the response
75
- plain_content: Plain text content
76
- image_detail: Level of detail for images
77
- request_model: A Pydantic model for structured requests
78
- tool_schemas: Tool schemas
79
- protected_init_params: Protected initialization parameters
80
- """
81
- message_flags = [
82
- instruction,
83
- context,
84
- guidance,
85
- images,
86
- sender,
87
- recipient,
88
- request_fields,
89
- plain_content,
90
- image_detail,
91
- tool_schemas,
92
- request_model,
93
- ]
94
-
95
- if all(x == MessageFlag.MESSAGE_LOAD for x in message_flags):
96
- protected_init_params = protected_init_params or {}
97
- super().__init__(**protected_init_params)
98
- return
99
-
100
- if all(x == MessageFlag.MESSAGE_CLONE for x in message_flags):
101
- super().__init__(role=MessageRole.USER)
102
- return
103
-
104
- super().__init__(
105
- role=MessageRole.USER,
106
- content=prepare_instruction_content(
107
- guidance=guidance,
108
- instruction=instruction,
109
- context=context,
110
- images=images,
111
- request_fields=request_fields,
112
- plain_content=plain_content,
113
- image_detail=image_detail,
114
- request_model=request_model,
115
- tool_schemas=tool_schemas,
116
- ),
117
- sender=sender or "user",
118
- recipient=recipient or "N/A",
119
- )
120
-
121
- @property
122
- def guidance(self) -> str | None:
123
- """Get the guidance content of the instruction."""
124
- return self.content.get(["guidance"], None)
125
-
126
- @guidance.setter
127
- def guidance(self, guidance: str) -> None:
128
- """Set the guidance content of the instruction."""
129
- if not isinstance(guidance, str):
130
- guidance = to_str(guidance)
131
- self.content["guidance"] = guidance
132
-
133
- @property
134
- def instruction(self) -> JsonValue | None:
135
- """Get the main instruction content."""
136
- if "plain_content" in self.content:
137
- return self.content["plain_content"]
138
- else:
139
- return self.content.get(["instruction"], None)
140
-
141
- @instruction.setter
142
- def instruction(self, instruction: JsonValue) -> None:
143
- """Set the main instruction content."""
144
- self.content["instruction"] = instruction
145
-
146
- @property
147
- def context(self) -> JsonValue | None:
148
- """Get the context of the instruction."""
149
- return self.content.get(["context"], None)
150
-
151
- @context.setter
152
- def context(self, context: JsonValue) -> None:
153
- """Set the context of the instruction."""
154
- if not isinstance(context, list):
155
- context = [context]
156
- self.content["context"] = context
157
-
158
- @property
159
- def tool_schemas(self) -> JsonValue | None:
160
- """Get the schemas of the tools in the instruction."""
161
- return self.content.get(["tool_schemas"], None)
162
-
163
- @tool_schemas.setter
164
- def tool_schemas(self, tool_schemas: dict) -> None:
165
- """Set the schemas of the tools in the instruction."""
166
- self.content["tool_schemas"] = tool_schemas
167
-
168
- @property
169
- def plain_content(self) -> str | None:
170
- """Get the plain text content of the instruction."""
171
- return self.content.get(["plain_content"], None)
172
-
173
- @plain_content.setter
174
- def plain_content(self, plain_content: str) -> None:
175
- """Set the plain text content of the instruction."""
176
- self.content["plain_content"] = plain_content
177
-
178
- @property
179
- def image_detail(self) -> Literal["low", "high", "auto"] | None:
180
- """Get the image detail level of the instruction."""
181
- return self.content.get(["image_detail"], None)
182
-
183
- @image_detail.setter
184
- def image_detail(
185
- self, image_detail: Literal["low", "high", "auto"]
186
- ) -> None:
187
- """Set the image detail level of the instruction."""
188
- self.content["image_detail"] = image_detail
189
-
190
- @property
191
- def images(self) -> list:
192
- """Get the images associated with the instruction."""
193
- return self.content.get(["images"], [])
194
-
195
- @images.setter
196
- def images(self, images: list) -> None:
197
- """Set the images associated with the instruction."""
198
- if not isinstance(images, list):
199
- images = [images]
200
- self.content["images"] = images
201
-
202
- @property
203
- def request_fields(self) -> dict | None:
204
- """Get the requested fields in the instruction."""
205
- return self.content.get(["request_fields"], None)
206
-
207
- @request_fields.setter
208
- def request_fields(self, request_fields: dict) -> None:
209
- """Set the requested fields in the instruction."""
210
- self.content["request_fields"] = request_fields
211
- self.content["request_response_format"] = (
212
- prepare_request_response_format(request_fields)
213
- )
214
-
215
- @property
216
- def request_model(self) -> type[BaseModel] | None:
217
- """Get the request model of the instruction."""
218
- return self.content.get(["request_model"], None)
219
-
220
- @request_model.setter
221
- def request_model(self, request_model: type[BaseModel]) -> None:
222
- """
223
- Set the request model of the instruction.
224
-
225
- This also updates request fields and context based on the model.
226
- """
227
- if isinstance(request_model, BaseModel):
228
- self.content["request_model"] = type(request_model)
229
- else:
230
- self.content["request_model"] = request_model
231
-
232
- self.request_fields = {}
233
- self.extend_context(
234
- respond_schema_info=request_model.model_json_schema()
235
- )
236
- self.request_fields = break_down_pydantic_annotation(request_model)
237
-
238
- def extend_images(
239
- self,
240
- images: list | str,
241
- image_detail: Literal["low", "high", "auto"] = None,
242
- ) -> None:
243
- """
244
- Add new images to the instruction.
245
-
246
- Args:
247
- images: New images to add
248
- image_detail: Optional new image detail level
249
- """
250
- images = images if isinstance(images, list) else [images]
251
- _ima: list = self.content.get(["images"], [])
252
- _ima.extend(images)
253
- self.images = _ima
254
-
255
- if image_detail:
256
- self.image_detail = image_detail
257
-
258
- def extend_context(self, *args, **kwargs) -> None:
259
- """
260
- Add new context to the instruction.
261
-
262
- Args:
263
- *args: Positional arguments to add to context
264
- **kwargs: Keyword arguments to add to context
265
- """
266
- context: list = self.content.get("context", [])
267
-
268
- if args:
269
- context.extend(args)
270
- if kwargs:
271
- kwargs = copy(kwargs)
272
- for k, v in kwargs.items():
273
- context.append({k: v})
274
-
275
- self.context = context
276
-
277
- def update(
278
- self,
279
- *args,
280
- guidance: JsonValue = None,
281
- instruction: JsonValue = None,
282
- request_fields: JsonValue = None,
283
- plain_content: JsonValue = None,
284
- request_model: BaseModel | type[BaseModel] = None,
285
- images: str | list = None,
286
- image_detail: Literal["low", "high", "auto"] = None,
287
- tool_schemas: dict = None,
288
- **kwargs,
289
- ):
290
- """
291
- Update multiple aspects of the instruction.
292
-
293
- Args:
294
- *args: Positional arguments for context update
295
- guidance: New guidance content
296
- instruction: New instruction content
297
- request_fields: New request fields
298
- plain_content: New plain text content
299
- request_model: New request model
300
- images: New images to add
301
- image_detail: New image detail level
302
- tool_schemas: New tool schemas
303
- **kwargs: Additional keyword arguments for context update
304
-
305
- Raises:
306
- ValueError: If both request_model and request_fields are provided
307
- """
308
- if request_model and request_fields:
309
- raise ValueError(
310
- "You cannot pass both request_model and request_fields "
311
- "to create_instruction"
312
- )
313
- if guidance:
314
- self.guidance = guidance
315
-
316
- if instruction:
317
- self.instruction = instruction
318
-
319
- if plain_content:
320
- self.plain_content = plain_content
321
-
322
- if request_fields:
323
- self.request_fields = request_fields
324
-
325
- if request_model:
326
- self.request_model = request_model
327
-
328
- if images:
329
- self.images = images
330
-
331
- if image_detail:
332
- self.image_detail = image_detail
333
-
334
- if tool_schemas:
335
- self.tool_schemas = tool_schemas
336
-
337
- self.extend_context(*args, **kwargs)
338
-
339
- @override
340
- def _format_content(self) -> dict[str, Any]:
341
- """Format the content of the instruction."""
342
- content = self.content.to_dict()
343
- text_content = format_text_content(content)
344
- if "images" not in content:
345
- return {"role": self.role.value, "content": text_content}
346
- else:
347
- content = format_image_content(
348
- text_content=text_content,
349
- images=self.images,
350
- image_detail=self.image_detail,
351
- )
352
- return {"role": self.role.value, "content": content}
353
-
354
- @override
355
- def to_log(self) -> Log:
356
- """
357
- Convert the message to a Log object.
358
-
359
- Creates a Log instance containing the message content and additional
360
- information as loginfo.
361
-
362
- Returns:
363
- Log: A Log object representing the message.
364
- """
365
- dict_ = self.to_dict()
366
- content = dict_.pop("content")
367
- content.pop("request_model", None)
368
- content.pop("request_fields", None)
369
- _log = Log(
370
- content=content,
371
- loginfo=dict_,
372
- )
373
- return _log
374
-
375
-
376
- __all__ = ["Instruction"]
@@ -1,286 +0,0 @@
1
- # Copyright (c) 2023 - 2024, HaiyangLi <quantocean.li at gmail dot com>
2
- #
3
- # SPDX-License-Identifier: Apache-2.0
4
-
5
- import inspect
6
-
7
- from lionagi.core._class_registry import get_class
8
- from lionagi.core.generic.types import Component, Log
9
- from lionagi.core.typing import (
10
- Any,
11
- Communicatable,
12
- Enum,
13
- Field,
14
- Note,
15
- field_serializer,
16
- field_validator,
17
- override,
18
- )
19
- from lionagi.libs.utils import copy
20
-
21
- from .base_mail import BaseMail
22
-
23
-
24
- class MessageRole(str, Enum):
25
- """
26
- Enum for possible roles a message can assume in a conversation.
27
-
28
- These roles define the nature and purpose of messages in the system:
29
- - SYSTEM: System-level messages providing context or instructions
30
- - USER: Messages from users making requests or providing input
31
- - ASSISTANT: Messages from AI assistants providing responses
32
- """
33
-
34
- SYSTEM = "system"
35
- USER = "user"
36
- ASSISTANT = "assistant"
37
-
38
-
39
- class MessageFlag(str, Enum):
40
- """
41
- Enum to signal special message construction modes.
42
-
43
- These flags are used internally to control message instantiation:
44
- - MESSAGE_CLONE: Signal to create a clone of an existing message
45
- - MESSAGE_LOAD: Signal to load a message from stored data
46
- """
47
-
48
- MESSAGE_CLONE = "MESSAGE_CLONE"
49
- MESSAGE_LOAD = "MESSAGE_LOAD"
50
-
51
-
52
- class MessageField(str, Enum):
53
- """
54
- Enum for standard message fields.
55
-
56
- Defines the standard fields that can be present in a message:
57
- - TIMESTAMP: Message creation timestamp
58
- - LION_CLASS: Class identifier for LION system
59
- - ROLE: Message role (system/user/assistant)
60
- - CONTENT: Message content
61
- - id: Unique message identifier
62
- - SENDER: Message sender
63
- - RECIPIENT: Message recipient
64
- - METADATA: Additional message metadata
65
- """
66
-
67
- TIMESTAMP = "timestamp"
68
- LION_CLASS = "lion_class"
69
- ROLE = "role"
70
- CONTENT = "content"
71
- id = "id"
72
- SENDER = "sender"
73
- RECIPIENT = "recipient"
74
- METADATA = "metadata"
75
-
76
-
77
- MESSAGE_FIELDS = [i.value for i in MessageField.__members__.values()]
78
-
79
-
80
- class RoledMessage(Component, BaseMail):
81
- """
82
- A base class representing a message with roles and properties.
83
-
84
- This class combines functionality from Component and BaseMail to create
85
- a versatile message object with role-based behavior. It serves as the
86
- foundation for all specific message types in the system.
87
-
88
- Attributes:
89
- content (Note): The content of the message, stored in a Note object
90
- role (MessageRole): The role of the message in the conversation
91
- (system, user, or assistant)
92
-
93
- Example:
94
- >>> msg = RoledMessage(role=MessageRole.USER, content="Hello")
95
- >>> print(msg.role)
96
- MessageRole.USER
97
- """
98
-
99
- content: Note = Field(
100
- default_factory=Note,
101
- description="The content of the message.",
102
- )
103
-
104
- role: MessageRole | None = Field(
105
- default=None,
106
- description="The role of the message in the conversation.",
107
- examples=["system", "user", "assistant"],
108
- )
109
-
110
- @property
111
- def image_content(self) -> list[dict[str, Any]] | None:
112
- """
113
- Return image content if present in the message.
114
-
115
- Returns:
116
- Optional[List[Dict[str, Any]]]: A list of image content
117
- dictionaries, or None if no images are present.
118
- """
119
- msg_ = self.chat_msg
120
- if isinstance(msg_, dict) and isinstance(msg_["content"], list):
121
- return [i for i in msg_["content"] if i["type"] == "image_url"]
122
- return None
123
-
124
- @property
125
- def chat_msg(self) -> dict[str, Any] | None:
126
- """
127
- Return message in chat representation format.
128
-
129
- Returns:
130
- Optional[Dict[str, Any]]: The message formatted for chat use,
131
- or None if formatting fails.
132
- """
133
- try:
134
- return self._format_content()
135
- except Exception:
136
- return None
137
-
138
- @field_validator("role")
139
- def _validate_role(cls, v: Any) -> MessageRole | None:
140
-
141
- if v in [r.value for r in MessageRole]:
142
- return MessageRole(v)
143
- raise ValueError(f"Invalid message role: {v}")
144
-
145
- def clone(self) -> "RoledMessage":
146
- """
147
- Creates a copy of the current RoledMessage object.
148
-
149
- Creates a new instance with the same attributes as the current one,
150
- but with a new identity. The original message is referenced in the
151
- clone's metadata.
152
-
153
- Returns:
154
- RoledMessage: A new instance with copied attributes.
155
- """
156
- cls = self.__class__
157
- signature = inspect.signature(cls.__init__)
158
- param_num = len(signature.parameters) - 2
159
-
160
- init_args = [MessageFlag.MESSAGE_CLONE] * param_num
161
-
162
- obj = cls(*init_args)
163
- obj.role = self.role
164
- obj.content = self.content
165
- obj.metadata.set("clone_from", self)
166
-
167
- return obj
168
-
169
- @override
170
- @classmethod
171
- def from_dict(cls, data: dict, /, **kwargs: Any) -> "RoledMessage":
172
- """
173
- Loads a RoledMessage object from a dictionary.
174
-
175
- Creates a new instance from serialized data, handling both standard
176
- fields and any extra fields that might be present.
177
-
178
- Args:
179
- data: The dictionary containing the message data
180
- **kwargs: Additional keyword arguments to override data
181
-
182
- Returns:
183
- RoledMessage: An instance created from the dictionary
184
- """
185
- data = copy(data)
186
- if kwargs:
187
- data.update(kwargs)
188
- if "lion_class" in data:
189
- cls = get_class(data.pop("lion_class"))
190
- signature = inspect.signature(cls.__init__)
191
- param_num = len(signature.parameters) - 2
192
-
193
- init_args = [MessageFlag.MESSAGE_LOAD] * param_num
194
-
195
- extra_fields = {}
196
- for k, v in list(data.items()):
197
- if k not in cls.model_fields:
198
- extra_fields[k] = data.pop(k)
199
-
200
- obj = cls(*init_args, protected_init_params=data)
201
-
202
- for k, v in extra_fields.items():
203
- obj.add_field(name=k, value=v)
204
-
205
- metadata = data.get("metadata", {})
206
- last_updated = metadata.get("last_updated", None)
207
- if last_updated is not None:
208
- obj.metadata.set(["last_updated"], last_updated)
209
- return obj
210
-
211
- @override
212
- def __str__(self) -> str:
213
-
214
- content_preview = (
215
- f"{str(self.content)[:75]}..."
216
- if len(str(self.content)) > 75
217
- else str(self.content)
218
- )
219
- return (
220
- f"Message(role={self.role}, sender={self.sender}, "
221
- f"content='{content_preview}')"
222
- )
223
-
224
- def to_log(self) -> Log:
225
- """
226
- Convert the message to a Log object.
227
-
228
- Creates a Log instance containing the message content and additional
229
- information as loginfo.
230
-
231
- Returns:
232
- Log: A Log object representing the message.
233
- """
234
- dict_ = self.to_dict()
235
- content = dict_.pop("content")
236
- _log = Log(
237
- content=content,
238
- loginfo=dict_,
239
- )
240
- return _log
241
-
242
- @field_serializer("content")
243
- def _serialize_content(self, value: Note) -> dict[str, Any]:
244
-
245
- output_dict = copy(value.content, deep=True)
246
- origin_obj = output_dict.pop("clone_from", None)
247
-
248
- if origin_obj and isinstance(origin_obj, Communicatable):
249
- info_dict = {
250
- "clone_from_info": {
251
- "original_id": origin_obj.id,
252
- "original_timestamp": origin_obj.timestamp,
253
- "original_sender": origin_obj.sender,
254
- "original_recipient": origin_obj.recipient,
255
- }
256
- }
257
- output_dict.update(info_dict)
258
- return output_dict
259
-
260
- @field_serializer("role")
261
- def _serialize_role(self, value: MessageRole):
262
- """
263
- Serialize the role for storage or transmission.
264
-
265
- Args:
266
- value: The MessageRole to serialize
267
-
268
- Returns:
269
- str: The string value of the role
270
- """
271
- return value.value
272
-
273
- def _format_content(self) -> dict[str, Any]:
274
- """
275
- Format the message content for chat representation.
276
-
277
- Handles both text and image content appropriately.
278
-
279
- Returns:
280
- dict[str, Any]: The formatted content with role and content fields
281
- """
282
- if self.content.get("images", None):
283
- content = self.content.to_dict()
284
- else:
285
- content = str(self.content.to_dict())
286
- return {"role": self.role.value, "content": content}