mirascope 2.0.0a6__py3-none-any.whl → 2.0.2__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.
- mirascope/_utils.py +34 -0
- mirascope/api/_generated/__init__.py +186 -5
- mirascope/api/_generated/annotations/client.py +38 -6
- mirascope/api/_generated/annotations/raw_client.py +366 -47
- mirascope/api/_generated/annotations/types/annotations_create_response.py +19 -6
- mirascope/api/_generated/annotations/types/annotations_get_response.py +19 -6
- mirascope/api/_generated/annotations/types/annotations_list_response_annotations_item.py +22 -7
- mirascope/api/_generated/annotations/types/annotations_update_response.py +19 -6
- mirascope/api/_generated/api_keys/__init__.py +12 -2
- mirascope/api/_generated/api_keys/client.py +107 -6
- mirascope/api/_generated/api_keys/raw_client.py +486 -38
- mirascope/api/_generated/api_keys/types/__init__.py +7 -1
- mirascope/api/_generated/api_keys/types/api_keys_list_all_for_org_response_item.py +40 -0
- mirascope/api/_generated/client.py +36 -0
- mirascope/api/_generated/docs/raw_client.py +71 -9
- mirascope/api/_generated/environment.py +3 -3
- mirascope/api/_generated/environments/__init__.py +6 -0
- mirascope/api/_generated/environments/client.py +158 -9
- mirascope/api/_generated/environments/raw_client.py +620 -52
- mirascope/api/_generated/environments/types/__init__.py +10 -0
- mirascope/api/_generated/environments/types/environments_get_analytics_response.py +60 -0
- mirascope/api/_generated/environments/types/environments_get_analytics_response_top_functions_item.py +24 -0
- mirascope/api/_generated/{organizations/types/organizations_credits_response.py → environments/types/environments_get_analytics_response_top_models_item.py} +6 -3
- mirascope/api/_generated/errors/__init__.py +6 -0
- mirascope/api/_generated/errors/bad_request_error.py +5 -2
- mirascope/api/_generated/errors/conflict_error.py +5 -2
- mirascope/api/_generated/errors/payment_required_error.py +15 -0
- mirascope/api/_generated/errors/service_unavailable_error.py +14 -0
- mirascope/api/_generated/errors/too_many_requests_error.py +15 -0
- mirascope/api/_generated/functions/__init__.py +10 -0
- mirascope/api/_generated/functions/client.py +222 -8
- mirascope/api/_generated/functions/raw_client.py +975 -134
- mirascope/api/_generated/functions/types/__init__.py +28 -4
- mirascope/api/_generated/functions/types/functions_get_by_env_response.py +53 -0
- mirascope/api/_generated/functions/types/functions_get_by_env_response_dependencies_value.py +22 -0
- mirascope/api/_generated/functions/types/functions_list_by_env_response.py +25 -0
- mirascope/api/_generated/functions/types/functions_list_by_env_response_functions_item.py +56 -0
- mirascope/api/_generated/functions/types/functions_list_by_env_response_functions_item_dependencies_value.py +22 -0
- mirascope/api/_generated/health/raw_client.py +74 -10
- mirascope/api/_generated/organization_invitations/__init__.py +33 -0
- mirascope/api/_generated/organization_invitations/client.py +546 -0
- mirascope/api/_generated/organization_invitations/raw_client.py +1519 -0
- mirascope/api/_generated/organization_invitations/types/__init__.py +53 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_accept_response.py +34 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_accept_response_role.py +7 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_create_request_role.py +7 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_create_response.py +48 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_create_response_role.py +7 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_create_response_status.py +7 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_get_response.py +48 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_get_response_role.py +7 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_get_response_status.py +7 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_list_response_item.py +48 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_list_response_item_role.py +7 -0
- mirascope/api/_generated/organization_invitations/types/organization_invitations_list_response_item_status.py +7 -0
- mirascope/api/_generated/organization_memberships/__init__.py +19 -0
- mirascope/api/_generated/organization_memberships/client.py +302 -0
- mirascope/api/_generated/organization_memberships/raw_client.py +736 -0
- mirascope/api/_generated/organization_memberships/types/__init__.py +27 -0
- mirascope/api/_generated/organization_memberships/types/organization_memberships_list_response_item.py +33 -0
- mirascope/api/_generated/organization_memberships/types/organization_memberships_list_response_item_role.py +7 -0
- mirascope/api/_generated/organization_memberships/types/organization_memberships_update_request_role.py +7 -0
- mirascope/api/_generated/organization_memberships/types/organization_memberships_update_response.py +31 -0
- mirascope/api/_generated/organization_memberships/types/organization_memberships_update_response_role.py +7 -0
- mirascope/api/_generated/organizations/__init__.py +26 -2
- mirascope/api/_generated/organizations/client.py +442 -20
- mirascope/api/_generated/organizations/raw_client.py +1763 -164
- mirascope/api/_generated/organizations/types/__init__.py +48 -2
- mirascope/api/_generated/organizations/types/organizations_create_payment_intent_response.py +24 -0
- mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_request_target_plan.py +7 -0
- mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_response.py +47 -0
- mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_response_validation_errors_item.py +33 -0
- mirascope/api/_generated/organizations/types/organizations_preview_subscription_change_response_validation_errors_item_resource.py +7 -0
- mirascope/api/_generated/organizations/types/organizations_router_balance_response.py +24 -0
- mirascope/api/_generated/organizations/types/organizations_subscription_response.py +53 -0
- mirascope/api/_generated/organizations/types/organizations_subscription_response_current_plan.py +7 -0
- mirascope/api/_generated/organizations/types/organizations_subscription_response_payment_method.py +26 -0
- mirascope/api/_generated/organizations/types/organizations_subscription_response_scheduled_change.py +34 -0
- mirascope/api/_generated/organizations/types/organizations_subscription_response_scheduled_change_target_plan.py +7 -0
- mirascope/api/_generated/organizations/types/organizations_update_subscription_request_target_plan.py +7 -0
- mirascope/api/_generated/organizations/types/organizations_update_subscription_response.py +35 -0
- mirascope/api/_generated/project_memberships/__init__.py +25 -0
- mirascope/api/_generated/project_memberships/client.py +437 -0
- mirascope/api/_generated/project_memberships/raw_client.py +1039 -0
- mirascope/api/_generated/project_memberships/types/__init__.py +29 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_create_request_role.py +7 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_create_response.py +35 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_create_response_role.py +7 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_list_response_item.py +33 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_list_response_item_role.py +7 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_update_request_role.py +7 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_update_response.py +35 -0
- mirascope/api/_generated/project_memberships/types/project_memberships_update_response_role.py +7 -0
- mirascope/api/_generated/projects/raw_client.py +415 -58
- mirascope/api/_generated/reference.md +2767 -397
- mirascope/api/_generated/tags/__init__.py +19 -0
- mirascope/api/_generated/tags/client.py +504 -0
- mirascope/api/_generated/tags/raw_client.py +1288 -0
- mirascope/api/_generated/tags/types/__init__.py +17 -0
- mirascope/api/_generated/tags/types/tags_create_response.py +41 -0
- mirascope/api/_generated/tags/types/tags_get_response.py +41 -0
- mirascope/api/_generated/tags/types/tags_list_response.py +23 -0
- mirascope/api/_generated/tags/types/tags_list_response_tags_item.py +41 -0
- mirascope/api/_generated/tags/types/tags_update_response.py +41 -0
- mirascope/api/_generated/token_cost/__init__.py +7 -0
- mirascope/api/_generated/token_cost/client.py +160 -0
- mirascope/api/_generated/token_cost/raw_client.py +264 -0
- mirascope/api/_generated/token_cost/types/__init__.py +8 -0
- mirascope/api/_generated/token_cost/types/token_cost_calculate_request_usage.py +54 -0
- mirascope/api/_generated/token_cost/types/token_cost_calculate_response.py +52 -0
- mirascope/api/_generated/traces/__init__.py +20 -0
- mirascope/api/_generated/traces/client.py +543 -0
- mirascope/api/_generated/traces/raw_client.py +1366 -96
- mirascope/api/_generated/traces/types/__init__.py +28 -0
- mirascope/api/_generated/traces/types/traces_get_analytics_summary_response.py +6 -0
- mirascope/api/_generated/traces/types/traces_get_trace_detail_by_env_response.py +33 -0
- mirascope/api/_generated/traces/types/traces_get_trace_detail_by_env_response_spans_item.py +88 -0
- mirascope/api/_generated/traces/types/traces_get_trace_detail_response_spans_item.py +0 -2
- mirascope/api/_generated/traces/types/traces_list_by_function_hash_response.py +25 -0
- mirascope/api/_generated/traces/types/traces_list_by_function_hash_response_traces_item.py +44 -0
- mirascope/api/_generated/traces/types/traces_search_by_env_request_attribute_filters_item.py +26 -0
- mirascope/api/_generated/traces/types/traces_search_by_env_request_attribute_filters_item_operator.py +7 -0
- mirascope/api/_generated/traces/types/traces_search_by_env_request_sort_by.py +7 -0
- mirascope/api/_generated/traces/types/traces_search_by_env_request_sort_order.py +7 -0
- mirascope/api/_generated/traces/types/traces_search_by_env_response.py +26 -0
- mirascope/api/_generated/traces/types/traces_search_by_env_response_spans_item.py +50 -0
- mirascope/api/_generated/traces/types/traces_search_response_spans_item.py +10 -1
- mirascope/api/_generated/types/__init__.py +32 -2
- mirascope/api/_generated/types/bad_request_error_body.py +50 -0
- mirascope/api/_generated/types/date.py +3 -0
- mirascope/api/_generated/types/immutable_resource_error.py +22 -0
- mirascope/api/_generated/types/internal_server_error_body.py +3 -3
- mirascope/api/_generated/types/plan_limit_exceeded_error.py +32 -0
- mirascope/api/_generated/types/plan_limit_exceeded_error_tag.py +7 -0
- mirascope/api/_generated/types/pricing_unavailable_error.py +23 -0
- mirascope/api/_generated/types/rate_limit_error.py +31 -0
- mirascope/api/_generated/types/rate_limit_error_tag.py +5 -0
- mirascope/api/_generated/types/service_unavailable_error_body.py +24 -0
- mirascope/api/_generated/types/service_unavailable_error_tag.py +7 -0
- mirascope/api/_generated/types/subscription_past_due_error.py +31 -0
- mirascope/api/_generated/types/subscription_past_due_error_tag.py +7 -0
- mirascope/api/settings.py +19 -1
- mirascope/llm/__init__.py +53 -10
- mirascope/llm/calls/__init__.py +2 -1
- mirascope/llm/calls/calls.py +29 -20
- mirascope/llm/calls/decorator.py +21 -7
- mirascope/llm/content/tool_output.py +22 -5
- mirascope/llm/exceptions.py +284 -71
- mirascope/llm/formatting/__init__.py +17 -0
- mirascope/llm/formatting/format.py +112 -35
- mirascope/llm/formatting/output_parser.py +178 -0
- mirascope/llm/formatting/partial.py +80 -7
- mirascope/llm/formatting/primitives.py +192 -0
- mirascope/llm/formatting/types.py +20 -8
- mirascope/llm/messages/__init__.py +3 -0
- mirascope/llm/messages/_utils.py +34 -0
- mirascope/llm/models/__init__.py +5 -0
- mirascope/llm/models/models.py +137 -69
- mirascope/llm/{providers/base → models}/params.py +7 -57
- mirascope/llm/models/thinking_config.py +61 -0
- mirascope/llm/prompts/_utils.py +0 -32
- mirascope/llm/prompts/decorator.py +16 -5
- mirascope/llm/prompts/prompts.py +160 -92
- mirascope/llm/providers/__init__.py +1 -4
- mirascope/llm/providers/anthropic/_utils/__init__.py +2 -0
- mirascope/llm/providers/anthropic/_utils/beta_decode.py +18 -9
- mirascope/llm/providers/anthropic/_utils/beta_encode.py +62 -13
- mirascope/llm/providers/anthropic/_utils/decode.py +18 -9
- mirascope/llm/providers/anthropic/_utils/encode.py +26 -7
- mirascope/llm/providers/anthropic/_utils/errors.py +2 -2
- mirascope/llm/providers/anthropic/beta_provider.py +64 -18
- mirascope/llm/providers/anthropic/provider.py +91 -33
- mirascope/llm/providers/base/__init__.py +0 -4
- mirascope/llm/providers/base/_utils.py +55 -6
- mirascope/llm/providers/base/base_provider.py +116 -37
- mirascope/llm/providers/google/_utils/__init__.py +2 -0
- mirascope/llm/providers/google/_utils/decode.py +20 -7
- mirascope/llm/providers/google/_utils/encode.py +26 -7
- mirascope/llm/providers/google/_utils/errors.py +3 -2
- mirascope/llm/providers/google/provider.py +64 -18
- mirascope/llm/providers/mirascope/_utils.py +13 -17
- mirascope/llm/providers/mirascope/provider.py +49 -18
- mirascope/llm/providers/mlx/_utils.py +7 -2
- mirascope/llm/providers/mlx/encoding/base.py +5 -2
- mirascope/llm/providers/mlx/encoding/transformers.py +5 -2
- mirascope/llm/providers/mlx/mlx.py +23 -6
- mirascope/llm/providers/mlx/provider.py +42 -13
- mirascope/llm/providers/openai/_utils/errors.py +2 -2
- mirascope/llm/providers/openai/completions/_utils/encode.py +20 -16
- mirascope/llm/providers/openai/completions/base_provider.py +40 -11
- mirascope/llm/providers/openai/provider.py +40 -10
- mirascope/llm/providers/openai/responses/_utils/__init__.py +2 -0
- mirascope/llm/providers/openai/responses/_utils/decode.py +19 -6
- mirascope/llm/providers/openai/responses/_utils/encode.py +22 -10
- mirascope/llm/providers/openai/responses/provider.py +56 -18
- mirascope/llm/providers/provider_registry.py +93 -19
- mirascope/llm/responses/__init__.py +6 -1
- mirascope/llm/responses/_utils.py +102 -12
- mirascope/llm/responses/base_response.py +5 -2
- mirascope/llm/responses/base_stream_response.py +115 -25
- mirascope/llm/responses/response.py +2 -1
- mirascope/llm/responses/root_response.py +89 -17
- mirascope/llm/responses/stream_response.py +6 -9
- mirascope/llm/tools/decorator.py +9 -4
- mirascope/llm/tools/tool_schema.py +17 -6
- mirascope/llm/tools/toolkit.py +35 -27
- mirascope/llm/tools/tools.py +45 -20
- mirascope/ops/__init__.py +4 -0
- mirascope/ops/_internal/closure.py +4 -1
- mirascope/ops/_internal/configuration.py +82 -31
- mirascope/ops/_internal/exporters/exporters.py +55 -35
- mirascope/ops/_internal/exporters/utils.py +37 -0
- mirascope/ops/_internal/instrumentation/llm/common.py +530 -0
- mirascope/ops/_internal/instrumentation/llm/cost.py +190 -0
- mirascope/ops/_internal/instrumentation/llm/encode.py +1 -1
- mirascope/ops/_internal/instrumentation/llm/llm.py +116 -1242
- mirascope/ops/_internal/instrumentation/llm/model.py +1798 -0
- mirascope/ops/_internal/instrumentation/llm/response.py +521 -0
- mirascope/ops/_internal/instrumentation/llm/serialize.py +300 -0
- mirascope/ops/_internal/protocols.py +83 -1
- mirascope/ops/_internal/traced_calls.py +18 -0
- mirascope/ops/_internal/traced_functions.py +125 -10
- mirascope/ops/_internal/tracing.py +78 -1
- mirascope/ops/_internal/utils.py +60 -4
- mirascope/ops/_internal/versioned_functions.py +1 -1
- {mirascope-2.0.0a6.dist-info → mirascope-2.0.2.dist-info}/METADATA +12 -11
- mirascope-2.0.2.dist-info/RECORD +424 -0
- {mirascope-2.0.0a6.dist-info → mirascope-2.0.2.dist-info}/licenses/LICENSE +1 -1
- mirascope-2.0.0a6.dist-info/RECORD +0 -316
- {mirascope-2.0.0a6.dist-info → mirascope-2.0.2.dist-info}/WHEEL +0 -0
|
@@ -179,6 +179,30 @@ client.traces.search(
|
|
|
179
179
|
<dl>
|
|
180
180
|
<dd>
|
|
181
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
|
+
|
|
182
206
|
**trace_id:** `typing.Optional[str]`
|
|
183
207
|
|
|
184
208
|
</dd>
|
|
@@ -227,6 +251,14 @@ client.traces.search(
|
|
|
227
251
|
<dl>
|
|
228
252
|
<dd>
|
|
229
253
|
|
|
254
|
+
**span_name_prefix:** `typing.Optional[str]`
|
|
255
|
+
|
|
256
|
+
</dd>
|
|
257
|
+
</dl>
|
|
258
|
+
|
|
259
|
+
<dl>
|
|
260
|
+
<dd>
|
|
261
|
+
|
|
230
262
|
**has_error:** `typing.Optional[bool]`
|
|
231
263
|
|
|
232
264
|
</dd>
|
|
@@ -307,6 +339,14 @@ client.traces.search(
|
|
|
307
339
|
<dl>
|
|
308
340
|
<dd>
|
|
309
341
|
|
|
342
|
+
**root_spans_only:** `typing.Optional[bool]`
|
|
343
|
+
|
|
344
|
+
</dd>
|
|
345
|
+
</dl>
|
|
346
|
+
|
|
347
|
+
<dl>
|
|
348
|
+
<dd>
|
|
349
|
+
|
|
310
350
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
311
351
|
|
|
312
352
|
</dd>
|
|
@@ -444,8 +484,7 @@ client.traces.getanalyticssummary(
|
|
|
444
484
|
</dl>
|
|
445
485
|
</details>
|
|
446
486
|
|
|
447
|
-
|
|
448
|
-
<details><summary><code>client.docs.<a href="src/mirascope/docs/client.py">openapi</a>()</code></summary>
|
|
487
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">listbyfunctionhash</a>(...)</code></summary>
|
|
449
488
|
<dl>
|
|
450
489
|
<dd>
|
|
451
490
|
|
|
@@ -461,7 +500,9 @@ client.traces.getanalyticssummary(
|
|
|
461
500
|
from mirascope.api._generated import Mirascope
|
|
462
501
|
|
|
463
502
|
client = Mirascope()
|
|
464
|
-
client.
|
|
503
|
+
client.traces.listbyfunctionhash(
|
|
504
|
+
hash="hash",
|
|
505
|
+
)
|
|
465
506
|
|
|
466
507
|
```
|
|
467
508
|
</dd>
|
|
@@ -477,6 +518,30 @@ client.docs.openapi()
|
|
|
477
518
|
<dl>
|
|
478
519
|
<dd>
|
|
479
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
|
+
|
|
480
545
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
481
546
|
|
|
482
547
|
</dd>
|
|
@@ -489,8 +554,7 @@ client.docs.openapi()
|
|
|
489
554
|
</dl>
|
|
490
555
|
</details>
|
|
491
556
|
|
|
492
|
-
|
|
493
|
-
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">list</a>()</code></summary>
|
|
557
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">searchbyenv</a>(...)</code></summary>
|
|
494
558
|
<dl>
|
|
495
559
|
<dd>
|
|
496
560
|
|
|
@@ -506,7 +570,13 @@ client.docs.openapi()
|
|
|
506
570
|
from mirascope.api._generated import Mirascope
|
|
507
571
|
|
|
508
572
|
client = Mirascope()
|
|
509
|
-
client.
|
|
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
|
+
)
|
|
510
580
|
|
|
511
581
|
```
|
|
512
582
|
</dd>
|
|
@@ -522,54 +592,55 @@ client.organizations.list()
|
|
|
522
592
|
<dl>
|
|
523
593
|
<dd>
|
|
524
594
|
|
|
525
|
-
**
|
|
595
|
+
**organization_id:** `str`
|
|
526
596
|
|
|
527
597
|
</dd>
|
|
528
598
|
</dl>
|
|
529
|
-
</dd>
|
|
530
|
-
</dl>
|
|
531
599
|
|
|
600
|
+
<dl>
|
|
601
|
+
<dd>
|
|
532
602
|
|
|
603
|
+
**project_id:** `str`
|
|
604
|
+
|
|
533
605
|
</dd>
|
|
534
606
|
</dl>
|
|
535
|
-
</details>
|
|
536
607
|
|
|
537
|
-
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">create</a>(...)</code></summary>
|
|
538
608
|
<dl>
|
|
539
609
|
<dd>
|
|
540
610
|
|
|
541
|
-
|
|
611
|
+
**environment_id:** `str`
|
|
612
|
+
|
|
613
|
+
</dd>
|
|
614
|
+
</dl>
|
|
542
615
|
|
|
543
616
|
<dl>
|
|
544
617
|
<dd>
|
|
545
618
|
|
|
619
|
+
**start_time:** `str`
|
|
620
|
+
|
|
621
|
+
</dd>
|
|
622
|
+
</dl>
|
|
623
|
+
|
|
546
624
|
<dl>
|
|
547
625
|
<dd>
|
|
548
626
|
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
client = Mirascope()
|
|
553
|
-
client.organizations.create(
|
|
554
|
-
name="name",
|
|
555
|
-
slug="slug",
|
|
556
|
-
)
|
|
557
|
-
|
|
558
|
-
```
|
|
559
|
-
</dd>
|
|
560
|
-
</dl>
|
|
627
|
+
**end_time:** `str`
|
|
628
|
+
|
|
561
629
|
</dd>
|
|
562
630
|
</dl>
|
|
563
631
|
|
|
564
|
-
#### ⚙️ Parameters
|
|
565
|
-
|
|
566
632
|
<dl>
|
|
567
633
|
<dd>
|
|
568
634
|
|
|
635
|
+
**query:** `typing.Optional[str]`
|
|
636
|
+
|
|
637
|
+
</dd>
|
|
638
|
+
</dl>
|
|
639
|
+
|
|
569
640
|
<dl>
|
|
570
641
|
<dd>
|
|
571
642
|
|
|
572
|
-
**
|
|
643
|
+
**input_messages_query:** `typing.Optional[str]`
|
|
573
644
|
|
|
574
645
|
</dd>
|
|
575
646
|
</dl>
|
|
@@ -577,7 +648,7 @@ client.organizations.create(
|
|
|
577
648
|
<dl>
|
|
578
649
|
<dd>
|
|
579
650
|
|
|
580
|
-
**
|
|
651
|
+
**output_messages_query:** `typing.Optional[str]`
|
|
581
652
|
|
|
582
653
|
</dd>
|
|
583
654
|
</dl>
|
|
@@ -585,53 +656,55 @@ client.organizations.create(
|
|
|
585
656
|
<dl>
|
|
586
657
|
<dd>
|
|
587
658
|
|
|
588
|
-
**
|
|
659
|
+
**fuzzy_search:** `typing.Optional[bool]`
|
|
589
660
|
|
|
590
661
|
</dd>
|
|
591
662
|
</dl>
|
|
592
|
-
</dd>
|
|
593
|
-
</dl>
|
|
594
663
|
|
|
664
|
+
<dl>
|
|
665
|
+
<dd>
|
|
595
666
|
|
|
667
|
+
**trace_id:** `typing.Optional[str]`
|
|
668
|
+
|
|
596
669
|
</dd>
|
|
597
670
|
</dl>
|
|
598
|
-
</details>
|
|
599
671
|
|
|
600
|
-
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">get</a>(...)</code></summary>
|
|
601
672
|
<dl>
|
|
602
673
|
<dd>
|
|
603
674
|
|
|
604
|
-
|
|
675
|
+
**span_id:** `typing.Optional[str]`
|
|
676
|
+
|
|
677
|
+
</dd>
|
|
678
|
+
</dl>
|
|
605
679
|
|
|
606
680
|
<dl>
|
|
607
681
|
<dd>
|
|
608
682
|
|
|
683
|
+
**model:** `typing.Optional[typing.Sequence[str]]`
|
|
684
|
+
|
|
685
|
+
</dd>
|
|
686
|
+
</dl>
|
|
687
|
+
|
|
609
688
|
<dl>
|
|
610
689
|
<dd>
|
|
611
690
|
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
client = Mirascope()
|
|
616
|
-
client.organizations.get(
|
|
617
|
-
id="id",
|
|
618
|
-
)
|
|
619
|
-
|
|
620
|
-
```
|
|
621
|
-
</dd>
|
|
622
|
-
</dl>
|
|
691
|
+
**provider:** `typing.Optional[typing.Sequence[str]]`
|
|
692
|
+
|
|
623
693
|
</dd>
|
|
624
694
|
</dl>
|
|
625
695
|
|
|
626
|
-
#### ⚙️ Parameters
|
|
627
|
-
|
|
628
696
|
<dl>
|
|
629
697
|
<dd>
|
|
630
698
|
|
|
699
|
+
**function_id:** `typing.Optional[str]`
|
|
700
|
+
|
|
701
|
+
</dd>
|
|
702
|
+
</dl>
|
|
703
|
+
|
|
631
704
|
<dl>
|
|
632
705
|
<dd>
|
|
633
706
|
|
|
634
|
-
**
|
|
707
|
+
**function_name:** `typing.Optional[str]`
|
|
635
708
|
|
|
636
709
|
</dd>
|
|
637
710
|
</dl>
|
|
@@ -639,53 +712,79 @@ client.organizations.get(
|
|
|
639
712
|
<dl>
|
|
640
713
|
<dd>
|
|
641
714
|
|
|
642
|
-
**
|
|
715
|
+
**span_name_prefix:** `typing.Optional[str]`
|
|
643
716
|
|
|
644
717
|
</dd>
|
|
645
718
|
</dl>
|
|
719
|
+
|
|
720
|
+
<dl>
|
|
721
|
+
<dd>
|
|
722
|
+
|
|
723
|
+
**has_error:** `typing.Optional[bool]`
|
|
724
|
+
|
|
646
725
|
</dd>
|
|
647
726
|
</dl>
|
|
648
727
|
|
|
728
|
+
<dl>
|
|
729
|
+
<dd>
|
|
649
730
|
|
|
731
|
+
**min_tokens:** `typing.Optional[float]`
|
|
732
|
+
|
|
650
733
|
</dd>
|
|
651
734
|
</dl>
|
|
652
|
-
</details>
|
|
653
735
|
|
|
654
|
-
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">update</a>(...)</code></summary>
|
|
655
736
|
<dl>
|
|
656
737
|
<dd>
|
|
657
738
|
|
|
658
|
-
|
|
739
|
+
**max_tokens:** `typing.Optional[float]`
|
|
740
|
+
|
|
741
|
+
</dd>
|
|
742
|
+
</dl>
|
|
659
743
|
|
|
660
744
|
<dl>
|
|
661
745
|
<dd>
|
|
662
746
|
|
|
747
|
+
**min_duration:** `typing.Optional[float]`
|
|
748
|
+
|
|
749
|
+
</dd>
|
|
750
|
+
</dl>
|
|
751
|
+
|
|
663
752
|
<dl>
|
|
664
753
|
<dd>
|
|
665
754
|
|
|
666
|
-
|
|
667
|
-
|
|
755
|
+
**max_duration:** `typing.Optional[float]`
|
|
756
|
+
|
|
757
|
+
</dd>
|
|
758
|
+
</dl>
|
|
668
759
|
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
id="id",
|
|
672
|
-
)
|
|
760
|
+
<dl>
|
|
761
|
+
<dd>
|
|
673
762
|
|
|
674
|
-
|
|
763
|
+
**attribute_filters:** `typing.Optional[typing.Sequence[TracesSearchByEnvRequestAttributeFiltersItem]]`
|
|
764
|
+
|
|
675
765
|
</dd>
|
|
676
766
|
</dl>
|
|
767
|
+
|
|
768
|
+
<dl>
|
|
769
|
+
<dd>
|
|
770
|
+
|
|
771
|
+
**limit:** `typing.Optional[float]`
|
|
772
|
+
|
|
677
773
|
</dd>
|
|
678
774
|
</dl>
|
|
679
775
|
|
|
680
|
-
#### ⚙️ Parameters
|
|
681
|
-
|
|
682
776
|
<dl>
|
|
683
777
|
<dd>
|
|
684
778
|
|
|
779
|
+
**offset:** `typing.Optional[float]`
|
|
780
|
+
|
|
781
|
+
</dd>
|
|
782
|
+
</dl>
|
|
783
|
+
|
|
685
784
|
<dl>
|
|
686
785
|
<dd>
|
|
687
786
|
|
|
688
|
-
**
|
|
787
|
+
**sort_by:** `typing.Optional[TracesSearchByEnvRequestSortBy]`
|
|
689
788
|
|
|
690
789
|
</dd>
|
|
691
790
|
</dl>
|
|
@@ -693,7 +792,7 @@ client.organizations.update(
|
|
|
693
792
|
<dl>
|
|
694
793
|
<dd>
|
|
695
794
|
|
|
696
|
-
**
|
|
795
|
+
**sort_order:** `typing.Optional[TracesSearchByEnvRequestSortOrder]`
|
|
697
796
|
|
|
698
797
|
</dd>
|
|
699
798
|
</dl>
|
|
@@ -701,7 +800,7 @@ client.organizations.update(
|
|
|
701
800
|
<dl>
|
|
702
801
|
<dd>
|
|
703
802
|
|
|
704
|
-
**
|
|
803
|
+
**root_spans_only:** `typing.Optional[bool]`
|
|
705
804
|
|
|
706
805
|
</dd>
|
|
707
806
|
</dl>
|
|
@@ -721,7 +820,7 @@ client.organizations.update(
|
|
|
721
820
|
</dl>
|
|
722
821
|
</details>
|
|
723
822
|
|
|
724
|
-
<details><summary><code>client.
|
|
823
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">gettracedetailbyenv</a>(...)</code></summary>
|
|
725
824
|
<dl>
|
|
726
825
|
<dd>
|
|
727
826
|
|
|
@@ -737,8 +836,11 @@ client.organizations.update(
|
|
|
737
836
|
from mirascope.api._generated import Mirascope
|
|
738
837
|
|
|
739
838
|
client = Mirascope()
|
|
740
|
-
client.
|
|
741
|
-
|
|
839
|
+
client.traces.gettracedetailbyenv(
|
|
840
|
+
organization_id="organizationId",
|
|
841
|
+
project_id="projectId",
|
|
842
|
+
environment_id="environmentId",
|
|
843
|
+
trace_id="traceId",
|
|
742
844
|
)
|
|
743
845
|
|
|
744
846
|
```
|
|
@@ -755,7 +857,31 @@ client.organizations.delete(
|
|
|
755
857
|
<dl>
|
|
756
858
|
<dd>
|
|
757
859
|
|
|
758
|
-
**
|
|
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`
|
|
759
885
|
|
|
760
886
|
</dd>
|
|
761
887
|
</dl>
|
|
@@ -775,7 +901,8 @@ client.organizations.delete(
|
|
|
775
901
|
</dl>
|
|
776
902
|
</details>
|
|
777
903
|
|
|
778
|
-
|
|
904
|
+
## docs
|
|
905
|
+
<details><summary><code>client.docs.<a href="src/mirascope/docs/client.py">openapi</a>()</code></summary>
|
|
779
906
|
<dl>
|
|
780
907
|
<dd>
|
|
781
908
|
|
|
@@ -791,9 +918,7 @@ client.organizations.delete(
|
|
|
791
918
|
from mirascope.api._generated import Mirascope
|
|
792
919
|
|
|
793
920
|
client = Mirascope()
|
|
794
|
-
client.
|
|
795
|
-
id="id",
|
|
796
|
-
)
|
|
921
|
+
client.docs.openapi()
|
|
797
922
|
|
|
798
923
|
```
|
|
799
924
|
</dd>
|
|
@@ -809,14 +934,6 @@ client.organizations.credits(
|
|
|
809
934
|
<dl>
|
|
810
935
|
<dd>
|
|
811
936
|
|
|
812
|
-
**id:** `str`
|
|
813
|
-
|
|
814
|
-
</dd>
|
|
815
|
-
</dl>
|
|
816
|
-
|
|
817
|
-
<dl>
|
|
818
|
-
<dd>
|
|
819
|
-
|
|
820
937
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
821
938
|
|
|
822
939
|
</dd>
|
|
@@ -829,8 +946,8 @@ client.organizations.credits(
|
|
|
829
946
|
</dl>
|
|
830
947
|
</details>
|
|
831
948
|
|
|
832
|
-
##
|
|
833
|
-
<details><summary><code>client.
|
|
949
|
+
## organizations
|
|
950
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">list</a>()</code></summary>
|
|
834
951
|
<dl>
|
|
835
952
|
<dd>
|
|
836
953
|
|
|
@@ -846,9 +963,7 @@ client.organizations.credits(
|
|
|
846
963
|
from mirascope.api._generated import Mirascope
|
|
847
964
|
|
|
848
965
|
client = Mirascope()
|
|
849
|
-
client.
|
|
850
|
-
organization_id="organizationId",
|
|
851
|
-
)
|
|
966
|
+
client.organizations.list()
|
|
852
967
|
|
|
853
968
|
```
|
|
854
969
|
</dd>
|
|
@@ -864,14 +979,6 @@ client.projects.list(
|
|
|
864
979
|
<dl>
|
|
865
980
|
<dd>
|
|
866
981
|
|
|
867
|
-
**organization_id:** `str`
|
|
868
|
-
|
|
869
|
-
</dd>
|
|
870
|
-
</dl>
|
|
871
|
-
|
|
872
|
-
<dl>
|
|
873
|
-
<dd>
|
|
874
|
-
|
|
875
982
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
876
983
|
|
|
877
984
|
</dd>
|
|
@@ -884,7 +991,7 @@ client.projects.list(
|
|
|
884
991
|
</dl>
|
|
885
992
|
</details>
|
|
886
993
|
|
|
887
|
-
<details><summary><code>client.
|
|
994
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">create</a>(...)</code></summary>
|
|
888
995
|
<dl>
|
|
889
996
|
<dd>
|
|
890
997
|
|
|
@@ -900,8 +1007,7 @@ client.projects.list(
|
|
|
900
1007
|
from mirascope.api._generated import Mirascope
|
|
901
1008
|
|
|
902
1009
|
client = Mirascope()
|
|
903
|
-
client.
|
|
904
|
-
organization_id="organizationId",
|
|
1010
|
+
client.organizations.create(
|
|
905
1011
|
name="name",
|
|
906
1012
|
slug="slug",
|
|
907
1013
|
)
|
|
@@ -920,14 +1026,6 @@ client.projects.create(
|
|
|
920
1026
|
<dl>
|
|
921
1027
|
<dd>
|
|
922
1028
|
|
|
923
|
-
**organization_id:** `str`
|
|
924
|
-
|
|
925
|
-
</dd>
|
|
926
|
-
</dl>
|
|
927
|
-
|
|
928
|
-
<dl>
|
|
929
|
-
<dd>
|
|
930
|
-
|
|
931
1029
|
**name:** `str` — a string at most 100 character(s) long
|
|
932
1030
|
|
|
933
1031
|
</dd>
|
|
@@ -956,7 +1054,7 @@ client.projects.create(
|
|
|
956
1054
|
</dl>
|
|
957
1055
|
</details>
|
|
958
1056
|
|
|
959
|
-
<details><summary><code>client.
|
|
1057
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">get</a>(...)</code></summary>
|
|
960
1058
|
<dl>
|
|
961
1059
|
<dd>
|
|
962
1060
|
|
|
@@ -972,9 +1070,8 @@ client.projects.create(
|
|
|
972
1070
|
from mirascope.api._generated import Mirascope
|
|
973
1071
|
|
|
974
1072
|
client = Mirascope()
|
|
975
|
-
client.
|
|
976
|
-
|
|
977
|
-
project_id="projectId",
|
|
1073
|
+
client.organizations.get(
|
|
1074
|
+
id="id",
|
|
978
1075
|
)
|
|
979
1076
|
|
|
980
1077
|
```
|
|
@@ -991,15 +1088,7 @@ client.projects.get(
|
|
|
991
1088
|
<dl>
|
|
992
1089
|
<dd>
|
|
993
1090
|
|
|
994
|
-
**
|
|
995
|
-
|
|
996
|
-
</dd>
|
|
997
|
-
</dl>
|
|
998
|
-
|
|
999
|
-
<dl>
|
|
1000
|
-
<dd>
|
|
1001
|
-
|
|
1002
|
-
**project_id:** `str`
|
|
1091
|
+
**id:** `str`
|
|
1003
1092
|
|
|
1004
1093
|
</dd>
|
|
1005
1094
|
</dl>
|
|
@@ -1019,7 +1108,7 @@ client.projects.get(
|
|
|
1019
1108
|
</dl>
|
|
1020
1109
|
</details>
|
|
1021
1110
|
|
|
1022
|
-
<details><summary><code>client.
|
|
1111
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">update</a>(...)</code></summary>
|
|
1023
1112
|
<dl>
|
|
1024
1113
|
<dd>
|
|
1025
1114
|
|
|
@@ -1035,9 +1124,8 @@ client.projects.get(
|
|
|
1035
1124
|
from mirascope.api._generated import Mirascope
|
|
1036
1125
|
|
|
1037
1126
|
client = Mirascope()
|
|
1038
|
-
client.
|
|
1039
|
-
|
|
1040
|
-
project_id="projectId",
|
|
1127
|
+
client.organizations.update(
|
|
1128
|
+
id="id",
|
|
1041
1129
|
)
|
|
1042
1130
|
|
|
1043
1131
|
```
|
|
@@ -1054,15 +1142,7 @@ client.projects.update(
|
|
|
1054
1142
|
<dl>
|
|
1055
1143
|
<dd>
|
|
1056
1144
|
|
|
1057
|
-
**
|
|
1058
|
-
|
|
1059
|
-
</dd>
|
|
1060
|
-
</dl>
|
|
1061
|
-
|
|
1062
|
-
<dl>
|
|
1063
|
-
<dd>
|
|
1064
|
-
|
|
1065
|
-
**project_id:** `str`
|
|
1145
|
+
**id:** `str`
|
|
1066
1146
|
|
|
1067
1147
|
</dd>
|
|
1068
1148
|
</dl>
|
|
@@ -1098,7 +1178,7 @@ client.projects.update(
|
|
|
1098
1178
|
</dl>
|
|
1099
1179
|
</details>
|
|
1100
1180
|
|
|
1101
|
-
<details><summary><code>client.
|
|
1181
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">delete</a>(...)</code></summary>
|
|
1102
1182
|
<dl>
|
|
1103
1183
|
<dd>
|
|
1104
1184
|
|
|
@@ -1114,9 +1194,8 @@ client.projects.update(
|
|
|
1114
1194
|
from mirascope.api._generated import Mirascope
|
|
1115
1195
|
|
|
1116
1196
|
client = Mirascope()
|
|
1117
|
-
client.
|
|
1118
|
-
|
|
1119
|
-
project_id="projectId",
|
|
1197
|
+
client.organizations.delete(
|
|
1198
|
+
id="id",
|
|
1120
1199
|
)
|
|
1121
1200
|
|
|
1122
1201
|
```
|
|
@@ -1133,15 +1212,7 @@ client.projects.delete(
|
|
|
1133
1212
|
<dl>
|
|
1134
1213
|
<dd>
|
|
1135
1214
|
|
|
1136
|
-
**
|
|
1137
|
-
|
|
1138
|
-
</dd>
|
|
1139
|
-
</dl>
|
|
1140
|
-
|
|
1141
|
-
<dl>
|
|
1142
|
-
<dd>
|
|
1143
|
-
|
|
1144
|
-
**project_id:** `str`
|
|
1215
|
+
**id:** `str`
|
|
1145
1216
|
|
|
1146
1217
|
</dd>
|
|
1147
1218
|
</dl>
|
|
@@ -1161,8 +1232,7 @@ client.projects.delete(
|
|
|
1161
1232
|
</dl>
|
|
1162
1233
|
</details>
|
|
1163
1234
|
|
|
1164
|
-
|
|
1165
|
-
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">list</a>(...)</code></summary>
|
|
1235
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">routerbalance</a>(...)</code></summary>
|
|
1166
1236
|
<dl>
|
|
1167
1237
|
<dd>
|
|
1168
1238
|
|
|
@@ -1178,9 +1248,8 @@ client.projects.delete(
|
|
|
1178
1248
|
from mirascope.api._generated import Mirascope
|
|
1179
1249
|
|
|
1180
1250
|
client = Mirascope()
|
|
1181
|
-
client.
|
|
1182
|
-
|
|
1183
|
-
project_id="projectId",
|
|
1251
|
+
client.organizations.routerbalance(
|
|
1252
|
+
id="id",
|
|
1184
1253
|
)
|
|
1185
1254
|
|
|
1186
1255
|
```
|
|
@@ -1197,15 +1266,7 @@ client.environments.list(
|
|
|
1197
1266
|
<dl>
|
|
1198
1267
|
<dd>
|
|
1199
1268
|
|
|
1200
|
-
**
|
|
1201
|
-
|
|
1202
|
-
</dd>
|
|
1203
|
-
</dl>
|
|
1204
|
-
|
|
1205
|
-
<dl>
|
|
1206
|
-
<dd>
|
|
1207
|
-
|
|
1208
|
-
**project_id:** `str`
|
|
1269
|
+
**id:** `str`
|
|
1209
1270
|
|
|
1210
1271
|
</dd>
|
|
1211
1272
|
</dl>
|
|
@@ -1225,7 +1286,7 @@ client.environments.list(
|
|
|
1225
1286
|
</dl>
|
|
1226
1287
|
</details>
|
|
1227
1288
|
|
|
1228
|
-
<details><summary><code>client.
|
|
1289
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">createpaymentintent</a>(...)</code></summary>
|
|
1229
1290
|
<dl>
|
|
1230
1291
|
<dd>
|
|
1231
1292
|
|
|
@@ -1241,11 +1302,9 @@ client.environments.list(
|
|
|
1241
1302
|
from mirascope.api._generated import Mirascope
|
|
1242
1303
|
|
|
1243
1304
|
client = Mirascope()
|
|
1244
|
-
client.
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
name="name",
|
|
1248
|
-
slug="slug",
|
|
1305
|
+
client.organizations.createpaymentintent(
|
|
1306
|
+
id="id",
|
|
1307
|
+
amount=1.1,
|
|
1249
1308
|
)
|
|
1250
1309
|
|
|
1251
1310
|
```
|
|
@@ -1262,7 +1321,7 @@ client.environments.create(
|
|
|
1262
1321
|
<dl>
|
|
1263
1322
|
<dd>
|
|
1264
1323
|
|
|
1265
|
-
**
|
|
1324
|
+
**id:** `str`
|
|
1266
1325
|
|
|
1267
1326
|
</dd>
|
|
1268
1327
|
</dl>
|
|
@@ -1270,7 +1329,7 @@ client.environments.create(
|
|
|
1270
1329
|
<dl>
|
|
1271
1330
|
<dd>
|
|
1272
1331
|
|
|
1273
|
-
**
|
|
1332
|
+
**amount:** `float` — a positive number
|
|
1274
1333
|
|
|
1275
1334
|
</dd>
|
|
1276
1335
|
</dl>
|
|
@@ -1278,15 +1337,53 @@ client.environments.create(
|
|
|
1278
1337
|
<dl>
|
|
1279
1338
|
<dd>
|
|
1280
1339
|
|
|
1281
|
-
**
|
|
1340
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1282
1341
|
|
|
1283
1342
|
</dd>
|
|
1284
1343
|
</dl>
|
|
1344
|
+
</dd>
|
|
1345
|
+
</dl>
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
</dd>
|
|
1349
|
+
</dl>
|
|
1350
|
+
</details>
|
|
1285
1351
|
|
|
1352
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">subscription</a>(...)</code></summary>
|
|
1286
1353
|
<dl>
|
|
1287
1354
|
<dd>
|
|
1288
1355
|
|
|
1289
|
-
|
|
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`
|
|
1290
1387
|
|
|
1291
1388
|
</dd>
|
|
1292
1389
|
</dl>
|
|
@@ -1306,7 +1403,7 @@ client.environments.create(
|
|
|
1306
1403
|
</dl>
|
|
1307
1404
|
</details>
|
|
1308
1405
|
|
|
1309
|
-
<details><summary><code>client.
|
|
1406
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">previewsubscriptionchange</a>(...)</code></summary>
|
|
1310
1407
|
<dl>
|
|
1311
1408
|
<dd>
|
|
1312
1409
|
|
|
@@ -1322,10 +1419,9 @@ client.environments.create(
|
|
|
1322
1419
|
from mirascope.api._generated import Mirascope
|
|
1323
1420
|
|
|
1324
1421
|
client = Mirascope()
|
|
1325
|
-
client.
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
environment_id="environmentId",
|
|
1422
|
+
client.organizations.previewsubscriptionchange(
|
|
1423
|
+
id="id",
|
|
1424
|
+
target_plan="free",
|
|
1329
1425
|
)
|
|
1330
1426
|
|
|
1331
1427
|
```
|
|
@@ -1342,15 +1438,7 @@ client.environments.get(
|
|
|
1342
1438
|
<dl>
|
|
1343
1439
|
<dd>
|
|
1344
1440
|
|
|
1345
|
-
**
|
|
1346
|
-
|
|
1347
|
-
</dd>
|
|
1348
|
-
</dl>
|
|
1349
|
-
|
|
1350
|
-
<dl>
|
|
1351
|
-
<dd>
|
|
1352
|
-
|
|
1353
|
-
**project_id:** `str`
|
|
1441
|
+
**id:** `str`
|
|
1354
1442
|
|
|
1355
1443
|
</dd>
|
|
1356
1444
|
</dl>
|
|
@@ -1358,7 +1446,7 @@ client.environments.get(
|
|
|
1358
1446
|
<dl>
|
|
1359
1447
|
<dd>
|
|
1360
1448
|
|
|
1361
|
-
**
|
|
1449
|
+
**target_plan:** `OrganizationsPreviewSubscriptionChangeRequestTargetPlan`
|
|
1362
1450
|
|
|
1363
1451
|
</dd>
|
|
1364
1452
|
</dl>
|
|
@@ -1378,7 +1466,7 @@ client.environments.get(
|
|
|
1378
1466
|
</dl>
|
|
1379
1467
|
</details>
|
|
1380
1468
|
|
|
1381
|
-
<details><summary><code>client.
|
|
1469
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">updatesubscription</a>(...)</code></summary>
|
|
1382
1470
|
<dl>
|
|
1383
1471
|
<dd>
|
|
1384
1472
|
|
|
@@ -1394,10 +1482,9 @@ client.environments.get(
|
|
|
1394
1482
|
from mirascope.api._generated import Mirascope
|
|
1395
1483
|
|
|
1396
1484
|
client = Mirascope()
|
|
1397
|
-
client.
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
environment_id="environmentId",
|
|
1485
|
+
client.organizations.updatesubscription(
|
|
1486
|
+
id="id",
|
|
1487
|
+
target_plan="free",
|
|
1401
1488
|
)
|
|
1402
1489
|
|
|
1403
1490
|
```
|
|
@@ -1414,7 +1501,7 @@ client.environments.update(
|
|
|
1414
1501
|
<dl>
|
|
1415
1502
|
<dd>
|
|
1416
1503
|
|
|
1417
|
-
**
|
|
1504
|
+
**id:** `str`
|
|
1418
1505
|
|
|
1419
1506
|
</dd>
|
|
1420
1507
|
</dl>
|
|
@@ -1422,7 +1509,7 @@ client.environments.update(
|
|
|
1422
1509
|
<dl>
|
|
1423
1510
|
<dd>
|
|
1424
1511
|
|
|
1425
|
-
**
|
|
1512
|
+
**target_plan:** `OrganizationsUpdateSubscriptionRequestTargetPlan`
|
|
1426
1513
|
|
|
1427
1514
|
</dd>
|
|
1428
1515
|
</dl>
|
|
@@ -1430,23 +1517,53 @@ client.environments.update(
|
|
|
1430
1517
|
<dl>
|
|
1431
1518
|
<dd>
|
|
1432
1519
|
|
|
1433
|
-
**
|
|
1520
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1434
1521
|
|
|
1435
1522
|
</dd>
|
|
1436
1523
|
</dl>
|
|
1524
|
+
</dd>
|
|
1525
|
+
</dl>
|
|
1437
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>
|
|
1438
1533
|
<dl>
|
|
1439
1534
|
<dd>
|
|
1440
1535
|
|
|
1441
|
-
|
|
1442
|
-
|
|
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>
|
|
1443
1555
|
</dd>
|
|
1444
1556
|
</dl>
|
|
1445
1557
|
|
|
1558
|
+
#### ⚙️ Parameters
|
|
1559
|
+
|
|
1446
1560
|
<dl>
|
|
1447
1561
|
<dd>
|
|
1448
1562
|
|
|
1449
|
-
|
|
1563
|
+
<dl>
|
|
1564
|
+
<dd>
|
|
1565
|
+
|
|
1566
|
+
**id:** `str`
|
|
1450
1567
|
|
|
1451
1568
|
</dd>
|
|
1452
1569
|
</dl>
|
|
@@ -1466,7 +1583,8 @@ client.environments.update(
|
|
|
1466
1583
|
</dl>
|
|
1467
1584
|
</details>
|
|
1468
1585
|
|
|
1469
|
-
|
|
1586
|
+
## organization-invitations
|
|
1587
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">list</a>(...)</code></summary>
|
|
1470
1588
|
<dl>
|
|
1471
1589
|
<dd>
|
|
1472
1590
|
|
|
@@ -1482,10 +1600,8 @@ client.environments.update(
|
|
|
1482
1600
|
from mirascope.api._generated import Mirascope
|
|
1483
1601
|
|
|
1484
1602
|
client = Mirascope()
|
|
1485
|
-
client.
|
|
1603
|
+
client.organization_invitations.list(
|
|
1486
1604
|
organization_id="organizationId",
|
|
1487
|
-
project_id="projectId",
|
|
1488
|
-
environment_id="environmentId",
|
|
1489
1605
|
)
|
|
1490
1606
|
|
|
1491
1607
|
```
|
|
@@ -1510,22 +1626,6 @@ client.environments.delete(
|
|
|
1510
1626
|
<dl>
|
|
1511
1627
|
<dd>
|
|
1512
1628
|
|
|
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
1629
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1530
1630
|
|
|
1531
1631
|
</dd>
|
|
@@ -1538,8 +1638,7 @@ client.environments.delete(
|
|
|
1538
1638
|
</dl>
|
|
1539
1639
|
</details>
|
|
1540
1640
|
|
|
1541
|
-
|
|
1542
|
-
<details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_list</a>(...)</code></summary>
|
|
1641
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">create</a>(...)</code></summary>
|
|
1543
1642
|
<dl>
|
|
1544
1643
|
<dd>
|
|
1545
1644
|
|
|
@@ -1555,10 +1654,10 @@ client.environments.delete(
|
|
|
1555
1654
|
from mirascope.api._generated import Mirascope
|
|
1556
1655
|
|
|
1557
1656
|
client = Mirascope()
|
|
1558
|
-
client.
|
|
1657
|
+
client.organization_invitations.create(
|
|
1559
1658
|
organization_id="organizationId",
|
|
1560
|
-
|
|
1561
|
-
|
|
1659
|
+
recipient_email="recipientEmail",
|
|
1660
|
+
role="ADMIN",
|
|
1562
1661
|
)
|
|
1563
1662
|
|
|
1564
1663
|
```
|
|
@@ -1583,7 +1682,7 @@ client.api_keys.api_keys_list(
|
|
|
1583
1682
|
<dl>
|
|
1584
1683
|
<dd>
|
|
1585
1684
|
|
|
1586
|
-
**
|
|
1685
|
+
**recipient_email:** `str` — a string matching the pattern ^[^ \t\n\r\f\v@]+@[^ \t\n\r\f\v@]+[.][^ \t\n\r\f\v@]+$
|
|
1587
1686
|
|
|
1588
1687
|
</dd>
|
|
1589
1688
|
</dl>
|
|
@@ -1591,7 +1690,7 @@ client.api_keys.api_keys_list(
|
|
|
1591
1690
|
<dl>
|
|
1592
1691
|
<dd>
|
|
1593
1692
|
|
|
1594
|
-
**
|
|
1693
|
+
**role:** `OrganizationInvitationsCreateRequestRole`
|
|
1595
1694
|
|
|
1596
1695
|
</dd>
|
|
1597
1696
|
</dl>
|
|
@@ -1611,7 +1710,7 @@ client.api_keys.api_keys_list(
|
|
|
1611
1710
|
</dl>
|
|
1612
1711
|
</details>
|
|
1613
1712
|
|
|
1614
|
-
<details><summary><code>client.
|
|
1713
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">get</a>(...)</code></summary>
|
|
1615
1714
|
<dl>
|
|
1616
1715
|
<dd>
|
|
1617
1716
|
|
|
@@ -1627,11 +1726,9 @@ client.api_keys.api_keys_list(
|
|
|
1627
1726
|
from mirascope.api._generated import Mirascope
|
|
1628
1727
|
|
|
1629
1728
|
client = Mirascope()
|
|
1630
|
-
client.
|
|
1729
|
+
client.organization_invitations.get(
|
|
1631
1730
|
organization_id="organizationId",
|
|
1632
|
-
|
|
1633
|
-
environment_id="environmentId",
|
|
1634
|
-
name="name",
|
|
1731
|
+
invitation_id="invitationId",
|
|
1635
1732
|
)
|
|
1636
1733
|
|
|
1637
1734
|
```
|
|
@@ -1656,7 +1753,7 @@ client.api_keys.api_keys_create(
|
|
|
1656
1753
|
<dl>
|
|
1657
1754
|
<dd>
|
|
1658
1755
|
|
|
1659
|
-
**
|
|
1756
|
+
**invitation_id:** `str`
|
|
1660
1757
|
|
|
1661
1758
|
</dd>
|
|
1662
1759
|
</dl>
|
|
@@ -1664,35 +1761,19 @@ client.api_keys.api_keys_create(
|
|
|
1664
1761
|
<dl>
|
|
1665
1762
|
<dd>
|
|
1666
1763
|
|
|
1667
|
-
**
|
|
1764
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1668
1765
|
|
|
1669
1766
|
</dd>
|
|
1670
1767
|
</dl>
|
|
1768
|
+
</dd>
|
|
1769
|
+
</dl>
|
|
1671
1770
|
|
|
1672
|
-
<dl>
|
|
1673
|
-
<dd>
|
|
1674
1771
|
|
|
1675
|
-
**name:** `str` — a string at most 100 character(s) long
|
|
1676
|
-
|
|
1677
1772
|
</dd>
|
|
1678
1773
|
</dl>
|
|
1774
|
+
</details>
|
|
1679
1775
|
|
|
1680
|
-
<
|
|
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>
|
|
1776
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">resend</a>(...)</code></summary>
|
|
1696
1777
|
<dl>
|
|
1697
1778
|
<dd>
|
|
1698
1779
|
|
|
@@ -1708,11 +1789,9 @@ client.api_keys.api_keys_create(
|
|
|
1708
1789
|
from mirascope.api._generated import Mirascope
|
|
1709
1790
|
|
|
1710
1791
|
client = Mirascope()
|
|
1711
|
-
client.
|
|
1792
|
+
client.organization_invitations.resend(
|
|
1712
1793
|
organization_id="organizationId",
|
|
1713
|
-
|
|
1714
|
-
environment_id="environmentId",
|
|
1715
|
-
api_key_id="apiKeyId",
|
|
1794
|
+
invitation_id="invitationId",
|
|
1716
1795
|
)
|
|
1717
1796
|
|
|
1718
1797
|
```
|
|
@@ -1737,23 +1816,7 @@ client.api_keys.api_keys_get(
|
|
|
1737
1816
|
<dl>
|
|
1738
1817
|
<dd>
|
|
1739
1818
|
|
|
1740
|
-
**
|
|
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`
|
|
1819
|
+
**invitation_id:** `str`
|
|
1757
1820
|
|
|
1758
1821
|
</dd>
|
|
1759
1822
|
</dl>
|
|
@@ -1773,7 +1836,7 @@ client.api_keys.api_keys_get(
|
|
|
1773
1836
|
</dl>
|
|
1774
1837
|
</details>
|
|
1775
1838
|
|
|
1776
|
-
<details><summary><code>client.
|
|
1839
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">revoke</a>(...)</code></summary>
|
|
1777
1840
|
<dl>
|
|
1778
1841
|
<dd>
|
|
1779
1842
|
|
|
@@ -1789,11 +1852,9 @@ client.api_keys.api_keys_get(
|
|
|
1789
1852
|
from mirascope.api._generated import Mirascope
|
|
1790
1853
|
|
|
1791
1854
|
client = Mirascope()
|
|
1792
|
-
client.
|
|
1855
|
+
client.organization_invitations.revoke(
|
|
1793
1856
|
organization_id="organizationId",
|
|
1794
|
-
|
|
1795
|
-
environment_id="environmentId",
|
|
1796
|
-
api_key_id="apiKeyId",
|
|
1857
|
+
invitation_id="invitationId",
|
|
1797
1858
|
)
|
|
1798
1859
|
|
|
1799
1860
|
```
|
|
@@ -1818,23 +1879,7 @@ client.api_keys.api_keys_delete(
|
|
|
1818
1879
|
<dl>
|
|
1819
1880
|
<dd>
|
|
1820
1881
|
|
|
1821
|
-
**
|
|
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`
|
|
1882
|
+
**invitation_id:** `str`
|
|
1838
1883
|
|
|
1839
1884
|
</dd>
|
|
1840
1885
|
</dl>
|
|
@@ -1854,8 +1899,7 @@ client.api_keys.api_keys_delete(
|
|
|
1854
1899
|
</dl>
|
|
1855
1900
|
</details>
|
|
1856
1901
|
|
|
1857
|
-
|
|
1858
|
-
<details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">list</a>()</code></summary>
|
|
1902
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">accept</a>(...)</code></summary>
|
|
1859
1903
|
<dl>
|
|
1860
1904
|
<dd>
|
|
1861
1905
|
|
|
@@ -1871,7 +1915,9 @@ client.api_keys.api_keys_delete(
|
|
|
1871
1915
|
from mirascope.api._generated import Mirascope
|
|
1872
1916
|
|
|
1873
1917
|
client = Mirascope()
|
|
1874
|
-
client.
|
|
1918
|
+
client.organization_invitations.accept(
|
|
1919
|
+
token="token",
|
|
1920
|
+
)
|
|
1875
1921
|
|
|
1876
1922
|
```
|
|
1877
1923
|
</dd>
|
|
@@ -1887,6 +1933,14 @@ client.functions.list()
|
|
|
1887
1933
|
<dl>
|
|
1888
1934
|
<dd>
|
|
1889
1935
|
|
|
1936
|
+
**token:** `str`
|
|
1937
|
+
|
|
1938
|
+
</dd>
|
|
1939
|
+
</dl>
|
|
1940
|
+
|
|
1941
|
+
<dl>
|
|
1942
|
+
<dd>
|
|
1943
|
+
|
|
1890
1944
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1891
1945
|
|
|
1892
1946
|
</dd>
|
|
@@ -1899,7 +1953,8 @@ client.functions.list()
|
|
|
1899
1953
|
</dl>
|
|
1900
1954
|
</details>
|
|
1901
1955
|
|
|
1902
|
-
|
|
1956
|
+
## organization-memberships
|
|
1957
|
+
<details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">list</a>(...)</code></summary>
|
|
1903
1958
|
<dl>
|
|
1904
1959
|
<dd>
|
|
1905
1960
|
|
|
@@ -1915,12 +1970,8 @@ client.functions.list()
|
|
|
1915
1970
|
from mirascope.api._generated import Mirascope
|
|
1916
1971
|
|
|
1917
1972
|
client = Mirascope()
|
|
1918
|
-
client.
|
|
1919
|
-
|
|
1920
|
-
hash="hash",
|
|
1921
|
-
signature="signature",
|
|
1922
|
-
signature_hash="signatureHash",
|
|
1923
|
-
name="name",
|
|
1973
|
+
client.organization_memberships.list(
|
|
1974
|
+
organization_id="organizationId",
|
|
1924
1975
|
)
|
|
1925
1976
|
|
|
1926
1977
|
```
|
|
@@ -1937,7 +1988,7 @@ client.functions.create(
|
|
|
1937
1988
|
<dl>
|
|
1938
1989
|
<dd>
|
|
1939
1990
|
|
|
1940
|
-
**
|
|
1991
|
+
**organization_id:** `str`
|
|
1941
1992
|
|
|
1942
1993
|
</dd>
|
|
1943
1994
|
</dl>
|
|
@@ -1945,55 +1996,54 @@ client.functions.create(
|
|
|
1945
1996
|
<dl>
|
|
1946
1997
|
<dd>
|
|
1947
1998
|
|
|
1948
|
-
**
|
|
1999
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1949
2000
|
|
|
1950
2001
|
</dd>
|
|
1951
2002
|
</dl>
|
|
2003
|
+
</dd>
|
|
2004
|
+
</dl>
|
|
1952
2005
|
|
|
1953
|
-
<dl>
|
|
1954
|
-
<dd>
|
|
1955
2006
|
|
|
1956
|
-
**signature:** `str`
|
|
1957
|
-
|
|
1958
2007
|
</dd>
|
|
1959
2008
|
</dl>
|
|
2009
|
+
</details>
|
|
1960
2010
|
|
|
2011
|
+
<details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">delete</a>(...)</code></summary>
|
|
1961
2012
|
<dl>
|
|
1962
2013
|
<dd>
|
|
1963
2014
|
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
</dd>
|
|
1967
|
-
</dl>
|
|
2015
|
+
#### 🔌 Usage
|
|
1968
2016
|
|
|
1969
2017
|
<dl>
|
|
1970
2018
|
<dd>
|
|
1971
2019
|
|
|
1972
|
-
**name:** `str`
|
|
1973
|
-
|
|
1974
|
-
</dd>
|
|
1975
|
-
</dl>
|
|
1976
|
-
|
|
1977
2020
|
<dl>
|
|
1978
2021
|
<dd>
|
|
1979
2022
|
|
|
1980
|
-
|
|
1981
|
-
|
|
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>
|
|
1982
2035
|
</dd>
|
|
1983
2036
|
</dl>
|
|
1984
2037
|
|
|
2038
|
+
#### ⚙️ Parameters
|
|
2039
|
+
|
|
1985
2040
|
<dl>
|
|
1986
2041
|
<dd>
|
|
1987
2042
|
|
|
1988
|
-
**tags:** `typing.Optional[typing.Sequence[str]]`
|
|
1989
|
-
|
|
1990
|
-
</dd>
|
|
1991
|
-
</dl>
|
|
1992
|
-
|
|
1993
2043
|
<dl>
|
|
1994
2044
|
<dd>
|
|
1995
2045
|
|
|
1996
|
-
**
|
|
2046
|
+
**organization_id:** `str`
|
|
1997
2047
|
|
|
1998
2048
|
</dd>
|
|
1999
2049
|
</dl>
|
|
@@ -2001,9 +2051,7 @@ client.functions.create(
|
|
|
2001
2051
|
<dl>
|
|
2002
2052
|
<dd>
|
|
2003
2053
|
|
|
2004
|
-
**
|
|
2005
|
-
typing.Dict[str, typing.Optional[FunctionsCreateRequestDependenciesValue]]
|
|
2006
|
-
]`
|
|
2054
|
+
**member_id:** `str`
|
|
2007
2055
|
|
|
2008
2056
|
</dd>
|
|
2009
2057
|
</dl>
|
|
@@ -2023,7 +2071,7 @@ client.functions.create(
|
|
|
2023
2071
|
</dl>
|
|
2024
2072
|
</details>
|
|
2025
2073
|
|
|
2026
|
-
<details><summary><code>client.
|
|
2074
|
+
<details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">update</a>(...)</code></summary>
|
|
2027
2075
|
<dl>
|
|
2028
2076
|
<dd>
|
|
2029
2077
|
|
|
@@ -2039,8 +2087,10 @@ client.functions.create(
|
|
|
2039
2087
|
from mirascope.api._generated import Mirascope
|
|
2040
2088
|
|
|
2041
2089
|
client = Mirascope()
|
|
2042
|
-
client.
|
|
2043
|
-
|
|
2090
|
+
client.organization_memberships.update(
|
|
2091
|
+
organization_id="organizationId",
|
|
2092
|
+
member_id="memberId",
|
|
2093
|
+
role="ADMIN",
|
|
2044
2094
|
)
|
|
2045
2095
|
|
|
2046
2096
|
```
|
|
@@ -2057,7 +2107,23 @@ client.functions.get(
|
|
|
2057
2107
|
<dl>
|
|
2058
2108
|
<dd>
|
|
2059
2109
|
|
|
2060
|
-
**
|
|
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`
|
|
2061
2127
|
|
|
2062
2128
|
</dd>
|
|
2063
2129
|
</dl>
|
|
@@ -2077,7 +2143,8 @@ client.functions.get(
|
|
|
2077
2143
|
</dl>
|
|
2078
2144
|
</details>
|
|
2079
2145
|
|
|
2080
|
-
|
|
2146
|
+
## projects
|
|
2147
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">list</a>(...)</code></summary>
|
|
2081
2148
|
<dl>
|
|
2082
2149
|
<dd>
|
|
2083
2150
|
|
|
@@ -2093,8 +2160,8 @@ client.functions.get(
|
|
|
2093
2160
|
from mirascope.api._generated import Mirascope
|
|
2094
2161
|
|
|
2095
2162
|
client = Mirascope()
|
|
2096
|
-
client.
|
|
2097
|
-
|
|
2163
|
+
client.projects.list(
|
|
2164
|
+
organization_id="organizationId",
|
|
2098
2165
|
)
|
|
2099
2166
|
|
|
2100
2167
|
```
|
|
@@ -2111,7 +2178,7 @@ client.functions.delete(
|
|
|
2111
2178
|
<dl>
|
|
2112
2179
|
<dd>
|
|
2113
2180
|
|
|
2114
|
-
**
|
|
2181
|
+
**organization_id:** `str`
|
|
2115
2182
|
|
|
2116
2183
|
</dd>
|
|
2117
2184
|
</dl>
|
|
@@ -2131,7 +2198,7 @@ client.functions.delete(
|
|
|
2131
2198
|
</dl>
|
|
2132
2199
|
</details>
|
|
2133
2200
|
|
|
2134
|
-
<details><summary><code>client.
|
|
2201
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">create</a>(...)</code></summary>
|
|
2135
2202
|
<dl>
|
|
2136
2203
|
<dd>
|
|
2137
2204
|
|
|
@@ -2147,8 +2214,10 @@ client.functions.delete(
|
|
|
2147
2214
|
from mirascope.api._generated import Mirascope
|
|
2148
2215
|
|
|
2149
2216
|
client = Mirascope()
|
|
2150
|
-
client.
|
|
2151
|
-
|
|
2217
|
+
client.projects.create(
|
|
2218
|
+
organization_id="organizationId",
|
|
2219
|
+
name="name",
|
|
2220
|
+
slug="slug",
|
|
2152
2221
|
)
|
|
2153
2222
|
|
|
2154
2223
|
```
|
|
@@ -2165,7 +2234,23 @@ client.functions.findbyhash(
|
|
|
2165
2234
|
<dl>
|
|
2166
2235
|
<dd>
|
|
2167
2236
|
|
|
2168
|
-
**
|
|
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]$
|
|
2169
2254
|
|
|
2170
2255
|
</dd>
|
|
2171
2256
|
</dl>
|
|
@@ -2185,8 +2270,7 @@ client.functions.findbyhash(
|
|
|
2185
2270
|
</dl>
|
|
2186
2271
|
</details>
|
|
2187
2272
|
|
|
2188
|
-
|
|
2189
|
-
<details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">list</a>(...)</code></summary>
|
|
2273
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">get</a>(...)</code></summary>
|
|
2190
2274
|
<dl>
|
|
2191
2275
|
<dd>
|
|
2192
2276
|
|
|
@@ -2202,7 +2286,10 @@ client.functions.findbyhash(
|
|
|
2202
2286
|
from mirascope.api._generated import Mirascope
|
|
2203
2287
|
|
|
2204
2288
|
client = Mirascope()
|
|
2205
|
-
client.
|
|
2289
|
+
client.projects.get(
|
|
2290
|
+
organization_id="organizationId",
|
|
2291
|
+
project_id="projectId",
|
|
2292
|
+
)
|
|
2206
2293
|
|
|
2207
2294
|
```
|
|
2208
2295
|
</dd>
|
|
@@ -2218,31 +2305,7 @@ client.annotations.list()
|
|
|
2218
2305
|
<dl>
|
|
2219
2306
|
<dd>
|
|
2220
2307
|
|
|
2221
|
-
**
|
|
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]`
|
|
2308
|
+
**organization_id:** `str`
|
|
2246
2309
|
|
|
2247
2310
|
</dd>
|
|
2248
2311
|
</dl>
|
|
@@ -2250,7 +2313,7 @@ client.annotations.list()
|
|
|
2250
2313
|
<dl>
|
|
2251
2314
|
<dd>
|
|
2252
2315
|
|
|
2253
|
-
**
|
|
2316
|
+
**project_id:** `str`
|
|
2254
2317
|
|
|
2255
2318
|
</dd>
|
|
2256
2319
|
</dl>
|
|
@@ -2270,7 +2333,7 @@ client.annotations.list()
|
|
|
2270
2333
|
</dl>
|
|
2271
2334
|
</details>
|
|
2272
2335
|
|
|
2273
|
-
<details><summary><code>client.
|
|
2336
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">update</a>(...)</code></summary>
|
|
2274
2337
|
<dl>
|
|
2275
2338
|
<dd>
|
|
2276
2339
|
|
|
@@ -2286,9 +2349,9 @@ client.annotations.list()
|
|
|
2286
2349
|
from mirascope.api._generated import Mirascope
|
|
2287
2350
|
|
|
2288
2351
|
client = Mirascope()
|
|
2289
|
-
client.
|
|
2290
|
-
|
|
2291
|
-
|
|
2352
|
+
client.projects.update(
|
|
2353
|
+
organization_id="organizationId",
|
|
2354
|
+
project_id="projectId",
|
|
2292
2355
|
)
|
|
2293
2356
|
|
|
2294
2357
|
```
|
|
@@ -2305,15 +2368,7 @@ client.annotations.create(
|
|
|
2305
2368
|
<dl>
|
|
2306
2369
|
<dd>
|
|
2307
2370
|
|
|
2308
|
-
**
|
|
2309
|
-
|
|
2310
|
-
</dd>
|
|
2311
|
-
</dl>
|
|
2312
|
-
|
|
2313
|
-
<dl>
|
|
2314
|
-
<dd>
|
|
2315
|
-
|
|
2316
|
-
**otel_trace_id:** `str`
|
|
2371
|
+
**organization_id:** `str`
|
|
2317
2372
|
|
|
2318
2373
|
</dd>
|
|
2319
2374
|
</dl>
|
|
@@ -2321,7 +2376,7 @@ client.annotations.create(
|
|
|
2321
2376
|
<dl>
|
|
2322
2377
|
<dd>
|
|
2323
2378
|
|
|
2324
|
-
**
|
|
2379
|
+
**project_id:** `str`
|
|
2325
2380
|
|
|
2326
2381
|
</dd>
|
|
2327
2382
|
</dl>
|
|
@@ -2329,7 +2384,7 @@ client.annotations.create(
|
|
|
2329
2384
|
<dl>
|
|
2330
2385
|
<dd>
|
|
2331
2386
|
|
|
2332
|
-
**
|
|
2387
|
+
**name:** `typing.Optional[str]` — a string at most 100 character(s) long
|
|
2333
2388
|
|
|
2334
2389
|
</dd>
|
|
2335
2390
|
</dl>
|
|
@@ -2337,7 +2392,7 @@ client.annotations.create(
|
|
|
2337
2392
|
<dl>
|
|
2338
2393
|
<dd>
|
|
2339
2394
|
|
|
2340
|
-
**
|
|
2395
|
+
**slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
2341
2396
|
|
|
2342
2397
|
</dd>
|
|
2343
2398
|
</dl>
|
|
@@ -2357,7 +2412,7 @@ client.annotations.create(
|
|
|
2357
2412
|
</dl>
|
|
2358
2413
|
</details>
|
|
2359
2414
|
|
|
2360
|
-
<details><summary><code>client.
|
|
2415
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">delete</a>(...)</code></summary>
|
|
2361
2416
|
<dl>
|
|
2362
2417
|
<dd>
|
|
2363
2418
|
|
|
@@ -2373,8 +2428,9 @@ client.annotations.create(
|
|
|
2373
2428
|
from mirascope.api._generated import Mirascope
|
|
2374
2429
|
|
|
2375
2430
|
client = Mirascope()
|
|
2376
|
-
client.
|
|
2377
|
-
|
|
2431
|
+
client.projects.delete(
|
|
2432
|
+
organization_id="organizationId",
|
|
2433
|
+
project_id="projectId",
|
|
2378
2434
|
)
|
|
2379
2435
|
|
|
2380
2436
|
```
|
|
@@ -2391,7 +2447,15 @@ client.annotations.get(
|
|
|
2391
2447
|
<dl>
|
|
2392
2448
|
<dd>
|
|
2393
2449
|
|
|
2394
|
-
**
|
|
2450
|
+
**organization_id:** `str`
|
|
2451
|
+
|
|
2452
|
+
</dd>
|
|
2453
|
+
</dl>
|
|
2454
|
+
|
|
2455
|
+
<dl>
|
|
2456
|
+
<dd>
|
|
2457
|
+
|
|
2458
|
+
**project_id:** `str`
|
|
2395
2459
|
|
|
2396
2460
|
</dd>
|
|
2397
2461
|
</dl>
|
|
@@ -2411,7 +2475,8 @@ client.annotations.get(
|
|
|
2411
2475
|
</dl>
|
|
2412
2476
|
</details>
|
|
2413
2477
|
|
|
2414
|
-
|
|
2478
|
+
## project-memberships
|
|
2479
|
+
<details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">list</a>(...)</code></summary>
|
|
2415
2480
|
<dl>
|
|
2416
2481
|
<dd>
|
|
2417
2482
|
|
|
@@ -2427,8 +2492,9 @@ client.annotations.get(
|
|
|
2427
2492
|
from mirascope.api._generated import Mirascope
|
|
2428
2493
|
|
|
2429
2494
|
client = Mirascope()
|
|
2430
|
-
client.
|
|
2431
|
-
|
|
2495
|
+
client.project_memberships.list(
|
|
2496
|
+
organization_id="organizationId",
|
|
2497
|
+
project_id="projectId",
|
|
2432
2498
|
)
|
|
2433
2499
|
|
|
2434
2500
|
```
|
|
@@ -2445,7 +2511,1858 @@ client.annotations.update(
|
|
|
2445
2511
|
<dl>
|
|
2446
2512
|
<dd>
|
|
2447
2513
|
|
|
2448
|
-
**
|
|
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`
|
|
2449
4366
|
|
|
2450
4367
|
</dd>
|
|
2451
4368
|
</dl>
|
|
@@ -2461,7 +4378,205 @@ client.annotations.update(
|
|
|
2461
4378
|
<dl>
|
|
2462
4379
|
<dd>
|
|
2463
4380
|
|
|
2464
|
-
**reasoning:** `typing.Optional[str]`
|
|
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`
|
|
2465
4580
|
|
|
2466
4581
|
</dd>
|
|
2467
4582
|
</dl>
|
|
@@ -2469,7 +4584,7 @@ client.annotations.update(
|
|
|
2469
4584
|
<dl>
|
|
2470
4585
|
<dd>
|
|
2471
4586
|
|
|
2472
|
-
**
|
|
4587
|
+
**name:** `str` — a string at most 100 character(s) long
|
|
2473
4588
|
|
|
2474
4589
|
</dd>
|
|
2475
4590
|
</dl>
|
|
@@ -2489,7 +4604,7 @@ client.annotations.update(
|
|
|
2489
4604
|
</dl>
|
|
2490
4605
|
</details>
|
|
2491
4606
|
|
|
2492
|
-
<details><summary><code>client.
|
|
4607
|
+
<details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">get</a>(...)</code></summary>
|
|
2493
4608
|
<dl>
|
|
2494
4609
|
<dd>
|
|
2495
4610
|
|
|
@@ -2505,8 +4620,10 @@ client.annotations.update(
|
|
|
2505
4620
|
from mirascope.api._generated import Mirascope
|
|
2506
4621
|
|
|
2507
4622
|
client = Mirascope()
|
|
2508
|
-
client.
|
|
2509
|
-
|
|
4623
|
+
client.tags.get(
|
|
4624
|
+
organization_id="organizationId",
|
|
4625
|
+
project_id="projectId",
|
|
4626
|
+
tag_id="tagId",
|
|
2510
4627
|
)
|
|
2511
4628
|
|
|
2512
4629
|
```
|
|
@@ -2523,7 +4640,260 @@ client.annotations.delete(
|
|
|
2523
4640
|
<dl>
|
|
2524
4641
|
<dd>
|
|
2525
4642
|
|
|
2526
|
-
**
|
|
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]`
|
|
2527
4897
|
|
|
2528
4898
|
</dd>
|
|
2529
4899
|
</dl>
|