mirascope 1.25.7__py3-none-any.whl → 2.0.0__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 (797) hide show
  1. mirascope/__init__.py +5 -52
  2. mirascope/_stubs.py +363 -0
  3. mirascope/api/__init__.py +14 -0
  4. mirascope/api/_generated/README.md +207 -0
  5. mirascope/api/_generated/__init__.py +440 -0
  6. mirascope/api/_generated/annotations/__init__.py +33 -0
  7. mirascope/api/_generated/annotations/client.py +506 -0
  8. mirascope/api/_generated/annotations/raw_client.py +1414 -0
  9. mirascope/api/_generated/annotations/types/__init__.py +31 -0
  10. mirascope/api/_generated/annotations/types/annotations_create_request_label.py +5 -0
  11. mirascope/api/_generated/annotations/types/annotations_create_response.py +48 -0
  12. mirascope/api/_generated/annotations/types/annotations_create_response_label.py +5 -0
  13. mirascope/api/_generated/annotations/types/annotations_get_response.py +48 -0
  14. mirascope/api/_generated/annotations/types/annotations_get_response_label.py +5 -0
  15. mirascope/api/_generated/annotations/types/annotations_list_request_label.py +5 -0
  16. mirascope/api/_generated/annotations/types/annotations_list_response.py +21 -0
  17. mirascope/api/_generated/annotations/types/annotations_list_response_annotations_item.py +50 -0
  18. mirascope/api/_generated/annotations/types/annotations_list_response_annotations_item_label.py +5 -0
  19. mirascope/api/_generated/annotations/types/annotations_update_request_label.py +5 -0
  20. mirascope/api/_generated/annotations/types/annotations_update_response.py +48 -0
  21. mirascope/api/_generated/annotations/types/annotations_update_response_label.py +5 -0
  22. mirascope/api/_generated/api_keys/__init__.py +17 -0
  23. mirascope/api/_generated/api_keys/client.py +530 -0
  24. mirascope/api/_generated/api_keys/raw_client.py +1236 -0
  25. mirascope/api/_generated/api_keys/types/__init__.py +15 -0
  26. mirascope/api/_generated/api_keys/types/api_keys_create_response.py +28 -0
  27. mirascope/api/_generated/api_keys/types/api_keys_get_response.py +27 -0
  28. mirascope/api/_generated/api_keys/types/api_keys_list_all_for_org_response_item.py +40 -0
  29. mirascope/api/_generated/api_keys/types/api_keys_list_response_item.py +27 -0
  30. mirascope/api/_generated/client.py +211 -0
  31. mirascope/api/_generated/core/__init__.py +52 -0
  32. mirascope/api/_generated/core/api_error.py +23 -0
  33. mirascope/api/_generated/core/client_wrapper.py +46 -0
  34. mirascope/api/_generated/core/datetime_utils.py +28 -0
  35. mirascope/api/_generated/core/file.py +67 -0
  36. mirascope/api/_generated/core/force_multipart.py +16 -0
  37. mirascope/api/_generated/core/http_client.py +543 -0
  38. mirascope/api/_generated/core/http_response.py +55 -0
  39. mirascope/api/_generated/core/jsonable_encoder.py +100 -0
  40. mirascope/api/_generated/core/pydantic_utilities.py +255 -0
  41. mirascope/api/_generated/core/query_encoder.py +58 -0
  42. mirascope/api/_generated/core/remove_none_from_dict.py +11 -0
  43. mirascope/api/_generated/core/request_options.py +35 -0
  44. mirascope/api/_generated/core/serialization.py +276 -0
  45. mirascope/api/_generated/docs/__init__.py +4 -0
  46. mirascope/api/_generated/docs/client.py +91 -0
  47. mirascope/api/_generated/docs/raw_client.py +178 -0
  48. mirascope/api/_generated/environment.py +9 -0
  49. mirascope/api/_generated/environments/__init__.py +23 -0
  50. mirascope/api/_generated/environments/client.py +649 -0
  51. mirascope/api/_generated/environments/raw_client.py +1567 -0
  52. mirascope/api/_generated/environments/types/__init__.py +25 -0
  53. mirascope/api/_generated/environments/types/environments_create_response.py +24 -0
  54. mirascope/api/_generated/environments/types/environments_get_analytics_response.py +60 -0
  55. mirascope/api/_generated/environments/types/environments_get_analytics_response_top_functions_item.py +24 -0
  56. mirascope/api/_generated/environments/types/environments_get_analytics_response_top_models_item.py +22 -0
  57. mirascope/api/_generated/environments/types/environments_get_response.py +24 -0
  58. mirascope/api/_generated/environments/types/environments_list_response_item.py +24 -0
  59. mirascope/api/_generated/environments/types/environments_update_response.py +24 -0
  60. mirascope/api/_generated/errors/__init__.py +25 -0
  61. mirascope/api/_generated/errors/bad_request_error.py +14 -0
  62. mirascope/api/_generated/errors/conflict_error.py +14 -0
  63. mirascope/api/_generated/errors/forbidden_error.py +11 -0
  64. mirascope/api/_generated/errors/internal_server_error.py +10 -0
  65. mirascope/api/_generated/errors/not_found_error.py +11 -0
  66. mirascope/api/_generated/errors/payment_required_error.py +15 -0
  67. mirascope/api/_generated/errors/service_unavailable_error.py +14 -0
  68. mirascope/api/_generated/errors/too_many_requests_error.py +15 -0
  69. mirascope/api/_generated/errors/unauthorized_error.py +11 -0
  70. mirascope/api/_generated/functions/__init__.py +39 -0
  71. mirascope/api/_generated/functions/client.py +647 -0
  72. mirascope/api/_generated/functions/raw_client.py +1890 -0
  73. mirascope/api/_generated/functions/types/__init__.py +53 -0
  74. mirascope/api/_generated/functions/types/functions_create_request_dependencies_value.py +20 -0
  75. mirascope/api/_generated/functions/types/functions_create_response.py +37 -0
  76. mirascope/api/_generated/functions/types/functions_create_response_dependencies_value.py +20 -0
  77. mirascope/api/_generated/functions/types/functions_find_by_hash_response.py +39 -0
  78. mirascope/api/_generated/functions/types/functions_find_by_hash_response_dependencies_value.py +20 -0
  79. mirascope/api/_generated/functions/types/functions_get_by_env_response.py +53 -0
  80. mirascope/api/_generated/functions/types/functions_get_by_env_response_dependencies_value.py +22 -0
  81. mirascope/api/_generated/functions/types/functions_get_response.py +37 -0
  82. mirascope/api/_generated/functions/types/functions_get_response_dependencies_value.py +20 -0
  83. mirascope/api/_generated/functions/types/functions_list_by_env_response.py +25 -0
  84. mirascope/api/_generated/functions/types/functions_list_by_env_response_functions_item.py +56 -0
  85. mirascope/api/_generated/functions/types/functions_list_by_env_response_functions_item_dependencies_value.py +22 -0
  86. mirascope/api/_generated/functions/types/functions_list_response.py +21 -0
  87. mirascope/api/_generated/functions/types/functions_list_response_functions_item.py +41 -0
  88. mirascope/api/_generated/functions/types/functions_list_response_functions_item_dependencies_value.py +20 -0
  89. mirascope/api/_generated/health/__init__.py +7 -0
  90. mirascope/api/_generated/health/client.py +92 -0
  91. mirascope/api/_generated/health/raw_client.py +175 -0
  92. mirascope/api/_generated/health/types/__init__.py +8 -0
  93. mirascope/api/_generated/health/types/health_check_response.py +22 -0
  94. mirascope/api/_generated/health/types/health_check_response_status.py +5 -0
  95. mirascope/api/_generated/organization_invitations/__init__.py +33 -0
  96. mirascope/api/_generated/organization_invitations/client.py +546 -0
  97. mirascope/api/_generated/organization_invitations/raw_client.py +1519 -0
  98. mirascope/api/_generated/organization_invitations/types/__init__.py +53 -0
  99. mirascope/api/_generated/organization_invitations/types/organization_invitations_accept_response.py +34 -0
  100. mirascope/api/_generated/organization_invitations/types/organization_invitations_accept_response_role.py +7 -0
  101. mirascope/api/_generated/organization_invitations/types/organization_invitations_create_request_role.py +7 -0
  102. mirascope/api/_generated/organization_invitations/types/organization_invitations_create_response.py +48 -0
  103. mirascope/api/_generated/organization_invitations/types/organization_invitations_create_response_role.py +7 -0
  104. mirascope/api/_generated/organization_invitations/types/organization_invitations_create_response_status.py +7 -0
  105. mirascope/api/_generated/organization_invitations/types/organization_invitations_get_response.py +48 -0
  106. mirascope/api/_generated/organization_invitations/types/organization_invitations_get_response_role.py +7 -0
  107. mirascope/api/_generated/organization_invitations/types/organization_invitations_get_response_status.py +7 -0
  108. mirascope/api/_generated/organization_invitations/types/organization_invitations_list_response_item.py +48 -0
  109. mirascope/api/_generated/organization_invitations/types/organization_invitations_list_response_item_role.py +7 -0
  110. mirascope/api/_generated/organization_invitations/types/organization_invitations_list_response_item_status.py +7 -0
  111. mirascope/api/_generated/organization_memberships/__init__.py +19 -0
  112. mirascope/api/_generated/organization_memberships/client.py +302 -0
  113. mirascope/api/_generated/organization_memberships/raw_client.py +736 -0
  114. mirascope/api/_generated/organization_memberships/types/__init__.py +27 -0
  115. mirascope/api/_generated/organization_memberships/types/organization_memberships_list_response_item.py +33 -0
  116. mirascope/api/_generated/organization_memberships/types/organization_memberships_list_response_item_role.py +7 -0
  117. mirascope/api/_generated/organization_memberships/types/organization_memberships_update_request_role.py +7 -0
  118. mirascope/api/_generated/organization_memberships/types/organization_memberships_update_response.py +31 -0
  119. mirascope/api/_generated/organization_memberships/types/organization_memberships_update_response_role.py +7 -0
  120. mirascope/api/_generated/organizations/__init__.py +51 -0
  121. mirascope/api/_generated/organizations/client.py +869 -0
  122. mirascope/api/_generated/organizations/raw_client.py +2593 -0
  123. mirascope/api/_generated/organizations/types/__init__.py +71 -0
  124. mirascope/api/_generated/organizations/types/organizations_create_payment_intent_response.py +24 -0
  125. mirascope/api/_generated/organizations/types/organizations_create_response.py +26 -0
  126. mirascope/api/_generated/organizations/types/organizations_create_response_role.py +5 -0
  127. mirascope/api/_generated/organizations/types/organizations_get_response.py +26 -0
  128. mirascope/api/_generated/organizations/types/organizations_get_response_role.py +5 -0
  129. mirascope/api/_generated/organizations/types/organizations_list_response_item.py +26 -0
  130. mirascope/api/_generated/organizations/types/organizations_list_response_item_role.py +5 -0
  131. mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_request_target_plan.py +7 -0
  132. mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_response.py +47 -0
  133. mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_response_validation_errors_item.py +33 -0
  134. mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_response_validation_errors_item_resource.py +7 -0
  135. mirascope/api/_generated/organizations/types/organizations_router_balance_response.py +24 -0
  136. mirascope/api/_generated/organizations/types/organizations_subscription_response.py +53 -0
  137. mirascope/api/_generated/organizations/types/organizations_subscription_response_current_plan.py +7 -0
  138. mirascope/api/_generated/organizations/types/organizations_subscription_response_payment_method.py +26 -0
  139. mirascope/api/_generated/organizations/types/organizations_subscription_response_scheduled_change.py +34 -0
  140. mirascope/api/_generated/organizations/types/organizations_subscription_response_scheduled_change_target_plan.py +7 -0
  141. mirascope/api/_generated/organizations/types/organizations_update_response.py +26 -0
  142. mirascope/api/_generated/organizations/types/organizations_update_response_role.py +5 -0
  143. mirascope/api/_generated/organizations/types/organizations_update_subscription_request_target_plan.py +7 -0
  144. mirascope/api/_generated/organizations/types/organizations_update_subscription_response.py +35 -0
  145. mirascope/api/_generated/project_memberships/__init__.py +25 -0
  146. mirascope/api/_generated/project_memberships/client.py +437 -0
  147. mirascope/api/_generated/project_memberships/raw_client.py +1039 -0
  148. mirascope/api/_generated/project_memberships/types/__init__.py +29 -0
  149. mirascope/api/_generated/project_memberships/types/project_memberships_create_request_role.py +7 -0
  150. mirascope/api/_generated/project_memberships/types/project_memberships_create_response.py +35 -0
  151. mirascope/api/_generated/project_memberships/types/project_memberships_create_response_role.py +7 -0
  152. mirascope/api/_generated/project_memberships/types/project_memberships_list_response_item.py +33 -0
  153. mirascope/api/_generated/project_memberships/types/project_memberships_list_response_item_role.py +7 -0
  154. mirascope/api/_generated/project_memberships/types/project_memberships_update_request_role.py +7 -0
  155. mirascope/api/_generated/project_memberships/types/project_memberships_update_response.py +35 -0
  156. mirascope/api/_generated/project_memberships/types/project_memberships_update_response_role.py +7 -0
  157. mirascope/api/_generated/projects/__init__.py +7 -0
  158. mirascope/api/_generated/projects/client.py +428 -0
  159. mirascope/api/_generated/projects/raw_client.py +1302 -0
  160. mirascope/api/_generated/projects/types/__init__.py +10 -0
  161. mirascope/api/_generated/projects/types/projects_create_response.py +25 -0
  162. mirascope/api/_generated/projects/types/projects_get_response.py +25 -0
  163. mirascope/api/_generated/projects/types/projects_list_response_item.py +25 -0
  164. mirascope/api/_generated/projects/types/projects_update_response.py +25 -0
  165. mirascope/api/_generated/reference.md +4915 -0
  166. mirascope/api/_generated/tags/__init__.py +19 -0
  167. mirascope/api/_generated/tags/client.py +504 -0
  168. mirascope/api/_generated/tags/raw_client.py +1288 -0
  169. mirascope/api/_generated/tags/types/__init__.py +17 -0
  170. mirascope/api/_generated/tags/types/tags_create_response.py +41 -0
  171. mirascope/api/_generated/tags/types/tags_get_response.py +41 -0
  172. mirascope/api/_generated/tags/types/tags_list_response.py +23 -0
  173. mirascope/api/_generated/tags/types/tags_list_response_tags_item.py +41 -0
  174. mirascope/api/_generated/tags/types/tags_update_response.py +41 -0
  175. mirascope/api/_generated/token_cost/__init__.py +7 -0
  176. mirascope/api/_generated/token_cost/client.py +160 -0
  177. mirascope/api/_generated/token_cost/raw_client.py +264 -0
  178. mirascope/api/_generated/token_cost/types/__init__.py +8 -0
  179. mirascope/api/_generated/token_cost/types/token_cost_calculate_request_usage.py +54 -0
  180. mirascope/api/_generated/token_cost/types/token_cost_calculate_response.py +52 -0
  181. mirascope/api/_generated/traces/__init__.py +97 -0
  182. mirascope/api/_generated/traces/client.py +1103 -0
  183. mirascope/api/_generated/traces/raw_client.py +2322 -0
  184. mirascope/api/_generated/traces/types/__init__.py +155 -0
  185. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item.py +29 -0
  186. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource.py +27 -0
  187. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item.py +23 -0
  188. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value.py +38 -0
  189. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_array_value.py +19 -0
  190. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_kvlist_value.py +22 -0
  191. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_kvlist_value_values_item.py +20 -0
  192. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item.py +29 -0
  193. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope.py +31 -0
  194. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item.py +23 -0
  195. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value.py +38 -0
  196. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_array_value.py +19 -0
  197. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_kvlist_value.py +22 -0
  198. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_kvlist_value_values_item.py +22 -0
  199. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item.py +48 -0
  200. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item.py +23 -0
  201. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value.py +38 -0
  202. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_array_value.py +19 -0
  203. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_kvlist_value.py +24 -0
  204. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_kvlist_value_values_item.py +22 -0
  205. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_status.py +20 -0
  206. mirascope/api/_generated/traces/types/traces_create_response.py +24 -0
  207. mirascope/api/_generated/traces/types/traces_create_response_partial_success.py +22 -0
  208. mirascope/api/_generated/traces/types/traces_get_analytics_summary_response.py +60 -0
  209. mirascope/api/_generated/traces/types/traces_get_analytics_summary_response_top_functions_item.py +24 -0
  210. mirascope/api/_generated/traces/types/traces_get_analytics_summary_response_top_models_item.py +22 -0
  211. mirascope/api/_generated/traces/types/traces_get_trace_detail_by_env_response.py +33 -0
  212. mirascope/api/_generated/traces/types/traces_get_trace_detail_by_env_response_spans_item.py +88 -0
  213. mirascope/api/_generated/traces/types/traces_get_trace_detail_response.py +33 -0
  214. mirascope/api/_generated/traces/types/traces_get_trace_detail_response_spans_item.py +88 -0
  215. mirascope/api/_generated/traces/types/traces_list_by_function_hash_response.py +25 -0
  216. mirascope/api/_generated/traces/types/traces_list_by_function_hash_response_traces_item.py +44 -0
  217. mirascope/api/_generated/traces/types/traces_search_by_env_request_attribute_filters_item.py +26 -0
  218. mirascope/api/_generated/traces/types/traces_search_by_env_request_attribute_filters_item_operator.py +7 -0
  219. mirascope/api/_generated/traces/types/traces_search_by_env_request_sort_by.py +7 -0
  220. mirascope/api/_generated/traces/types/traces_search_by_env_request_sort_order.py +7 -0
  221. mirascope/api/_generated/traces/types/traces_search_by_env_response.py +26 -0
  222. mirascope/api/_generated/traces/types/traces_search_by_env_response_spans_item.py +50 -0
  223. mirascope/api/_generated/traces/types/traces_search_request_attribute_filters_item.py +26 -0
  224. mirascope/api/_generated/traces/types/traces_search_request_attribute_filters_item_operator.py +7 -0
  225. mirascope/api/_generated/traces/types/traces_search_request_sort_by.py +7 -0
  226. mirascope/api/_generated/traces/types/traces_search_request_sort_order.py +5 -0
  227. mirascope/api/_generated/traces/types/traces_search_response.py +26 -0
  228. mirascope/api/_generated/traces/types/traces_search_response_spans_item.py +50 -0
  229. mirascope/api/_generated/types/__init__.py +85 -0
  230. mirascope/api/_generated/types/already_exists_error.py +22 -0
  231. mirascope/api/_generated/types/already_exists_error_tag.py +5 -0
  232. mirascope/api/_generated/types/bad_request_error_body.py +50 -0
  233. mirascope/api/_generated/types/click_house_error.py +22 -0
  234. mirascope/api/_generated/types/database_error.py +22 -0
  235. mirascope/api/_generated/types/database_error_tag.py +5 -0
  236. mirascope/api/_generated/types/date.py +3 -0
  237. mirascope/api/_generated/types/http_api_decode_error.py +27 -0
  238. mirascope/api/_generated/types/http_api_decode_error_tag.py +5 -0
  239. mirascope/api/_generated/types/immutable_resource_error.py +22 -0
  240. mirascope/api/_generated/types/internal_server_error_body.py +49 -0
  241. mirascope/api/_generated/types/issue.py +38 -0
  242. mirascope/api/_generated/types/issue_tag.py +10 -0
  243. mirascope/api/_generated/types/not_found_error_body.py +22 -0
  244. mirascope/api/_generated/types/not_found_error_tag.py +5 -0
  245. mirascope/api/_generated/types/number_from_string.py +3 -0
  246. mirascope/api/_generated/types/permission_denied_error.py +22 -0
  247. mirascope/api/_generated/types/permission_denied_error_tag.py +5 -0
  248. mirascope/api/_generated/types/plan_limit_exceeded_error.py +32 -0
  249. mirascope/api/_generated/types/plan_limit_exceeded_error_tag.py +7 -0
  250. mirascope/api/_generated/types/pricing_unavailable_error.py +23 -0
  251. mirascope/api/_generated/types/property_key.py +7 -0
  252. mirascope/api/_generated/types/property_key_key.py +25 -0
  253. mirascope/api/_generated/types/property_key_key_tag.py +5 -0
  254. mirascope/api/_generated/types/rate_limit_error.py +31 -0
  255. mirascope/api/_generated/types/rate_limit_error_tag.py +5 -0
  256. mirascope/api/_generated/types/service_unavailable_error_body.py +24 -0
  257. mirascope/api/_generated/types/service_unavailable_error_tag.py +7 -0
  258. mirascope/api/_generated/types/stripe_error.py +20 -0
  259. mirascope/api/_generated/types/subscription_past_due_error.py +31 -0
  260. mirascope/api/_generated/types/subscription_past_due_error_tag.py +7 -0
  261. mirascope/api/_generated/types/unauthorized_error_body.py +21 -0
  262. mirascope/api/_generated/types/unauthorized_error_tag.py +5 -0
  263. mirascope/api/client.py +255 -0
  264. mirascope/api/settings.py +99 -0
  265. mirascope/llm/__init__.py +290 -15
  266. mirascope/llm/calls/__init__.py +17 -0
  267. mirascope/llm/calls/calls.py +341 -0
  268. mirascope/llm/calls/decorator.py +275 -0
  269. mirascope/llm/content/__init__.py +71 -0
  270. mirascope/llm/content/audio.py +173 -0
  271. mirascope/llm/content/document.py +94 -0
  272. mirascope/llm/content/image.py +206 -0
  273. mirascope/llm/content/text.py +47 -0
  274. mirascope/llm/content/thought.py +58 -0
  275. mirascope/llm/content/tool_call.py +69 -0
  276. mirascope/llm/content/tool_output.py +43 -0
  277. mirascope/llm/context/__init__.py +6 -0
  278. mirascope/llm/context/_utils.py +41 -0
  279. mirascope/llm/context/context.py +24 -0
  280. mirascope/llm/exceptions.py +360 -0
  281. mirascope/llm/formatting/__init__.py +39 -0
  282. mirascope/llm/formatting/format.py +293 -0
  283. mirascope/llm/formatting/from_call_args.py +30 -0
  284. mirascope/llm/formatting/output_parser.py +178 -0
  285. mirascope/llm/formatting/partial.py +131 -0
  286. mirascope/llm/formatting/primitives.py +192 -0
  287. mirascope/llm/formatting/types.py +66 -0
  288. mirascope/llm/mcp/__init__.py +5 -0
  289. mirascope/llm/mcp/mcp_client.py +130 -0
  290. mirascope/llm/messages/__init__.py +35 -0
  291. mirascope/llm/messages/_utils.py +34 -0
  292. mirascope/llm/messages/message.py +190 -0
  293. mirascope/llm/models/__init__.py +21 -0
  294. mirascope/llm/models/models.py +1419 -0
  295. mirascope/llm/models/params.py +72 -0
  296. mirascope/llm/models/thinking_config.py +61 -0
  297. mirascope/llm/prompts/__init__.py +34 -0
  298. mirascope/llm/prompts/_utils.py +31 -0
  299. mirascope/llm/prompts/decorator.py +226 -0
  300. mirascope/llm/prompts/prompts.py +487 -0
  301. mirascope/llm/prompts/protocols.py +65 -0
  302. mirascope/llm/providers/__init__.py +62 -0
  303. mirascope/llm/providers/anthropic/__init__.py +11 -0
  304. mirascope/llm/providers/anthropic/_utils/__init__.py +27 -0
  305. mirascope/llm/providers/anthropic/_utils/beta_decode.py +282 -0
  306. mirascope/llm/providers/anthropic/_utils/beta_encode.py +266 -0
  307. mirascope/llm/providers/anthropic/_utils/decode.py +288 -0
  308. mirascope/llm/providers/anthropic/_utils/encode.py +418 -0
  309. mirascope/llm/providers/anthropic/_utils/errors.py +46 -0
  310. mirascope/llm/providers/anthropic/beta_provider.py +374 -0
  311. mirascope/llm/providers/anthropic/model_id.py +23 -0
  312. mirascope/llm/providers/anthropic/model_info.py +87 -0
  313. mirascope/llm/providers/anthropic/provider.py +479 -0
  314. mirascope/llm/providers/base/__init__.py +14 -0
  315. mirascope/llm/providers/base/_utils.py +253 -0
  316. mirascope/llm/providers/base/base_provider.py +1579 -0
  317. mirascope/llm/providers/base/kwargs.py +12 -0
  318. mirascope/llm/providers/google/__init__.py +6 -0
  319. mirascope/llm/providers/google/_utils/__init__.py +17 -0
  320. mirascope/llm/providers/google/_utils/decode.py +307 -0
  321. mirascope/llm/providers/google/_utils/encode.py +401 -0
  322. mirascope/llm/providers/google/_utils/errors.py +50 -0
  323. mirascope/llm/providers/google/message.py +7 -0
  324. mirascope/llm/providers/google/model_id.py +22 -0
  325. mirascope/llm/providers/google/model_info.py +63 -0
  326. mirascope/llm/providers/google/provider.py +492 -0
  327. mirascope/llm/providers/mirascope/__init__.py +5 -0
  328. mirascope/llm/providers/mirascope/_utils.py +73 -0
  329. mirascope/llm/providers/mirascope/provider.py +349 -0
  330. mirascope/llm/providers/mlx/__init__.py +9 -0
  331. mirascope/llm/providers/mlx/_utils.py +141 -0
  332. mirascope/llm/providers/mlx/encoding/__init__.py +8 -0
  333. mirascope/llm/providers/mlx/encoding/base.py +72 -0
  334. mirascope/llm/providers/mlx/encoding/transformers.py +150 -0
  335. mirascope/llm/providers/mlx/mlx.py +254 -0
  336. mirascope/llm/providers/mlx/model_id.py +17 -0
  337. mirascope/llm/providers/mlx/provider.py +452 -0
  338. mirascope/llm/providers/model_id.py +16 -0
  339. mirascope/llm/providers/ollama/__init__.py +7 -0
  340. mirascope/llm/providers/ollama/provider.py +71 -0
  341. mirascope/llm/providers/openai/__init__.py +15 -0
  342. mirascope/llm/providers/openai/_utils/__init__.py +5 -0
  343. mirascope/llm/providers/openai/_utils/errors.py +46 -0
  344. mirascope/llm/providers/openai/completions/__init__.py +7 -0
  345. mirascope/llm/providers/openai/completions/_utils/__init__.py +15 -0
  346. mirascope/llm/providers/openai/completions/_utils/decode.py +252 -0
  347. mirascope/llm/providers/openai/completions/_utils/encode.py +376 -0
  348. mirascope/llm/providers/openai/completions/base_provider.py +542 -0
  349. mirascope/llm/providers/openai/completions/provider.py +22 -0
  350. mirascope/llm/providers/openai/model_id.py +31 -0
  351. mirascope/llm/providers/openai/model_info.py +303 -0
  352. mirascope/llm/providers/openai/provider.py +441 -0
  353. mirascope/llm/providers/openai/responses/__init__.py +5 -0
  354. mirascope/llm/providers/openai/responses/_utils/__init__.py +15 -0
  355. mirascope/llm/providers/openai/responses/_utils/decode.py +260 -0
  356. mirascope/llm/providers/openai/responses/_utils/encode.py +384 -0
  357. mirascope/llm/providers/openai/responses/provider.py +513 -0
  358. mirascope/llm/providers/provider_id.py +24 -0
  359. mirascope/llm/providers/provider_registry.py +299 -0
  360. mirascope/llm/providers/together/__init__.py +7 -0
  361. mirascope/llm/providers/together/provider.py +40 -0
  362. mirascope/llm/responses/__init__.py +65 -0
  363. mirascope/llm/responses/_utils.py +146 -0
  364. mirascope/llm/responses/base_response.py +103 -0
  365. mirascope/llm/responses/base_stream_response.py +820 -0
  366. mirascope/llm/responses/finish_reason.py +28 -0
  367. mirascope/llm/responses/response.py +366 -0
  368. mirascope/llm/responses/root_response.py +248 -0
  369. mirascope/llm/responses/stream_response.py +581 -0
  370. mirascope/llm/responses/streams.py +363 -0
  371. mirascope/llm/responses/usage.py +95 -0
  372. mirascope/llm/tools/__init__.py +47 -0
  373. mirascope/llm/tools/_utils.py +34 -0
  374. mirascope/llm/tools/decorator.py +184 -0
  375. mirascope/llm/tools/protocols.py +96 -0
  376. mirascope/llm/tools/tool_schema.py +314 -0
  377. mirascope/llm/tools/toolkit.py +160 -0
  378. mirascope/llm/tools/tools.py +263 -0
  379. mirascope/llm/types/__init__.py +22 -0
  380. mirascope/llm/types/dataclass.py +9 -0
  381. mirascope/llm/types/jsonable.py +44 -0
  382. mirascope/llm/types/type_vars.py +19 -0
  383. mirascope/ops/__init__.py +111 -0
  384. mirascope/ops/_internal/__init__.py +5 -0
  385. mirascope/ops/_internal/closure.py +1169 -0
  386. mirascope/ops/_internal/configuration.py +177 -0
  387. mirascope/ops/_internal/context.py +76 -0
  388. mirascope/ops/_internal/exporters/__init__.py +26 -0
  389. mirascope/ops/_internal/exporters/exporters.py +395 -0
  390. mirascope/ops/_internal/exporters/processors.py +104 -0
  391. mirascope/ops/_internal/exporters/types.py +165 -0
  392. mirascope/ops/_internal/exporters/utils.py +29 -0
  393. mirascope/ops/_internal/instrumentation/__init__.py +8 -0
  394. mirascope/ops/_internal/instrumentation/llm/__init__.py +8 -0
  395. mirascope/ops/_internal/instrumentation/llm/common.py +530 -0
  396. mirascope/ops/_internal/instrumentation/llm/cost.py +190 -0
  397. mirascope/ops/_internal/instrumentation/llm/encode.py +238 -0
  398. mirascope/ops/_internal/instrumentation/llm/gen_ai_types/__init__.py +38 -0
  399. mirascope/ops/_internal/instrumentation/llm/gen_ai_types/gen_ai_input_messages.py +31 -0
  400. mirascope/ops/_internal/instrumentation/llm/gen_ai_types/gen_ai_output_messages.py +38 -0
  401. mirascope/ops/_internal/instrumentation/llm/gen_ai_types/gen_ai_system_instructions.py +18 -0
  402. mirascope/ops/_internal/instrumentation/llm/gen_ai_types/shared.py +100 -0
  403. mirascope/ops/_internal/instrumentation/llm/llm.py +161 -0
  404. mirascope/ops/_internal/instrumentation/llm/model.py +1798 -0
  405. mirascope/ops/_internal/instrumentation/llm/response.py +521 -0
  406. mirascope/ops/_internal/instrumentation/llm/serialize.py +300 -0
  407. mirascope/ops/_internal/propagation.py +198 -0
  408. mirascope/ops/_internal/protocols.py +133 -0
  409. mirascope/ops/_internal/session.py +139 -0
  410. mirascope/ops/_internal/spans.py +232 -0
  411. mirascope/ops/_internal/traced_calls.py +375 -0
  412. mirascope/ops/_internal/traced_functions.py +523 -0
  413. mirascope/ops/_internal/tracing.py +353 -0
  414. mirascope/ops/_internal/types.py +13 -0
  415. mirascope/ops/_internal/utils.py +123 -0
  416. mirascope/ops/_internal/versioned_calls.py +512 -0
  417. mirascope/ops/_internal/versioned_functions.py +357 -0
  418. mirascope/ops/_internal/versioning.py +303 -0
  419. mirascope/ops/exceptions.py +21 -0
  420. mirascope-2.0.0.dist-info/METADATA +203 -0
  421. mirascope-2.0.0.dist-info/RECORD +423 -0
  422. {mirascope-1.25.7.dist-info → mirascope-2.0.0.dist-info}/WHEEL +1 -1
  423. {mirascope-1.25.7.dist-info → mirascope-2.0.0.dist-info}/licenses/LICENSE +1 -1
  424. mirascope/beta/__init__.py +0 -3
  425. mirascope/beta/openai/__init__.py +0 -17
  426. mirascope/beta/openai/realtime/__init__.py +0 -13
  427. mirascope/beta/openai/realtime/_utils/__init__.py +0 -3
  428. mirascope/beta/openai/realtime/_utils/_audio.py +0 -74
  429. mirascope/beta/openai/realtime/_utils/_protocols.py +0 -50
  430. mirascope/beta/openai/realtime/realtime.py +0 -500
  431. mirascope/beta/openai/realtime/recording.py +0 -98
  432. mirascope/beta/openai/realtime/tool.py +0 -113
  433. mirascope/beta/rag/__init__.py +0 -24
  434. mirascope/beta/rag/base/__init__.py +0 -22
  435. mirascope/beta/rag/base/chunkers/__init__.py +0 -2
  436. mirascope/beta/rag/base/chunkers/base_chunker.py +0 -37
  437. mirascope/beta/rag/base/chunkers/text_chunker.py +0 -33
  438. mirascope/beta/rag/base/config.py +0 -8
  439. mirascope/beta/rag/base/document.py +0 -11
  440. mirascope/beta/rag/base/embedders.py +0 -35
  441. mirascope/beta/rag/base/embedding_params.py +0 -18
  442. mirascope/beta/rag/base/embedding_response.py +0 -30
  443. mirascope/beta/rag/base/query_results.py +0 -7
  444. mirascope/beta/rag/base/vectorstore_params.py +0 -18
  445. mirascope/beta/rag/base/vectorstores.py +0 -37
  446. mirascope/beta/rag/chroma/__init__.py +0 -11
  447. mirascope/beta/rag/chroma/types.py +0 -62
  448. mirascope/beta/rag/chroma/vectorstores.py +0 -121
  449. mirascope/beta/rag/cohere/__init__.py +0 -11
  450. mirascope/beta/rag/cohere/embedders.py +0 -87
  451. mirascope/beta/rag/cohere/embedding_params.py +0 -29
  452. mirascope/beta/rag/cohere/embedding_response.py +0 -29
  453. mirascope/beta/rag/cohere/py.typed +0 -0
  454. mirascope/beta/rag/openai/__init__.py +0 -11
  455. mirascope/beta/rag/openai/embedders.py +0 -144
  456. mirascope/beta/rag/openai/embedding_params.py +0 -18
  457. mirascope/beta/rag/openai/embedding_response.py +0 -14
  458. mirascope/beta/rag/openai/py.typed +0 -0
  459. mirascope/beta/rag/pinecone/__init__.py +0 -19
  460. mirascope/beta/rag/pinecone/types.py +0 -143
  461. mirascope/beta/rag/pinecone/vectorstores.py +0 -148
  462. mirascope/beta/rag/weaviate/__init__.py +0 -6
  463. mirascope/beta/rag/weaviate/types.py +0 -92
  464. mirascope/beta/rag/weaviate/vectorstores.py +0 -103
  465. mirascope/core/__init__.py +0 -109
  466. mirascope/core/anthropic/__init__.py +0 -31
  467. mirascope/core/anthropic/_call.py +0 -67
  468. mirascope/core/anthropic/_call_kwargs.py +0 -13
  469. mirascope/core/anthropic/_thinking.py +0 -70
  470. mirascope/core/anthropic/_utils/__init__.py +0 -16
  471. mirascope/core/anthropic/_utils/_convert_common_call_params.py +0 -25
  472. mirascope/core/anthropic/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -21
  473. mirascope/core/anthropic/_utils/_convert_message_params.py +0 -102
  474. mirascope/core/anthropic/_utils/_get_json_output.py +0 -31
  475. mirascope/core/anthropic/_utils/_handle_stream.py +0 -113
  476. mirascope/core/anthropic/_utils/_message_param_converter.py +0 -154
  477. mirascope/core/anthropic/_utils/_setup_call.py +0 -146
  478. mirascope/core/anthropic/call_params.py +0 -44
  479. mirascope/core/anthropic/call_response.py +0 -226
  480. mirascope/core/anthropic/call_response_chunk.py +0 -152
  481. mirascope/core/anthropic/dynamic_config.py +0 -40
  482. mirascope/core/anthropic/py.typed +0 -0
  483. mirascope/core/anthropic/stream.py +0 -204
  484. mirascope/core/anthropic/tool.py +0 -101
  485. mirascope/core/azure/__init__.py +0 -31
  486. mirascope/core/azure/_call.py +0 -67
  487. mirascope/core/azure/_call_kwargs.py +0 -13
  488. mirascope/core/azure/_utils/__init__.py +0 -14
  489. mirascope/core/azure/_utils/_convert_common_call_params.py +0 -26
  490. mirascope/core/azure/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -21
  491. mirascope/core/azure/_utils/_convert_message_params.py +0 -121
  492. mirascope/core/azure/_utils/_get_credential.py +0 -33
  493. mirascope/core/azure/_utils/_get_json_output.py +0 -27
  494. mirascope/core/azure/_utils/_handle_stream.py +0 -130
  495. mirascope/core/azure/_utils/_message_param_converter.py +0 -117
  496. mirascope/core/azure/_utils/_setup_call.py +0 -183
  497. mirascope/core/azure/call_params.py +0 -59
  498. mirascope/core/azure/call_response.py +0 -215
  499. mirascope/core/azure/call_response_chunk.py +0 -105
  500. mirascope/core/azure/dynamic_config.py +0 -30
  501. mirascope/core/azure/py.typed +0 -0
  502. mirascope/core/azure/stream.py +0 -147
  503. mirascope/core/azure/tool.py +0 -93
  504. mirascope/core/base/__init__.py +0 -86
  505. mirascope/core/base/_call_factory.py +0 -256
  506. mirascope/core/base/_create.py +0 -253
  507. mirascope/core/base/_extract.py +0 -175
  508. mirascope/core/base/_extract_with_tools.py +0 -189
  509. mirascope/core/base/_partial.py +0 -95
  510. mirascope/core/base/_utils/__init__.py +0 -92
  511. mirascope/core/base/_utils/_base_message_param_converter.py +0 -22
  512. mirascope/core/base/_utils/_base_type.py +0 -26
  513. mirascope/core/base/_utils/_convert_base_model_to_base_tool.py +0 -48
  514. mirascope/core/base/_utils/_convert_base_type_to_base_tool.py +0 -24
  515. mirascope/core/base/_utils/_convert_function_to_base_tool.py +0 -139
  516. mirascope/core/base/_utils/_convert_messages_to_message_params.py +0 -178
  517. mirascope/core/base/_utils/_convert_provider_finish_reason_to_finish_reason.py +0 -20
  518. mirascope/core/base/_utils/_default_tool_docstring.py +0 -6
  519. mirascope/core/base/_utils/_extract_tool_return.py +0 -42
  520. mirascope/core/base/_utils/_fn_is_async.py +0 -24
  521. mirascope/core/base/_utils/_format_template.py +0 -32
  522. mirascope/core/base/_utils/_get_audio_type.py +0 -18
  523. mirascope/core/base/_utils/_get_common_usage.py +0 -20
  524. mirascope/core/base/_utils/_get_create_fn_or_async_create_fn.py +0 -137
  525. mirascope/core/base/_utils/_get_document_type.py +0 -7
  526. mirascope/core/base/_utils/_get_dynamic_configuration.py +0 -69
  527. mirascope/core/base/_utils/_get_fields_from_call_args.py +0 -34
  528. mirascope/core/base/_utils/_get_fn_args.py +0 -23
  529. mirascope/core/base/_utils/_get_image_dimensions.py +0 -39
  530. mirascope/core/base/_utils/_get_image_type.py +0 -26
  531. mirascope/core/base/_utils/_get_metadata.py +0 -17
  532. mirascope/core/base/_utils/_get_possible_user_message_param.py +0 -21
  533. mirascope/core/base/_utils/_get_prompt_template.py +0 -28
  534. mirascope/core/base/_utils/_get_template_values.py +0 -51
  535. mirascope/core/base/_utils/_get_template_variables.py +0 -38
  536. mirascope/core/base/_utils/_get_unsupported_tool_config_keys.py +0 -10
  537. mirascope/core/base/_utils/_is_prompt_template.py +0 -24
  538. mirascope/core/base/_utils/_json_mode_content.py +0 -17
  539. mirascope/core/base/_utils/_messages_decorator.py +0 -121
  540. mirascope/core/base/_utils/_parse_content_template.py +0 -323
  541. mirascope/core/base/_utils/_parse_prompt_messages.py +0 -63
  542. mirascope/core/base/_utils/_pil_image_to_bytes.py +0 -13
  543. mirascope/core/base/_utils/_protocols.py +0 -901
  544. mirascope/core/base/_utils/_setup_call.py +0 -79
  545. mirascope/core/base/_utils/_setup_extract_tool.py +0 -30
  546. mirascope/core/base/call_kwargs.py +0 -13
  547. mirascope/core/base/call_params.py +0 -36
  548. mirascope/core/base/call_response.py +0 -338
  549. mirascope/core/base/call_response_chunk.py +0 -130
  550. mirascope/core/base/dynamic_config.py +0 -82
  551. mirascope/core/base/from_call_args.py +0 -30
  552. mirascope/core/base/merge_decorators.py +0 -59
  553. mirascope/core/base/message_param.py +0 -175
  554. mirascope/core/base/messages.py +0 -116
  555. mirascope/core/base/metadata.py +0 -13
  556. mirascope/core/base/prompt.py +0 -497
  557. mirascope/core/base/response_model_config_dict.py +0 -9
  558. mirascope/core/base/stream.py +0 -479
  559. mirascope/core/base/stream_config.py +0 -11
  560. mirascope/core/base/structured_stream.py +0 -296
  561. mirascope/core/base/tool.py +0 -214
  562. mirascope/core/base/toolkit.py +0 -176
  563. mirascope/core/base/types.py +0 -344
  564. mirascope/core/bedrock/__init__.py +0 -34
  565. mirascope/core/bedrock/_call.py +0 -68
  566. mirascope/core/bedrock/_call_kwargs.py +0 -12
  567. mirascope/core/bedrock/_types.py +0 -104
  568. mirascope/core/bedrock/_utils/__init__.py +0 -14
  569. mirascope/core/bedrock/_utils/_convert_common_call_params.py +0 -39
  570. mirascope/core/bedrock/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -23
  571. mirascope/core/bedrock/_utils/_convert_message_params.py +0 -111
  572. mirascope/core/bedrock/_utils/_get_json_output.py +0 -30
  573. mirascope/core/bedrock/_utils/_handle_stream.py +0 -104
  574. mirascope/core/bedrock/_utils/_message_param_converter.py +0 -172
  575. mirascope/core/bedrock/_utils/_setup_call.py +0 -258
  576. mirascope/core/bedrock/call_params.py +0 -38
  577. mirascope/core/bedrock/call_response.py +0 -248
  578. mirascope/core/bedrock/call_response_chunk.py +0 -111
  579. mirascope/core/bedrock/dynamic_config.py +0 -37
  580. mirascope/core/bedrock/py.typed +0 -0
  581. mirascope/core/bedrock/stream.py +0 -154
  582. mirascope/core/bedrock/tool.py +0 -100
  583. mirascope/core/cohere/__init__.py +0 -30
  584. mirascope/core/cohere/_call.py +0 -67
  585. mirascope/core/cohere/_call_kwargs.py +0 -11
  586. mirascope/core/cohere/_types.py +0 -20
  587. mirascope/core/cohere/_utils/__init__.py +0 -14
  588. mirascope/core/cohere/_utils/_convert_common_call_params.py +0 -26
  589. mirascope/core/cohere/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -24
  590. mirascope/core/cohere/_utils/_convert_message_params.py +0 -32
  591. mirascope/core/cohere/_utils/_get_json_output.py +0 -30
  592. mirascope/core/cohere/_utils/_handle_stream.py +0 -35
  593. mirascope/core/cohere/_utils/_message_param_converter.py +0 -54
  594. mirascope/core/cohere/_utils/_setup_call.py +0 -150
  595. mirascope/core/cohere/call_params.py +0 -62
  596. mirascope/core/cohere/call_response.py +0 -205
  597. mirascope/core/cohere/call_response_chunk.py +0 -125
  598. mirascope/core/cohere/dynamic_config.py +0 -32
  599. mirascope/core/cohere/py.typed +0 -0
  600. mirascope/core/cohere/stream.py +0 -113
  601. mirascope/core/cohere/tool.py +0 -93
  602. mirascope/core/costs/__init__.py +0 -5
  603. mirascope/core/costs/_anthropic_calculate_cost.py +0 -219
  604. mirascope/core/costs/_azure_calculate_cost.py +0 -11
  605. mirascope/core/costs/_bedrock_calculate_cost.py +0 -15
  606. mirascope/core/costs/_cohere_calculate_cost.py +0 -44
  607. mirascope/core/costs/_gemini_calculate_cost.py +0 -67
  608. mirascope/core/costs/_google_calculate_cost.py +0 -427
  609. mirascope/core/costs/_groq_calculate_cost.py +0 -156
  610. mirascope/core/costs/_litellm_calculate_cost.py +0 -11
  611. mirascope/core/costs/_mistral_calculate_cost.py +0 -64
  612. mirascope/core/costs/_openai_calculate_cost.py +0 -416
  613. mirascope/core/costs/_vertex_calculate_cost.py +0 -67
  614. mirascope/core/costs/_xai_calculate_cost.py +0 -104
  615. mirascope/core/costs/calculate_cost.py +0 -86
  616. mirascope/core/gemini/__init__.py +0 -40
  617. mirascope/core/gemini/_call.py +0 -67
  618. mirascope/core/gemini/_call_kwargs.py +0 -12
  619. mirascope/core/gemini/_utils/__init__.py +0 -14
  620. mirascope/core/gemini/_utils/_convert_common_call_params.py +0 -39
  621. mirascope/core/gemini/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -23
  622. mirascope/core/gemini/_utils/_convert_message_params.py +0 -156
  623. mirascope/core/gemini/_utils/_get_json_output.py +0 -35
  624. mirascope/core/gemini/_utils/_handle_stream.py +0 -33
  625. mirascope/core/gemini/_utils/_message_param_converter.py +0 -209
  626. mirascope/core/gemini/_utils/_setup_call.py +0 -149
  627. mirascope/core/gemini/call_params.py +0 -52
  628. mirascope/core/gemini/call_response.py +0 -216
  629. mirascope/core/gemini/call_response_chunk.py +0 -100
  630. mirascope/core/gemini/dynamic_config.py +0 -26
  631. mirascope/core/gemini/stream.py +0 -120
  632. mirascope/core/gemini/tool.py +0 -104
  633. mirascope/core/google/__init__.py +0 -29
  634. mirascope/core/google/_call.py +0 -67
  635. mirascope/core/google/_call_kwargs.py +0 -13
  636. mirascope/core/google/_utils/__init__.py +0 -14
  637. mirascope/core/google/_utils/_convert_common_call_params.py +0 -38
  638. mirascope/core/google/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -27
  639. mirascope/core/google/_utils/_convert_message_params.py +0 -297
  640. mirascope/core/google/_utils/_get_json_output.py +0 -37
  641. mirascope/core/google/_utils/_handle_stream.py +0 -58
  642. mirascope/core/google/_utils/_message_param_converter.py +0 -200
  643. mirascope/core/google/_utils/_setup_call.py +0 -201
  644. mirascope/core/google/_utils/_validate_media_type.py +0 -58
  645. mirascope/core/google/call_params.py +0 -22
  646. mirascope/core/google/call_response.py +0 -255
  647. mirascope/core/google/call_response_chunk.py +0 -135
  648. mirascope/core/google/dynamic_config.py +0 -26
  649. mirascope/core/google/stream.py +0 -199
  650. mirascope/core/google/tool.py +0 -146
  651. mirascope/core/groq/__init__.py +0 -30
  652. mirascope/core/groq/_call.py +0 -67
  653. mirascope/core/groq/_call_kwargs.py +0 -13
  654. mirascope/core/groq/_utils/__init__.py +0 -14
  655. mirascope/core/groq/_utils/_convert_common_call_params.py +0 -26
  656. mirascope/core/groq/_utils/_convert_message_params.py +0 -112
  657. mirascope/core/groq/_utils/_get_json_output.py +0 -27
  658. mirascope/core/groq/_utils/_handle_stream.py +0 -123
  659. mirascope/core/groq/_utils/_message_param_converter.py +0 -89
  660. mirascope/core/groq/_utils/_setup_call.py +0 -132
  661. mirascope/core/groq/call_params.py +0 -52
  662. mirascope/core/groq/call_response.py +0 -213
  663. mirascope/core/groq/call_response_chunk.py +0 -104
  664. mirascope/core/groq/dynamic_config.py +0 -29
  665. mirascope/core/groq/py.typed +0 -0
  666. mirascope/core/groq/stream.py +0 -135
  667. mirascope/core/groq/tool.py +0 -80
  668. mirascope/core/litellm/__init__.py +0 -28
  669. mirascope/core/litellm/_call.py +0 -67
  670. mirascope/core/litellm/_utils/__init__.py +0 -5
  671. mirascope/core/litellm/_utils/_setup_call.py +0 -109
  672. mirascope/core/litellm/call_params.py +0 -10
  673. mirascope/core/litellm/call_response.py +0 -24
  674. mirascope/core/litellm/call_response_chunk.py +0 -14
  675. mirascope/core/litellm/dynamic_config.py +0 -8
  676. mirascope/core/litellm/py.typed +0 -0
  677. mirascope/core/litellm/stream.py +0 -86
  678. mirascope/core/litellm/tool.py +0 -13
  679. mirascope/core/mistral/__init__.py +0 -36
  680. mirascope/core/mistral/_call.py +0 -65
  681. mirascope/core/mistral/_call_kwargs.py +0 -19
  682. mirascope/core/mistral/_utils/__init__.py +0 -14
  683. mirascope/core/mistral/_utils/_convert_common_call_params.py +0 -24
  684. mirascope/core/mistral/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -22
  685. mirascope/core/mistral/_utils/_convert_message_params.py +0 -122
  686. mirascope/core/mistral/_utils/_get_json_output.py +0 -34
  687. mirascope/core/mistral/_utils/_handle_stream.py +0 -139
  688. mirascope/core/mistral/_utils/_message_param_converter.py +0 -176
  689. mirascope/core/mistral/_utils/_setup_call.py +0 -164
  690. mirascope/core/mistral/call_params.py +0 -36
  691. mirascope/core/mistral/call_response.py +0 -205
  692. mirascope/core/mistral/call_response_chunk.py +0 -105
  693. mirascope/core/mistral/dynamic_config.py +0 -33
  694. mirascope/core/mistral/py.typed +0 -0
  695. mirascope/core/mistral/stream.py +0 -120
  696. mirascope/core/mistral/tool.py +0 -81
  697. mirascope/core/openai/__init__.py +0 -31
  698. mirascope/core/openai/_call.py +0 -67
  699. mirascope/core/openai/_call_kwargs.py +0 -13
  700. mirascope/core/openai/_utils/__init__.py +0 -14
  701. mirascope/core/openai/_utils/_convert_common_call_params.py +0 -26
  702. mirascope/core/openai/_utils/_convert_message_params.py +0 -148
  703. mirascope/core/openai/_utils/_get_json_output.py +0 -31
  704. mirascope/core/openai/_utils/_handle_stream.py +0 -138
  705. mirascope/core/openai/_utils/_message_param_converter.py +0 -105
  706. mirascope/core/openai/_utils/_setup_call.py +0 -155
  707. mirascope/core/openai/call_params.py +0 -92
  708. mirascope/core/openai/call_response.py +0 -273
  709. mirascope/core/openai/call_response_chunk.py +0 -139
  710. mirascope/core/openai/dynamic_config.py +0 -34
  711. mirascope/core/openai/py.typed +0 -0
  712. mirascope/core/openai/stream.py +0 -185
  713. mirascope/core/openai/tool.py +0 -101
  714. mirascope/core/py.typed +0 -0
  715. mirascope/core/vertex/__init__.py +0 -45
  716. mirascope/core/vertex/_call.py +0 -62
  717. mirascope/core/vertex/_call_kwargs.py +0 -12
  718. mirascope/core/vertex/_utils/__init__.py +0 -14
  719. mirascope/core/vertex/_utils/_convert_common_call_params.py +0 -37
  720. mirascope/core/vertex/_utils/_convert_finish_reason_to_common_finish_reasons.py +0 -23
  721. mirascope/core/vertex/_utils/_convert_message_params.py +0 -171
  722. mirascope/core/vertex/_utils/_get_json_output.py +0 -36
  723. mirascope/core/vertex/_utils/_handle_stream.py +0 -33
  724. mirascope/core/vertex/_utils/_message_param_converter.py +0 -133
  725. mirascope/core/vertex/_utils/_setup_call.py +0 -160
  726. mirascope/core/vertex/call_params.py +0 -24
  727. mirascope/core/vertex/call_response.py +0 -206
  728. mirascope/core/vertex/call_response_chunk.py +0 -99
  729. mirascope/core/vertex/dynamic_config.py +0 -28
  730. mirascope/core/vertex/stream.py +0 -119
  731. mirascope/core/vertex/tool.py +0 -101
  732. mirascope/core/xai/__init__.py +0 -28
  733. mirascope/core/xai/_call.py +0 -67
  734. mirascope/core/xai/_utils/__init__.py +0 -5
  735. mirascope/core/xai/_utils/_setup_call.py +0 -113
  736. mirascope/core/xai/call_params.py +0 -10
  737. mirascope/core/xai/call_response.py +0 -16
  738. mirascope/core/xai/call_response_chunk.py +0 -14
  739. mirascope/core/xai/dynamic_config.py +0 -8
  740. mirascope/core/xai/py.typed +0 -0
  741. mirascope/core/xai/stream.py +0 -57
  742. mirascope/core/xai/tool.py +0 -13
  743. mirascope/experimental/graphs/__init__.py +0 -5
  744. mirascope/experimental/graphs/finite_state_machine.py +0 -714
  745. mirascope/integrations/__init__.py +0 -16
  746. mirascope/integrations/_middleware_factory.py +0 -403
  747. mirascope/integrations/langfuse/__init__.py +0 -3
  748. mirascope/integrations/langfuse/_utils.py +0 -114
  749. mirascope/integrations/langfuse/_with_langfuse.py +0 -70
  750. mirascope/integrations/logfire/__init__.py +0 -3
  751. mirascope/integrations/logfire/_utils.py +0 -225
  752. mirascope/integrations/logfire/_with_logfire.py +0 -63
  753. mirascope/integrations/otel/__init__.py +0 -10
  754. mirascope/integrations/otel/_utils.py +0 -270
  755. mirascope/integrations/otel/_with_hyperdx.py +0 -60
  756. mirascope/integrations/otel/_with_otel.py +0 -59
  757. mirascope/integrations/tenacity.py +0 -14
  758. mirascope/llm/_call.py +0 -401
  759. mirascope/llm/_context.py +0 -384
  760. mirascope/llm/_override.py +0 -3639
  761. mirascope/llm/_protocols.py +0 -500
  762. mirascope/llm/_response_metaclass.py +0 -31
  763. mirascope/llm/call_response.py +0 -158
  764. mirascope/llm/call_response_chunk.py +0 -66
  765. mirascope/llm/stream.py +0 -162
  766. mirascope/llm/tool.py +0 -64
  767. mirascope/mcp/__init__.py +0 -7
  768. mirascope/mcp/_utils.py +0 -288
  769. mirascope/mcp/client.py +0 -167
  770. mirascope/mcp/server.py +0 -356
  771. mirascope/mcp/tools.py +0 -110
  772. mirascope/py.typed +0 -0
  773. mirascope/retries/__init__.py +0 -11
  774. mirascope/retries/fallback.py +0 -131
  775. mirascope/retries/tenacity.py +0 -50
  776. mirascope/tools/__init__.py +0 -37
  777. mirascope/tools/base.py +0 -98
  778. mirascope/tools/system/__init__.py +0 -0
  779. mirascope/tools/system/_docker_operation.py +0 -166
  780. mirascope/tools/system/_file_system.py +0 -267
  781. mirascope/tools/web/__init__.py +0 -0
  782. mirascope/tools/web/_duckduckgo.py +0 -111
  783. mirascope/tools/web/_httpx.py +0 -125
  784. mirascope/tools/web/_parse_url_content.py +0 -94
  785. mirascope/tools/web/_requests.py +0 -54
  786. mirascope/v0/__init__.py +0 -43
  787. mirascope/v0/anthropic.py +0 -54
  788. mirascope/v0/base/__init__.py +0 -12
  789. mirascope/v0/base/calls.py +0 -118
  790. mirascope/v0/base/extractors.py +0 -122
  791. mirascope/v0/base/ops_utils.py +0 -207
  792. mirascope/v0/base/prompts.py +0 -48
  793. mirascope/v0/base/types.py +0 -14
  794. mirascope/v0/base/utils.py +0 -21
  795. mirascope/v0/openai.py +0 -54
  796. mirascope-1.25.7.dist-info/METADATA +0 -169
  797. mirascope-1.25.7.dist-info/RECORD +0 -378
mirascope/api/_generated/reference.md ADDED
@@ -0,0 +1,4915 @@
1
+ # Reference
2
+ ## health
3
+ <details><summary><code>client.health.<a href="src/mirascope/health/client.py">check</a>()</code></summary>
4
+ <dl>
5
+ <dd>
6
+
7
+ #### 🔌 Usage
8
+
9
+ <dl>
10
+ <dd>
11
+
12
+ <dl>
13
+ <dd>
14
+
15
+ ```python
16
+ from mirascope.api._generated import Mirascope
17
+
18
+ client = Mirascope()
19
+ client.health.check()
20
+
21
+ ```
22
+ </dd>
23
+ </dl>
24
+ </dd>
25
+ </dl>
26
+
27
+ #### ⚙️ Parameters
28
+
29
+ <dl>
30
+ <dd>
31
+
32
+ <dl>
33
+ <dd>
34
+
35
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
36
+
37
+ </dd>
38
+ </dl>
39
+ </dd>
40
+ </dl>
41
+
42
+
43
+ </dd>
44
+ </dl>
45
+ </details>
46
+
47
+ ## traces
48
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">create</a>(...)</code></summary>
49
+ <dl>
50
+ <dd>
51
+
52
+ #### 🔌 Usage
53
+
54
+ <dl>
55
+ <dd>
56
+
57
+ <dl>
58
+ <dd>
59
+
60
+ ```python
61
+ from mirascope.api._generated import Mirascope
62
+ from mirascope.api._generated.traces import (
63
+ TracesCreateRequestResourceSpansItem,
64
+ TracesCreateRequestResourceSpansItemScopeSpansItem,
65
+ TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem,
66
+ )
67
+
68
+ client = Mirascope()
69
+ client.traces.create(
70
+ resource_spans=[
71
+ TracesCreateRequestResourceSpansItem(
72
+ scope_spans=[
73
+ TracesCreateRequestResourceSpansItemScopeSpansItem(
74
+ spans=[
75
+ TracesCreateRequestResourceSpansItemScopeSpansItemSpansItem(
76
+ trace_id="traceId",
77
+ span_id="spanId",
78
+ name="name",
79
+ start_time_unix_nano="startTimeUnixNano",
80
+ end_time_unix_nano="endTimeUnixNano",
81
+ )
82
+ ],
83
+ )
84
+ ],
85
+ )
86
+ ],
87
+ )
88
+
89
+ ```
90
+ </dd>
91
+ </dl>
92
+ </dd>
93
+ </dl>
94
+
95
+ #### ⚙️ Parameters
96
+
97
+ <dl>
98
+ <dd>
99
+
100
+ <dl>
101
+ <dd>
102
+
103
+ **resource_spans:** `typing.Sequence[TracesCreateRequestResourceSpansItem]`
104
+
105
+ </dd>
106
+ </dl>
107
+
108
+ <dl>
109
+ <dd>
110
+
111
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
112
+
113
+ </dd>
114
+ </dl>
115
+ </dd>
116
+ </dl>
117
+
118
+
119
+ </dd>
120
+ </dl>
121
+ </details>
122
+
123
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">search</a>(...)</code></summary>
124
+ <dl>
125
+ <dd>
126
+
127
+ #### 🔌 Usage
128
+
129
+ <dl>
130
+ <dd>
131
+
132
+ <dl>
133
+ <dd>
134
+
135
+ ```python
136
+ from mirascope.api._generated import Mirascope
137
+
138
+ client = Mirascope()
139
+ client.traces.search(
140
+ start_time="startTime",
141
+ end_time="endTime",
142
+ )
143
+
144
+ ```
145
+ </dd>
146
+ </dl>
147
+ </dd>
148
+ </dl>
149
+
150
+ #### ⚙️ Parameters
151
+
152
+ <dl>
153
+ <dd>
154
+
155
+ <dl>
156
+ <dd>
157
+
158
+ **start_time:** `str`
159
+
160
+ </dd>
161
+ </dl>
162
+
163
+ <dl>
164
+ <dd>
165
+
166
+ **end_time:** `str`
167
+
168
+ </dd>
169
+ </dl>
170
+
171
+ <dl>
172
+ <dd>
173
+
174
+ **query:** `typing.Optional[str]`
175
+
176
+ </dd>
177
+ </dl>
178
+
179
+ <dl>
180
+ <dd>
181
+
182
+ **input_messages_query:** `typing.Optional[str]`
183
+
184
+ </dd>
185
+ </dl>
186
+
187
+ <dl>
188
+ <dd>
189
+
190
+ **output_messages_query:** `typing.Optional[str]`
191
+
192
+ </dd>
193
+ </dl>
194
+
195
+ <dl>
196
+ <dd>
197
+
198
+ **fuzzy_search:** `typing.Optional[bool]`
199
+
200
+ </dd>
201
+ </dl>
202
+
203
+ <dl>
204
+ <dd>
205
+
206
+ **trace_id:** `typing.Optional[str]`
207
+
208
+ </dd>
209
+ </dl>
210
+
211
+ <dl>
212
+ <dd>
213
+
214
+ **span_id:** `typing.Optional[str]`
215
+
216
+ </dd>
217
+ </dl>
218
+
219
+ <dl>
220
+ <dd>
221
+
222
+ **model:** `typing.Optional[typing.Sequence[str]]`
223
+
224
+ </dd>
225
+ </dl>
226
+
227
+ <dl>
228
+ <dd>
229
+
230
+ **provider:** `typing.Optional[typing.Sequence[str]]`
231
+
232
+ </dd>
233
+ </dl>
234
+
235
+ <dl>
236
+ <dd>
237
+
238
+ **function_id:** `typing.Optional[str]`
239
+
240
+ </dd>
241
+ </dl>
242
+
243
+ <dl>
244
+ <dd>
245
+
246
+ **function_name:** `typing.Optional[str]`
247
+
248
+ </dd>
249
+ </dl>
250
+
251
+ <dl>
252
+ <dd>
253
+
254
+ **span_name_prefix:** `typing.Optional[str]`
255
+
256
+ </dd>
257
+ </dl>
258
+
259
+ <dl>
260
+ <dd>
261
+
262
+ **has_error:** `typing.Optional[bool]`
263
+
264
+ </dd>
265
+ </dl>
266
+
267
+ <dl>
268
+ <dd>
269
+
270
+ **min_tokens:** `typing.Optional[float]`
271
+
272
+ </dd>
273
+ </dl>
274
+
275
+ <dl>
276
+ <dd>
277
+
278
+ **max_tokens:** `typing.Optional[float]`
279
+
280
+ </dd>
281
+ </dl>
282
+
283
+ <dl>
284
+ <dd>
285
+
286
+ **min_duration:** `typing.Optional[float]`
287
+
288
+ </dd>
289
+ </dl>
290
+
291
+ <dl>
292
+ <dd>
293
+
294
+ **max_duration:** `typing.Optional[float]`
295
+
296
+ </dd>
297
+ </dl>
298
+
299
+ <dl>
300
+ <dd>
301
+
302
+ **attribute_filters:** `typing.Optional[typing.Sequence[TracesSearchRequestAttributeFiltersItem]]`
303
+
304
+ </dd>
305
+ </dl>
306
+
307
+ <dl>
308
+ <dd>
309
+
310
+ **limit:** `typing.Optional[float]`
311
+
312
+ </dd>
313
+ </dl>
314
+
315
+ <dl>
316
+ <dd>
317
+
318
+ **offset:** `typing.Optional[float]`
319
+
320
+ </dd>
321
+ </dl>
322
+
323
+ <dl>
324
+ <dd>
325
+
326
+ **sort_by:** `typing.Optional[TracesSearchRequestSortBy]`
327
+
328
+ </dd>
329
+ </dl>
330
+
331
+ <dl>
332
+ <dd>
333
+
334
+ **sort_order:** `typing.Optional[TracesSearchRequestSortOrder]`
335
+
336
+ </dd>
337
+ </dl>
338
+
339
+ <dl>
340
+ <dd>
341
+
342
+ **root_spans_only:** `typing.Optional[bool]`
343
+
344
+ </dd>
345
+ </dl>
346
+
347
+ <dl>
348
+ <dd>
349
+
350
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
351
+
352
+ </dd>
353
+ </dl>
354
+ </dd>
355
+ </dl>
356
+
357
+
358
+ </dd>
359
+ </dl>
360
+ </details>
361
+
362
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">gettracedetail</a>(...)</code></summary>
363
+ <dl>
364
+ <dd>
365
+
366
+ #### 🔌 Usage
367
+
368
+ <dl>
369
+ <dd>
370
+
371
+ <dl>
372
+ <dd>
373
+
374
+ ```python
375
+ from mirascope.api._generated import Mirascope
376
+
377
+ client = Mirascope()
378
+ client.traces.gettracedetail(
379
+ trace_id="traceId",
380
+ )
381
+
382
+ ```
383
+ </dd>
384
+ </dl>
385
+ </dd>
386
+ </dl>
387
+
388
+ #### ⚙️ Parameters
389
+
390
+ <dl>
391
+ <dd>
392
+
393
+ <dl>
394
+ <dd>
395
+
396
+ **trace_id:** `str`
397
+
398
+ </dd>
399
+ </dl>
400
+
401
+ <dl>
402
+ <dd>
403
+
404
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
405
+
406
+ </dd>
407
+ </dl>
408
+ </dd>
409
+ </dl>
410
+
411
+
412
+ </dd>
413
+ </dl>
414
+ </details>
415
+
416
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">getanalyticssummary</a>(...)</code></summary>
417
+ <dl>
418
+ <dd>
419
+
420
+ #### 🔌 Usage
421
+
422
+ <dl>
423
+ <dd>
424
+
425
+ <dl>
426
+ <dd>
427
+
428
+ ```python
429
+ from mirascope.api._generated import Mirascope
430
+
431
+ client = Mirascope()
432
+ client.traces.getanalyticssummary(
433
+ start_time="startTime",
434
+ end_time="endTime",
435
+ )
436
+
437
+ ```
438
+ </dd>
439
+ </dl>
440
+ </dd>
441
+ </dl>
442
+
443
+ #### ⚙️ Parameters
444
+
445
+ <dl>
446
+ <dd>
447
+
448
+ <dl>
449
+ <dd>
450
+
451
+ **start_time:** `str`
452
+
453
+ </dd>
454
+ </dl>
455
+
456
+ <dl>
457
+ <dd>
458
+
459
+ **end_time:** `str`
460
+
461
+ </dd>
462
+ </dl>
463
+
464
+ <dl>
465
+ <dd>
466
+
467
+ **function_id:** `typing.Optional[str]`
468
+
469
+ </dd>
470
+ </dl>
471
+
472
+ <dl>
473
+ <dd>
474
+
475
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
476
+
477
+ </dd>
478
+ </dl>
479
+ </dd>
480
+ </dl>
481
+
482
+
483
+ </dd>
484
+ </dl>
485
+ </details>
486
+
487
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">listbyfunctionhash</a>(...)</code></summary>
488
+ <dl>
489
+ <dd>
490
+
491
+ #### 🔌 Usage
492
+
493
+ <dl>
494
+ <dd>
495
+
496
+ <dl>
497
+ <dd>
498
+
499
+ ```python
500
+ from mirascope.api._generated import Mirascope
501
+
502
+ client = Mirascope()
503
+ client.traces.listbyfunctionhash(
504
+ hash="hash",
505
+ )
506
+
507
+ ```
508
+ </dd>
509
+ </dl>
510
+ </dd>
511
+ </dl>
512
+
513
+ #### ⚙️ Parameters
514
+
515
+ <dl>
516
+ <dd>
517
+
518
+ <dl>
519
+ <dd>
520
+
521
+ **hash:** `str`
522
+
523
+ </dd>
524
+ </dl>
525
+
526
+ <dl>
527
+ <dd>
528
+
529
+ **limit:** `typing.Optional[NumberFromString]`
530
+
531
+ </dd>
532
+ </dl>
533
+
534
+ <dl>
535
+ <dd>
536
+
537
+ **offset:** `typing.Optional[NumberFromString]`
538
+
539
+ </dd>
540
+ </dl>
541
+
542
+ <dl>
543
+ <dd>
544
+
545
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
546
+
547
+ </dd>
548
+ </dl>
549
+ </dd>
550
+ </dl>
551
+
552
+
553
+ </dd>
554
+ </dl>
555
+ </details>
556
+
557
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">searchbyenv</a>(...)</code></summary>
558
+ <dl>
559
+ <dd>
560
+
561
+ #### 🔌 Usage
562
+
563
+ <dl>
564
+ <dd>
565
+
566
+ <dl>
567
+ <dd>
568
+
569
+ ```python
570
+ from mirascope.api._generated import Mirascope
571
+
572
+ client = Mirascope()
573
+ client.traces.searchbyenv(
574
+ organization_id="organizationId",
575
+ project_id="projectId",
576
+ environment_id="environmentId",
577
+ start_time="startTime",
578
+ end_time="endTime",
579
+ )
580
+
581
+ ```
582
+ </dd>
583
+ </dl>
584
+ </dd>
585
+ </dl>
586
+
587
+ #### ⚙️ Parameters
588
+
589
+ <dl>
590
+ <dd>
591
+
592
+ <dl>
593
+ <dd>
594
+
595
+ **organization_id:** `str`
596
+
597
+ </dd>
598
+ </dl>
599
+
600
+ <dl>
601
+ <dd>
602
+
603
+ **project_id:** `str`
604
+
605
+ </dd>
606
+ </dl>
607
+
608
+ <dl>
609
+ <dd>
610
+
611
+ **environment_id:** `str`
612
+
613
+ </dd>
614
+ </dl>
615
+
616
+ <dl>
617
+ <dd>
618
+
619
+ **start_time:** `str`
620
+
621
+ </dd>
622
+ </dl>
623
+
624
+ <dl>
625
+ <dd>
626
+
627
+ **end_time:** `str`
628
+
629
+ </dd>
630
+ </dl>
631
+
632
+ <dl>
633
+ <dd>
634
+
635
+ **query:** `typing.Optional[str]`
636
+
637
+ </dd>
638
+ </dl>
639
+
640
+ <dl>
641
+ <dd>
642
+
643
+ **input_messages_query:** `typing.Optional[str]`
644
+
645
+ </dd>
646
+ </dl>
647
+
648
+ <dl>
649
+ <dd>
650
+
651
+ **output_messages_query:** `typing.Optional[str]`
652
+
653
+ </dd>
654
+ </dl>
655
+
656
+ <dl>
657
+ <dd>
658
+
659
+ **fuzzy_search:** `typing.Optional[bool]`
660
+
661
+ </dd>
662
+ </dl>
663
+
664
+ <dl>
665
+ <dd>
666
+
667
+ **trace_id:** `typing.Optional[str]`
668
+
669
+ </dd>
670
+ </dl>
671
+
672
+ <dl>
673
+ <dd>
674
+
675
+ **span_id:** `typing.Optional[str]`
676
+
677
+ </dd>
678
+ </dl>
679
+
680
+ <dl>
681
+ <dd>
682
+
683
+ **model:** `typing.Optional[typing.Sequence[str]]`
684
+
685
+ </dd>
686
+ </dl>
687
+
688
+ <dl>
689
+ <dd>
690
+
691
+ **provider:** `typing.Optional[typing.Sequence[str]]`
692
+
693
+ </dd>
694
+ </dl>
695
+
696
+ <dl>
697
+ <dd>
698
+
699
+ **function_id:** `typing.Optional[str]`
700
+
701
+ </dd>
702
+ </dl>
703
+
704
+ <dl>
705
+ <dd>
706
+
707
+ **function_name:** `typing.Optional[str]`
708
+
709
+ </dd>
710
+ </dl>
711
+
712
+ <dl>
713
+ <dd>
714
+
715
+ **span_name_prefix:** `typing.Optional[str]`
716
+
717
+ </dd>
718
+ </dl>
719
+
720
+ <dl>
721
+ <dd>
722
+
723
+ **has_error:** `typing.Optional[bool]`
724
+
725
+ </dd>
726
+ </dl>
727
+
728
+ <dl>
729
+ <dd>
730
+
731
+ **min_tokens:** `typing.Optional[float]`
732
+
733
+ </dd>
734
+ </dl>
735
+
736
+ <dl>
737
+ <dd>
738
+
739
+ **max_tokens:** `typing.Optional[float]`
740
+
741
+ </dd>
742
+ </dl>
743
+
744
+ <dl>
745
+ <dd>
746
+
747
+ **min_duration:** `typing.Optional[float]`
748
+
749
+ </dd>
750
+ </dl>
751
+
752
+ <dl>
753
+ <dd>
754
+
755
+ **max_duration:** `typing.Optional[float]`
756
+
757
+ </dd>
758
+ </dl>
759
+
760
+ <dl>
761
+ <dd>
762
+
763
+ **attribute_filters:** `typing.Optional[typing.Sequence[TracesSearchByEnvRequestAttributeFiltersItem]]`
764
+
765
+ </dd>
766
+ </dl>
767
+
768
+ <dl>
769
+ <dd>
770
+
771
+ **limit:** `typing.Optional[float]`
772
+
773
+ </dd>
774
+ </dl>
775
+
776
+ <dl>
777
+ <dd>
778
+
779
+ **offset:** `typing.Optional[float]`
780
+
781
+ </dd>
782
+ </dl>
783
+
784
+ <dl>
785
+ <dd>
786
+
787
+ **sort_by:** `typing.Optional[TracesSearchByEnvRequestSortBy]`
788
+
789
+ </dd>
790
+ </dl>
791
+
792
+ <dl>
793
+ <dd>
794
+
795
+ **sort_order:** `typing.Optional[TracesSearchByEnvRequestSortOrder]`
796
+
797
+ </dd>
798
+ </dl>
799
+
800
+ <dl>
801
+ <dd>
802
+
803
+ **root_spans_only:** `typing.Optional[bool]`
804
+
805
+ </dd>
806
+ </dl>
807
+
808
+ <dl>
809
+ <dd>
810
+
811
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
812
+
813
+ </dd>
814
+ </dl>
815
+ </dd>
816
+ </dl>
817
+
818
+
819
+ </dd>
820
+ </dl>
821
+ </details>
822
+
823
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">gettracedetailbyenv</a>(...)</code></summary>
824
+ <dl>
825
+ <dd>
826
+
827
+ #### 🔌 Usage
828
+
829
+ <dl>
830
+ <dd>
831
+
832
+ <dl>
833
+ <dd>
834
+
835
+ ```python
836
+ from mirascope.api._generated import Mirascope
837
+
838
+ client = Mirascope()
839
+ client.traces.gettracedetailbyenv(
840
+ organization_id="organizationId",
841
+ project_id="projectId",
842
+ environment_id="environmentId",
843
+ trace_id="traceId",
844
+ )
845
+
846
+ ```
847
+ </dd>
848
+ </dl>
849
+ </dd>
850
+ </dl>
851
+
852
+ #### ⚙️ Parameters
853
+
854
+ <dl>
855
+ <dd>
856
+
857
+ <dl>
858
+ <dd>
859
+
860
+ **organization_id:** `str`
861
+
862
+ </dd>
863
+ </dl>
864
+
865
+ <dl>
866
+ <dd>
867
+
868
+ **project_id:** `str`
869
+
870
+ </dd>
871
+ </dl>
872
+
873
+ <dl>
874
+ <dd>
875
+
876
+ **environment_id:** `str`
877
+
878
+ </dd>
879
+ </dl>
880
+
881
+ <dl>
882
+ <dd>
883
+
884
+ **trace_id:** `str`
885
+
886
+ </dd>
887
+ </dl>
888
+
889
+ <dl>
890
+ <dd>
891
+
892
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
893
+
894
+ </dd>
895
+ </dl>
896
+ </dd>
897
+ </dl>
898
+
899
+
900
+ </dd>
901
+ </dl>
902
+ </details>
903
+
904
+ ## docs
905
+ <details><summary><code>client.docs.<a href="src/mirascope/docs/client.py">openapi</a>()</code></summary>
906
+ <dl>
907
+ <dd>
908
+
909
+ #### 🔌 Usage
910
+
911
+ <dl>
912
+ <dd>
913
+
914
+ <dl>
915
+ <dd>
916
+
917
+ ```python
918
+ from mirascope.api._generated import Mirascope
919
+
920
+ client = Mirascope()
921
+ client.docs.openapi()
922
+
923
+ ```
924
+ </dd>
925
+ </dl>
926
+ </dd>
927
+ </dl>
928
+
929
+ #### ⚙️ Parameters
930
+
931
+ <dl>
932
+ <dd>
933
+
934
+ <dl>
935
+ <dd>
936
+
937
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
938
+
939
+ </dd>
940
+ </dl>
941
+ </dd>
942
+ </dl>
943
+
944
+
945
+ </dd>
946
+ </dl>
947
+ </details>
948
+
949
+ ## organizations
950
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">list</a>()</code></summary>
951
+ <dl>
952
+ <dd>
953
+
954
+ #### 🔌 Usage
955
+
956
+ <dl>
957
+ <dd>
958
+
959
+ <dl>
960
+ <dd>
961
+
962
+ ```python
963
+ from mirascope.api._generated import Mirascope
964
+
965
+ client = Mirascope()
966
+ client.organizations.list()
967
+
968
+ ```
969
+ </dd>
970
+ </dl>
971
+ </dd>
972
+ </dl>
973
+
974
+ #### ⚙️ Parameters
975
+
976
+ <dl>
977
+ <dd>
978
+
979
+ <dl>
980
+ <dd>
981
+
982
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
983
+
984
+ </dd>
985
+ </dl>
986
+ </dd>
987
+ </dl>
988
+
989
+
990
+ </dd>
991
+ </dl>
992
+ </details>
993
+
994
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">create</a>(...)</code></summary>
995
+ <dl>
996
+ <dd>
997
+
998
+ #### 🔌 Usage
999
+
1000
+ <dl>
1001
+ <dd>
1002
+
1003
+ <dl>
1004
+ <dd>
1005
+
1006
+ ```python
1007
+ from mirascope.api._generated import Mirascope
1008
+
1009
+ client = Mirascope()
1010
+ client.organizations.create(
1011
+ name="name",
1012
+ slug="slug",
1013
+ )
1014
+
1015
+ ```
1016
+ </dd>
1017
+ </dl>
1018
+ </dd>
1019
+ </dl>
1020
+
1021
+ #### ⚙️ Parameters
1022
+
1023
+ <dl>
1024
+ <dd>
1025
+
1026
+ <dl>
1027
+ <dd>
1028
+
1029
+ **name:** `str` — a string at most 100 character(s) long
1030
+
1031
+ </dd>
1032
+ </dl>
1033
+
1034
+ <dl>
1035
+ <dd>
1036
+
1037
+ **slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
1038
+
1039
+ </dd>
1040
+ </dl>
1041
+
1042
+ <dl>
1043
+ <dd>
1044
+
1045
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1046
+
1047
+ </dd>
1048
+ </dl>
1049
+ </dd>
1050
+ </dl>
1051
+
1052
+
1053
+ </dd>
1054
+ </dl>
1055
+ </details>
1056
+
1057
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">get</a>(...)</code></summary>
1058
+ <dl>
1059
+ <dd>
1060
+
1061
+ #### 🔌 Usage
1062
+
1063
+ <dl>
1064
+ <dd>
1065
+
1066
+ <dl>
1067
+ <dd>
1068
+
1069
+ ```python
1070
+ from mirascope.api._generated import Mirascope
1071
+
1072
+ client = Mirascope()
1073
+ client.organizations.get(
1074
+ id="id",
1075
+ )
1076
+
1077
+ ```
1078
+ </dd>
1079
+ </dl>
1080
+ </dd>
1081
+ </dl>
1082
+
1083
+ #### ⚙️ Parameters
1084
+
1085
+ <dl>
1086
+ <dd>
1087
+
1088
+ <dl>
1089
+ <dd>
1090
+
1091
+ **id:** `str`
1092
+
1093
+ </dd>
1094
+ </dl>
1095
+
1096
+ <dl>
1097
+ <dd>
1098
+
1099
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1100
+
1101
+ </dd>
1102
+ </dl>
1103
+ </dd>
1104
+ </dl>
1105
+
1106
+
1107
+ </dd>
1108
+ </dl>
1109
+ </details>
1110
+
1111
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">update</a>(...)</code></summary>
1112
+ <dl>
1113
+ <dd>
1114
+
1115
+ #### 🔌 Usage
1116
+
1117
+ <dl>
1118
+ <dd>
1119
+
1120
+ <dl>
1121
+ <dd>
1122
+
1123
+ ```python
1124
+ from mirascope.api._generated import Mirascope
1125
+
1126
+ client = Mirascope()
1127
+ client.organizations.update(
1128
+ id="id",
1129
+ )
1130
+
1131
+ ```
1132
+ </dd>
1133
+ </dl>
1134
+ </dd>
1135
+ </dl>
1136
+
1137
+ #### ⚙️ Parameters
1138
+
1139
+ <dl>
1140
+ <dd>
1141
+
1142
+ <dl>
1143
+ <dd>
1144
+
1145
+ **id:** `str`
1146
+
1147
+ </dd>
1148
+ </dl>
1149
+
1150
+ <dl>
1151
+ <dd>
1152
+
1153
+ **name:** `typing.Optional[str]` — a string at most 100 character(s) long
1154
+
1155
+ </dd>
1156
+ </dl>
1157
+
1158
+ <dl>
1159
+ <dd>
1160
+
1161
+ **slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
1162
+
1163
+ </dd>
1164
+ </dl>
1165
+
1166
+ <dl>
1167
+ <dd>
1168
+
1169
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1170
+
1171
+ </dd>
1172
+ </dl>
1173
+ </dd>
1174
+ </dl>
1175
+
1176
+
1177
+ </dd>
1178
+ </dl>
1179
+ </details>
1180
+
1181
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">delete</a>(...)</code></summary>
1182
+ <dl>
1183
+ <dd>
1184
+
1185
+ #### 🔌 Usage
1186
+
1187
+ <dl>
1188
+ <dd>
1189
+
1190
+ <dl>
1191
+ <dd>
1192
+
1193
+ ```python
1194
+ from mirascope.api._generated import Mirascope
1195
+
1196
+ client = Mirascope()
1197
+ client.organizations.delete(
1198
+ id="id",
1199
+ )
1200
+
1201
+ ```
1202
+ </dd>
1203
+ </dl>
1204
+ </dd>
1205
+ </dl>
1206
+
1207
+ #### ⚙️ Parameters
1208
+
1209
+ <dl>
1210
+ <dd>
1211
+
1212
+ <dl>
1213
+ <dd>
1214
+
1215
+ **id:** `str`
1216
+
1217
+ </dd>
1218
+ </dl>
1219
+
1220
+ <dl>
1221
+ <dd>
1222
+
1223
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1224
+
1225
+ </dd>
1226
+ </dl>
1227
+ </dd>
1228
+ </dl>
1229
+
1230
+
1231
+ </dd>
1232
+ </dl>
1233
+ </details>
1234
+
1235
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">routerbalance</a>(...)</code></summary>
1236
+ <dl>
1237
+ <dd>
1238
+
1239
+ #### 🔌 Usage
1240
+
1241
+ <dl>
1242
+ <dd>
1243
+
1244
+ <dl>
1245
+ <dd>
1246
+
1247
+ ```python
1248
+ from mirascope.api._generated import Mirascope
1249
+
1250
+ client = Mirascope()
1251
+ client.organizations.routerbalance(
1252
+ id="id",
1253
+ )
1254
+
1255
+ ```
1256
+ </dd>
1257
+ </dl>
1258
+ </dd>
1259
+ </dl>
1260
+
1261
+ #### ⚙️ Parameters
1262
+
1263
+ <dl>
1264
+ <dd>
1265
+
1266
+ <dl>
1267
+ <dd>
1268
+
1269
+ **id:** `str`
1270
+
1271
+ </dd>
1272
+ </dl>
1273
+
1274
+ <dl>
1275
+ <dd>
1276
+
1277
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1278
+
1279
+ </dd>
1280
+ </dl>
1281
+ </dd>
1282
+ </dl>
1283
+
1284
+
1285
+ </dd>
1286
+ </dl>
1287
+ </details>
1288
+
1289
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">createpaymentintent</a>(...)</code></summary>
1290
+ <dl>
1291
+ <dd>
1292
+
1293
+ #### 🔌 Usage
1294
+
1295
+ <dl>
1296
+ <dd>
1297
+
1298
+ <dl>
1299
+ <dd>
1300
+
1301
+ ```python
1302
+ from mirascope.api._generated import Mirascope
1303
+
1304
+ client = Mirascope()
1305
+ client.organizations.createpaymentintent(
1306
+ id="id",
1307
+ amount=1.1,
1308
+ )
1309
+
1310
+ ```
1311
+ </dd>
1312
+ </dl>
1313
+ </dd>
1314
+ </dl>
1315
+
1316
+ #### ⚙️ Parameters
1317
+
1318
+ <dl>
1319
+ <dd>
1320
+
1321
+ <dl>
1322
+ <dd>
1323
+
1324
+ **id:** `str`
1325
+
1326
+ </dd>
1327
+ </dl>
1328
+
1329
+ <dl>
1330
+ <dd>
1331
+
1332
+ **amount:** `float` — a positive number
1333
+
1334
+ </dd>
1335
+ </dl>
1336
+
1337
+ <dl>
1338
+ <dd>
1339
+
1340
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1341
+
1342
+ </dd>
1343
+ </dl>
1344
+ </dd>
1345
+ </dl>
1346
+
1347
+
1348
+ </dd>
1349
+ </dl>
1350
+ </details>
1351
+
1352
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">subscription</a>(...)</code></summary>
1353
+ <dl>
1354
+ <dd>
1355
+
1356
+ #### 🔌 Usage
1357
+
1358
+ <dl>
1359
+ <dd>
1360
+
1361
+ <dl>
1362
+ <dd>
1363
+
1364
+ ```python
1365
+ from mirascope.api._generated import Mirascope
1366
+
1367
+ client = Mirascope()
1368
+ client.organizations.subscription(
1369
+ id="id",
1370
+ )
1371
+
1372
+ ```
1373
+ </dd>
1374
+ </dl>
1375
+ </dd>
1376
+ </dl>
1377
+
1378
+ #### ⚙️ Parameters
1379
+
1380
+ <dl>
1381
+ <dd>
1382
+
1383
+ <dl>
1384
+ <dd>
1385
+
1386
+ **id:** `str`
1387
+
1388
+ </dd>
1389
+ </dl>
1390
+
1391
+ <dl>
1392
+ <dd>
1393
+
1394
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1395
+
1396
+ </dd>
1397
+ </dl>
1398
+ </dd>
1399
+ </dl>
1400
+
1401
+
1402
+ </dd>
1403
+ </dl>
1404
+ </details>
1405
+
1406
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">previewsubscriptionchange</a>(...)</code></summary>
1407
+ <dl>
1408
+ <dd>
1409
+
1410
+ #### 🔌 Usage
1411
+
1412
+ <dl>
1413
+ <dd>
1414
+
1415
+ <dl>
1416
+ <dd>
1417
+
1418
+ ```python
1419
+ from mirascope.api._generated import Mirascope
1420
+
1421
+ client = Mirascope()
1422
+ client.organizations.previewsubscriptionchange(
1423
+ id="id",
1424
+ target_plan="free",
1425
+ )
1426
+
1427
+ ```
1428
+ </dd>
1429
+ </dl>
1430
+ </dd>
1431
+ </dl>
1432
+
1433
+ #### ⚙️ Parameters
1434
+
1435
+ <dl>
1436
+ <dd>
1437
+
1438
+ <dl>
1439
+ <dd>
1440
+
1441
+ **id:** `str`
1442
+
1443
+ </dd>
1444
+ </dl>
1445
+
1446
+ <dl>
1447
+ <dd>
1448
+
1449
+ **target_plan:** `OrganizationsPreviewSubscriptionChangeRequestTargetPlan`
1450
+
1451
+ </dd>
1452
+ </dl>
1453
+
1454
+ <dl>
1455
+ <dd>
1456
+
1457
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1458
+
1459
+ </dd>
1460
+ </dl>
1461
+ </dd>
1462
+ </dl>
1463
+
1464
+
1465
+ </dd>
1466
+ </dl>
1467
+ </details>
1468
+
1469
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">updatesubscription</a>(...)</code></summary>
1470
+ <dl>
1471
+ <dd>
1472
+
1473
+ #### 🔌 Usage
1474
+
1475
+ <dl>
1476
+ <dd>
1477
+
1478
+ <dl>
1479
+ <dd>
1480
+
1481
+ ```python
1482
+ from mirascope.api._generated import Mirascope
1483
+
1484
+ client = Mirascope()
1485
+ client.organizations.updatesubscription(
1486
+ id="id",
1487
+ target_plan="free",
1488
+ )
1489
+
1490
+ ```
1491
+ </dd>
1492
+ </dl>
1493
+ </dd>
1494
+ </dl>
1495
+
1496
+ #### ⚙️ Parameters
1497
+
1498
+ <dl>
1499
+ <dd>
1500
+
1501
+ <dl>
1502
+ <dd>
1503
+
1504
+ **id:** `str`
1505
+
1506
+ </dd>
1507
+ </dl>
1508
+
1509
+ <dl>
1510
+ <dd>
1511
+
1512
+ **target_plan:** `OrganizationsUpdateSubscriptionRequestTargetPlan`
1513
+
1514
+ </dd>
1515
+ </dl>
1516
+
1517
+ <dl>
1518
+ <dd>
1519
+
1520
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1521
+
1522
+ </dd>
1523
+ </dl>
1524
+ </dd>
1525
+ </dl>
1526
+
1527
+
1528
+ </dd>
1529
+ </dl>
1530
+ </details>
1531
+
1532
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">cancelscheduleddowngrade</a>(...)</code></summary>
1533
+ <dl>
1534
+ <dd>
1535
+
1536
+ #### 🔌 Usage
1537
+
1538
+ <dl>
1539
+ <dd>
1540
+
1541
+ <dl>
1542
+ <dd>
1543
+
1544
+ ```python
1545
+ from mirascope.api._generated import Mirascope
1546
+
1547
+ client = Mirascope()
1548
+ client.organizations.cancelscheduleddowngrade(
1549
+ id="id",
1550
+ )
1551
+
1552
+ ```
1553
+ </dd>
1554
+ </dl>
1555
+ </dd>
1556
+ </dl>
1557
+
1558
+ #### ⚙️ Parameters
1559
+
1560
+ <dl>
1561
+ <dd>
1562
+
1563
+ <dl>
1564
+ <dd>
1565
+
1566
+ **id:** `str`
1567
+
1568
+ </dd>
1569
+ </dl>
1570
+
1571
+ <dl>
1572
+ <dd>
1573
+
1574
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1575
+
1576
+ </dd>
1577
+ </dl>
1578
+ </dd>
1579
+ </dl>
1580
+
1581
+
1582
+ </dd>
1583
+ </dl>
1584
+ </details>
1585
+
1586
+ ## organization-invitations
1587
+ <details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">list</a>(...)</code></summary>
1588
+ <dl>
1589
+ <dd>
1590
+
1591
+ #### 🔌 Usage
1592
+
1593
+ <dl>
1594
+ <dd>
1595
+
1596
+ <dl>
1597
+ <dd>
1598
+
1599
+ ```python
1600
+ from mirascope.api._generated import Mirascope
1601
+
1602
+ client = Mirascope()
1603
+ client.organization_invitations.list(
1604
+ organization_id="organizationId",
1605
+ )
1606
+
1607
+ ```
1608
+ </dd>
1609
+ </dl>
1610
+ </dd>
1611
+ </dl>
1612
+
1613
+ #### ⚙️ Parameters
1614
+
1615
+ <dl>
1616
+ <dd>
1617
+
1618
+ <dl>
1619
+ <dd>
1620
+
1621
+ **organization_id:** `str`
1622
+
1623
+ </dd>
1624
+ </dl>
1625
+
1626
+ <dl>
1627
+ <dd>
1628
+
1629
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1630
+
1631
+ </dd>
1632
+ </dl>
1633
+ </dd>
1634
+ </dl>
1635
+
1636
+
1637
+ </dd>
1638
+ </dl>
1639
+ </details>
1640
+
1641
+ <details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">create</a>(...)</code></summary>
1642
+ <dl>
1643
+ <dd>
1644
+
1645
+ #### 🔌 Usage
1646
+
1647
+ <dl>
1648
+ <dd>
1649
+
1650
+ <dl>
1651
+ <dd>
1652
+
1653
+ ```python
1654
+ from mirascope.api._generated import Mirascope
1655
+
1656
+ client = Mirascope()
1657
+ client.organization_invitations.create(
1658
+ organization_id="organizationId",
1659
+ recipient_email="recipientEmail",
1660
+ role="ADMIN",
1661
+ )
1662
+
1663
+ ```
1664
+ </dd>
1665
+ </dl>
1666
+ </dd>
1667
+ </dl>
1668
+
1669
+ #### ⚙️ Parameters
1670
+
1671
+ <dl>
1672
+ <dd>
1673
+
1674
+ <dl>
1675
+ <dd>
1676
+
1677
+ **organization_id:** `str`
1678
+
1679
+ </dd>
1680
+ </dl>
1681
+
1682
+ <dl>
1683
+ <dd>
1684
+
1685
+ **recipient_email:** `str` — a string matching the pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$
1686
+
1687
+ </dd>
1688
+ </dl>
1689
+
1690
+ <dl>
1691
+ <dd>
1692
+
1693
+ **role:** `OrganizationInvitationsCreateRequestRole`
1694
+
1695
+ </dd>
1696
+ </dl>
1697
+
1698
+ <dl>
1699
+ <dd>
1700
+
1701
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1702
+
1703
+ </dd>
1704
+ </dl>
1705
+ </dd>
1706
+ </dl>
1707
+
1708
+
1709
+ </dd>
1710
+ </dl>
1711
+ </details>
1712
+
1713
+ <details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">get</a>(...)</code></summary>
1714
+ <dl>
1715
+ <dd>
1716
+
1717
+ #### 🔌 Usage
1718
+
1719
+ <dl>
1720
+ <dd>
1721
+
1722
+ <dl>
1723
+ <dd>
1724
+
1725
+ ```python
1726
+ from mirascope.api._generated import Mirascope
1727
+
1728
+ client = Mirascope()
1729
+ client.organization_invitations.get(
1730
+ organization_id="organizationId",
1731
+ invitation_id="invitationId",
1732
+ )
1733
+
1734
+ ```
1735
+ </dd>
1736
+ </dl>
1737
+ </dd>
1738
+ </dl>
1739
+
1740
+ #### ⚙️ Parameters
1741
+
1742
+ <dl>
1743
+ <dd>
1744
+
1745
+ <dl>
1746
+ <dd>
1747
+
1748
+ **organization_id:** `str`
1749
+
1750
+ </dd>
1751
+ </dl>
1752
+
1753
+ <dl>
1754
+ <dd>
1755
+
1756
+ **invitation_id:** `str`
1757
+
1758
+ </dd>
1759
+ </dl>
1760
+
1761
+ <dl>
1762
+ <dd>
1763
+
1764
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1765
+
1766
+ </dd>
1767
+ </dl>
1768
+ </dd>
1769
+ </dl>
1770
+
1771
+
1772
+ </dd>
1773
+ </dl>
1774
+ </details>
1775
+
1776
+ <details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">resend</a>(...)</code></summary>
1777
+ <dl>
1778
+ <dd>
1779
+
1780
+ #### 🔌 Usage
1781
+
1782
+ <dl>
1783
+ <dd>
1784
+
1785
+ <dl>
1786
+ <dd>
1787
+
1788
+ ```python
1789
+ from mirascope.api._generated import Mirascope
1790
+
1791
+ client = Mirascope()
1792
+ client.organization_invitations.resend(
1793
+ organization_id="organizationId",
1794
+ invitation_id="invitationId",
1795
+ )
1796
+
1797
+ ```
1798
+ </dd>
1799
+ </dl>
1800
+ </dd>
1801
+ </dl>
1802
+
1803
+ #### ⚙️ Parameters
1804
+
1805
+ <dl>
1806
+ <dd>
1807
+
1808
+ <dl>
1809
+ <dd>
1810
+
1811
+ **organization_id:** `str`
1812
+
1813
+ </dd>
1814
+ </dl>
1815
+
1816
+ <dl>
1817
+ <dd>
1818
+
1819
+ **invitation_id:** `str`
1820
+
1821
+ </dd>
1822
+ </dl>
1823
+
1824
+ <dl>
1825
+ <dd>
1826
+
1827
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1828
+
1829
+ </dd>
1830
+ </dl>
1831
+ </dd>
1832
+ </dl>
1833
+
1834
+
1835
+ </dd>
1836
+ </dl>
1837
+ </details>
1838
+
1839
+ <details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">revoke</a>(...)</code></summary>
1840
+ <dl>
1841
+ <dd>
1842
+
1843
+ #### 🔌 Usage
1844
+
1845
+ <dl>
1846
+ <dd>
1847
+
1848
+ <dl>
1849
+ <dd>
1850
+
1851
+ ```python
1852
+ from mirascope.api._generated import Mirascope
1853
+
1854
+ client = Mirascope()
1855
+ client.organization_invitations.revoke(
1856
+ organization_id="organizationId",
1857
+ invitation_id="invitationId",
1858
+ )
1859
+
1860
+ ```
1861
+ </dd>
1862
+ </dl>
1863
+ </dd>
1864
+ </dl>
1865
+
1866
+ #### ⚙️ Parameters
1867
+
1868
+ <dl>
1869
+ <dd>
1870
+
1871
+ <dl>
1872
+ <dd>
1873
+
1874
+ **organization_id:** `str`
1875
+
1876
+ </dd>
1877
+ </dl>
1878
+
1879
+ <dl>
1880
+ <dd>
1881
+
1882
+ **invitation_id:** `str`
1883
+
1884
+ </dd>
1885
+ </dl>
1886
+
1887
+ <dl>
1888
+ <dd>
1889
+
1890
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1891
+
1892
+ </dd>
1893
+ </dl>
1894
+ </dd>
1895
+ </dl>
1896
+
1897
+
1898
+ </dd>
1899
+ </dl>
1900
+ </details>
1901
+
1902
+ <details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">accept</a>(...)</code></summary>
1903
+ <dl>
1904
+ <dd>
1905
+
1906
+ #### 🔌 Usage
1907
+
1908
+ <dl>
1909
+ <dd>
1910
+
1911
+ <dl>
1912
+ <dd>
1913
+
1914
+ ```python
1915
+ from mirascope.api._generated import Mirascope
1916
+
1917
+ client = Mirascope()
1918
+ client.organization_invitations.accept(
1919
+ token="token",
1920
+ )
1921
+
1922
+ ```
1923
+ </dd>
1924
+ </dl>
1925
+ </dd>
1926
+ </dl>
1927
+
1928
+ #### ⚙️ Parameters
1929
+
1930
+ <dl>
1931
+ <dd>
1932
+
1933
+ <dl>
1934
+ <dd>
1935
+
1936
+ **token:** `str`
1937
+
1938
+ </dd>
1939
+ </dl>
1940
+
1941
+ <dl>
1942
+ <dd>
1943
+
1944
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1945
+
1946
+ </dd>
1947
+ </dl>
1948
+ </dd>
1949
+ </dl>
1950
+
1951
+
1952
+ </dd>
1953
+ </dl>
1954
+ </details>
1955
+
1956
+ ## organization-memberships
1957
+ <details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">list</a>(...)</code></summary>
1958
+ <dl>
1959
+ <dd>
1960
+
1961
+ #### 🔌 Usage
1962
+
1963
+ <dl>
1964
+ <dd>
1965
+
1966
+ <dl>
1967
+ <dd>
1968
+
1969
+ ```python
1970
+ from mirascope.api._generated import Mirascope
1971
+
1972
+ client = Mirascope()
1973
+ client.organization_memberships.list(
1974
+ organization_id="organizationId",
1975
+ )
1976
+
1977
+ ```
1978
+ </dd>
1979
+ </dl>
1980
+ </dd>
1981
+ </dl>
1982
+
1983
+ #### ⚙️ Parameters
1984
+
1985
+ <dl>
1986
+ <dd>
1987
+
1988
+ <dl>
1989
+ <dd>
1990
+
1991
+ **organization_id:** `str`
1992
+
1993
+ </dd>
1994
+ </dl>
1995
+
1996
+ <dl>
1997
+ <dd>
1998
+
1999
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2000
+
2001
+ </dd>
2002
+ </dl>
2003
+ </dd>
2004
+ </dl>
2005
+
2006
+
2007
+ </dd>
2008
+ </dl>
2009
+ </details>
2010
+
2011
+ <details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">delete</a>(...)</code></summary>
2012
+ <dl>
2013
+ <dd>
2014
+
2015
+ #### 🔌 Usage
2016
+
2017
+ <dl>
2018
+ <dd>
2019
+
2020
+ <dl>
2021
+ <dd>
2022
+
2023
+ ```python
2024
+ from mirascope.api._generated import Mirascope
2025
+
2026
+ client = Mirascope()
2027
+ client.organization_memberships.delete(
2028
+ organization_id="organizationId",
2029
+ member_id="memberId",
2030
+ )
2031
+
2032
+ ```
2033
+ </dd>
2034
+ </dl>
2035
+ </dd>
2036
+ </dl>
2037
+
2038
+ #### ⚙️ Parameters
2039
+
2040
+ <dl>
2041
+ <dd>
2042
+
2043
+ <dl>
2044
+ <dd>
2045
+
2046
+ **organization_id:** `str`
2047
+
2048
+ </dd>
2049
+ </dl>
2050
+
2051
+ <dl>
2052
+ <dd>
2053
+
2054
+ **member_id:** `str`
2055
+
2056
+ </dd>
2057
+ </dl>
2058
+
2059
+ <dl>
2060
+ <dd>
2061
+
2062
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2063
+
2064
+ </dd>
2065
+ </dl>
2066
+ </dd>
2067
+ </dl>
2068
+
2069
+
2070
+ </dd>
2071
+ </dl>
2072
+ </details>
2073
+
2074
+ <details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">update</a>(...)</code></summary>
2075
+ <dl>
2076
+ <dd>
2077
+
2078
+ #### 🔌 Usage
2079
+
2080
+ <dl>
2081
+ <dd>
2082
+
2083
+ <dl>
2084
+ <dd>
2085
+
2086
+ ```python
2087
+ from mirascope.api._generated import Mirascope
2088
+
2089
+ client = Mirascope()
2090
+ client.organization_memberships.update(
2091
+ organization_id="organizationId",
2092
+ member_id="memberId",
2093
+ role="ADMIN",
2094
+ )
2095
+
2096
+ ```
2097
+ </dd>
2098
+ </dl>
2099
+ </dd>
2100
+ </dl>
2101
+
2102
+ #### ⚙️ Parameters
2103
+
2104
+ <dl>
2105
+ <dd>
2106
+
2107
+ <dl>
2108
+ <dd>
2109
+
2110
+ **organization_id:** `str`
2111
+
2112
+ </dd>
2113
+ </dl>
2114
+
2115
+ <dl>
2116
+ <dd>
2117
+
2118
+ **member_id:** `str`
2119
+
2120
+ </dd>
2121
+ </dl>
2122
+
2123
+ <dl>
2124
+ <dd>
2125
+
2126
+ **role:** `OrganizationMembershipsUpdateRequestRole`
2127
+
2128
+ </dd>
2129
+ </dl>
2130
+
2131
+ <dl>
2132
+ <dd>
2133
+
2134
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2135
+
2136
+ </dd>
2137
+ </dl>
2138
+ </dd>
2139
+ </dl>
2140
+
2141
+
2142
+ </dd>
2143
+ </dl>
2144
+ </details>
2145
+
2146
+ ## projects
2147
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">list</a>(...)</code></summary>
2148
+ <dl>
2149
+ <dd>
2150
+
2151
+ #### 🔌 Usage
2152
+
2153
+ <dl>
2154
+ <dd>
2155
+
2156
+ <dl>
2157
+ <dd>
2158
+
2159
+ ```python
2160
+ from mirascope.api._generated import Mirascope
2161
+
2162
+ client = Mirascope()
2163
+ client.projects.list(
2164
+ organization_id="organizationId",
2165
+ )
2166
+
2167
+ ```
2168
+ </dd>
2169
+ </dl>
2170
+ </dd>
2171
+ </dl>
2172
+
2173
+ #### ⚙️ Parameters
2174
+
2175
+ <dl>
2176
+ <dd>
2177
+
2178
+ <dl>
2179
+ <dd>
2180
+
2181
+ **organization_id:** `str`
2182
+
2183
+ </dd>
2184
+ </dl>
2185
+
2186
+ <dl>
2187
+ <dd>
2188
+
2189
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2190
+
2191
+ </dd>
2192
+ </dl>
2193
+ </dd>
2194
+ </dl>
2195
+
2196
+
2197
+ </dd>
2198
+ </dl>
2199
+ </details>
2200
+
2201
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">create</a>(...)</code></summary>
2202
+ <dl>
2203
+ <dd>
2204
+
2205
+ #### 🔌 Usage
2206
+
2207
+ <dl>
2208
+ <dd>
2209
+
2210
+ <dl>
2211
+ <dd>
2212
+
2213
+ ```python
2214
+ from mirascope.api._generated import Mirascope
2215
+
2216
+ client = Mirascope()
2217
+ client.projects.create(
2218
+ organization_id="organizationId",
2219
+ name="name",
2220
+ slug="slug",
2221
+ )
2222
+
2223
+ ```
2224
+ </dd>
2225
+ </dl>
2226
+ </dd>
2227
+ </dl>
2228
+
2229
+ #### ⚙️ Parameters
2230
+
2231
+ <dl>
2232
+ <dd>
2233
+
2234
+ <dl>
2235
+ <dd>
2236
+
2237
+ **organization_id:** `str`
2238
+
2239
+ </dd>
2240
+ </dl>
2241
+
2242
+ <dl>
2243
+ <dd>
2244
+
2245
+ **name:** `str` — a string at most 100 character(s) long
2246
+
2247
+ </dd>
2248
+ </dl>
2249
+
2250
+ <dl>
2251
+ <dd>
2252
+
2253
+ **slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
2254
+
2255
+ </dd>
2256
+ </dl>
2257
+
2258
+ <dl>
2259
+ <dd>
2260
+
2261
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2262
+
2263
+ </dd>
2264
+ </dl>
2265
+ </dd>
2266
+ </dl>
2267
+
2268
+
2269
+ </dd>
2270
+ </dl>
2271
+ </details>
2272
+
2273
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">get</a>(...)</code></summary>
2274
+ <dl>
2275
+ <dd>
2276
+
2277
+ #### 🔌 Usage
2278
+
2279
+ <dl>
2280
+ <dd>
2281
+
2282
+ <dl>
2283
+ <dd>
2284
+
2285
+ ```python
2286
+ from mirascope.api._generated import Mirascope
2287
+
2288
+ client = Mirascope()
2289
+ client.projects.get(
2290
+ organization_id="organizationId",
2291
+ project_id="projectId",
2292
+ )
2293
+
2294
+ ```
2295
+ </dd>
2296
+ </dl>
2297
+ </dd>
2298
+ </dl>
2299
+
2300
+ #### ⚙️ Parameters
2301
+
2302
+ <dl>
2303
+ <dd>
2304
+
2305
+ <dl>
2306
+ <dd>
2307
+
2308
+ **organization_id:** `str`
2309
+
2310
+ </dd>
2311
+ </dl>
2312
+
2313
+ <dl>
2314
+ <dd>
2315
+
2316
+ **project_id:** `str`
2317
+
2318
+ </dd>
2319
+ </dl>
2320
+
2321
+ <dl>
2322
+ <dd>
2323
+
2324
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2325
+
2326
+ </dd>
2327
+ </dl>
2328
+ </dd>
2329
+ </dl>
2330
+
2331
+
2332
+ </dd>
2333
+ </dl>
2334
+ </details>
2335
+
2336
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">update</a>(...)</code></summary>
2337
+ <dl>
2338
+ <dd>
2339
+
2340
+ #### 🔌 Usage
2341
+
2342
+ <dl>
2343
+ <dd>
2344
+
2345
+ <dl>
2346
+ <dd>
2347
+
2348
+ ```python
2349
+ from mirascope.api._generated import Mirascope
2350
+
2351
+ client = Mirascope()
2352
+ client.projects.update(
2353
+ organization_id="organizationId",
2354
+ project_id="projectId",
2355
+ )
2356
+
2357
+ ```
2358
+ </dd>
2359
+ </dl>
2360
+ </dd>
2361
+ </dl>
2362
+
2363
+ #### ⚙️ Parameters
2364
+
2365
+ <dl>
2366
+ <dd>
2367
+
2368
+ <dl>
2369
+ <dd>
2370
+
2371
+ **organization_id:** `str`
2372
+
2373
+ </dd>
2374
+ </dl>
2375
+
2376
+ <dl>
2377
+ <dd>
2378
+
2379
+ **project_id:** `str`
2380
+
2381
+ </dd>
2382
+ </dl>
2383
+
2384
+ <dl>
2385
+ <dd>
2386
+
2387
+ **name:** `typing.Optional[str]` — a string at most 100 character(s) long
2388
+
2389
+ </dd>
2390
+ </dl>
2391
+
2392
+ <dl>
2393
+ <dd>
2394
+
2395
+ **slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
2396
+
2397
+ </dd>
2398
+ </dl>
2399
+
2400
+ <dl>
2401
+ <dd>
2402
+
2403
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2404
+
2405
+ </dd>
2406
+ </dl>
2407
+ </dd>
2408
+ </dl>
2409
+
2410
+
2411
+ </dd>
2412
+ </dl>
2413
+ </details>
2414
+
2415
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">delete</a>(...)</code></summary>
2416
+ <dl>
2417
+ <dd>
2418
+
2419
+ #### 🔌 Usage
2420
+
2421
+ <dl>
2422
+ <dd>
2423
+
2424
+ <dl>
2425
+ <dd>
2426
+
2427
+ ```python
2428
+ from mirascope.api._generated import Mirascope
2429
+
2430
+ client = Mirascope()
2431
+ client.projects.delete(
2432
+ organization_id="organizationId",
2433
+ project_id="projectId",
2434
+ )
2435
+
2436
+ ```
2437
+ </dd>
2438
+ </dl>
2439
+ </dd>
2440
+ </dl>
2441
+
2442
+ #### ⚙️ Parameters
2443
+
2444
+ <dl>
2445
+ <dd>
2446
+
2447
+ <dl>
2448
+ <dd>
2449
+
2450
+ **organization_id:** `str`
2451
+
2452
+ </dd>
2453
+ </dl>
2454
+
2455
+ <dl>
2456
+ <dd>
2457
+
2458
+ **project_id:** `str`
2459
+
2460
+ </dd>
2461
+ </dl>
2462
+
2463
+ <dl>
2464
+ <dd>
2465
+
2466
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2467
+
2468
+ </dd>
2469
+ </dl>
2470
+ </dd>
2471
+ </dl>
2472
+
2473
+
2474
+ </dd>
2475
+ </dl>
2476
+ </details>
2477
+
2478
+ ## project-memberships
2479
+ <details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">list</a>(...)</code></summary>
2480
+ <dl>
2481
+ <dd>
2482
+
2483
+ #### 🔌 Usage
2484
+
2485
+ <dl>
2486
+ <dd>
2487
+
2488
+ <dl>
2489
+ <dd>
2490
+
2491
+ ```python
2492
+ from mirascope.api._generated import Mirascope
2493
+
2494
+ client = Mirascope()
2495
+ client.project_memberships.list(
2496
+ organization_id="organizationId",
2497
+ project_id="projectId",
2498
+ )
2499
+
2500
+ ```
2501
+ </dd>
2502
+ </dl>
2503
+ </dd>
2504
+ </dl>
2505
+
2506
+ #### ⚙️ Parameters
2507
+
2508
+ <dl>
2509
+ <dd>
2510
+
2511
+ <dl>
2512
+ <dd>
2513
+
2514
+ **organization_id:** `str`
2515
+
2516
+ </dd>
2517
+ </dl>
2518
+
2519
+ <dl>
2520
+ <dd>
2521
+
2522
+ **project_id:** `str`
2523
+
2524
+ </dd>
2525
+ </dl>
2526
+
2527
+ <dl>
2528
+ <dd>
2529
+
2530
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2531
+
2532
+ </dd>
2533
+ </dl>
2534
+ </dd>
2535
+ </dl>
2536
+
2537
+
2538
+ </dd>
2539
+ </dl>
2540
+ </details>
2541
+
2542
+ <details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">create</a>(...)</code></summary>
2543
+ <dl>
2544
+ <dd>
2545
+
2546
+ #### 🔌 Usage
2547
+
2548
+ <dl>
2549
+ <dd>
2550
+
2551
+ <dl>
2552
+ <dd>
2553
+
2554
+ ```python
2555
+ from mirascope.api._generated import Mirascope
2556
+
2557
+ client = Mirascope()
2558
+ client.project_memberships.create(
2559
+ organization_id="organizationId",
2560
+ project_id="projectId",
2561
+ member_id="memberId",
2562
+ role="ADMIN",
2563
+ )
2564
+
2565
+ ```
2566
+ </dd>
2567
+ </dl>
2568
+ </dd>
2569
+ </dl>
2570
+
2571
+ #### ⚙️ Parameters
2572
+
2573
+ <dl>
2574
+ <dd>
2575
+
2576
+ <dl>
2577
+ <dd>
2578
+
2579
+ **organization_id:** `str`
2580
+
2581
+ </dd>
2582
+ </dl>
2583
+
2584
+ <dl>
2585
+ <dd>
2586
+
2587
+ **project_id:** `str`
2588
+
2589
+ </dd>
2590
+ </dl>
2591
+
2592
+ <dl>
2593
+ <dd>
2594
+
2595
+ **member_id:** `str`
2596
+
2597
+ </dd>
2598
+ </dl>
2599
+
2600
+ <dl>
2601
+ <dd>
2602
+
2603
+ **role:** `ProjectMembershipsCreateRequestRole`
2604
+
2605
+ </dd>
2606
+ </dl>
2607
+
2608
+ <dl>
2609
+ <dd>
2610
+
2611
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2612
+
2613
+ </dd>
2614
+ </dl>
2615
+ </dd>
2616
+ </dl>
2617
+
2618
+
2619
+ </dd>
2620
+ </dl>
2621
+ </details>
2622
+
2623
+ <details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">delete</a>(...)</code></summary>
2624
+ <dl>
2625
+ <dd>
2626
+
2627
+ #### 🔌 Usage
2628
+
2629
+ <dl>
2630
+ <dd>
2631
+
2632
+ <dl>
2633
+ <dd>
2634
+
2635
+ ```python
2636
+ from mirascope.api._generated import Mirascope
2637
+
2638
+ client = Mirascope()
2639
+ client.project_memberships.delete(
2640
+ organization_id="organizationId",
2641
+ project_id="projectId",
2642
+ member_id="memberId",
2643
+ )
2644
+
2645
+ ```
2646
+ </dd>
2647
+ </dl>
2648
+ </dd>
2649
+ </dl>
2650
+
2651
+ #### ⚙️ Parameters
2652
+
2653
+ <dl>
2654
+ <dd>
2655
+
2656
+ <dl>
2657
+ <dd>
2658
+
2659
+ **organization_id:** `str`
2660
+
2661
+ </dd>
2662
+ </dl>
2663
+
2664
+ <dl>
2665
+ <dd>
2666
+
2667
+ **project_id:** `str`
2668
+
2669
+ </dd>
2670
+ </dl>
2671
+
2672
+ <dl>
2673
+ <dd>
2674
+
2675
+ **member_id:** `str`
2676
+
2677
+ </dd>
2678
+ </dl>
2679
+
2680
+ <dl>
2681
+ <dd>
2682
+
2683
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2684
+
2685
+ </dd>
2686
+ </dl>
2687
+ </dd>
2688
+ </dl>
2689
+
2690
+
2691
+ </dd>
2692
+ </dl>
2693
+ </details>
2694
+
2695
+ <details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">update</a>(...)</code></summary>
2696
+ <dl>
2697
+ <dd>
2698
+
2699
+ #### 🔌 Usage
2700
+
2701
+ <dl>
2702
+ <dd>
2703
+
2704
+ <dl>
2705
+ <dd>
2706
+
2707
+ ```python
2708
+ from mirascope.api._generated import Mirascope
2709
+
2710
+ client = Mirascope()
2711
+ client.project_memberships.update(
2712
+ organization_id="organizationId",
2713
+ project_id="projectId",
2714
+ member_id="memberId",
2715
+ role="ADMIN",
2716
+ )
2717
+
2718
+ ```
2719
+ </dd>
2720
+ </dl>
2721
+ </dd>
2722
+ </dl>
2723
+
2724
+ #### ⚙️ Parameters
2725
+
2726
+ <dl>
2727
+ <dd>
2728
+
2729
+ <dl>
2730
+ <dd>
2731
+
2732
+ **organization_id:** `str`
2733
+
2734
+ </dd>
2735
+ </dl>
2736
+
2737
+ <dl>
2738
+ <dd>
2739
+
2740
+ **project_id:** `str`
2741
+
2742
+ </dd>
2743
+ </dl>
2744
+
2745
+ <dl>
2746
+ <dd>
2747
+
2748
+ **member_id:** `str`
2749
+
2750
+ </dd>
2751
+ </dl>
2752
+
2753
+ <dl>
2754
+ <dd>
2755
+
2756
+ **role:** `ProjectMembershipsUpdateRequestRole`
2757
+
2758
+ </dd>
2759
+ </dl>
2760
+
2761
+ <dl>
2762
+ <dd>
2763
+
2764
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2765
+
2766
+ </dd>
2767
+ </dl>
2768
+ </dd>
2769
+ </dl>
2770
+
2771
+
2772
+ </dd>
2773
+ </dl>
2774
+ </details>
2775
+
2776
+ ## environments
2777
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">list</a>(...)</code></summary>
2778
+ <dl>
2779
+ <dd>
2780
+
2781
+ #### 🔌 Usage
2782
+
2783
+ <dl>
2784
+ <dd>
2785
+
2786
+ <dl>
2787
+ <dd>
2788
+
2789
+ ```python
2790
+ from mirascope.api._generated import Mirascope
2791
+
2792
+ client = Mirascope()
2793
+ client.environments.list(
2794
+ organization_id="organizationId",
2795
+ project_id="projectId",
2796
+ )
2797
+
2798
+ ```
2799
+ </dd>
2800
+ </dl>
2801
+ </dd>
2802
+ </dl>
2803
+
2804
+ #### ⚙️ Parameters
2805
+
2806
+ <dl>
2807
+ <dd>
2808
+
2809
+ <dl>
2810
+ <dd>
2811
+
2812
+ **organization_id:** `str`
2813
+
2814
+ </dd>
2815
+ </dl>
2816
+
2817
+ <dl>
2818
+ <dd>
2819
+
2820
+ **project_id:** `str`
2821
+
2822
+ </dd>
2823
+ </dl>
2824
+
2825
+ <dl>
2826
+ <dd>
2827
+
2828
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2829
+
2830
+ </dd>
2831
+ </dl>
2832
+ </dd>
2833
+ </dl>
2834
+
2835
+
2836
+ </dd>
2837
+ </dl>
2838
+ </details>
2839
+
2840
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">create</a>(...)</code></summary>
2841
+ <dl>
2842
+ <dd>
2843
+
2844
+ #### 🔌 Usage
2845
+
2846
+ <dl>
2847
+ <dd>
2848
+
2849
+ <dl>
2850
+ <dd>
2851
+
2852
+ ```python
2853
+ from mirascope.api._generated import Mirascope
2854
+
2855
+ client = Mirascope()
2856
+ client.environments.create(
2857
+ organization_id="organizationId",
2858
+ project_id="projectId",
2859
+ name="name",
2860
+ slug="slug",
2861
+ )
2862
+
2863
+ ```
2864
+ </dd>
2865
+ </dl>
2866
+ </dd>
2867
+ </dl>
2868
+
2869
+ #### ⚙️ Parameters
2870
+
2871
+ <dl>
2872
+ <dd>
2873
+
2874
+ <dl>
2875
+ <dd>
2876
+
2877
+ **organization_id:** `str`
2878
+
2879
+ </dd>
2880
+ </dl>
2881
+
2882
+ <dl>
2883
+ <dd>
2884
+
2885
+ **project_id:** `str`
2886
+
2887
+ </dd>
2888
+ </dl>
2889
+
2890
+ <dl>
2891
+ <dd>
2892
+
2893
+ **name:** `str` — a string at most 100 character(s) long
2894
+
2895
+ </dd>
2896
+ </dl>
2897
+
2898
+ <dl>
2899
+ <dd>
2900
+
2901
+ **slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
2902
+
2903
+ </dd>
2904
+ </dl>
2905
+
2906
+ <dl>
2907
+ <dd>
2908
+
2909
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2910
+
2911
+ </dd>
2912
+ </dl>
2913
+ </dd>
2914
+ </dl>
2915
+
2916
+
2917
+ </dd>
2918
+ </dl>
2919
+ </details>
2920
+
2921
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">get</a>(...)</code></summary>
2922
+ <dl>
2923
+ <dd>
2924
+
2925
+ #### 🔌 Usage
2926
+
2927
+ <dl>
2928
+ <dd>
2929
+
2930
+ <dl>
2931
+ <dd>
2932
+
2933
+ ```python
2934
+ from mirascope.api._generated import Mirascope
2935
+
2936
+ client = Mirascope()
2937
+ client.environments.get(
2938
+ organization_id="organizationId",
2939
+ project_id="projectId",
2940
+ environment_id="environmentId",
2941
+ )
2942
+
2943
+ ```
2944
+ </dd>
2945
+ </dl>
2946
+ </dd>
2947
+ </dl>
2948
+
2949
+ #### ⚙️ Parameters
2950
+
2951
+ <dl>
2952
+ <dd>
2953
+
2954
+ <dl>
2955
+ <dd>
2956
+
2957
+ **organization_id:** `str`
2958
+
2959
+ </dd>
2960
+ </dl>
2961
+
2962
+ <dl>
2963
+ <dd>
2964
+
2965
+ **project_id:** `str`
2966
+
2967
+ </dd>
2968
+ </dl>
2969
+
2970
+ <dl>
2971
+ <dd>
2972
+
2973
+ **environment_id:** `str`
2974
+
2975
+ </dd>
2976
+ </dl>
2977
+
2978
+ <dl>
2979
+ <dd>
2980
+
2981
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2982
+
2983
+ </dd>
2984
+ </dl>
2985
+ </dd>
2986
+ </dl>
2987
+
2988
+
2989
+ </dd>
2990
+ </dl>
2991
+ </details>
2992
+
2993
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">update</a>(...)</code></summary>
2994
+ <dl>
2995
+ <dd>
2996
+
2997
+ #### 🔌 Usage
2998
+
2999
+ <dl>
3000
+ <dd>
3001
+
3002
+ <dl>
3003
+ <dd>
3004
+
3005
+ ```python
3006
+ from mirascope.api._generated import Mirascope
3007
+
3008
+ client = Mirascope()
3009
+ client.environments.update(
3010
+ organization_id="organizationId",
3011
+ project_id="projectId",
3012
+ environment_id="environmentId",
3013
+ )
3014
+
3015
+ ```
3016
+ </dd>
3017
+ </dl>
3018
+ </dd>
3019
+ </dl>
3020
+
3021
+ #### ⚙️ Parameters
3022
+
3023
+ <dl>
3024
+ <dd>
3025
+
3026
+ <dl>
3027
+ <dd>
3028
+
3029
+ **organization_id:** `str`
3030
+
3031
+ </dd>
3032
+ </dl>
3033
+
3034
+ <dl>
3035
+ <dd>
3036
+
3037
+ **project_id:** `str`
3038
+
3039
+ </dd>
3040
+ </dl>
3041
+
3042
+ <dl>
3043
+ <dd>
3044
+
3045
+ **environment_id:** `str`
3046
+
3047
+ </dd>
3048
+ </dl>
3049
+
3050
+ <dl>
3051
+ <dd>
3052
+
3053
+ **name:** `typing.Optional[str]` — a string at most 100 character(s) long
3054
+
3055
+ </dd>
3056
+ </dl>
3057
+
3058
+ <dl>
3059
+ <dd>
3060
+
3061
+ **slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
3062
+
3063
+ </dd>
3064
+ </dl>
3065
+
3066
+ <dl>
3067
+ <dd>
3068
+
3069
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3070
+
3071
+ </dd>
3072
+ </dl>
3073
+ </dd>
3074
+ </dl>
3075
+
3076
+
3077
+ </dd>
3078
+ </dl>
3079
+ </details>
3080
+
3081
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">delete</a>(...)</code></summary>
3082
+ <dl>
3083
+ <dd>
3084
+
3085
+ #### 🔌 Usage
3086
+
3087
+ <dl>
3088
+ <dd>
3089
+
3090
+ <dl>
3091
+ <dd>
3092
+
3093
+ ```python
3094
+ from mirascope.api._generated import Mirascope
3095
+
3096
+ client = Mirascope()
3097
+ client.environments.delete(
3098
+ organization_id="organizationId",
3099
+ project_id="projectId",
3100
+ environment_id="environmentId",
3101
+ )
3102
+
3103
+ ```
3104
+ </dd>
3105
+ </dl>
3106
+ </dd>
3107
+ </dl>
3108
+
3109
+ #### ⚙️ Parameters
3110
+
3111
+ <dl>
3112
+ <dd>
3113
+
3114
+ <dl>
3115
+ <dd>
3116
+
3117
+ **organization_id:** `str`
3118
+
3119
+ </dd>
3120
+ </dl>
3121
+
3122
+ <dl>
3123
+ <dd>
3124
+
3125
+ **project_id:** `str`
3126
+
3127
+ </dd>
3128
+ </dl>
3129
+
3130
+ <dl>
3131
+ <dd>
3132
+
3133
+ **environment_id:** `str`
3134
+
3135
+ </dd>
3136
+ </dl>
3137
+
3138
+ <dl>
3139
+ <dd>
3140
+
3141
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3142
+
3143
+ </dd>
3144
+ </dl>
3145
+ </dd>
3146
+ </dl>
3147
+
3148
+
3149
+ </dd>
3150
+ </dl>
3151
+ </details>
3152
+
3153
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">getanalytics</a>(...)</code></summary>
3154
+ <dl>
3155
+ <dd>
3156
+
3157
+ #### 🔌 Usage
3158
+
3159
+ <dl>
3160
+ <dd>
3161
+
3162
+ <dl>
3163
+ <dd>
3164
+
3165
+ ```python
3166
+ from mirascope.api._generated import Mirascope
3167
+
3168
+ client = Mirascope()
3169
+ client.environments.getanalytics(
3170
+ organization_id="organizationId",
3171
+ project_id="projectId",
3172
+ environment_id="environmentId",
3173
+ start_time="startTime",
3174
+ end_time="endTime",
3175
+ )
3176
+
3177
+ ```
3178
+ </dd>
3179
+ </dl>
3180
+ </dd>
3181
+ </dl>
3182
+
3183
+ #### ⚙️ Parameters
3184
+
3185
+ <dl>
3186
+ <dd>
3187
+
3188
+ <dl>
3189
+ <dd>
3190
+
3191
+ **organization_id:** `str`
3192
+
3193
+ </dd>
3194
+ </dl>
3195
+
3196
+ <dl>
3197
+ <dd>
3198
+
3199
+ **project_id:** `str`
3200
+
3201
+ </dd>
3202
+ </dl>
3203
+
3204
+ <dl>
3205
+ <dd>
3206
+
3207
+ **environment_id:** `str`
3208
+
3209
+ </dd>
3210
+ </dl>
3211
+
3212
+ <dl>
3213
+ <dd>
3214
+
3215
+ **start_time:** `str`
3216
+
3217
+ </dd>
3218
+ </dl>
3219
+
3220
+ <dl>
3221
+ <dd>
3222
+
3223
+ **end_time:** `str`
3224
+
3225
+ </dd>
3226
+ </dl>
3227
+
3228
+ <dl>
3229
+ <dd>
3230
+
3231
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3232
+
3233
+ </dd>
3234
+ </dl>
3235
+ </dd>
3236
+ </dl>
3237
+
3238
+
3239
+ </dd>
3240
+ </dl>
3241
+ </details>
3242
+
3243
+ ## apiKeys
3244
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_list_all_for_org</a>(...)</code></summary>
3245
+ <dl>
3246
+ <dd>
3247
+
3248
+ #### 🔌 Usage
3249
+
3250
+ <dl>
3251
+ <dd>
3252
+
3253
+ <dl>
3254
+ <dd>
3255
+
3256
+ ```python
3257
+ from mirascope.api._generated import Mirascope
3258
+
3259
+ client = Mirascope()
3260
+ client.api_keys.api_keys_list_all_for_org(
3261
+ organization_id="organizationId",
3262
+ )
3263
+
3264
+ ```
3265
+ </dd>
3266
+ </dl>
3267
+ </dd>
3268
+ </dl>
3269
+
3270
+ #### ⚙️ Parameters
3271
+
3272
+ <dl>
3273
+ <dd>
3274
+
3275
+ <dl>
3276
+ <dd>
3277
+
3278
+ **organization_id:** `str`
3279
+
3280
+ </dd>
3281
+ </dl>
3282
+
3283
+ <dl>
3284
+ <dd>
3285
+
3286
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3287
+
3288
+ </dd>
3289
+ </dl>
3290
+ </dd>
3291
+ </dl>
3292
+
3293
+
3294
+ </dd>
3295
+ </dl>
3296
+ </details>
3297
+
3298
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_list</a>(...)</code></summary>
3299
+ <dl>
3300
+ <dd>
3301
+
3302
+ #### 🔌 Usage
3303
+
3304
+ <dl>
3305
+ <dd>
3306
+
3307
+ <dl>
3308
+ <dd>
3309
+
3310
+ ```python
3311
+ from mirascope.api._generated import Mirascope
3312
+
3313
+ client = Mirascope()
3314
+ client.api_keys.api_keys_list(
3315
+ organization_id="organizationId",
3316
+ project_id="projectId",
3317
+ environment_id="environmentId",
3318
+ )
3319
+
3320
+ ```
3321
+ </dd>
3322
+ </dl>
3323
+ </dd>
3324
+ </dl>
3325
+
3326
+ #### ⚙️ Parameters
3327
+
3328
+ <dl>
3329
+ <dd>
3330
+
3331
+ <dl>
3332
+ <dd>
3333
+
3334
+ **organization_id:** `str`
3335
+
3336
+ </dd>
3337
+ </dl>
3338
+
3339
+ <dl>
3340
+ <dd>
3341
+
3342
+ **project_id:** `str`
3343
+
3344
+ </dd>
3345
+ </dl>
3346
+
3347
+ <dl>
3348
+ <dd>
3349
+
3350
+ **environment_id:** `str`
3351
+
3352
+ </dd>
3353
+ </dl>
3354
+
3355
+ <dl>
3356
+ <dd>
3357
+
3358
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3359
+
3360
+ </dd>
3361
+ </dl>
3362
+ </dd>
3363
+ </dl>
3364
+
3365
+
3366
+ </dd>
3367
+ </dl>
3368
+ </details>
3369
+
3370
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_create</a>(...)</code></summary>
3371
+ <dl>
3372
+ <dd>
3373
+
3374
+ #### 🔌 Usage
3375
+
3376
+ <dl>
3377
+ <dd>
3378
+
3379
+ <dl>
3380
+ <dd>
3381
+
3382
+ ```python
3383
+ from mirascope.api._generated import Mirascope
3384
+
3385
+ client = Mirascope()
3386
+ client.api_keys.api_keys_create(
3387
+ organization_id="organizationId",
3388
+ project_id="projectId",
3389
+ environment_id="environmentId",
3390
+ name="name",
3391
+ )
3392
+
3393
+ ```
3394
+ </dd>
3395
+ </dl>
3396
+ </dd>
3397
+ </dl>
3398
+
3399
+ #### ⚙️ Parameters
3400
+
3401
+ <dl>
3402
+ <dd>
3403
+
3404
+ <dl>
3405
+ <dd>
3406
+
3407
+ **organization_id:** `str`
3408
+
3409
+ </dd>
3410
+ </dl>
3411
+
3412
+ <dl>
3413
+ <dd>
3414
+
3415
+ **project_id:** `str`
3416
+
3417
+ </dd>
3418
+ </dl>
3419
+
3420
+ <dl>
3421
+ <dd>
3422
+
3423
+ **environment_id:** `str`
3424
+
3425
+ </dd>
3426
+ </dl>
3427
+
3428
+ <dl>
3429
+ <dd>
3430
+
3431
+ **name:** `str` — a string at most 100 character(s) long
3432
+
3433
+ </dd>
3434
+ </dl>
3435
+
3436
+ <dl>
3437
+ <dd>
3438
+
3439
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3440
+
3441
+ </dd>
3442
+ </dl>
3443
+ </dd>
3444
+ </dl>
3445
+
3446
+
3447
+ </dd>
3448
+ </dl>
3449
+ </details>
3450
+
3451
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_get</a>(...)</code></summary>
3452
+ <dl>
3453
+ <dd>
3454
+
3455
+ #### 🔌 Usage
3456
+
3457
+ <dl>
3458
+ <dd>
3459
+
3460
+ <dl>
3461
+ <dd>
3462
+
3463
+ ```python
3464
+ from mirascope.api._generated import Mirascope
3465
+
3466
+ client = Mirascope()
3467
+ client.api_keys.api_keys_get(
3468
+ organization_id="organizationId",
3469
+ project_id="projectId",
3470
+ environment_id="environmentId",
3471
+ api_key_id="apiKeyId",
3472
+ )
3473
+
3474
+ ```
3475
+ </dd>
3476
+ </dl>
3477
+ </dd>
3478
+ </dl>
3479
+
3480
+ #### ⚙️ Parameters
3481
+
3482
+ <dl>
3483
+ <dd>
3484
+
3485
+ <dl>
3486
+ <dd>
3487
+
3488
+ **organization_id:** `str`
3489
+
3490
+ </dd>
3491
+ </dl>
3492
+
3493
+ <dl>
3494
+ <dd>
3495
+
3496
+ **project_id:** `str`
3497
+
3498
+ </dd>
3499
+ </dl>
3500
+
3501
+ <dl>
3502
+ <dd>
3503
+
3504
+ **environment_id:** `str`
3505
+
3506
+ </dd>
3507
+ </dl>
3508
+
3509
+ <dl>
3510
+ <dd>
3511
+
3512
+ **api_key_id:** `str`
3513
+
3514
+ </dd>
3515
+ </dl>
3516
+
3517
+ <dl>
3518
+ <dd>
3519
+
3520
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3521
+
3522
+ </dd>
3523
+ </dl>
3524
+ </dd>
3525
+ </dl>
3526
+
3527
+
3528
+ </dd>
3529
+ </dl>
3530
+ </details>
3531
+
3532
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_delete</a>(...)</code></summary>
3533
+ <dl>
3534
+ <dd>
3535
+
3536
+ #### 🔌 Usage
3537
+
3538
+ <dl>
3539
+ <dd>
3540
+
3541
+ <dl>
3542
+ <dd>
3543
+
3544
+ ```python
3545
+ from mirascope.api._generated import Mirascope
3546
+
3547
+ client = Mirascope()
3548
+ client.api_keys.api_keys_delete(
3549
+ organization_id="organizationId",
3550
+ project_id="projectId",
3551
+ environment_id="environmentId",
3552
+ api_key_id="apiKeyId",
3553
+ )
3554
+
3555
+ ```
3556
+ </dd>
3557
+ </dl>
3558
+ </dd>
3559
+ </dl>
3560
+
3561
+ #### ⚙️ Parameters
3562
+
3563
+ <dl>
3564
+ <dd>
3565
+
3566
+ <dl>
3567
+ <dd>
3568
+
3569
+ **organization_id:** `str`
3570
+
3571
+ </dd>
3572
+ </dl>
3573
+
3574
+ <dl>
3575
+ <dd>
3576
+
3577
+ **project_id:** `str`
3578
+
3579
+ </dd>
3580
+ </dl>
3581
+
3582
+ <dl>
3583
+ <dd>
3584
+
3585
+ **environment_id:** `str`
3586
+
3587
+ </dd>
3588
+ </dl>
3589
+
3590
+ <dl>
3591
+ <dd>
3592
+
3593
+ **api_key_id:** `str`
3594
+
3595
+ </dd>
3596
+ </dl>
3597
+
3598
+ <dl>
3599
+ <dd>
3600
+
3601
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3602
+
3603
+ </dd>
3604
+ </dl>
3605
+ </dd>
3606
+ </dl>
3607
+
3608
+
3609
+ </dd>
3610
+ </dl>
3611
+ </details>
3612
+
3613
+ ## functions
3614
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">list</a>()</code></summary>
3615
+ <dl>
3616
+ <dd>
3617
+
3618
+ #### 🔌 Usage
3619
+
3620
+ <dl>
3621
+ <dd>
3622
+
3623
+ <dl>
3624
+ <dd>
3625
+
3626
+ ```python
3627
+ from mirascope.api._generated import Mirascope
3628
+
3629
+ client = Mirascope()
3630
+ client.functions.list()
3631
+
3632
+ ```
3633
+ </dd>
3634
+ </dl>
3635
+ </dd>
3636
+ </dl>
3637
+
3638
+ #### ⚙️ Parameters
3639
+
3640
+ <dl>
3641
+ <dd>
3642
+
3643
+ <dl>
3644
+ <dd>
3645
+
3646
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3647
+
3648
+ </dd>
3649
+ </dl>
3650
+ </dd>
3651
+ </dl>
3652
+
3653
+
3654
+ </dd>
3655
+ </dl>
3656
+ </details>
3657
+
3658
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">create</a>(...)</code></summary>
3659
+ <dl>
3660
+ <dd>
3661
+
3662
+ #### 🔌 Usage
3663
+
3664
+ <dl>
3665
+ <dd>
3666
+
3667
+ <dl>
3668
+ <dd>
3669
+
3670
+ ```python
3671
+ from mirascope.api._generated import Mirascope
3672
+
3673
+ client = Mirascope()
3674
+ client.functions.create(
3675
+ code="code",
3676
+ hash="hash",
3677
+ signature="signature",
3678
+ signature_hash="signatureHash",
3679
+ name="name",
3680
+ )
3681
+
3682
+ ```
3683
+ </dd>
3684
+ </dl>
3685
+ </dd>
3686
+ </dl>
3687
+
3688
+ #### ⚙️ Parameters
3689
+
3690
+ <dl>
3691
+ <dd>
3692
+
3693
+ <dl>
3694
+ <dd>
3695
+
3696
+ **code:** `str`
3697
+
3698
+ </dd>
3699
+ </dl>
3700
+
3701
+ <dl>
3702
+ <dd>
3703
+
3704
+ **hash:** `str`
3705
+
3706
+ </dd>
3707
+ </dl>
3708
+
3709
+ <dl>
3710
+ <dd>
3711
+
3712
+ **signature:** `str`
3713
+
3714
+ </dd>
3715
+ </dl>
3716
+
3717
+ <dl>
3718
+ <dd>
3719
+
3720
+ **signature_hash:** `str`
3721
+
3722
+ </dd>
3723
+ </dl>
3724
+
3725
+ <dl>
3726
+ <dd>
3727
+
3728
+ **name:** `str`
3729
+
3730
+ </dd>
3731
+ </dl>
3732
+
3733
+ <dl>
3734
+ <dd>
3735
+
3736
+ **description:** `typing.Optional[str]`
3737
+
3738
+ </dd>
3739
+ </dl>
3740
+
3741
+ <dl>
3742
+ <dd>
3743
+
3744
+ **tags:** `typing.Optional[typing.Sequence[str]]`
3745
+
3746
+ </dd>
3747
+ </dl>
3748
+
3749
+ <dl>
3750
+ <dd>
3751
+
3752
+ **metadata:** `typing.Optional[typing.Dict[str, typing.Optional[str]]]`
3753
+
3754
+ </dd>
3755
+ </dl>
3756
+
3757
+ <dl>
3758
+ <dd>
3759
+
3760
+ **dependencies:** `typing.Optional[
3761
+ typing.Dict[str, typing.Optional[FunctionsCreateRequestDependenciesValue]]
3762
+ ]`
3763
+
3764
+ </dd>
3765
+ </dl>
3766
+
3767
+ <dl>
3768
+ <dd>
3769
+
3770
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3771
+
3772
+ </dd>
3773
+ </dl>
3774
+ </dd>
3775
+ </dl>
3776
+
3777
+
3778
+ </dd>
3779
+ </dl>
3780
+ </details>
3781
+
3782
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">get</a>(...)</code></summary>
3783
+ <dl>
3784
+ <dd>
3785
+
3786
+ #### 🔌 Usage
3787
+
3788
+ <dl>
3789
+ <dd>
3790
+
3791
+ <dl>
3792
+ <dd>
3793
+
3794
+ ```python
3795
+ from mirascope.api._generated import Mirascope
3796
+
3797
+ client = Mirascope()
3798
+ client.functions.get(
3799
+ id="id",
3800
+ )
3801
+
3802
+ ```
3803
+ </dd>
3804
+ </dl>
3805
+ </dd>
3806
+ </dl>
3807
+
3808
+ #### ⚙️ Parameters
3809
+
3810
+ <dl>
3811
+ <dd>
3812
+
3813
+ <dl>
3814
+ <dd>
3815
+
3816
+ **id:** `str`
3817
+
3818
+ </dd>
3819
+ </dl>
3820
+
3821
+ <dl>
3822
+ <dd>
3823
+
3824
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3825
+
3826
+ </dd>
3827
+ </dl>
3828
+ </dd>
3829
+ </dl>
3830
+
3831
+
3832
+ </dd>
3833
+ </dl>
3834
+ </details>
3835
+
3836
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">delete</a>(...)</code></summary>
3837
+ <dl>
3838
+ <dd>
3839
+
3840
+ #### 🔌 Usage
3841
+
3842
+ <dl>
3843
+ <dd>
3844
+
3845
+ <dl>
3846
+ <dd>
3847
+
3848
+ ```python
3849
+ from mirascope.api._generated import Mirascope
3850
+
3851
+ client = Mirascope()
3852
+ client.functions.delete(
3853
+ id="id",
3854
+ )
3855
+
3856
+ ```
3857
+ </dd>
3858
+ </dl>
3859
+ </dd>
3860
+ </dl>
3861
+
3862
+ #### ⚙️ Parameters
3863
+
3864
+ <dl>
3865
+ <dd>
3866
+
3867
+ <dl>
3868
+ <dd>
3869
+
3870
+ **id:** `str`
3871
+
3872
+ </dd>
3873
+ </dl>
3874
+
3875
+ <dl>
3876
+ <dd>
3877
+
3878
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3879
+
3880
+ </dd>
3881
+ </dl>
3882
+ </dd>
3883
+ </dl>
3884
+
3885
+
3886
+ </dd>
3887
+ </dl>
3888
+ </details>
3889
+
3890
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">findbyhash</a>(...)</code></summary>
3891
+ <dl>
3892
+ <dd>
3893
+
3894
+ #### 🔌 Usage
3895
+
3896
+ <dl>
3897
+ <dd>
3898
+
3899
+ <dl>
3900
+ <dd>
3901
+
3902
+ ```python
3903
+ from mirascope.api._generated import Mirascope
3904
+
3905
+ client = Mirascope()
3906
+ client.functions.findbyhash(
3907
+ hash="hash",
3908
+ )
3909
+
3910
+ ```
3911
+ </dd>
3912
+ </dl>
3913
+ </dd>
3914
+ </dl>
3915
+
3916
+ #### ⚙️ Parameters
3917
+
3918
+ <dl>
3919
+ <dd>
3920
+
3921
+ <dl>
3922
+ <dd>
3923
+
3924
+ **hash:** `str`
3925
+
3926
+ </dd>
3927
+ </dl>
3928
+
3929
+ <dl>
3930
+ <dd>
3931
+
3932
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3933
+
3934
+ </dd>
3935
+ </dl>
3936
+ </dd>
3937
+ </dl>
3938
+
3939
+
3940
+ </dd>
3941
+ </dl>
3942
+ </details>
3943
+
3944
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">getbyenv</a>(...)</code></summary>
3945
+ <dl>
3946
+ <dd>
3947
+
3948
+ #### 🔌 Usage
3949
+
3950
+ <dl>
3951
+ <dd>
3952
+
3953
+ <dl>
3954
+ <dd>
3955
+
3956
+ ```python
3957
+ from mirascope.api._generated import Mirascope
3958
+
3959
+ client = Mirascope()
3960
+ client.functions.getbyenv(
3961
+ organization_id="organizationId",
3962
+ project_id="projectId",
3963
+ environment_id="environmentId",
3964
+ function_id="functionId",
3965
+ )
3966
+
3967
+ ```
3968
+ </dd>
3969
+ </dl>
3970
+ </dd>
3971
+ </dl>
3972
+
3973
+ #### ⚙️ Parameters
3974
+
3975
+ <dl>
3976
+ <dd>
3977
+
3978
+ <dl>
3979
+ <dd>
3980
+
3981
+ **organization_id:** `str`
3982
+
3983
+ </dd>
3984
+ </dl>
3985
+
3986
+ <dl>
3987
+ <dd>
3988
+
3989
+ **project_id:** `str`
3990
+
3991
+ </dd>
3992
+ </dl>
3993
+
3994
+ <dl>
3995
+ <dd>
3996
+
3997
+ **environment_id:** `str`
3998
+
3999
+ </dd>
4000
+ </dl>
4001
+
4002
+ <dl>
4003
+ <dd>
4004
+
4005
+ **function_id:** `str`
4006
+
4007
+ </dd>
4008
+ </dl>
4009
+
4010
+ <dl>
4011
+ <dd>
4012
+
4013
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4014
+
4015
+ </dd>
4016
+ </dl>
4017
+ </dd>
4018
+ </dl>
4019
+
4020
+
4021
+ </dd>
4022
+ </dl>
4023
+ </details>
4024
+
4025
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">listbyenv</a>(...)</code></summary>
4026
+ <dl>
4027
+ <dd>
4028
+
4029
+ #### 🔌 Usage
4030
+
4031
+ <dl>
4032
+ <dd>
4033
+
4034
+ <dl>
4035
+ <dd>
4036
+
4037
+ ```python
4038
+ from mirascope.api._generated import Mirascope
4039
+
4040
+ client = Mirascope()
4041
+ client.functions.listbyenv(
4042
+ organization_id="organizationId",
4043
+ project_id="projectId",
4044
+ environment_id="environmentId",
4045
+ )
4046
+
4047
+ ```
4048
+ </dd>
4049
+ </dl>
4050
+ </dd>
4051
+ </dl>
4052
+
4053
+ #### ⚙️ Parameters
4054
+
4055
+ <dl>
4056
+ <dd>
4057
+
4058
+ <dl>
4059
+ <dd>
4060
+
4061
+ **organization_id:** `str`
4062
+
4063
+ </dd>
4064
+ </dl>
4065
+
4066
+ <dl>
4067
+ <dd>
4068
+
4069
+ **project_id:** `str`
4070
+
4071
+ </dd>
4072
+ </dl>
4073
+
4074
+ <dl>
4075
+ <dd>
4076
+
4077
+ **environment_id:** `str`
4078
+
4079
+ </dd>
4080
+ </dl>
4081
+
4082
+ <dl>
4083
+ <dd>
4084
+
4085
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4086
+
4087
+ </dd>
4088
+ </dl>
4089
+ </dd>
4090
+ </dl>
4091
+
4092
+
4093
+ </dd>
4094
+ </dl>
4095
+ </details>
4096
+
4097
+ ## annotations
4098
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">list</a>(...)</code></summary>
4099
+ <dl>
4100
+ <dd>
4101
+
4102
+ #### 🔌 Usage
4103
+
4104
+ <dl>
4105
+ <dd>
4106
+
4107
+ <dl>
4108
+ <dd>
4109
+
4110
+ ```python
4111
+ from mirascope.api._generated import Mirascope
4112
+
4113
+ client = Mirascope()
4114
+ client.annotations.list()
4115
+
4116
+ ```
4117
+ </dd>
4118
+ </dl>
4119
+ </dd>
4120
+ </dl>
4121
+
4122
+ #### ⚙️ Parameters
4123
+
4124
+ <dl>
4125
+ <dd>
4126
+
4127
+ <dl>
4128
+ <dd>
4129
+
4130
+ **otel_trace_id:** `typing.Optional[str]`
4131
+
4132
+ </dd>
4133
+ </dl>
4134
+
4135
+ <dl>
4136
+ <dd>
4137
+
4138
+ **otel_span_id:** `typing.Optional[str]`
4139
+
4140
+ </dd>
4141
+ </dl>
4142
+
4143
+ <dl>
4144
+ <dd>
4145
+
4146
+ **label:** `typing.Optional[AnnotationsListRequestLabel]`
4147
+
4148
+ </dd>
4149
+ </dl>
4150
+
4151
+ <dl>
4152
+ <dd>
4153
+
4154
+ **limit:** `typing.Optional[NumberFromString]`
4155
+
4156
+ </dd>
4157
+ </dl>
4158
+
4159
+ <dl>
4160
+ <dd>
4161
+
4162
+ **offset:** `typing.Optional[NumberFromString]`
4163
+
4164
+ </dd>
4165
+ </dl>
4166
+
4167
+ <dl>
4168
+ <dd>
4169
+
4170
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4171
+
4172
+ </dd>
4173
+ </dl>
4174
+ </dd>
4175
+ </dl>
4176
+
4177
+
4178
+ </dd>
4179
+ </dl>
4180
+ </details>
4181
+
4182
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">create</a>(...)</code></summary>
4183
+ <dl>
4184
+ <dd>
4185
+
4186
+ #### 🔌 Usage
4187
+
4188
+ <dl>
4189
+ <dd>
4190
+
4191
+ <dl>
4192
+ <dd>
4193
+
4194
+ ```python
4195
+ from mirascope.api._generated import Mirascope
4196
+
4197
+ client = Mirascope()
4198
+ client.annotations.create(
4199
+ otel_span_id="otelSpanId",
4200
+ otel_trace_id="otelTraceId",
4201
+ )
4202
+
4203
+ ```
4204
+ </dd>
4205
+ </dl>
4206
+ </dd>
4207
+ </dl>
4208
+
4209
+ #### ⚙️ Parameters
4210
+
4211
+ <dl>
4212
+ <dd>
4213
+
4214
+ <dl>
4215
+ <dd>
4216
+
4217
+ **otel_span_id:** `str`
4218
+
4219
+ </dd>
4220
+ </dl>
4221
+
4222
+ <dl>
4223
+ <dd>
4224
+
4225
+ **otel_trace_id:** `str`
4226
+
4227
+ </dd>
4228
+ </dl>
4229
+
4230
+ <dl>
4231
+ <dd>
4232
+
4233
+ **label:** `typing.Optional[AnnotationsCreateRequestLabel]`
4234
+
4235
+ </dd>
4236
+ </dl>
4237
+
4238
+ <dl>
4239
+ <dd>
4240
+
4241
+ **reasoning:** `typing.Optional[str]`
4242
+
4243
+ </dd>
4244
+ </dl>
4245
+
4246
+ <dl>
4247
+ <dd>
4248
+
4249
+ **metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]`
4250
+
4251
+ </dd>
4252
+ </dl>
4253
+
4254
+ <dl>
4255
+ <dd>
4256
+
4257
+ **tags:** `typing.Optional[typing.Sequence[str]]`
4258
+
4259
+ </dd>
4260
+ </dl>
4261
+
4262
+ <dl>
4263
+ <dd>
4264
+
4265
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4266
+
4267
+ </dd>
4268
+ </dl>
4269
+ </dd>
4270
+ </dl>
4271
+
4272
+
4273
+ </dd>
4274
+ </dl>
4275
+ </details>
4276
+
4277
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">get</a>(...)</code></summary>
4278
+ <dl>
4279
+ <dd>
4280
+
4281
+ #### 🔌 Usage
4282
+
4283
+ <dl>
4284
+ <dd>
4285
+
4286
+ <dl>
4287
+ <dd>
4288
+
4289
+ ```python
4290
+ from mirascope.api._generated import Mirascope
4291
+
4292
+ client = Mirascope()
4293
+ client.annotations.get(
4294
+ id="id",
4295
+ )
4296
+
4297
+ ```
4298
+ </dd>
4299
+ </dl>
4300
+ </dd>
4301
+ </dl>
4302
+
4303
+ #### ⚙️ Parameters
4304
+
4305
+ <dl>
4306
+ <dd>
4307
+
4308
+ <dl>
4309
+ <dd>
4310
+
4311
+ **id:** `str`
4312
+
4313
+ </dd>
4314
+ </dl>
4315
+
4316
+ <dl>
4317
+ <dd>
4318
+
4319
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4320
+
4321
+ </dd>
4322
+ </dl>
4323
+ </dd>
4324
+ </dl>
4325
+
4326
+
4327
+ </dd>
4328
+ </dl>
4329
+ </details>
4330
+
4331
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">update</a>(...)</code></summary>
4332
+ <dl>
4333
+ <dd>
4334
+
4335
+ #### 🔌 Usage
4336
+
4337
+ <dl>
4338
+ <dd>
4339
+
4340
+ <dl>
4341
+ <dd>
4342
+
4343
+ ```python
4344
+ from mirascope.api._generated import Mirascope
4345
+
4346
+ client = Mirascope()
4347
+ client.annotations.update(
4348
+ id="id",
4349
+ )
4350
+
4351
+ ```
4352
+ </dd>
4353
+ </dl>
4354
+ </dd>
4355
+ </dl>
4356
+
4357
+ #### ⚙️ Parameters
4358
+
4359
+ <dl>
4360
+ <dd>
4361
+
4362
+ <dl>
4363
+ <dd>
4364
+
4365
+ **id:** `str`
4366
+
4367
+ </dd>
4368
+ </dl>
4369
+
4370
+ <dl>
4371
+ <dd>
4372
+
4373
+ **label:** `typing.Optional[AnnotationsUpdateRequestLabel]`
4374
+
4375
+ </dd>
4376
+ </dl>
4377
+
4378
+ <dl>
4379
+ <dd>
4380
+
4381
+ **reasoning:** `typing.Optional[str]`
4382
+
4383
+ </dd>
4384
+ </dl>
4385
+
4386
+ <dl>
4387
+ <dd>
4388
+
4389
+ **metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]`
4390
+
4391
+ </dd>
4392
+ </dl>
4393
+
4394
+ <dl>
4395
+ <dd>
4396
+
4397
+ **tags:** `typing.Optional[typing.Sequence[str]]`
4398
+
4399
+ </dd>
4400
+ </dl>
4401
+
4402
+ <dl>
4403
+ <dd>
4404
+
4405
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4406
+
4407
+ </dd>
4408
+ </dl>
4409
+ </dd>
4410
+ </dl>
4411
+
4412
+
4413
+ </dd>
4414
+ </dl>
4415
+ </details>
4416
+
4417
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">delete</a>(...)</code></summary>
4418
+ <dl>
4419
+ <dd>
4420
+
4421
+ #### 🔌 Usage
4422
+
4423
+ <dl>
4424
+ <dd>
4425
+
4426
+ <dl>
4427
+ <dd>
4428
+
4429
+ ```python
4430
+ from mirascope.api._generated import Mirascope
4431
+
4432
+ client = Mirascope()
4433
+ client.annotations.delete(
4434
+ id="id",
4435
+ )
4436
+
4437
+ ```
4438
+ </dd>
4439
+ </dl>
4440
+ </dd>
4441
+ </dl>
4442
+
4443
+ #### ⚙️ Parameters
4444
+
4445
+ <dl>
4446
+ <dd>
4447
+
4448
+ <dl>
4449
+ <dd>
4450
+
4451
+ **id:** `str`
4452
+
4453
+ </dd>
4454
+ </dl>
4455
+
4456
+ <dl>
4457
+ <dd>
4458
+
4459
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4460
+
4461
+ </dd>
4462
+ </dl>
4463
+ </dd>
4464
+ </dl>
4465
+
4466
+
4467
+ </dd>
4468
+ </dl>
4469
+ </details>
4470
+
4471
+ ## tags
4472
+ <details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">list</a>(...)</code></summary>
4473
+ <dl>
4474
+ <dd>
4475
+
4476
+ #### 🔌 Usage
4477
+
4478
+ <dl>
4479
+ <dd>
4480
+
4481
+ <dl>
4482
+ <dd>
4483
+
4484
+ ```python
4485
+ from mirascope.api._generated import Mirascope
4486
+
4487
+ client = Mirascope()
4488
+ client.tags.list(
4489
+ organization_id="organizationId",
4490
+ project_id="projectId",
4491
+ )
4492
+
4493
+ ```
4494
+ </dd>
4495
+ </dl>
4496
+ </dd>
4497
+ </dl>
4498
+
4499
+ #### ⚙️ Parameters
4500
+
4501
+ <dl>
4502
+ <dd>
4503
+
4504
+ <dl>
4505
+ <dd>
4506
+
4507
+ **organization_id:** `str`
4508
+
4509
+ </dd>
4510
+ </dl>
4511
+
4512
+ <dl>
4513
+ <dd>
4514
+
4515
+ **project_id:** `str`
4516
+
4517
+ </dd>
4518
+ </dl>
4519
+
4520
+ <dl>
4521
+ <dd>
4522
+
4523
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4524
+
4525
+ </dd>
4526
+ </dl>
4527
+ </dd>
4528
+ </dl>
4529
+
4530
+
4531
+ </dd>
4532
+ </dl>
4533
+ </details>
4534
+
4535
+ <details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">create</a>(...)</code></summary>
4536
+ <dl>
4537
+ <dd>
4538
+
4539
+ #### 🔌 Usage
4540
+
4541
+ <dl>
4542
+ <dd>
4543
+
4544
+ <dl>
4545
+ <dd>
4546
+
4547
+ ```python
4548
+ from mirascope.api._generated import Mirascope
4549
+
4550
+ client = Mirascope()
4551
+ client.tags.create(
4552
+ organization_id="organizationId",
4553
+ project_id="projectId",
4554
+ name="name",
4555
+ )
4556
+
4557
+ ```
4558
+ </dd>
4559
+ </dl>
4560
+ </dd>
4561
+ </dl>
4562
+
4563
+ #### ⚙️ Parameters
4564
+
4565
+ <dl>
4566
+ <dd>
4567
+
4568
+ <dl>
4569
+ <dd>
4570
+
4571
+ **organization_id:** `str`
4572
+
4573
+ </dd>
4574
+ </dl>
4575
+
4576
+ <dl>
4577
+ <dd>
4578
+
4579
+ **project_id:** `str`
4580
+
4581
+ </dd>
4582
+ </dl>
4583
+
4584
+ <dl>
4585
+ <dd>
4586
+
4587
+ **name:** `str` — a string at most 100 character(s) long
4588
+
4589
+ </dd>
4590
+ </dl>
4591
+
4592
+ <dl>
4593
+ <dd>
4594
+
4595
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4596
+
4597
+ </dd>
4598
+ </dl>
4599
+ </dd>
4600
+ </dl>
4601
+
4602
+
4603
+ </dd>
4604
+ </dl>
4605
+ </details>
4606
+
4607
+ <details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">get</a>(...)</code></summary>
4608
+ <dl>
4609
+ <dd>
4610
+
4611
+ #### 🔌 Usage
4612
+
4613
+ <dl>
4614
+ <dd>
4615
+
4616
+ <dl>
4617
+ <dd>
4618
+
4619
+ ```python
4620
+ from mirascope.api._generated import Mirascope
4621
+
4622
+ client = Mirascope()
4623
+ client.tags.get(
4624
+ organization_id="organizationId",
4625
+ project_id="projectId",
4626
+ tag_id="tagId",
4627
+ )
4628
+
4629
+ ```
4630
+ </dd>
4631
+ </dl>
4632
+ </dd>
4633
+ </dl>
4634
+
4635
+ #### ⚙️ Parameters
4636
+
4637
+ <dl>
4638
+ <dd>
4639
+
4640
+ <dl>
4641
+ <dd>
4642
+
4643
+ **organization_id:** `str`
4644
+
4645
+ </dd>
4646
+ </dl>
4647
+
4648
+ <dl>
4649
+ <dd>
4650
+
4651
+ **project_id:** `str`
4652
+
4653
+ </dd>
4654
+ </dl>
4655
+
4656
+ <dl>
4657
+ <dd>
4658
+
4659
+ **tag_id:** `str`
4660
+
4661
+ </dd>
4662
+ </dl>
4663
+
4664
+ <dl>
4665
+ <dd>
4666
+
4667
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4668
+
4669
+ </dd>
4670
+ </dl>
4671
+ </dd>
4672
+ </dl>
4673
+
4674
+
4675
+ </dd>
4676
+ </dl>
4677
+ </details>
4678
+
4679
+ <details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">update</a>(...)</code></summary>
4680
+ <dl>
4681
+ <dd>
4682
+
4683
+ #### 🔌 Usage
4684
+
4685
+ <dl>
4686
+ <dd>
4687
+
4688
+ <dl>
4689
+ <dd>
4690
+
4691
+ ```python
4692
+ from mirascope.api._generated import Mirascope
4693
+
4694
+ client = Mirascope()
4695
+ client.tags.update(
4696
+ organization_id="organizationId",
4697
+ project_id="projectId",
4698
+ tag_id="tagId",
4699
+ )
4700
+
4701
+ ```
4702
+ </dd>
4703
+ </dl>
4704
+ </dd>
4705
+ </dl>
4706
+
4707
+ #### ⚙️ Parameters
4708
+
4709
+ <dl>
4710
+ <dd>
4711
+
4712
+ <dl>
4713
+ <dd>
4714
+
4715
+ **organization_id:** `str`
4716
+
4717
+ </dd>
4718
+ </dl>
4719
+
4720
+ <dl>
4721
+ <dd>
4722
+
4723
+ **project_id:** `str`
4724
+
4725
+ </dd>
4726
+ </dl>
4727
+
4728
+ <dl>
4729
+ <dd>
4730
+
4731
+ **tag_id:** `str`
4732
+
4733
+ </dd>
4734
+ </dl>
4735
+
4736
+ <dl>
4737
+ <dd>
4738
+
4739
+ **name:** `typing.Optional[str]` — a string at most 100 character(s) long
4740
+
4741
+ </dd>
4742
+ </dl>
4743
+
4744
+ <dl>
4745
+ <dd>
4746
+
4747
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4748
+
4749
+ </dd>
4750
+ </dl>
4751
+ </dd>
4752
+ </dl>
4753
+
4754
+
4755
+ </dd>
4756
+ </dl>
4757
+ </details>
4758
+
4759
+ <details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">delete</a>(...)</code></summary>
4760
+ <dl>
4761
+ <dd>
4762
+
4763
+ #### 🔌 Usage
4764
+
4765
+ <dl>
4766
+ <dd>
4767
+
4768
+ <dl>
4769
+ <dd>
4770
+
4771
+ ```python
4772
+ from mirascope.api._generated import Mirascope
4773
+
4774
+ client = Mirascope()
4775
+ client.tags.delete(
4776
+ organization_id="organizationId",
4777
+ project_id="projectId",
4778
+ tag_id="tagId",
4779
+ )
4780
+
4781
+ ```
4782
+ </dd>
4783
+ </dl>
4784
+ </dd>
4785
+ </dl>
4786
+
4787
+ #### ⚙️ Parameters
4788
+
4789
+ <dl>
4790
+ <dd>
4791
+
4792
+ <dl>
4793
+ <dd>
4794
+
4795
+ **organization_id:** `str`
4796
+
4797
+ </dd>
4798
+ </dl>
4799
+
4800
+ <dl>
4801
+ <dd>
4802
+
4803
+ **project_id:** `str`
4804
+
4805
+ </dd>
4806
+ </dl>
4807
+
4808
+ <dl>
4809
+ <dd>
4810
+
4811
+ **tag_id:** `str`
4812
+
4813
+ </dd>
4814
+ </dl>
4815
+
4816
+ <dl>
4817
+ <dd>
4818
+
4819
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4820
+
4821
+ </dd>
4822
+ </dl>
4823
+ </dd>
4824
+ </dl>
4825
+
4826
+
4827
+ </dd>
4828
+ </dl>
4829
+ </details>
4830
+
4831
+ ## token-cost
4832
+ <details><summary><code>client.token_cost.<a href="src/mirascope/token_cost/client.py">calculate</a>(...)</code></summary>
4833
+ <dl>
4834
+ <dd>
4835
+
4836
+ #### 🔌 Usage
4837
+
4838
+ <dl>
4839
+ <dd>
4840
+
4841
+ <dl>
4842
+ <dd>
4843
+
4844
+ ```python
4845
+ from mirascope.api._generated import Mirascope
4846
+ from mirascope.api._generated.token_cost import TokenCostCalculateRequestUsage
4847
+
4848
+ client = Mirascope()
4849
+ client.token_cost.calculate(
4850
+ provider="provider",
4851
+ model="model",
4852
+ usage=TokenCostCalculateRequestUsage(
4853
+ input_tokens=1.1,
4854
+ output_tokens=1.1,
4855
+ ),
4856
+ )
4857
+
4858
+ ```
4859
+ </dd>
4860
+ </dl>
4861
+ </dd>
4862
+ </dl>
4863
+
4864
+ #### ⚙️ Parameters
4865
+
4866
+ <dl>
4867
+ <dd>
4868
+
4869
+ <dl>
4870
+ <dd>
4871
+
4872
+ **provider:** `str` — a non empty string
4873
+
4874
+ </dd>
4875
+ </dl>
4876
+
4877
+ <dl>
4878
+ <dd>
4879
+
4880
+ **model:** `str` — a non empty string
4881
+
4882
+ </dd>
4883
+ </dl>
4884
+
4885
+ <dl>
4886
+ <dd>
4887
+
4888
+ **usage:** `TokenCostCalculateRequestUsage`
4889
+
4890
+ </dd>
4891
+ </dl>
4892
+
4893
+ <dl>
4894
+ <dd>
4895
+
4896
+ **via_router:** `typing.Optional[bool]`
4897
+
4898
+ </dd>
4899
+ </dl>
4900
+
4901
+ <dl>
4902
+ <dd>
4903
+
4904
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
4905
+
4906
+ </dd>
4907
+ </dl>
4908
+ </dd>
4909
+ </dl>
4910
+
4911
+
4912
+ </dd>
4913
+ </dl>
4914
+ </details>
4915
+