mirascope 2.0.0a4__py3-none-any.whl → 2.0.0a6__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 (215) hide show
  1. mirascope/__init__.py +10 -1
  2. mirascope/_stubs.py +363 -0
  3. mirascope/api/__init__.py +8 -0
  4. mirascope/api/_generated/__init__.py +119 -1
  5. mirascope/api/_generated/annotations/__init__.py +33 -0
  6. mirascope/api/_generated/annotations/client.py +474 -0
  7. mirascope/api/_generated/annotations/raw_client.py +1095 -0
  8. mirascope/api/_generated/annotations/types/__init__.py +31 -0
  9. mirascope/api/_generated/annotations/types/annotations_create_request_label.py +5 -0
  10. mirascope/api/_generated/annotations/types/annotations_create_response.py +35 -0
  11. mirascope/api/_generated/annotations/types/annotations_create_response_label.py +5 -0
  12. mirascope/api/_generated/annotations/types/annotations_get_response.py +35 -0
  13. mirascope/api/_generated/annotations/types/annotations_get_response_label.py +5 -0
  14. mirascope/api/_generated/annotations/types/annotations_list_request_label.py +5 -0
  15. mirascope/api/_generated/annotations/types/annotations_list_response.py +21 -0
  16. mirascope/api/_generated/annotations/types/annotations_list_response_annotations_item.py +35 -0
  17. mirascope/api/_generated/annotations/types/annotations_list_response_annotations_item_label.py +5 -0
  18. mirascope/api/_generated/annotations/types/annotations_update_request_label.py +5 -0
  19. mirascope/api/_generated/annotations/types/annotations_update_response.py +35 -0
  20. mirascope/api/_generated/annotations/types/annotations_update_response_label.py +5 -0
  21. mirascope/api/_generated/api_keys/__init__.py +7 -0
  22. mirascope/api/_generated/api_keys/client.py +429 -0
  23. mirascope/api/_generated/api_keys/raw_client.py +788 -0
  24. mirascope/api/_generated/api_keys/types/__init__.py +9 -0
  25. mirascope/api/_generated/api_keys/types/api_keys_create_response.py +28 -0
  26. mirascope/api/_generated/api_keys/types/api_keys_get_response.py +27 -0
  27. mirascope/api/_generated/api_keys/types/api_keys_list_response_item.py +27 -0
  28. mirascope/api/_generated/client.py +12 -0
  29. mirascope/api/_generated/core/client_wrapper.py +2 -14
  30. mirascope/api/_generated/core/datetime_utils.py +1 -3
  31. mirascope/api/_generated/core/file.py +2 -5
  32. mirascope/api/_generated/core/http_client.py +36 -112
  33. mirascope/api/_generated/core/jsonable_encoder.py +1 -3
  34. mirascope/api/_generated/core/pydantic_utilities.py +19 -74
  35. mirascope/api/_generated/core/query_encoder.py +1 -3
  36. mirascope/api/_generated/core/serialization.py +4 -10
  37. mirascope/api/_generated/docs/client.py +2 -6
  38. mirascope/api/_generated/docs/raw_client.py +4 -20
  39. mirascope/api/_generated/environments/__init__.py +17 -0
  40. mirascope/api/_generated/environments/client.py +500 -0
  41. mirascope/api/_generated/environments/raw_client.py +999 -0
  42. mirascope/api/_generated/environments/types/__init__.py +15 -0
  43. mirascope/api/_generated/environments/types/environments_create_response.py +24 -0
  44. mirascope/api/_generated/environments/types/environments_get_response.py +24 -0
  45. mirascope/api/_generated/environments/types/environments_list_response_item.py +24 -0
  46. mirascope/api/_generated/environments/types/environments_update_response.py +24 -0
  47. mirascope/api/_generated/errors/__init__.py +2 -0
  48. mirascope/api/_generated/errors/bad_request_error.py +1 -5
  49. mirascope/api/_generated/errors/conflict_error.py +1 -5
  50. mirascope/api/_generated/errors/forbidden_error.py +1 -5
  51. mirascope/api/_generated/errors/internal_server_error.py +1 -6
  52. mirascope/api/_generated/errors/not_found_error.py +1 -5
  53. mirascope/api/_generated/errors/unauthorized_error.py +11 -0
  54. mirascope/api/_generated/functions/__init__.py +29 -0
  55. mirascope/api/_generated/functions/client.py +433 -0
  56. mirascope/api/_generated/functions/raw_client.py +1049 -0
  57. mirascope/api/_generated/functions/types/__init__.py +29 -0
  58. mirascope/api/_generated/functions/types/functions_create_request_dependencies_value.py +20 -0
  59. mirascope/api/_generated/functions/types/functions_create_response.py +37 -0
  60. mirascope/api/_generated/functions/types/functions_create_response_dependencies_value.py +20 -0
  61. mirascope/api/_generated/functions/types/functions_find_by_hash_response.py +39 -0
  62. mirascope/api/_generated/functions/types/functions_find_by_hash_response_dependencies_value.py +20 -0
  63. mirascope/api/_generated/functions/types/functions_get_response.py +37 -0
  64. mirascope/api/_generated/functions/types/functions_get_response_dependencies_value.py +20 -0
  65. mirascope/api/_generated/functions/types/functions_list_response.py +21 -0
  66. mirascope/api/_generated/functions/types/functions_list_response_functions_item.py +41 -0
  67. mirascope/api/_generated/functions/types/functions_list_response_functions_item_dependencies_value.py +20 -0
  68. mirascope/api/_generated/health/client.py +2 -6
  69. mirascope/api/_generated/health/raw_client.py +5 -23
  70. mirascope/api/_generated/health/types/health_check_response.py +1 -3
  71. mirascope/api/_generated/organizations/__init__.py +2 -0
  72. mirascope/api/_generated/organizations/client.py +94 -27
  73. mirascope/api/_generated/organizations/raw_client.py +246 -128
  74. mirascope/api/_generated/organizations/types/__init__.py +2 -0
  75. mirascope/api/_generated/organizations/types/organizations_create_response.py +5 -3
  76. mirascope/api/_generated/organizations/types/organizations_create_response_role.py +1 -3
  77. mirascope/api/_generated/organizations/types/organizations_credits_response.py +19 -0
  78. mirascope/api/_generated/organizations/types/organizations_get_response.py +5 -3
  79. mirascope/api/_generated/organizations/types/organizations_get_response_role.py +1 -3
  80. mirascope/api/_generated/organizations/types/organizations_list_response_item.py +5 -3
  81. mirascope/api/_generated/organizations/types/organizations_list_response_item_role.py +1 -3
  82. mirascope/api/_generated/organizations/types/organizations_update_response.py +5 -3
  83. mirascope/api/_generated/organizations/types/organizations_update_response_role.py +1 -3
  84. mirascope/api/_generated/projects/__init__.py +2 -12
  85. mirascope/api/_generated/projects/client.py +38 -68
  86. mirascope/api/_generated/projects/raw_client.py +92 -163
  87. mirascope/api/_generated/projects/types/__init__.py +1 -6
  88. mirascope/api/_generated/projects/types/projects_create_response.py +4 -9
  89. mirascope/api/_generated/projects/types/projects_get_response.py +4 -9
  90. mirascope/api/_generated/projects/types/projects_list_response_item.py +4 -9
  91. mirascope/api/_generated/projects/types/projects_update_response.py +4 -9
  92. mirascope/api/_generated/reference.md +1862 -70
  93. mirascope/api/_generated/traces/__init__.py +22 -0
  94. mirascope/api/_generated/traces/client.py +398 -0
  95. mirascope/api/_generated/traces/raw_client.py +902 -18
  96. mirascope/api/_generated/traces/types/__init__.py +32 -0
  97. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item.py +4 -11
  98. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource.py +2 -6
  99. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item.py +1 -3
  100. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value.py +8 -24
  101. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_array_value.py +2 -6
  102. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_kvlist_value.py +3 -9
  103. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_kvlist_value_values_item.py +2 -6
  104. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item.py +3 -9
  105. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope.py +4 -8
  106. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item.py +2 -6
  107. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value.py +8 -24
  108. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_array_value.py +2 -6
  109. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_kvlist_value.py +3 -9
  110. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_kvlist_value_values_item.py +1 -3
  111. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item.py +6 -18
  112. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item.py +3 -9
  113. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value.py +8 -24
  114. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_array_value.py +2 -6
  115. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_kvlist_value.py +2 -6
  116. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_kvlist_value_values_item.py +1 -3
  117. mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_status.py +2 -6
  118. mirascope/api/_generated/traces/types/traces_create_response.py +2 -5
  119. mirascope/api/_generated/traces/types/traces_create_response_partial_success.py +3 -9
  120. mirascope/api/_generated/traces/types/traces_get_analytics_summary_response.py +54 -0
  121. mirascope/api/_generated/traces/types/traces_get_analytics_summary_response_top_functions_item.py +24 -0
  122. mirascope/api/_generated/traces/types/traces_get_analytics_summary_response_top_models_item.py +22 -0
  123. mirascope/api/_generated/traces/types/traces_get_trace_detail_response.py +33 -0
  124. mirascope/api/_generated/traces/types/traces_get_trace_detail_response_spans_item.py +90 -0
  125. mirascope/api/_generated/traces/types/traces_search_request_attribute_filters_item.py +26 -0
  126. mirascope/api/_generated/traces/types/traces_search_request_attribute_filters_item_operator.py +7 -0
  127. mirascope/api/_generated/traces/types/traces_search_request_sort_by.py +7 -0
  128. mirascope/api/_generated/traces/types/traces_search_request_sort_order.py +5 -0
  129. mirascope/api/_generated/traces/types/traces_search_response.py +26 -0
  130. mirascope/api/_generated/traces/types/traces_search_response_spans_item.py +41 -0
  131. mirascope/api/_generated/types/__init__.py +18 -0
  132. mirascope/api/_generated/types/already_exists_error.py +1 -3
  133. mirascope/api/_generated/types/click_house_error.py +22 -0
  134. mirascope/api/_generated/types/database_error.py +1 -3
  135. mirascope/api/_generated/types/http_api_decode_error.py +1 -3
  136. mirascope/api/_generated/types/internal_server_error_body.py +49 -0
  137. mirascope/api/_generated/types/issue.py +1 -3
  138. mirascope/api/_generated/types/issue_tag.py +1 -8
  139. mirascope/api/_generated/types/not_found_error_body.py +1 -3
  140. mirascope/api/_generated/types/number_from_string.py +3 -0
  141. mirascope/api/_generated/types/permission_denied_error.py +1 -3
  142. mirascope/api/_generated/types/permission_denied_error_tag.py +1 -3
  143. mirascope/api/_generated/types/property_key_key.py +1 -3
  144. mirascope/api/_generated/types/stripe_error.py +20 -0
  145. mirascope/api/_generated/types/unauthorized_error_body.py +21 -0
  146. mirascope/api/_generated/types/unauthorized_error_tag.py +5 -0
  147. mirascope/llm/__init__.py +6 -2
  148. mirascope/llm/content/tool_call.py +6 -0
  149. mirascope/llm/exceptions.py +28 -0
  150. mirascope/llm/formatting/__init__.py +2 -2
  151. mirascope/llm/formatting/format.py +120 -8
  152. mirascope/llm/formatting/types.py +1 -56
  153. mirascope/llm/mcp/__init__.py +2 -2
  154. mirascope/llm/mcp/mcp_client.py +130 -0
  155. mirascope/llm/providers/__init__.py +26 -5
  156. mirascope/llm/providers/anthropic/__init__.py +3 -21
  157. mirascope/llm/providers/anthropic/_utils/__init__.py +2 -0
  158. mirascope/llm/providers/anthropic/_utils/beta_decode.py +4 -2
  159. mirascope/llm/providers/anthropic/_utils/beta_encode.py +13 -12
  160. mirascope/llm/providers/anthropic/_utils/decode.py +4 -2
  161. mirascope/llm/providers/anthropic/_utils/encode.py +57 -14
  162. mirascope/llm/providers/anthropic/_utils/errors.py +46 -0
  163. mirascope/llm/providers/anthropic/beta_provider.py +6 -0
  164. mirascope/llm/providers/anthropic/provider.py +5 -0
  165. mirascope/llm/providers/base/__init__.py +5 -2
  166. mirascope/llm/providers/base/_utils.py +2 -7
  167. mirascope/llm/providers/base/base_provider.py +173 -58
  168. mirascope/llm/providers/base/params.py +63 -34
  169. mirascope/llm/providers/google/__init__.py +2 -17
  170. mirascope/llm/providers/google/_utils/__init__.py +2 -0
  171. mirascope/llm/providers/google/_utils/decode.py +17 -8
  172. mirascope/llm/providers/google/_utils/encode.py +105 -16
  173. mirascope/llm/providers/google/_utils/errors.py +49 -0
  174. mirascope/llm/providers/google/model_info.py +1 -0
  175. mirascope/llm/providers/google/provider.py +9 -5
  176. mirascope/llm/providers/mirascope/__init__.py +5 -0
  177. mirascope/llm/providers/mirascope/_utils.py +77 -0
  178. mirascope/llm/providers/mirascope/provider.py +318 -0
  179. mirascope/llm/providers/mlx/__init__.py +2 -17
  180. mirascope/llm/providers/mlx/_utils.py +9 -2
  181. mirascope/llm/providers/mlx/provider.py +8 -0
  182. mirascope/llm/providers/ollama/__init__.py +1 -13
  183. mirascope/llm/providers/openai/__init__.py +10 -1
  184. mirascope/llm/providers/openai/_utils/__init__.py +5 -0
  185. mirascope/llm/providers/openai/_utils/errors.py +46 -0
  186. mirascope/llm/providers/openai/completions/__init__.py +2 -20
  187. mirascope/llm/providers/openai/completions/_utils/decode.py +14 -3
  188. mirascope/llm/providers/openai/completions/_utils/encode.py +15 -12
  189. mirascope/llm/providers/openai/completions/base_provider.py +6 -6
  190. mirascope/llm/providers/openai/provider.py +14 -1
  191. mirascope/llm/providers/openai/responses/__init__.py +1 -17
  192. mirascope/llm/providers/openai/responses/_utils/decode.py +2 -2
  193. mirascope/llm/providers/openai/responses/_utils/encode.py +43 -15
  194. mirascope/llm/providers/openai/responses/provider.py +13 -7
  195. mirascope/llm/providers/provider_id.py +1 -0
  196. mirascope/llm/providers/provider_registry.py +59 -3
  197. mirascope/llm/providers/together/__init__.py +1 -13
  198. mirascope/llm/responses/base_stream_response.py +24 -20
  199. mirascope/llm/tools/decorator.py +8 -4
  200. mirascope/llm/tools/tool_schema.py +33 -6
  201. mirascope/llm/tools/tools.py +84 -16
  202. mirascope/ops/__init__.py +60 -109
  203. mirascope/ops/_internal/closure.py +62 -11
  204. mirascope/ops/_internal/instrumentation/llm/llm.py +1 -2
  205. mirascope/ops/_internal/traced_functions.py +23 -4
  206. mirascope/ops/_internal/versioned_functions.py +54 -43
  207. {mirascope-2.0.0a4.dist-info → mirascope-2.0.0a6.dist-info}/METADATA +7 -7
  208. mirascope-2.0.0a6.dist-info/RECORD +316 -0
  209. mirascope/llm/formatting/_utils.py +0 -78
  210. mirascope/llm/mcp/client.py +0 -118
  211. mirascope/llm/providers/_missing_import_stubs.py +0 -49
  212. mirascope/llm/providers/load_provider.py +0 -54
  213. mirascope-2.0.0a4.dist-info/RECORD +0 -247
  214. {mirascope-2.0.0a4.dist-info → mirascope-2.0.0a6.dist-info}/WHEEL +0 -0
  215. {mirascope-2.0.0a4.dist-info → mirascope-2.0.0a6.dist-info}/licenses/LICENSE +0 -0
@@ -116,6 +116,330 @@ client.traces.create(
116
116
  </dl>
117
117
 
118
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
+ **trace_id:** `typing.Optional[str]`
183
+
184
+ </dd>
185
+ </dl>
186
+
187
+ <dl>
188
+ <dd>
189
+
190
+ **span_id:** `typing.Optional[str]`
191
+
192
+ </dd>
193
+ </dl>
194
+
195
+ <dl>
196
+ <dd>
197
+
198
+ **model:** `typing.Optional[typing.Sequence[str]]`
199
+
200
+ </dd>
201
+ </dl>
202
+
203
+ <dl>
204
+ <dd>
205
+
206
+ **provider:** `typing.Optional[typing.Sequence[str]]`
207
+
208
+ </dd>
209
+ </dl>
210
+
211
+ <dl>
212
+ <dd>
213
+
214
+ **function_id:** `typing.Optional[str]`
215
+
216
+ </dd>
217
+ </dl>
218
+
219
+ <dl>
220
+ <dd>
221
+
222
+ **function_name:** `typing.Optional[str]`
223
+
224
+ </dd>
225
+ </dl>
226
+
227
+ <dl>
228
+ <dd>
229
+
230
+ **has_error:** `typing.Optional[bool]`
231
+
232
+ </dd>
233
+ </dl>
234
+
235
+ <dl>
236
+ <dd>
237
+
238
+ **min_tokens:** `typing.Optional[float]`
239
+
240
+ </dd>
241
+ </dl>
242
+
243
+ <dl>
244
+ <dd>
245
+
246
+ **max_tokens:** `typing.Optional[float]`
247
+
248
+ </dd>
249
+ </dl>
250
+
251
+ <dl>
252
+ <dd>
253
+
254
+ **min_duration:** `typing.Optional[float]`
255
+
256
+ </dd>
257
+ </dl>
258
+
259
+ <dl>
260
+ <dd>
261
+
262
+ **max_duration:** `typing.Optional[float]`
263
+
264
+ </dd>
265
+ </dl>
266
+
267
+ <dl>
268
+ <dd>
269
+
270
+ **attribute_filters:** `typing.Optional[typing.Sequence[TracesSearchRequestAttributeFiltersItem]]`
271
+
272
+ </dd>
273
+ </dl>
274
+
275
+ <dl>
276
+ <dd>
277
+
278
+ **limit:** `typing.Optional[float]`
279
+
280
+ </dd>
281
+ </dl>
282
+
283
+ <dl>
284
+ <dd>
285
+
286
+ **offset:** `typing.Optional[float]`
287
+
288
+ </dd>
289
+ </dl>
290
+
291
+ <dl>
292
+ <dd>
293
+
294
+ **sort_by:** `typing.Optional[TracesSearchRequestSortBy]`
295
+
296
+ </dd>
297
+ </dl>
298
+
299
+ <dl>
300
+ <dd>
301
+
302
+ **sort_order:** `typing.Optional[TracesSearchRequestSortOrder]`
303
+
304
+ </dd>
305
+ </dl>
306
+
307
+ <dl>
308
+ <dd>
309
+
310
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
311
+
312
+ </dd>
313
+ </dl>
314
+ </dd>
315
+ </dl>
316
+
317
+
318
+ </dd>
319
+ </dl>
320
+ </details>
321
+
322
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">gettracedetail</a>(...)</code></summary>
323
+ <dl>
324
+ <dd>
325
+
326
+ #### 🔌 Usage
327
+
328
+ <dl>
329
+ <dd>
330
+
331
+ <dl>
332
+ <dd>
333
+
334
+ ```python
335
+ from mirascope.api._generated import Mirascope
336
+
337
+ client = Mirascope()
338
+ client.traces.gettracedetail(
339
+ trace_id="traceId",
340
+ )
341
+
342
+ ```
343
+ </dd>
344
+ </dl>
345
+ </dd>
346
+ </dl>
347
+
348
+ #### ⚙️ Parameters
349
+
350
+ <dl>
351
+ <dd>
352
+
353
+ <dl>
354
+ <dd>
355
+
356
+ **trace_id:** `str`
357
+
358
+ </dd>
359
+ </dl>
360
+
361
+ <dl>
362
+ <dd>
363
+
364
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
365
+
366
+ </dd>
367
+ </dl>
368
+ </dd>
369
+ </dl>
370
+
371
+
372
+ </dd>
373
+ </dl>
374
+ </details>
375
+
376
+ <details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">getanalyticssummary</a>(...)</code></summary>
377
+ <dl>
378
+ <dd>
379
+
380
+ #### 🔌 Usage
381
+
382
+ <dl>
383
+ <dd>
384
+
385
+ <dl>
386
+ <dd>
387
+
388
+ ```python
389
+ from mirascope.api._generated import Mirascope
390
+
391
+ client = Mirascope()
392
+ client.traces.getanalyticssummary(
393
+ start_time="startTime",
394
+ end_time="endTime",
395
+ )
396
+
397
+ ```
398
+ </dd>
399
+ </dl>
400
+ </dd>
401
+ </dl>
402
+
403
+ #### ⚙️ Parameters
404
+
405
+ <dl>
406
+ <dd>
407
+
408
+ <dl>
409
+ <dd>
410
+
411
+ **start_time:** `str`
412
+
413
+ </dd>
414
+ </dl>
415
+
416
+ <dl>
417
+ <dd>
418
+
419
+ **end_time:** `str`
420
+
421
+ </dd>
422
+ </dl>
423
+
424
+ <dl>
425
+ <dd>
426
+
427
+ **function_id:** `typing.Optional[str]`
428
+
429
+ </dd>
430
+ </dl>
431
+
432
+ <dl>
433
+ <dd>
434
+
435
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
436
+
437
+ </dd>
438
+ </dl>
439
+ </dd>
440
+ </dl>
441
+
442
+
119
443
  </dd>
120
444
  </dl>
121
445
  </details>
@@ -137,7 +461,1340 @@ client.traces.create(
137
461
  from mirascope.api._generated import Mirascope
138
462
 
139
463
  client = Mirascope()
140
- client.docs.openapi()
464
+ client.docs.openapi()
465
+
466
+ ```
467
+ </dd>
468
+ </dl>
469
+ </dd>
470
+ </dl>
471
+
472
+ #### ⚙️ Parameters
473
+
474
+ <dl>
475
+ <dd>
476
+
477
+ <dl>
478
+ <dd>
479
+
480
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
481
+
482
+ </dd>
483
+ </dl>
484
+ </dd>
485
+ </dl>
486
+
487
+
488
+ </dd>
489
+ </dl>
490
+ </details>
491
+
492
+ ## organizations
493
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">list</a>()</code></summary>
494
+ <dl>
495
+ <dd>
496
+
497
+ #### 🔌 Usage
498
+
499
+ <dl>
500
+ <dd>
501
+
502
+ <dl>
503
+ <dd>
504
+
505
+ ```python
506
+ from mirascope.api._generated import Mirascope
507
+
508
+ client = Mirascope()
509
+ client.organizations.list()
510
+
511
+ ```
512
+ </dd>
513
+ </dl>
514
+ </dd>
515
+ </dl>
516
+
517
+ #### ⚙️ Parameters
518
+
519
+ <dl>
520
+ <dd>
521
+
522
+ <dl>
523
+ <dd>
524
+
525
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
526
+
527
+ </dd>
528
+ </dl>
529
+ </dd>
530
+ </dl>
531
+
532
+
533
+ </dd>
534
+ </dl>
535
+ </details>
536
+
537
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">create</a>(...)</code></summary>
538
+ <dl>
539
+ <dd>
540
+
541
+ #### 🔌 Usage
542
+
543
+ <dl>
544
+ <dd>
545
+
546
+ <dl>
547
+ <dd>
548
+
549
+ ```python
550
+ from mirascope.api._generated import Mirascope
551
+
552
+ client = Mirascope()
553
+ client.organizations.create(
554
+ name="name",
555
+ slug="slug",
556
+ )
557
+
558
+ ```
559
+ </dd>
560
+ </dl>
561
+ </dd>
562
+ </dl>
563
+
564
+ #### ⚙️ Parameters
565
+
566
+ <dl>
567
+ <dd>
568
+
569
+ <dl>
570
+ <dd>
571
+
572
+ **name:** `str` — a string at most 100 character(s) long
573
+
574
+ </dd>
575
+ </dl>
576
+
577
+ <dl>
578
+ <dd>
579
+
580
+ **slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
581
+
582
+ </dd>
583
+ </dl>
584
+
585
+ <dl>
586
+ <dd>
587
+
588
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
589
+
590
+ </dd>
591
+ </dl>
592
+ </dd>
593
+ </dl>
594
+
595
+
596
+ </dd>
597
+ </dl>
598
+ </details>
599
+
600
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">get</a>(...)</code></summary>
601
+ <dl>
602
+ <dd>
603
+
604
+ #### 🔌 Usage
605
+
606
+ <dl>
607
+ <dd>
608
+
609
+ <dl>
610
+ <dd>
611
+
612
+ ```python
613
+ from mirascope.api._generated import Mirascope
614
+
615
+ client = Mirascope()
616
+ client.organizations.get(
617
+ id="id",
618
+ )
619
+
620
+ ```
621
+ </dd>
622
+ </dl>
623
+ </dd>
624
+ </dl>
625
+
626
+ #### ⚙️ Parameters
627
+
628
+ <dl>
629
+ <dd>
630
+
631
+ <dl>
632
+ <dd>
633
+
634
+ **id:** `str`
635
+
636
+ </dd>
637
+ </dl>
638
+
639
+ <dl>
640
+ <dd>
641
+
642
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
643
+
644
+ </dd>
645
+ </dl>
646
+ </dd>
647
+ </dl>
648
+
649
+
650
+ </dd>
651
+ </dl>
652
+ </details>
653
+
654
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">update</a>(...)</code></summary>
655
+ <dl>
656
+ <dd>
657
+
658
+ #### 🔌 Usage
659
+
660
+ <dl>
661
+ <dd>
662
+
663
+ <dl>
664
+ <dd>
665
+
666
+ ```python
667
+ from mirascope.api._generated import Mirascope
668
+
669
+ client = Mirascope()
670
+ client.organizations.update(
671
+ id="id",
672
+ )
673
+
674
+ ```
675
+ </dd>
676
+ </dl>
677
+ </dd>
678
+ </dl>
679
+
680
+ #### ⚙️ Parameters
681
+
682
+ <dl>
683
+ <dd>
684
+
685
+ <dl>
686
+ <dd>
687
+
688
+ **id:** `str`
689
+
690
+ </dd>
691
+ </dl>
692
+
693
+ <dl>
694
+ <dd>
695
+
696
+ **name:** `typing.Optional[str]` — a string at most 100 character(s) long
697
+
698
+ </dd>
699
+ </dl>
700
+
701
+ <dl>
702
+ <dd>
703
+
704
+ **slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
705
+
706
+ </dd>
707
+ </dl>
708
+
709
+ <dl>
710
+ <dd>
711
+
712
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
713
+
714
+ </dd>
715
+ </dl>
716
+ </dd>
717
+ </dl>
718
+
719
+
720
+ </dd>
721
+ </dl>
722
+ </details>
723
+
724
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">delete</a>(...)</code></summary>
725
+ <dl>
726
+ <dd>
727
+
728
+ #### 🔌 Usage
729
+
730
+ <dl>
731
+ <dd>
732
+
733
+ <dl>
734
+ <dd>
735
+
736
+ ```python
737
+ from mirascope.api._generated import Mirascope
738
+
739
+ client = Mirascope()
740
+ client.organizations.delete(
741
+ id="id",
742
+ )
743
+
744
+ ```
745
+ </dd>
746
+ </dl>
747
+ </dd>
748
+ </dl>
749
+
750
+ #### ⚙️ Parameters
751
+
752
+ <dl>
753
+ <dd>
754
+
755
+ <dl>
756
+ <dd>
757
+
758
+ **id:** `str`
759
+
760
+ </dd>
761
+ </dl>
762
+
763
+ <dl>
764
+ <dd>
765
+
766
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
767
+
768
+ </dd>
769
+ </dl>
770
+ </dd>
771
+ </dl>
772
+
773
+
774
+ </dd>
775
+ </dl>
776
+ </details>
777
+
778
+ <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">credits</a>(...)</code></summary>
779
+ <dl>
780
+ <dd>
781
+
782
+ #### 🔌 Usage
783
+
784
+ <dl>
785
+ <dd>
786
+
787
+ <dl>
788
+ <dd>
789
+
790
+ ```python
791
+ from mirascope.api._generated import Mirascope
792
+
793
+ client = Mirascope()
794
+ client.organizations.credits(
795
+ id="id",
796
+ )
797
+
798
+ ```
799
+ </dd>
800
+ </dl>
801
+ </dd>
802
+ </dl>
803
+
804
+ #### ⚙️ Parameters
805
+
806
+ <dl>
807
+ <dd>
808
+
809
+ <dl>
810
+ <dd>
811
+
812
+ **id:** `str`
813
+
814
+ </dd>
815
+ </dl>
816
+
817
+ <dl>
818
+ <dd>
819
+
820
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
821
+
822
+ </dd>
823
+ </dl>
824
+ </dd>
825
+ </dl>
826
+
827
+
828
+ </dd>
829
+ </dl>
830
+ </details>
831
+
832
+ ## projects
833
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">list</a>(...)</code></summary>
834
+ <dl>
835
+ <dd>
836
+
837
+ #### 🔌 Usage
838
+
839
+ <dl>
840
+ <dd>
841
+
842
+ <dl>
843
+ <dd>
844
+
845
+ ```python
846
+ from mirascope.api._generated import Mirascope
847
+
848
+ client = Mirascope()
849
+ client.projects.list(
850
+ organization_id="organizationId",
851
+ )
852
+
853
+ ```
854
+ </dd>
855
+ </dl>
856
+ </dd>
857
+ </dl>
858
+
859
+ #### ⚙️ Parameters
860
+
861
+ <dl>
862
+ <dd>
863
+
864
+ <dl>
865
+ <dd>
866
+
867
+ **organization_id:** `str`
868
+
869
+ </dd>
870
+ </dl>
871
+
872
+ <dl>
873
+ <dd>
874
+
875
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
876
+
877
+ </dd>
878
+ </dl>
879
+ </dd>
880
+ </dl>
881
+
882
+
883
+ </dd>
884
+ </dl>
885
+ </details>
886
+
887
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">create</a>(...)</code></summary>
888
+ <dl>
889
+ <dd>
890
+
891
+ #### 🔌 Usage
892
+
893
+ <dl>
894
+ <dd>
895
+
896
+ <dl>
897
+ <dd>
898
+
899
+ ```python
900
+ from mirascope.api._generated import Mirascope
901
+
902
+ client = Mirascope()
903
+ client.projects.create(
904
+ organization_id="organizationId",
905
+ name="name",
906
+ slug="slug",
907
+ )
908
+
909
+ ```
910
+ </dd>
911
+ </dl>
912
+ </dd>
913
+ </dl>
914
+
915
+ #### ⚙️ Parameters
916
+
917
+ <dl>
918
+ <dd>
919
+
920
+ <dl>
921
+ <dd>
922
+
923
+ **organization_id:** `str`
924
+
925
+ </dd>
926
+ </dl>
927
+
928
+ <dl>
929
+ <dd>
930
+
931
+ **name:** `str` — a string at most 100 character(s) long
932
+
933
+ </dd>
934
+ </dl>
935
+
936
+ <dl>
937
+ <dd>
938
+
939
+ **slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
940
+
941
+ </dd>
942
+ </dl>
943
+
944
+ <dl>
945
+ <dd>
946
+
947
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
948
+
949
+ </dd>
950
+ </dl>
951
+ </dd>
952
+ </dl>
953
+
954
+
955
+ </dd>
956
+ </dl>
957
+ </details>
958
+
959
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">get</a>(...)</code></summary>
960
+ <dl>
961
+ <dd>
962
+
963
+ #### 🔌 Usage
964
+
965
+ <dl>
966
+ <dd>
967
+
968
+ <dl>
969
+ <dd>
970
+
971
+ ```python
972
+ from mirascope.api._generated import Mirascope
973
+
974
+ client = Mirascope()
975
+ client.projects.get(
976
+ organization_id="organizationId",
977
+ project_id="projectId",
978
+ )
979
+
980
+ ```
981
+ </dd>
982
+ </dl>
983
+ </dd>
984
+ </dl>
985
+
986
+ #### ⚙️ Parameters
987
+
988
+ <dl>
989
+ <dd>
990
+
991
+ <dl>
992
+ <dd>
993
+
994
+ **organization_id:** `str`
995
+
996
+ </dd>
997
+ </dl>
998
+
999
+ <dl>
1000
+ <dd>
1001
+
1002
+ **project_id:** `str`
1003
+
1004
+ </dd>
1005
+ </dl>
1006
+
1007
+ <dl>
1008
+ <dd>
1009
+
1010
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1011
+
1012
+ </dd>
1013
+ </dl>
1014
+ </dd>
1015
+ </dl>
1016
+
1017
+
1018
+ </dd>
1019
+ </dl>
1020
+ </details>
1021
+
1022
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">update</a>(...)</code></summary>
1023
+ <dl>
1024
+ <dd>
1025
+
1026
+ #### 🔌 Usage
1027
+
1028
+ <dl>
1029
+ <dd>
1030
+
1031
+ <dl>
1032
+ <dd>
1033
+
1034
+ ```python
1035
+ from mirascope.api._generated import Mirascope
1036
+
1037
+ client = Mirascope()
1038
+ client.projects.update(
1039
+ organization_id="organizationId",
1040
+ project_id="projectId",
1041
+ )
1042
+
1043
+ ```
1044
+ </dd>
1045
+ </dl>
1046
+ </dd>
1047
+ </dl>
1048
+
1049
+ #### ⚙️ Parameters
1050
+
1051
+ <dl>
1052
+ <dd>
1053
+
1054
+ <dl>
1055
+ <dd>
1056
+
1057
+ **organization_id:** `str`
1058
+
1059
+ </dd>
1060
+ </dl>
1061
+
1062
+ <dl>
1063
+ <dd>
1064
+
1065
+ **project_id:** `str`
1066
+
1067
+ </dd>
1068
+ </dl>
1069
+
1070
+ <dl>
1071
+ <dd>
1072
+
1073
+ **name:** `typing.Optional[str]` — a string at most 100 character(s) long
1074
+
1075
+ </dd>
1076
+ </dl>
1077
+
1078
+ <dl>
1079
+ <dd>
1080
+
1081
+ **slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
1082
+
1083
+ </dd>
1084
+ </dl>
1085
+
1086
+ <dl>
1087
+ <dd>
1088
+
1089
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1090
+
1091
+ </dd>
1092
+ </dl>
1093
+ </dd>
1094
+ </dl>
1095
+
1096
+
1097
+ </dd>
1098
+ </dl>
1099
+ </details>
1100
+
1101
+ <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">delete</a>(...)</code></summary>
1102
+ <dl>
1103
+ <dd>
1104
+
1105
+ #### 🔌 Usage
1106
+
1107
+ <dl>
1108
+ <dd>
1109
+
1110
+ <dl>
1111
+ <dd>
1112
+
1113
+ ```python
1114
+ from mirascope.api._generated import Mirascope
1115
+
1116
+ client = Mirascope()
1117
+ client.projects.delete(
1118
+ organization_id="organizationId",
1119
+ project_id="projectId",
1120
+ )
1121
+
1122
+ ```
1123
+ </dd>
1124
+ </dl>
1125
+ </dd>
1126
+ </dl>
1127
+
1128
+ #### ⚙️ Parameters
1129
+
1130
+ <dl>
1131
+ <dd>
1132
+
1133
+ <dl>
1134
+ <dd>
1135
+
1136
+ **organization_id:** `str`
1137
+
1138
+ </dd>
1139
+ </dl>
1140
+
1141
+ <dl>
1142
+ <dd>
1143
+
1144
+ **project_id:** `str`
1145
+
1146
+ </dd>
1147
+ </dl>
1148
+
1149
+ <dl>
1150
+ <dd>
1151
+
1152
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1153
+
1154
+ </dd>
1155
+ </dl>
1156
+ </dd>
1157
+ </dl>
1158
+
1159
+
1160
+ </dd>
1161
+ </dl>
1162
+ </details>
1163
+
1164
+ ## environments
1165
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">list</a>(...)</code></summary>
1166
+ <dl>
1167
+ <dd>
1168
+
1169
+ #### 🔌 Usage
1170
+
1171
+ <dl>
1172
+ <dd>
1173
+
1174
+ <dl>
1175
+ <dd>
1176
+
1177
+ ```python
1178
+ from mirascope.api._generated import Mirascope
1179
+
1180
+ client = Mirascope()
1181
+ client.environments.list(
1182
+ organization_id="organizationId",
1183
+ project_id="projectId",
1184
+ )
1185
+
1186
+ ```
1187
+ </dd>
1188
+ </dl>
1189
+ </dd>
1190
+ </dl>
1191
+
1192
+ #### ⚙️ Parameters
1193
+
1194
+ <dl>
1195
+ <dd>
1196
+
1197
+ <dl>
1198
+ <dd>
1199
+
1200
+ **organization_id:** `str`
1201
+
1202
+ </dd>
1203
+ </dl>
1204
+
1205
+ <dl>
1206
+ <dd>
1207
+
1208
+ **project_id:** `str`
1209
+
1210
+ </dd>
1211
+ </dl>
1212
+
1213
+ <dl>
1214
+ <dd>
1215
+
1216
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1217
+
1218
+ </dd>
1219
+ </dl>
1220
+ </dd>
1221
+ </dl>
1222
+
1223
+
1224
+ </dd>
1225
+ </dl>
1226
+ </details>
1227
+
1228
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">create</a>(...)</code></summary>
1229
+ <dl>
1230
+ <dd>
1231
+
1232
+ #### 🔌 Usage
1233
+
1234
+ <dl>
1235
+ <dd>
1236
+
1237
+ <dl>
1238
+ <dd>
1239
+
1240
+ ```python
1241
+ from mirascope.api._generated import Mirascope
1242
+
1243
+ client = Mirascope()
1244
+ client.environments.create(
1245
+ organization_id="organizationId",
1246
+ project_id="projectId",
1247
+ name="name",
1248
+ slug="slug",
1249
+ )
1250
+
1251
+ ```
1252
+ </dd>
1253
+ </dl>
1254
+ </dd>
1255
+ </dl>
1256
+
1257
+ #### ⚙️ Parameters
1258
+
1259
+ <dl>
1260
+ <dd>
1261
+
1262
+ <dl>
1263
+ <dd>
1264
+
1265
+ **organization_id:** `str`
1266
+
1267
+ </dd>
1268
+ </dl>
1269
+
1270
+ <dl>
1271
+ <dd>
1272
+
1273
+ **project_id:** `str`
1274
+
1275
+ </dd>
1276
+ </dl>
1277
+
1278
+ <dl>
1279
+ <dd>
1280
+
1281
+ **name:** `str` — a string at most 100 character(s) long
1282
+
1283
+ </dd>
1284
+ </dl>
1285
+
1286
+ <dl>
1287
+ <dd>
1288
+
1289
+ **slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
1290
+
1291
+ </dd>
1292
+ </dl>
1293
+
1294
+ <dl>
1295
+ <dd>
1296
+
1297
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1298
+
1299
+ </dd>
1300
+ </dl>
1301
+ </dd>
1302
+ </dl>
1303
+
1304
+
1305
+ </dd>
1306
+ </dl>
1307
+ </details>
1308
+
1309
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">get</a>(...)</code></summary>
1310
+ <dl>
1311
+ <dd>
1312
+
1313
+ #### 🔌 Usage
1314
+
1315
+ <dl>
1316
+ <dd>
1317
+
1318
+ <dl>
1319
+ <dd>
1320
+
1321
+ ```python
1322
+ from mirascope.api._generated import Mirascope
1323
+
1324
+ client = Mirascope()
1325
+ client.environments.get(
1326
+ organization_id="organizationId",
1327
+ project_id="projectId",
1328
+ environment_id="environmentId",
1329
+ )
1330
+
1331
+ ```
1332
+ </dd>
1333
+ </dl>
1334
+ </dd>
1335
+ </dl>
1336
+
1337
+ #### ⚙️ Parameters
1338
+
1339
+ <dl>
1340
+ <dd>
1341
+
1342
+ <dl>
1343
+ <dd>
1344
+
1345
+ **organization_id:** `str`
1346
+
1347
+ </dd>
1348
+ </dl>
1349
+
1350
+ <dl>
1351
+ <dd>
1352
+
1353
+ **project_id:** `str`
1354
+
1355
+ </dd>
1356
+ </dl>
1357
+
1358
+ <dl>
1359
+ <dd>
1360
+
1361
+ **environment_id:** `str`
1362
+
1363
+ </dd>
1364
+ </dl>
1365
+
1366
+ <dl>
1367
+ <dd>
1368
+
1369
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1370
+
1371
+ </dd>
1372
+ </dl>
1373
+ </dd>
1374
+ </dl>
1375
+
1376
+
1377
+ </dd>
1378
+ </dl>
1379
+ </details>
1380
+
1381
+ <details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">update</a>(...)</code></summary>
1382
+ <dl>
1383
+ <dd>
1384
+
1385
+ #### 🔌 Usage
1386
+
1387
+ <dl>
1388
+ <dd>
1389
+
1390
+ <dl>
1391
+ <dd>
1392
+
1393
+ ```python
1394
+ from mirascope.api._generated import Mirascope
1395
+
1396
+ client = Mirascope()
1397
+ client.environments.update(
1398
+ organization_id="organizationId",
1399
+ project_id="projectId",
1400
+ environment_id="environmentId",
1401
+ )
1402
+
1403
+ ```
1404
+ </dd>
1405
+ </dl>
1406
+ </dd>
1407
+ </dl>
1408
+
1409
+ #### ⚙️ Parameters
1410
+
1411
+ <dl>
1412
+ <dd>
1413
+
1414
+ <dl>
1415
+ <dd>
1416
+
1417
+ **organization_id:** `str`
1418
+
1419
+ </dd>
1420
+ </dl>
1421
+
1422
+ <dl>
1423
+ <dd>
1424
+
1425
+ **project_id:** `str`
1426
+
1427
+ </dd>
1428
+ </dl>
1429
+
1430
+ <dl>
1431
+ <dd>
1432
+
1433
+ **environment_id:** `str`
1434
+
1435
+ </dd>
1436
+ </dl>
1437
+
1438
+ <dl>
1439
+ <dd>
1440
+
1441
+ **name:** `typing.Optional[str]` — a string at most 100 character(s) long
1442
+
1443
+ </dd>
1444
+ </dl>
1445
+
1446
+ <dl>
1447
+ <dd>
1448
+
1449
+ **slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
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.environments.<a href="src/mirascope/environments/client.py">delete</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.environments.delete(
1486
+ organization_id="organizationId",
1487
+ project_id="projectId",
1488
+ environment_id="environmentId",
1489
+ )
1490
+
1491
+ ```
1492
+ </dd>
1493
+ </dl>
1494
+ </dd>
1495
+ </dl>
1496
+
1497
+ #### ⚙️ Parameters
1498
+
1499
+ <dl>
1500
+ <dd>
1501
+
1502
+ <dl>
1503
+ <dd>
1504
+
1505
+ **organization_id:** `str`
1506
+
1507
+ </dd>
1508
+ </dl>
1509
+
1510
+ <dl>
1511
+ <dd>
1512
+
1513
+ **project_id:** `str`
1514
+
1515
+ </dd>
1516
+ </dl>
1517
+
1518
+ <dl>
1519
+ <dd>
1520
+
1521
+ **environment_id:** `str`
1522
+
1523
+ </dd>
1524
+ </dl>
1525
+
1526
+ <dl>
1527
+ <dd>
1528
+
1529
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1530
+
1531
+ </dd>
1532
+ </dl>
1533
+ </dd>
1534
+ </dl>
1535
+
1536
+
1537
+ </dd>
1538
+ </dl>
1539
+ </details>
1540
+
1541
+ ## apiKeys
1542
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_list</a>(...)</code></summary>
1543
+ <dl>
1544
+ <dd>
1545
+
1546
+ #### 🔌 Usage
1547
+
1548
+ <dl>
1549
+ <dd>
1550
+
1551
+ <dl>
1552
+ <dd>
1553
+
1554
+ ```python
1555
+ from mirascope.api._generated import Mirascope
1556
+
1557
+ client = Mirascope()
1558
+ client.api_keys.api_keys_list(
1559
+ organization_id="organizationId",
1560
+ project_id="projectId",
1561
+ environment_id="environmentId",
1562
+ )
1563
+
1564
+ ```
1565
+ </dd>
1566
+ </dl>
1567
+ </dd>
1568
+ </dl>
1569
+
1570
+ #### ⚙️ Parameters
1571
+
1572
+ <dl>
1573
+ <dd>
1574
+
1575
+ <dl>
1576
+ <dd>
1577
+
1578
+ **organization_id:** `str`
1579
+
1580
+ </dd>
1581
+ </dl>
1582
+
1583
+ <dl>
1584
+ <dd>
1585
+
1586
+ **project_id:** `str`
1587
+
1588
+ </dd>
1589
+ </dl>
1590
+
1591
+ <dl>
1592
+ <dd>
1593
+
1594
+ **environment_id:** `str`
1595
+
1596
+ </dd>
1597
+ </dl>
1598
+
1599
+ <dl>
1600
+ <dd>
1601
+
1602
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1603
+
1604
+ </dd>
1605
+ </dl>
1606
+ </dd>
1607
+ </dl>
1608
+
1609
+
1610
+ </dd>
1611
+ </dl>
1612
+ </details>
1613
+
1614
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_create</a>(...)</code></summary>
1615
+ <dl>
1616
+ <dd>
1617
+
1618
+ #### 🔌 Usage
1619
+
1620
+ <dl>
1621
+ <dd>
1622
+
1623
+ <dl>
1624
+ <dd>
1625
+
1626
+ ```python
1627
+ from mirascope.api._generated import Mirascope
1628
+
1629
+ client = Mirascope()
1630
+ client.api_keys.api_keys_create(
1631
+ organization_id="organizationId",
1632
+ project_id="projectId",
1633
+ environment_id="environmentId",
1634
+ name="name",
1635
+ )
1636
+
1637
+ ```
1638
+ </dd>
1639
+ </dl>
1640
+ </dd>
1641
+ </dl>
1642
+
1643
+ #### ⚙️ Parameters
1644
+
1645
+ <dl>
1646
+ <dd>
1647
+
1648
+ <dl>
1649
+ <dd>
1650
+
1651
+ **organization_id:** `str`
1652
+
1653
+ </dd>
1654
+ </dl>
1655
+
1656
+ <dl>
1657
+ <dd>
1658
+
1659
+ **project_id:** `str`
1660
+
1661
+ </dd>
1662
+ </dl>
1663
+
1664
+ <dl>
1665
+ <dd>
1666
+
1667
+ **environment_id:** `str`
1668
+
1669
+ </dd>
1670
+ </dl>
1671
+
1672
+ <dl>
1673
+ <dd>
1674
+
1675
+ **name:** `str` — a string at most 100 character(s) long
1676
+
1677
+ </dd>
1678
+ </dl>
1679
+
1680
+ <dl>
1681
+ <dd>
1682
+
1683
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1684
+
1685
+ </dd>
1686
+ </dl>
1687
+ </dd>
1688
+ </dl>
1689
+
1690
+
1691
+ </dd>
1692
+ </dl>
1693
+ </details>
1694
+
1695
+ <details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_get</a>(...)</code></summary>
1696
+ <dl>
1697
+ <dd>
1698
+
1699
+ #### 🔌 Usage
1700
+
1701
+ <dl>
1702
+ <dd>
1703
+
1704
+ <dl>
1705
+ <dd>
1706
+
1707
+ ```python
1708
+ from mirascope.api._generated import Mirascope
1709
+
1710
+ client = Mirascope()
1711
+ client.api_keys.api_keys_get(
1712
+ organization_id="organizationId",
1713
+ project_id="projectId",
1714
+ environment_id="environmentId",
1715
+ api_key_id="apiKeyId",
1716
+ )
1717
+
1718
+ ```
1719
+ </dd>
1720
+ </dl>
1721
+ </dd>
1722
+ </dl>
1723
+
1724
+ #### ⚙️ Parameters
1725
+
1726
+ <dl>
1727
+ <dd>
1728
+
1729
+ <dl>
1730
+ <dd>
1731
+
1732
+ **organization_id:** `str`
1733
+
1734
+ </dd>
1735
+ </dl>
1736
+
1737
+ <dl>
1738
+ <dd>
1739
+
1740
+ **project_id:** `str`
1741
+
1742
+ </dd>
1743
+ </dl>
1744
+
1745
+ <dl>
1746
+ <dd>
1747
+
1748
+ **environment_id:** `str`
1749
+
1750
+ </dd>
1751
+ </dl>
1752
+
1753
+ <dl>
1754
+ <dd>
1755
+
1756
+ **api_key_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.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_delete</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.api_keys.api_keys_delete(
1793
+ organization_id="organizationId",
1794
+ project_id="projectId",
1795
+ environment_id="environmentId",
1796
+ api_key_id="apiKeyId",
1797
+ )
141
1798
 
142
1799
  ```
143
1800
  </dd>
@@ -153,6 +1810,38 @@ client.docs.openapi()
153
1810
  <dl>
154
1811
  <dd>
155
1812
 
1813
+ **organization_id:** `str`
1814
+
1815
+ </dd>
1816
+ </dl>
1817
+
1818
+ <dl>
1819
+ <dd>
1820
+
1821
+ **project_id:** `str`
1822
+
1823
+ </dd>
1824
+ </dl>
1825
+
1826
+ <dl>
1827
+ <dd>
1828
+
1829
+ **environment_id:** `str`
1830
+
1831
+ </dd>
1832
+ </dl>
1833
+
1834
+ <dl>
1835
+ <dd>
1836
+
1837
+ **api_key_id:** `str`
1838
+
1839
+ </dd>
1840
+ </dl>
1841
+
1842
+ <dl>
1843
+ <dd>
1844
+
156
1845
  **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
157
1846
 
158
1847
  </dd>
@@ -165,8 +1854,8 @@ client.docs.openapi()
165
1854
  </dl>
166
1855
  </details>
167
1856
 
168
- ## organizations
169
- <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">list</a>()</code></summary>
1857
+ ## functions
1858
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">list</a>()</code></summary>
170
1859
  <dl>
171
1860
  <dd>
172
1861
 
@@ -182,7 +1871,7 @@ client.docs.openapi()
182
1871
  from mirascope.api._generated import Mirascope
183
1872
 
184
1873
  client = Mirascope()
185
- client.organizations.list()
1874
+ client.functions.list()
186
1875
 
187
1876
  ```
188
1877
  </dd>
@@ -210,7 +1899,7 @@ client.organizations.list()
210
1899
  </dl>
211
1900
  </details>
212
1901
 
213
- <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">create</a>(...)</code></summary>
1902
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">create</a>(...)</code></summary>
214
1903
  <dl>
215
1904
  <dd>
216
1905
 
@@ -226,7 +1915,11 @@ client.organizations.list()
226
1915
  from mirascope.api._generated import Mirascope
227
1916
 
228
1917
  client = Mirascope()
229
- client.organizations.create(
1918
+ client.functions.create(
1919
+ code="code",
1920
+ hash="hash",
1921
+ signature="signature",
1922
+ signature_hash="signatureHash",
230
1923
  name="name",
231
1924
  )
232
1925
 
@@ -244,7 +1937,73 @@ client.organizations.create(
244
1937
  <dl>
245
1938
  <dd>
246
1939
 
247
- **name:** `str` — a string at most 100 character(s) long
1940
+ **code:** `str`
1941
+
1942
+ </dd>
1943
+ </dl>
1944
+
1945
+ <dl>
1946
+ <dd>
1947
+
1948
+ **hash:** `str`
1949
+
1950
+ </dd>
1951
+ </dl>
1952
+
1953
+ <dl>
1954
+ <dd>
1955
+
1956
+ **signature:** `str`
1957
+
1958
+ </dd>
1959
+ </dl>
1960
+
1961
+ <dl>
1962
+ <dd>
1963
+
1964
+ **signature_hash:** `str`
1965
+
1966
+ </dd>
1967
+ </dl>
1968
+
1969
+ <dl>
1970
+ <dd>
1971
+
1972
+ **name:** `str`
1973
+
1974
+ </dd>
1975
+ </dl>
1976
+
1977
+ <dl>
1978
+ <dd>
1979
+
1980
+ **description:** `typing.Optional[str]`
1981
+
1982
+ </dd>
1983
+ </dl>
1984
+
1985
+ <dl>
1986
+ <dd>
1987
+
1988
+ **tags:** `typing.Optional[typing.Sequence[str]]`
1989
+
1990
+ </dd>
1991
+ </dl>
1992
+
1993
+ <dl>
1994
+ <dd>
1995
+
1996
+ **metadata:** `typing.Optional[typing.Dict[str, typing.Optional[str]]]`
1997
+
1998
+ </dd>
1999
+ </dl>
2000
+
2001
+ <dl>
2002
+ <dd>
2003
+
2004
+ **dependencies:** `typing.Optional[
2005
+ typing.Dict[str, typing.Optional[FunctionsCreateRequestDependenciesValue]]
2006
+ ]`
248
2007
 
249
2008
  </dd>
250
2009
  </dl>
@@ -264,7 +2023,7 @@ client.organizations.create(
264
2023
  </dl>
265
2024
  </details>
266
2025
 
267
- <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">get</a>(...)</code></summary>
2026
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">get</a>(...)</code></summary>
268
2027
  <dl>
269
2028
  <dd>
270
2029
 
@@ -280,7 +2039,7 @@ client.organizations.create(
280
2039
  from mirascope.api._generated import Mirascope
281
2040
 
282
2041
  client = Mirascope()
283
- client.organizations.get(
2042
+ client.functions.get(
284
2043
  id="id",
285
2044
  )
286
2045
 
@@ -318,7 +2077,7 @@ client.organizations.get(
318
2077
  </dl>
319
2078
  </details>
320
2079
 
321
- <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">update</a>(...)</code></summary>
2080
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">delete</a>(...)</code></summary>
322
2081
  <dl>
323
2082
  <dd>
324
2083
 
@@ -334,9 +2093,8 @@ client.organizations.get(
334
2093
  from mirascope.api._generated import Mirascope
335
2094
 
336
2095
  client = Mirascope()
337
- client.organizations.update(
2096
+ client.functions.delete(
338
2097
  id="id",
339
- name="name",
340
2098
  )
341
2099
 
342
2100
  ```
@@ -361,14 +2119,6 @@ client.organizations.update(
361
2119
  <dl>
362
2120
  <dd>
363
2121
 
364
- **name:** `str` — a string at most 100 character(s) long
365
-
366
- </dd>
367
- </dl>
368
-
369
- <dl>
370
- <dd>
371
-
372
2122
  **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
373
2123
 
374
2124
  </dd>
@@ -381,7 +2131,7 @@ client.organizations.update(
381
2131
  </dl>
382
2132
  </details>
383
2133
 
384
- <details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">delete</a>(...)</code></summary>
2134
+ <details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">findbyhash</a>(...)</code></summary>
385
2135
  <dl>
386
2136
  <dd>
387
2137
 
@@ -397,8 +2147,8 @@ client.organizations.update(
397
2147
  from mirascope.api._generated import Mirascope
398
2148
 
399
2149
  client = Mirascope()
400
- client.organizations.delete(
401
- id="id",
2150
+ client.functions.findbyhash(
2151
+ hash="hash",
402
2152
  )
403
2153
 
404
2154
  ```
@@ -415,7 +2165,7 @@ client.organizations.delete(
415
2165
  <dl>
416
2166
  <dd>
417
2167
 
418
- **id:** `str`
2168
+ **hash:** `str`
419
2169
 
420
2170
  </dd>
421
2171
  </dl>
@@ -435,8 +2185,8 @@ client.organizations.delete(
435
2185
  </dl>
436
2186
  </details>
437
2187
 
438
- ## projects
439
- <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">list</a>(...)</code></summary>
2188
+ ## annotations
2189
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">list</a>(...)</code></summary>
440
2190
  <dl>
441
2191
  <dd>
442
2192
 
@@ -452,9 +2202,7 @@ client.organizations.delete(
452
2202
  from mirascope.api._generated import Mirascope
453
2203
 
454
2204
  client = Mirascope()
455
- client.projects.list(
456
- organization_id="organizationId",
457
- )
2205
+ client.annotations.list()
458
2206
 
459
2207
  ```
460
2208
  </dd>
@@ -470,7 +2218,39 @@ client.projects.list(
470
2218
  <dl>
471
2219
  <dd>
472
2220
 
473
- **organization_id:** `str`
2221
+ **otel_trace_id:** `typing.Optional[str]`
2222
+
2223
+ </dd>
2224
+ </dl>
2225
+
2226
+ <dl>
2227
+ <dd>
2228
+
2229
+ **otel_span_id:** `typing.Optional[str]`
2230
+
2231
+ </dd>
2232
+ </dl>
2233
+
2234
+ <dl>
2235
+ <dd>
2236
+
2237
+ **label:** `typing.Optional[AnnotationsListRequestLabel]`
2238
+
2239
+ </dd>
2240
+ </dl>
2241
+
2242
+ <dl>
2243
+ <dd>
2244
+
2245
+ **limit:** `typing.Optional[NumberFromString]`
2246
+
2247
+ </dd>
2248
+ </dl>
2249
+
2250
+ <dl>
2251
+ <dd>
2252
+
2253
+ **offset:** `typing.Optional[NumberFromString]`
474
2254
 
475
2255
  </dd>
476
2256
  </dl>
@@ -490,7 +2270,7 @@ client.projects.list(
490
2270
  </dl>
491
2271
  </details>
492
2272
 
493
- <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">create</a>(...)</code></summary>
2273
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">create</a>(...)</code></summary>
494
2274
  <dl>
495
2275
  <dd>
496
2276
 
@@ -506,9 +2286,9 @@ client.projects.list(
506
2286
  from mirascope.api._generated import Mirascope
507
2287
 
508
2288
  client = Mirascope()
509
- client.projects.create(
510
- organization_id="organizationId",
511
- name="name",
2289
+ client.annotations.create(
2290
+ otel_span_id="otelSpanId",
2291
+ otel_trace_id="otelTraceId",
512
2292
  )
513
2293
 
514
2294
  ```
@@ -525,7 +2305,7 @@ client.projects.create(
525
2305
  <dl>
526
2306
  <dd>
527
2307
 
528
- **organization_id:** `str`
2308
+ **otel_span_id:** `str`
529
2309
 
530
2310
  </dd>
531
2311
  </dl>
@@ -533,7 +2313,31 @@ client.projects.create(
533
2313
  <dl>
534
2314
  <dd>
535
2315
 
536
- **name:** `str` — a string at most 100 character(s) long
2316
+ **otel_trace_id:** `str`
2317
+
2318
+ </dd>
2319
+ </dl>
2320
+
2321
+ <dl>
2322
+ <dd>
2323
+
2324
+ **label:** `typing.Optional[AnnotationsCreateRequestLabel]`
2325
+
2326
+ </dd>
2327
+ </dl>
2328
+
2329
+ <dl>
2330
+ <dd>
2331
+
2332
+ **reasoning:** `typing.Optional[str]`
2333
+
2334
+ </dd>
2335
+ </dl>
2336
+
2337
+ <dl>
2338
+ <dd>
2339
+
2340
+ **metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]`
537
2341
 
538
2342
  </dd>
539
2343
  </dl>
@@ -553,7 +2357,7 @@ client.projects.create(
553
2357
  </dl>
554
2358
  </details>
555
2359
 
556
- <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">get</a>(...)</code></summary>
2360
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">get</a>(...)</code></summary>
557
2361
  <dl>
558
2362
  <dd>
559
2363
 
@@ -569,9 +2373,8 @@ client.projects.create(
569
2373
  from mirascope.api._generated import Mirascope
570
2374
 
571
2375
  client = Mirascope()
572
- client.projects.get(
573
- organization_id="organizationId",
574
- project_id="projectId",
2376
+ client.annotations.get(
2377
+ id="id",
575
2378
  )
576
2379
 
577
2380
  ```
@@ -588,15 +2391,7 @@ client.projects.get(
588
2391
  <dl>
589
2392
  <dd>
590
2393
 
591
- **organization_id:** `str`
592
-
593
- </dd>
594
- </dl>
595
-
596
- <dl>
597
- <dd>
598
-
599
- **project_id:** `str`
2394
+ **id:** `str`
600
2395
 
601
2396
  </dd>
602
2397
  </dl>
@@ -616,7 +2411,7 @@ client.projects.get(
616
2411
  </dl>
617
2412
  </details>
618
2413
 
619
- <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">update</a>(...)</code></summary>
2414
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">update</a>(...)</code></summary>
620
2415
  <dl>
621
2416
  <dd>
622
2417
 
@@ -632,10 +2427,8 @@ client.projects.get(
632
2427
  from mirascope.api._generated import Mirascope
633
2428
 
634
2429
  client = Mirascope()
635
- client.projects.update(
636
- organization_id="organizationId",
637
- project_id="projectId",
638
- name="name",
2430
+ client.annotations.update(
2431
+ id="id",
639
2432
  )
640
2433
 
641
2434
  ```
@@ -652,7 +2445,7 @@ client.projects.update(
652
2445
  <dl>
653
2446
  <dd>
654
2447
 
655
- **organization_id:** `str`
2448
+ **id:** `str`
656
2449
 
657
2450
  </dd>
658
2451
  </dl>
@@ -660,7 +2453,7 @@ client.projects.update(
660
2453
  <dl>
661
2454
  <dd>
662
2455
 
663
- **project_id:** `str`
2456
+ **label:** `typing.Optional[AnnotationsUpdateRequestLabel]`
664
2457
 
665
2458
  </dd>
666
2459
  </dl>
@@ -668,7 +2461,15 @@ client.projects.update(
668
2461
  <dl>
669
2462
  <dd>
670
2463
 
671
- **name:** `str` — a string at most 100 character(s) long
2464
+ **reasoning:** `typing.Optional[str]`
2465
+
2466
+ </dd>
2467
+ </dl>
2468
+
2469
+ <dl>
2470
+ <dd>
2471
+
2472
+ **metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]`
672
2473
 
673
2474
  </dd>
674
2475
  </dl>
@@ -688,7 +2489,7 @@ client.projects.update(
688
2489
  </dl>
689
2490
  </details>
690
2491
 
691
- <details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">delete</a>(...)</code></summary>
2492
+ <details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">delete</a>(...)</code></summary>
692
2493
  <dl>
693
2494
  <dd>
694
2495
 
@@ -704,9 +2505,8 @@ client.projects.update(
704
2505
  from mirascope.api._generated import Mirascope
705
2506
 
706
2507
  client = Mirascope()
707
- client.projects.delete(
708
- organization_id="organizationId",
709
- project_id="projectId",
2508
+ client.annotations.delete(
2509
+ id="id",
710
2510
  )
711
2511
 
712
2512
  ```
@@ -723,15 +2523,7 @@ client.projects.delete(
723
2523
  <dl>
724
2524
  <dd>
725
2525
 
726
- **organization_id:** `str`
727
-
728
- </dd>
729
- </dl>
730
-
731
- <dl>
732
- <dd>
733
-
734
- **project_id:** `str`
2526
+ **id:** `str`
735
2527
 
736
2528
  </dd>
737
2529
  </dl>