mirascope 2.0.0a5__py3-none-any.whl → 2.0.1__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/__init__.py +10 -1
- mirascope/_stubs.py +363 -0
- mirascope/api/__init__.py +8 -0
- mirascope/api/_generated/__init__.py +285 -2
- mirascope/api/_generated/annotations/__init__.py +33 -0
- mirascope/api/_generated/annotations/client.py +506 -0
- mirascope/api/_generated/annotations/raw_client.py +1414 -0
- mirascope/api/_generated/annotations/types/__init__.py +31 -0
- mirascope/api/_generated/annotations/types/annotations_create_request_label.py +5 -0
- mirascope/api/_generated/annotations/types/annotations_create_response.py +48 -0
- mirascope/api/_generated/annotations/types/annotations_create_response_label.py +5 -0
- mirascope/api/_generated/annotations/types/annotations_get_response.py +48 -0
- mirascope/api/_generated/annotations/types/annotations_get_response_label.py +5 -0
- mirascope/api/_generated/annotations/types/annotations_list_request_label.py +5 -0
- mirascope/api/_generated/annotations/types/annotations_list_response.py +21 -0
- mirascope/api/_generated/annotations/types/annotations_list_response_annotations_item.py +50 -0
- mirascope/api/_generated/annotations/types/annotations_list_response_annotations_item_label.py +5 -0
- mirascope/api/_generated/annotations/types/annotations_update_request_label.py +5 -0
- mirascope/api/_generated/annotations/types/annotations_update_response.py +48 -0
- mirascope/api/_generated/annotations/types/annotations_update_response_label.py +5 -0
- mirascope/api/_generated/api_keys/__init__.py +12 -2
- mirascope/api/_generated/api_keys/client.py +77 -0
- mirascope/api/_generated/api_keys/raw_client.py +422 -39
- mirascope/api/_generated/api_keys/types/__init__.py +7 -1
- mirascope/api/_generated/api_keys/types/api_keys_create_response.py +4 -12
- mirascope/api/_generated/api_keys/types/api_keys_get_response.py +4 -12
- mirascope/api/_generated/api_keys/types/api_keys_list_all_for_org_response_item.py +40 -0
- mirascope/api/_generated/api_keys/types/api_keys_list_response_item.py +4 -12
- mirascope/api/_generated/client.py +42 -0
- mirascope/api/_generated/core/client_wrapper.py +2 -14
- mirascope/api/_generated/core/datetime_utils.py +1 -3
- mirascope/api/_generated/core/file.py +2 -5
- mirascope/api/_generated/core/http_client.py +36 -112
- mirascope/api/_generated/core/jsonable_encoder.py +1 -3
- mirascope/api/_generated/core/pydantic_utilities.py +19 -74
- mirascope/api/_generated/core/query_encoder.py +1 -3
- mirascope/api/_generated/core/serialization.py +4 -10
- mirascope/api/_generated/docs/client.py +2 -6
- mirascope/api/_generated/docs/raw_client.py +51 -5
- mirascope/api/_generated/environment.py +3 -3
- mirascope/api/_generated/environments/__init__.py +6 -0
- mirascope/api/_generated/environments/client.py +117 -0
- mirascope/api/_generated/environments/raw_client.py +530 -51
- mirascope/api/_generated/environments/types/__init__.py +10 -0
- mirascope/api/_generated/environments/types/environments_create_response.py +1 -3
- 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/environments/types/environments_get_analytics_response_top_models_item.py +22 -0
- mirascope/api/_generated/environments/types/environments_get_response.py +1 -3
- mirascope/api/_generated/environments/types/environments_list_response_item.py +1 -3
- mirascope/api/_generated/environments/types/environments_update_response.py +1 -3
- mirascope/api/_generated/errors/__init__.py +8 -0
- mirascope/api/_generated/errors/bad_request_error.py +1 -2
- mirascope/api/_generated/errors/conflict_error.py +1 -2
- mirascope/api/_generated/errors/forbidden_error.py +1 -5
- mirascope/api/_generated/errors/internal_server_error.py +1 -6
- mirascope/api/_generated/errors/not_found_error.py +1 -5
- 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/errors/unauthorized_error.py +11 -0
- mirascope/api/_generated/functions/__init__.py +39 -0
- mirascope/api/_generated/functions/client.py +647 -0
- mirascope/api/_generated/functions/raw_client.py +1890 -0
- mirascope/api/_generated/functions/types/__init__.py +53 -0
- mirascope/api/_generated/functions/types/functions_create_request_dependencies_value.py +20 -0
- mirascope/api/_generated/functions/types/functions_create_response.py +37 -0
- mirascope/api/_generated/functions/types/functions_create_response_dependencies_value.py +20 -0
- mirascope/api/_generated/functions/types/functions_find_by_hash_response.py +39 -0
- mirascope/api/_generated/functions/types/functions_find_by_hash_response_dependencies_value.py +20 -0
- 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_get_response.py +37 -0
- mirascope/api/_generated/functions/types/functions_get_response_dependencies_value.py +20 -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/functions/types/functions_list_response.py +21 -0
- mirascope/api/_generated/functions/types/functions_list_response_functions_item.py +41 -0
- mirascope/api/_generated/functions/types/functions_list_response_functions_item_dependencies_value.py +20 -0
- mirascope/api/_generated/health/client.py +2 -6
- mirascope/api/_generated/health/raw_client.py +51 -5
- mirascope/api/_generated/health/types/health_check_response.py +1 -3
- 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 -0
- mirascope/api/_generated/organizations/client.py +465 -0
- mirascope/api/_generated/organizations/raw_client.py +1799 -108
- mirascope/api/_generated/organizations/types/__init__.py +48 -0
- mirascope/api/_generated/organizations/types/organizations_create_payment_intent_response.py +24 -0
- mirascope/api/_generated/organizations/types/organizations_create_response.py +4 -3
- mirascope/api/_generated/organizations/types/organizations_create_response_role.py +1 -3
- mirascope/api/_generated/organizations/types/organizations_get_response.py +4 -3
- mirascope/api/_generated/organizations/types/organizations_get_response_role.py +1 -3
- mirascope/api/_generated/organizations/types/organizations_list_response_item.py +4 -3
- mirascope/api/_generated/organizations/types/organizations_list_response_item_role.py +1 -3
- 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_response.py +4 -3
- mirascope/api/_generated/organizations/types/organizations_update_response_role.py +1 -3
- 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/__init__.py +2 -12
- mirascope/api/_generated/projects/client.py +17 -71
- mirascope/api/_generated/projects/raw_client.py +295 -51
- mirascope/api/_generated/projects/types/__init__.py +1 -6
- mirascope/api/_generated/projects/types/projects_create_response.py +3 -9
- mirascope/api/_generated/projects/types/projects_get_response.py +3 -9
- mirascope/api/_generated/projects/types/projects_list_response_item.py +3 -9
- mirascope/api/_generated/projects/types/projects_update_response.py +3 -9
- mirascope/api/_generated/reference.md +3619 -182
- 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 +42 -0
- mirascope/api/_generated/traces/client.py +941 -0
- mirascope/api/_generated/traces/raw_client.py +2177 -23
- mirascope/api/_generated/traces/types/__init__.py +60 -0
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item.py +4 -11
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item.py +1 -3
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value.py +8 -24
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_array_value.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_kvlist_value.py +3 -9
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_resource_attributes_item_value_kvlist_value_values_item.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item.py +3 -9
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope.py +4 -8
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value.py +8 -24
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_array_value.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_kvlist_value.py +3 -9
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_scope_attributes_item_value_kvlist_value_values_item.py +1 -3
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item.py +6 -18
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item.py +3 -9
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value.py +8 -24
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_array_value.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_kvlist_value.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_attributes_item_value_kvlist_value_values_item.py +1 -3
- mirascope/api/_generated/traces/types/traces_create_request_resource_spans_item_scope_spans_item_spans_item_status.py +2 -6
- mirascope/api/_generated/traces/types/traces_create_response.py +2 -5
- mirascope/api/_generated/traces/types/traces_create_response_partial_success.py +3 -9
- mirascope/api/_generated/traces/types/traces_get_analytics_summary_response.py +60 -0
- mirascope/api/_generated/traces/types/traces_get_analytics_summary_response_top_functions_item.py +24 -0
- mirascope/api/_generated/traces/types/traces_get_analytics_summary_response_top_models_item.py +22 -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.py +33 -0
- mirascope/api/_generated/traces/types/traces_get_trace_detail_response_spans_item.py +88 -0
- 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_request_attribute_filters_item.py +26 -0
- mirascope/api/_generated/traces/types/traces_search_request_attribute_filters_item_operator.py +7 -0
- mirascope/api/_generated/traces/types/traces_search_request_sort_by.py +7 -0
- mirascope/api/_generated/traces/types/traces_search_request_sort_order.py +5 -0
- mirascope/api/_generated/traces/types/traces_search_response.py +26 -0
- mirascope/api/_generated/traces/types/traces_search_response_spans_item.py +50 -0
- mirascope/api/_generated/types/__init__.py +48 -0
- mirascope/api/_generated/types/already_exists_error.py +1 -3
- mirascope/api/_generated/types/bad_request_error_body.py +50 -0
- mirascope/api/_generated/types/click_house_error.py +22 -0
- mirascope/api/_generated/types/database_error.py +1 -3
- mirascope/api/_generated/types/date.py +3 -0
- mirascope/api/_generated/types/http_api_decode_error.py +1 -3
- mirascope/api/_generated/types/immutable_resource_error.py +22 -0
- mirascope/api/_generated/types/internal_server_error_body.py +49 -0
- mirascope/api/_generated/types/issue.py +1 -3
- mirascope/api/_generated/types/issue_tag.py +1 -8
- mirascope/api/_generated/types/not_found_error_body.py +1 -3
- mirascope/api/_generated/types/number_from_string.py +3 -0
- mirascope/api/_generated/types/permission_denied_error.py +1 -3
- mirascope/api/_generated/types/permission_denied_error_tag.py +1 -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/property_key_key.py +1 -3
- 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/stripe_error.py +20 -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/_generated/types/unauthorized_error_body.py +21 -0
- mirascope/api/_generated/types/unauthorized_error_tag.py +5 -0
- mirascope/api/settings.py +19 -1
- mirascope/llm/__init__.py +55 -8
- mirascope/llm/calls/__init__.py +2 -1
- mirascope/llm/calls/calls.py +3 -1
- mirascope/llm/calls/decorator.py +21 -7
- mirascope/llm/content/tool_call.py +6 -0
- mirascope/llm/content/tool_output.py +22 -5
- mirascope/llm/exceptions.py +284 -71
- mirascope/llm/formatting/__init__.py +19 -2
- mirascope/llm/formatting/format.py +219 -30
- 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 +21 -64
- mirascope/llm/mcp/__init__.py +2 -2
- mirascope/llm/mcp/mcp_client.py +130 -0
- 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 +16 -37
- 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 +131 -68
- mirascope/llm/providers/__init__.py +18 -2
- mirascope/llm/providers/anthropic/__init__.py +3 -21
- mirascope/llm/providers/anthropic/_utils/__init__.py +2 -0
- mirascope/llm/providers/anthropic/_utils/beta_decode.py +22 -11
- mirascope/llm/providers/anthropic/_utils/beta_encode.py +75 -25
- mirascope/llm/providers/anthropic/_utils/decode.py +22 -11
- mirascope/llm/providers/anthropic/_utils/encode.py +82 -20
- 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 -2
- mirascope/llm/providers/base/_utils.py +55 -11
- mirascope/llm/providers/base/base_provider.py +116 -37
- mirascope/llm/providers/google/__init__.py +2 -17
- mirascope/llm/providers/google/_utils/__init__.py +2 -0
- mirascope/llm/providers/google/_utils/decode.py +37 -15
- mirascope/llm/providers/google/_utils/encode.py +127 -19
- mirascope/llm/providers/google/_utils/errors.py +3 -2
- mirascope/llm/providers/google/model_info.py +1 -0
- mirascope/llm/providers/google/provider.py +68 -19
- mirascope/llm/providers/mirascope/__init__.py +5 -0
- mirascope/llm/providers/mirascope/_utils.py +73 -0
- mirascope/llm/providers/mirascope/provider.py +349 -0
- mirascope/llm/providers/mlx/__init__.py +2 -17
- mirascope/llm/providers/mlx/_utils.py +8 -3
- 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/ollama/__init__.py +1 -13
- mirascope/llm/providers/openai/_utils/errors.py +2 -2
- mirascope/llm/providers/openai/completions/__init__.py +2 -20
- mirascope/llm/providers/openai/completions/_utils/decode.py +14 -3
- mirascope/llm/providers/openai/completions/_utils/encode.py +35 -28
- mirascope/llm/providers/openai/completions/base_provider.py +40 -11
- mirascope/llm/providers/openai/provider.py +40 -10
- mirascope/llm/providers/openai/responses/__init__.py +1 -17
- mirascope/llm/providers/openai/responses/_utils/__init__.py +2 -0
- mirascope/llm/providers/openai/responses/_utils/decode.py +21 -8
- mirascope/llm/providers/openai/responses/_utils/encode.py +59 -19
- mirascope/llm/providers/openai/responses/provider.py +56 -18
- mirascope/llm/providers/provider_id.py +1 -0
- mirascope/llm/providers/provider_registry.py +96 -19
- mirascope/llm/providers/together/__init__.py +1 -13
- 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 +139 -45
- 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 +17 -8
- mirascope/llm/tools/tool_schema.py +43 -10
- mirascope/llm/tools/toolkit.py +35 -27
- mirascope/llm/tools/tools.py +123 -30
- mirascope/ops/__init__.py +64 -109
- mirascope/ops/_internal/configuration.py +82 -31
- mirascope/ops/_internal/exporters/exporters.py +64 -11
- 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 -1243
- 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 +4 -0
- mirascope/ops/_internal/traced_functions.py +141 -12
- mirascope/ops/_internal/tracing.py +78 -1
- mirascope/ops/_internal/utils.py +52 -4
- mirascope/ops/_internal/versioned_functions.py +54 -43
- {mirascope-2.0.0a5.dist-info → mirascope-2.0.1.dist-info}/METADATA +14 -13
- mirascope-2.0.1.dist-info/RECORD +423 -0
- {mirascope-2.0.0a5.dist-info → mirascope-2.0.1.dist-info}/licenses/LICENSE +1 -1
- mirascope/llm/formatting/_utils.py +0 -78
- mirascope/llm/mcp/client.py +0 -118
- mirascope/llm/providers/_missing_import_stubs.py +0 -49
- mirascope-2.0.0a5.dist-info/RECORD +0 -265
- {mirascope-2.0.0a5.dist-info → mirascope-2.0.1.dist-info}/WHEEL +0 -0
|
@@ -116,6 +116,787 @@ client.traces.create(
|
|
|
116
116
|
</dl>
|
|
117
117
|
|
|
118
118
|
|
|
119
|
+
</dd>
|
|
120
|
+
</dl>
|
|
121
|
+
</details>
|
|
122
|
+
|
|
123
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">search</a>(...)</code></summary>
|
|
124
|
+
<dl>
|
|
125
|
+
<dd>
|
|
126
|
+
|
|
127
|
+
#### 🔌 Usage
|
|
128
|
+
|
|
129
|
+
<dl>
|
|
130
|
+
<dd>
|
|
131
|
+
|
|
132
|
+
<dl>
|
|
133
|
+
<dd>
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
from mirascope.api._generated import Mirascope
|
|
137
|
+
|
|
138
|
+
client = Mirascope()
|
|
139
|
+
client.traces.search(
|
|
140
|
+
start_time="startTime",
|
|
141
|
+
end_time="endTime",
|
|
142
|
+
)
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
</dd>
|
|
146
|
+
</dl>
|
|
147
|
+
</dd>
|
|
148
|
+
</dl>
|
|
149
|
+
|
|
150
|
+
#### ⚙️ Parameters
|
|
151
|
+
|
|
152
|
+
<dl>
|
|
153
|
+
<dd>
|
|
154
|
+
|
|
155
|
+
<dl>
|
|
156
|
+
<dd>
|
|
157
|
+
|
|
158
|
+
**start_time:** `str`
|
|
159
|
+
|
|
160
|
+
</dd>
|
|
161
|
+
</dl>
|
|
162
|
+
|
|
163
|
+
<dl>
|
|
164
|
+
<dd>
|
|
165
|
+
|
|
166
|
+
**end_time:** `str`
|
|
167
|
+
|
|
168
|
+
</dd>
|
|
169
|
+
</dl>
|
|
170
|
+
|
|
171
|
+
<dl>
|
|
172
|
+
<dd>
|
|
173
|
+
|
|
174
|
+
**query:** `typing.Optional[str]`
|
|
175
|
+
|
|
176
|
+
</dd>
|
|
177
|
+
</dl>
|
|
178
|
+
|
|
179
|
+
<dl>
|
|
180
|
+
<dd>
|
|
181
|
+
|
|
182
|
+
**input_messages_query:** `typing.Optional[str]`
|
|
183
|
+
|
|
184
|
+
</dd>
|
|
185
|
+
</dl>
|
|
186
|
+
|
|
187
|
+
<dl>
|
|
188
|
+
<dd>
|
|
189
|
+
|
|
190
|
+
**output_messages_query:** `typing.Optional[str]`
|
|
191
|
+
|
|
192
|
+
</dd>
|
|
193
|
+
</dl>
|
|
194
|
+
|
|
195
|
+
<dl>
|
|
196
|
+
<dd>
|
|
197
|
+
|
|
198
|
+
**fuzzy_search:** `typing.Optional[bool]`
|
|
199
|
+
|
|
200
|
+
</dd>
|
|
201
|
+
</dl>
|
|
202
|
+
|
|
203
|
+
<dl>
|
|
204
|
+
<dd>
|
|
205
|
+
|
|
206
|
+
**trace_id:** `typing.Optional[str]`
|
|
207
|
+
|
|
208
|
+
</dd>
|
|
209
|
+
</dl>
|
|
210
|
+
|
|
211
|
+
<dl>
|
|
212
|
+
<dd>
|
|
213
|
+
|
|
214
|
+
**span_id:** `typing.Optional[str]`
|
|
215
|
+
|
|
216
|
+
</dd>
|
|
217
|
+
</dl>
|
|
218
|
+
|
|
219
|
+
<dl>
|
|
220
|
+
<dd>
|
|
221
|
+
|
|
222
|
+
**model:** `typing.Optional[typing.Sequence[str]]`
|
|
223
|
+
|
|
224
|
+
</dd>
|
|
225
|
+
</dl>
|
|
226
|
+
|
|
227
|
+
<dl>
|
|
228
|
+
<dd>
|
|
229
|
+
|
|
230
|
+
**provider:** `typing.Optional[typing.Sequence[str]]`
|
|
231
|
+
|
|
232
|
+
</dd>
|
|
233
|
+
</dl>
|
|
234
|
+
|
|
235
|
+
<dl>
|
|
236
|
+
<dd>
|
|
237
|
+
|
|
238
|
+
**function_id:** `typing.Optional[str]`
|
|
239
|
+
|
|
240
|
+
</dd>
|
|
241
|
+
</dl>
|
|
242
|
+
|
|
243
|
+
<dl>
|
|
244
|
+
<dd>
|
|
245
|
+
|
|
246
|
+
**function_name:** `typing.Optional[str]`
|
|
247
|
+
|
|
248
|
+
</dd>
|
|
249
|
+
</dl>
|
|
250
|
+
|
|
251
|
+
<dl>
|
|
252
|
+
<dd>
|
|
253
|
+
|
|
254
|
+
**span_name_prefix:** `typing.Optional[str]`
|
|
255
|
+
|
|
256
|
+
</dd>
|
|
257
|
+
</dl>
|
|
258
|
+
|
|
259
|
+
<dl>
|
|
260
|
+
<dd>
|
|
261
|
+
|
|
262
|
+
**has_error:** `typing.Optional[bool]`
|
|
263
|
+
|
|
264
|
+
</dd>
|
|
265
|
+
</dl>
|
|
266
|
+
|
|
267
|
+
<dl>
|
|
268
|
+
<dd>
|
|
269
|
+
|
|
270
|
+
**min_tokens:** `typing.Optional[float]`
|
|
271
|
+
|
|
272
|
+
</dd>
|
|
273
|
+
</dl>
|
|
274
|
+
|
|
275
|
+
<dl>
|
|
276
|
+
<dd>
|
|
277
|
+
|
|
278
|
+
**max_tokens:** `typing.Optional[float]`
|
|
279
|
+
|
|
280
|
+
</dd>
|
|
281
|
+
</dl>
|
|
282
|
+
|
|
283
|
+
<dl>
|
|
284
|
+
<dd>
|
|
285
|
+
|
|
286
|
+
**min_duration:** `typing.Optional[float]`
|
|
287
|
+
|
|
288
|
+
</dd>
|
|
289
|
+
</dl>
|
|
290
|
+
|
|
291
|
+
<dl>
|
|
292
|
+
<dd>
|
|
293
|
+
|
|
294
|
+
**max_duration:** `typing.Optional[float]`
|
|
295
|
+
|
|
296
|
+
</dd>
|
|
297
|
+
</dl>
|
|
298
|
+
|
|
299
|
+
<dl>
|
|
300
|
+
<dd>
|
|
301
|
+
|
|
302
|
+
**attribute_filters:** `typing.Optional[typing.Sequence[TracesSearchRequestAttributeFiltersItem]]`
|
|
303
|
+
|
|
304
|
+
</dd>
|
|
305
|
+
</dl>
|
|
306
|
+
|
|
307
|
+
<dl>
|
|
308
|
+
<dd>
|
|
309
|
+
|
|
310
|
+
**limit:** `typing.Optional[float]`
|
|
311
|
+
|
|
312
|
+
</dd>
|
|
313
|
+
</dl>
|
|
314
|
+
|
|
315
|
+
<dl>
|
|
316
|
+
<dd>
|
|
317
|
+
|
|
318
|
+
**offset:** `typing.Optional[float]`
|
|
319
|
+
|
|
320
|
+
</dd>
|
|
321
|
+
</dl>
|
|
322
|
+
|
|
323
|
+
<dl>
|
|
324
|
+
<dd>
|
|
325
|
+
|
|
326
|
+
**sort_by:** `typing.Optional[TracesSearchRequestSortBy]`
|
|
327
|
+
|
|
328
|
+
</dd>
|
|
329
|
+
</dl>
|
|
330
|
+
|
|
331
|
+
<dl>
|
|
332
|
+
<dd>
|
|
333
|
+
|
|
334
|
+
**sort_order:** `typing.Optional[TracesSearchRequestSortOrder]`
|
|
335
|
+
|
|
336
|
+
</dd>
|
|
337
|
+
</dl>
|
|
338
|
+
|
|
339
|
+
<dl>
|
|
340
|
+
<dd>
|
|
341
|
+
|
|
342
|
+
**root_spans_only:** `typing.Optional[bool]`
|
|
343
|
+
|
|
344
|
+
</dd>
|
|
345
|
+
</dl>
|
|
346
|
+
|
|
347
|
+
<dl>
|
|
348
|
+
<dd>
|
|
349
|
+
|
|
350
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
351
|
+
|
|
352
|
+
</dd>
|
|
353
|
+
</dl>
|
|
354
|
+
</dd>
|
|
355
|
+
</dl>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</dd>
|
|
359
|
+
</dl>
|
|
360
|
+
</details>
|
|
361
|
+
|
|
362
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">gettracedetail</a>(...)</code></summary>
|
|
363
|
+
<dl>
|
|
364
|
+
<dd>
|
|
365
|
+
|
|
366
|
+
#### 🔌 Usage
|
|
367
|
+
|
|
368
|
+
<dl>
|
|
369
|
+
<dd>
|
|
370
|
+
|
|
371
|
+
<dl>
|
|
372
|
+
<dd>
|
|
373
|
+
|
|
374
|
+
```python
|
|
375
|
+
from mirascope.api._generated import Mirascope
|
|
376
|
+
|
|
377
|
+
client = Mirascope()
|
|
378
|
+
client.traces.gettracedetail(
|
|
379
|
+
trace_id="traceId",
|
|
380
|
+
)
|
|
381
|
+
|
|
382
|
+
```
|
|
383
|
+
</dd>
|
|
384
|
+
</dl>
|
|
385
|
+
</dd>
|
|
386
|
+
</dl>
|
|
387
|
+
|
|
388
|
+
#### ⚙️ Parameters
|
|
389
|
+
|
|
390
|
+
<dl>
|
|
391
|
+
<dd>
|
|
392
|
+
|
|
393
|
+
<dl>
|
|
394
|
+
<dd>
|
|
395
|
+
|
|
396
|
+
**trace_id:** `str`
|
|
397
|
+
|
|
398
|
+
</dd>
|
|
399
|
+
</dl>
|
|
400
|
+
|
|
401
|
+
<dl>
|
|
402
|
+
<dd>
|
|
403
|
+
|
|
404
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
405
|
+
|
|
406
|
+
</dd>
|
|
407
|
+
</dl>
|
|
408
|
+
</dd>
|
|
409
|
+
</dl>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
</dd>
|
|
413
|
+
</dl>
|
|
414
|
+
</details>
|
|
415
|
+
|
|
416
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">getanalyticssummary</a>(...)</code></summary>
|
|
417
|
+
<dl>
|
|
418
|
+
<dd>
|
|
419
|
+
|
|
420
|
+
#### 🔌 Usage
|
|
421
|
+
|
|
422
|
+
<dl>
|
|
423
|
+
<dd>
|
|
424
|
+
|
|
425
|
+
<dl>
|
|
426
|
+
<dd>
|
|
427
|
+
|
|
428
|
+
```python
|
|
429
|
+
from mirascope.api._generated import Mirascope
|
|
430
|
+
|
|
431
|
+
client = Mirascope()
|
|
432
|
+
client.traces.getanalyticssummary(
|
|
433
|
+
start_time="startTime",
|
|
434
|
+
end_time="endTime",
|
|
435
|
+
)
|
|
436
|
+
|
|
437
|
+
```
|
|
438
|
+
</dd>
|
|
439
|
+
</dl>
|
|
440
|
+
</dd>
|
|
441
|
+
</dl>
|
|
442
|
+
|
|
443
|
+
#### ⚙️ Parameters
|
|
444
|
+
|
|
445
|
+
<dl>
|
|
446
|
+
<dd>
|
|
447
|
+
|
|
448
|
+
<dl>
|
|
449
|
+
<dd>
|
|
450
|
+
|
|
451
|
+
**start_time:** `str`
|
|
452
|
+
|
|
453
|
+
</dd>
|
|
454
|
+
</dl>
|
|
455
|
+
|
|
456
|
+
<dl>
|
|
457
|
+
<dd>
|
|
458
|
+
|
|
459
|
+
**end_time:** `str`
|
|
460
|
+
|
|
461
|
+
</dd>
|
|
462
|
+
</dl>
|
|
463
|
+
|
|
464
|
+
<dl>
|
|
465
|
+
<dd>
|
|
466
|
+
|
|
467
|
+
**function_id:** `typing.Optional[str]`
|
|
468
|
+
|
|
469
|
+
</dd>
|
|
470
|
+
</dl>
|
|
471
|
+
|
|
472
|
+
<dl>
|
|
473
|
+
<dd>
|
|
474
|
+
|
|
475
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
476
|
+
|
|
477
|
+
</dd>
|
|
478
|
+
</dl>
|
|
479
|
+
</dd>
|
|
480
|
+
</dl>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
</dd>
|
|
484
|
+
</dl>
|
|
485
|
+
</details>
|
|
486
|
+
|
|
487
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">listbyfunctionhash</a>(...)</code></summary>
|
|
488
|
+
<dl>
|
|
489
|
+
<dd>
|
|
490
|
+
|
|
491
|
+
#### 🔌 Usage
|
|
492
|
+
|
|
493
|
+
<dl>
|
|
494
|
+
<dd>
|
|
495
|
+
|
|
496
|
+
<dl>
|
|
497
|
+
<dd>
|
|
498
|
+
|
|
499
|
+
```python
|
|
500
|
+
from mirascope.api._generated import Mirascope
|
|
501
|
+
|
|
502
|
+
client = Mirascope()
|
|
503
|
+
client.traces.listbyfunctionhash(
|
|
504
|
+
hash="hash",
|
|
505
|
+
)
|
|
506
|
+
|
|
507
|
+
```
|
|
508
|
+
</dd>
|
|
509
|
+
</dl>
|
|
510
|
+
</dd>
|
|
511
|
+
</dl>
|
|
512
|
+
|
|
513
|
+
#### ⚙️ Parameters
|
|
514
|
+
|
|
515
|
+
<dl>
|
|
516
|
+
<dd>
|
|
517
|
+
|
|
518
|
+
<dl>
|
|
519
|
+
<dd>
|
|
520
|
+
|
|
521
|
+
**hash:** `str`
|
|
522
|
+
|
|
523
|
+
</dd>
|
|
524
|
+
</dl>
|
|
525
|
+
|
|
526
|
+
<dl>
|
|
527
|
+
<dd>
|
|
528
|
+
|
|
529
|
+
**limit:** `typing.Optional[NumberFromString]`
|
|
530
|
+
|
|
531
|
+
</dd>
|
|
532
|
+
</dl>
|
|
533
|
+
|
|
534
|
+
<dl>
|
|
535
|
+
<dd>
|
|
536
|
+
|
|
537
|
+
**offset:** `typing.Optional[NumberFromString]`
|
|
538
|
+
|
|
539
|
+
</dd>
|
|
540
|
+
</dl>
|
|
541
|
+
|
|
542
|
+
<dl>
|
|
543
|
+
<dd>
|
|
544
|
+
|
|
545
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
546
|
+
|
|
547
|
+
</dd>
|
|
548
|
+
</dl>
|
|
549
|
+
</dd>
|
|
550
|
+
</dl>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
</dd>
|
|
554
|
+
</dl>
|
|
555
|
+
</details>
|
|
556
|
+
|
|
557
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">searchbyenv</a>(...)</code></summary>
|
|
558
|
+
<dl>
|
|
559
|
+
<dd>
|
|
560
|
+
|
|
561
|
+
#### 🔌 Usage
|
|
562
|
+
|
|
563
|
+
<dl>
|
|
564
|
+
<dd>
|
|
565
|
+
|
|
566
|
+
<dl>
|
|
567
|
+
<dd>
|
|
568
|
+
|
|
569
|
+
```python
|
|
570
|
+
from mirascope.api._generated import Mirascope
|
|
571
|
+
|
|
572
|
+
client = Mirascope()
|
|
573
|
+
client.traces.searchbyenv(
|
|
574
|
+
organization_id="organizationId",
|
|
575
|
+
project_id="projectId",
|
|
576
|
+
environment_id="environmentId",
|
|
577
|
+
start_time="startTime",
|
|
578
|
+
end_time="endTime",
|
|
579
|
+
)
|
|
580
|
+
|
|
581
|
+
```
|
|
582
|
+
</dd>
|
|
583
|
+
</dl>
|
|
584
|
+
</dd>
|
|
585
|
+
</dl>
|
|
586
|
+
|
|
587
|
+
#### ⚙️ Parameters
|
|
588
|
+
|
|
589
|
+
<dl>
|
|
590
|
+
<dd>
|
|
591
|
+
|
|
592
|
+
<dl>
|
|
593
|
+
<dd>
|
|
594
|
+
|
|
595
|
+
**organization_id:** `str`
|
|
596
|
+
|
|
597
|
+
</dd>
|
|
598
|
+
</dl>
|
|
599
|
+
|
|
600
|
+
<dl>
|
|
601
|
+
<dd>
|
|
602
|
+
|
|
603
|
+
**project_id:** `str`
|
|
604
|
+
|
|
605
|
+
</dd>
|
|
606
|
+
</dl>
|
|
607
|
+
|
|
608
|
+
<dl>
|
|
609
|
+
<dd>
|
|
610
|
+
|
|
611
|
+
**environment_id:** `str`
|
|
612
|
+
|
|
613
|
+
</dd>
|
|
614
|
+
</dl>
|
|
615
|
+
|
|
616
|
+
<dl>
|
|
617
|
+
<dd>
|
|
618
|
+
|
|
619
|
+
**start_time:** `str`
|
|
620
|
+
|
|
621
|
+
</dd>
|
|
622
|
+
</dl>
|
|
623
|
+
|
|
624
|
+
<dl>
|
|
625
|
+
<dd>
|
|
626
|
+
|
|
627
|
+
**end_time:** `str`
|
|
628
|
+
|
|
629
|
+
</dd>
|
|
630
|
+
</dl>
|
|
631
|
+
|
|
632
|
+
<dl>
|
|
633
|
+
<dd>
|
|
634
|
+
|
|
635
|
+
**query:** `typing.Optional[str]`
|
|
636
|
+
|
|
637
|
+
</dd>
|
|
638
|
+
</dl>
|
|
639
|
+
|
|
640
|
+
<dl>
|
|
641
|
+
<dd>
|
|
642
|
+
|
|
643
|
+
**input_messages_query:** `typing.Optional[str]`
|
|
644
|
+
|
|
645
|
+
</dd>
|
|
646
|
+
</dl>
|
|
647
|
+
|
|
648
|
+
<dl>
|
|
649
|
+
<dd>
|
|
650
|
+
|
|
651
|
+
**output_messages_query:** `typing.Optional[str]`
|
|
652
|
+
|
|
653
|
+
</dd>
|
|
654
|
+
</dl>
|
|
655
|
+
|
|
656
|
+
<dl>
|
|
657
|
+
<dd>
|
|
658
|
+
|
|
659
|
+
**fuzzy_search:** `typing.Optional[bool]`
|
|
660
|
+
|
|
661
|
+
</dd>
|
|
662
|
+
</dl>
|
|
663
|
+
|
|
664
|
+
<dl>
|
|
665
|
+
<dd>
|
|
666
|
+
|
|
667
|
+
**trace_id:** `typing.Optional[str]`
|
|
668
|
+
|
|
669
|
+
</dd>
|
|
670
|
+
</dl>
|
|
671
|
+
|
|
672
|
+
<dl>
|
|
673
|
+
<dd>
|
|
674
|
+
|
|
675
|
+
**span_id:** `typing.Optional[str]`
|
|
676
|
+
|
|
677
|
+
</dd>
|
|
678
|
+
</dl>
|
|
679
|
+
|
|
680
|
+
<dl>
|
|
681
|
+
<dd>
|
|
682
|
+
|
|
683
|
+
**model:** `typing.Optional[typing.Sequence[str]]`
|
|
684
|
+
|
|
685
|
+
</dd>
|
|
686
|
+
</dl>
|
|
687
|
+
|
|
688
|
+
<dl>
|
|
689
|
+
<dd>
|
|
690
|
+
|
|
691
|
+
**provider:** `typing.Optional[typing.Sequence[str]]`
|
|
692
|
+
|
|
693
|
+
</dd>
|
|
694
|
+
</dl>
|
|
695
|
+
|
|
696
|
+
<dl>
|
|
697
|
+
<dd>
|
|
698
|
+
|
|
699
|
+
**function_id:** `typing.Optional[str]`
|
|
700
|
+
|
|
701
|
+
</dd>
|
|
702
|
+
</dl>
|
|
703
|
+
|
|
704
|
+
<dl>
|
|
705
|
+
<dd>
|
|
706
|
+
|
|
707
|
+
**function_name:** `typing.Optional[str]`
|
|
708
|
+
|
|
709
|
+
</dd>
|
|
710
|
+
</dl>
|
|
711
|
+
|
|
712
|
+
<dl>
|
|
713
|
+
<dd>
|
|
714
|
+
|
|
715
|
+
**span_name_prefix:** `typing.Optional[str]`
|
|
716
|
+
|
|
717
|
+
</dd>
|
|
718
|
+
</dl>
|
|
719
|
+
|
|
720
|
+
<dl>
|
|
721
|
+
<dd>
|
|
722
|
+
|
|
723
|
+
**has_error:** `typing.Optional[bool]`
|
|
724
|
+
|
|
725
|
+
</dd>
|
|
726
|
+
</dl>
|
|
727
|
+
|
|
728
|
+
<dl>
|
|
729
|
+
<dd>
|
|
730
|
+
|
|
731
|
+
**min_tokens:** `typing.Optional[float]`
|
|
732
|
+
|
|
733
|
+
</dd>
|
|
734
|
+
</dl>
|
|
735
|
+
|
|
736
|
+
<dl>
|
|
737
|
+
<dd>
|
|
738
|
+
|
|
739
|
+
**max_tokens:** `typing.Optional[float]`
|
|
740
|
+
|
|
741
|
+
</dd>
|
|
742
|
+
</dl>
|
|
743
|
+
|
|
744
|
+
<dl>
|
|
745
|
+
<dd>
|
|
746
|
+
|
|
747
|
+
**min_duration:** `typing.Optional[float]`
|
|
748
|
+
|
|
749
|
+
</dd>
|
|
750
|
+
</dl>
|
|
751
|
+
|
|
752
|
+
<dl>
|
|
753
|
+
<dd>
|
|
754
|
+
|
|
755
|
+
**max_duration:** `typing.Optional[float]`
|
|
756
|
+
|
|
757
|
+
</dd>
|
|
758
|
+
</dl>
|
|
759
|
+
|
|
760
|
+
<dl>
|
|
761
|
+
<dd>
|
|
762
|
+
|
|
763
|
+
**attribute_filters:** `typing.Optional[typing.Sequence[TracesSearchByEnvRequestAttributeFiltersItem]]`
|
|
764
|
+
|
|
765
|
+
</dd>
|
|
766
|
+
</dl>
|
|
767
|
+
|
|
768
|
+
<dl>
|
|
769
|
+
<dd>
|
|
770
|
+
|
|
771
|
+
**limit:** `typing.Optional[float]`
|
|
772
|
+
|
|
773
|
+
</dd>
|
|
774
|
+
</dl>
|
|
775
|
+
|
|
776
|
+
<dl>
|
|
777
|
+
<dd>
|
|
778
|
+
|
|
779
|
+
**offset:** `typing.Optional[float]`
|
|
780
|
+
|
|
781
|
+
</dd>
|
|
782
|
+
</dl>
|
|
783
|
+
|
|
784
|
+
<dl>
|
|
785
|
+
<dd>
|
|
786
|
+
|
|
787
|
+
**sort_by:** `typing.Optional[TracesSearchByEnvRequestSortBy]`
|
|
788
|
+
|
|
789
|
+
</dd>
|
|
790
|
+
</dl>
|
|
791
|
+
|
|
792
|
+
<dl>
|
|
793
|
+
<dd>
|
|
794
|
+
|
|
795
|
+
**sort_order:** `typing.Optional[TracesSearchByEnvRequestSortOrder]`
|
|
796
|
+
|
|
797
|
+
</dd>
|
|
798
|
+
</dl>
|
|
799
|
+
|
|
800
|
+
<dl>
|
|
801
|
+
<dd>
|
|
802
|
+
|
|
803
|
+
**root_spans_only:** `typing.Optional[bool]`
|
|
804
|
+
|
|
805
|
+
</dd>
|
|
806
|
+
</dl>
|
|
807
|
+
|
|
808
|
+
<dl>
|
|
809
|
+
<dd>
|
|
810
|
+
|
|
811
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
812
|
+
|
|
813
|
+
</dd>
|
|
814
|
+
</dl>
|
|
815
|
+
</dd>
|
|
816
|
+
</dl>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
</dd>
|
|
820
|
+
</dl>
|
|
821
|
+
</details>
|
|
822
|
+
|
|
823
|
+
<details><summary><code>client.traces.<a href="src/mirascope/traces/client.py">gettracedetailbyenv</a>(...)</code></summary>
|
|
824
|
+
<dl>
|
|
825
|
+
<dd>
|
|
826
|
+
|
|
827
|
+
#### 🔌 Usage
|
|
828
|
+
|
|
829
|
+
<dl>
|
|
830
|
+
<dd>
|
|
831
|
+
|
|
832
|
+
<dl>
|
|
833
|
+
<dd>
|
|
834
|
+
|
|
835
|
+
```python
|
|
836
|
+
from mirascope.api._generated import Mirascope
|
|
837
|
+
|
|
838
|
+
client = Mirascope()
|
|
839
|
+
client.traces.gettracedetailbyenv(
|
|
840
|
+
organization_id="organizationId",
|
|
841
|
+
project_id="projectId",
|
|
842
|
+
environment_id="environmentId",
|
|
843
|
+
trace_id="traceId",
|
|
844
|
+
)
|
|
845
|
+
|
|
846
|
+
```
|
|
847
|
+
</dd>
|
|
848
|
+
</dl>
|
|
849
|
+
</dd>
|
|
850
|
+
</dl>
|
|
851
|
+
|
|
852
|
+
#### ⚙️ Parameters
|
|
853
|
+
|
|
854
|
+
<dl>
|
|
855
|
+
<dd>
|
|
856
|
+
|
|
857
|
+
<dl>
|
|
858
|
+
<dd>
|
|
859
|
+
|
|
860
|
+
**organization_id:** `str`
|
|
861
|
+
|
|
862
|
+
</dd>
|
|
863
|
+
</dl>
|
|
864
|
+
|
|
865
|
+
<dl>
|
|
866
|
+
<dd>
|
|
867
|
+
|
|
868
|
+
**project_id:** `str`
|
|
869
|
+
|
|
870
|
+
</dd>
|
|
871
|
+
</dl>
|
|
872
|
+
|
|
873
|
+
<dl>
|
|
874
|
+
<dd>
|
|
875
|
+
|
|
876
|
+
**environment_id:** `str`
|
|
877
|
+
|
|
878
|
+
</dd>
|
|
879
|
+
</dl>
|
|
880
|
+
|
|
881
|
+
<dl>
|
|
882
|
+
<dd>
|
|
883
|
+
|
|
884
|
+
**trace_id:** `str`
|
|
885
|
+
|
|
886
|
+
</dd>
|
|
887
|
+
</dl>
|
|
888
|
+
|
|
889
|
+
<dl>
|
|
890
|
+
<dd>
|
|
891
|
+
|
|
892
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
893
|
+
|
|
894
|
+
</dd>
|
|
895
|
+
</dl>
|
|
896
|
+
</dd>
|
|
897
|
+
</dl>
|
|
898
|
+
|
|
899
|
+
|
|
119
900
|
</dd>
|
|
120
901
|
</dl>
|
|
121
902
|
</details>
|
|
@@ -137,7 +918,2477 @@ client.traces.create(
|
|
|
137
918
|
from mirascope.api._generated import Mirascope
|
|
138
919
|
|
|
139
920
|
client = Mirascope()
|
|
140
|
-
client.docs.openapi()
|
|
921
|
+
client.docs.openapi()
|
|
922
|
+
|
|
923
|
+
```
|
|
924
|
+
</dd>
|
|
925
|
+
</dl>
|
|
926
|
+
</dd>
|
|
927
|
+
</dl>
|
|
928
|
+
|
|
929
|
+
#### ⚙️ Parameters
|
|
930
|
+
|
|
931
|
+
<dl>
|
|
932
|
+
<dd>
|
|
933
|
+
|
|
934
|
+
<dl>
|
|
935
|
+
<dd>
|
|
936
|
+
|
|
937
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
938
|
+
|
|
939
|
+
</dd>
|
|
940
|
+
</dl>
|
|
941
|
+
</dd>
|
|
942
|
+
</dl>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
</dd>
|
|
946
|
+
</dl>
|
|
947
|
+
</details>
|
|
948
|
+
|
|
949
|
+
## organizations
|
|
950
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">list</a>()</code></summary>
|
|
951
|
+
<dl>
|
|
952
|
+
<dd>
|
|
953
|
+
|
|
954
|
+
#### 🔌 Usage
|
|
955
|
+
|
|
956
|
+
<dl>
|
|
957
|
+
<dd>
|
|
958
|
+
|
|
959
|
+
<dl>
|
|
960
|
+
<dd>
|
|
961
|
+
|
|
962
|
+
```python
|
|
963
|
+
from mirascope.api._generated import Mirascope
|
|
964
|
+
|
|
965
|
+
client = Mirascope()
|
|
966
|
+
client.organizations.list()
|
|
967
|
+
|
|
968
|
+
```
|
|
969
|
+
</dd>
|
|
970
|
+
</dl>
|
|
971
|
+
</dd>
|
|
972
|
+
</dl>
|
|
973
|
+
|
|
974
|
+
#### ⚙️ Parameters
|
|
975
|
+
|
|
976
|
+
<dl>
|
|
977
|
+
<dd>
|
|
978
|
+
|
|
979
|
+
<dl>
|
|
980
|
+
<dd>
|
|
981
|
+
|
|
982
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
983
|
+
|
|
984
|
+
</dd>
|
|
985
|
+
</dl>
|
|
986
|
+
</dd>
|
|
987
|
+
</dl>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
</dd>
|
|
991
|
+
</dl>
|
|
992
|
+
</details>
|
|
993
|
+
|
|
994
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">create</a>(...)</code></summary>
|
|
995
|
+
<dl>
|
|
996
|
+
<dd>
|
|
997
|
+
|
|
998
|
+
#### 🔌 Usage
|
|
999
|
+
|
|
1000
|
+
<dl>
|
|
1001
|
+
<dd>
|
|
1002
|
+
|
|
1003
|
+
<dl>
|
|
1004
|
+
<dd>
|
|
1005
|
+
|
|
1006
|
+
```python
|
|
1007
|
+
from mirascope.api._generated import Mirascope
|
|
1008
|
+
|
|
1009
|
+
client = Mirascope()
|
|
1010
|
+
client.organizations.create(
|
|
1011
|
+
name="name",
|
|
1012
|
+
slug="slug",
|
|
1013
|
+
)
|
|
1014
|
+
|
|
1015
|
+
```
|
|
1016
|
+
</dd>
|
|
1017
|
+
</dl>
|
|
1018
|
+
</dd>
|
|
1019
|
+
</dl>
|
|
1020
|
+
|
|
1021
|
+
#### ⚙️ Parameters
|
|
1022
|
+
|
|
1023
|
+
<dl>
|
|
1024
|
+
<dd>
|
|
1025
|
+
|
|
1026
|
+
<dl>
|
|
1027
|
+
<dd>
|
|
1028
|
+
|
|
1029
|
+
**name:** `str` — a string at most 100 character(s) long
|
|
1030
|
+
|
|
1031
|
+
</dd>
|
|
1032
|
+
</dl>
|
|
1033
|
+
|
|
1034
|
+
<dl>
|
|
1035
|
+
<dd>
|
|
1036
|
+
|
|
1037
|
+
**slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
1038
|
+
|
|
1039
|
+
</dd>
|
|
1040
|
+
</dl>
|
|
1041
|
+
|
|
1042
|
+
<dl>
|
|
1043
|
+
<dd>
|
|
1044
|
+
|
|
1045
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1046
|
+
|
|
1047
|
+
</dd>
|
|
1048
|
+
</dl>
|
|
1049
|
+
</dd>
|
|
1050
|
+
</dl>
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
</dd>
|
|
1054
|
+
</dl>
|
|
1055
|
+
</details>
|
|
1056
|
+
|
|
1057
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">get</a>(...)</code></summary>
|
|
1058
|
+
<dl>
|
|
1059
|
+
<dd>
|
|
1060
|
+
|
|
1061
|
+
#### 🔌 Usage
|
|
1062
|
+
|
|
1063
|
+
<dl>
|
|
1064
|
+
<dd>
|
|
1065
|
+
|
|
1066
|
+
<dl>
|
|
1067
|
+
<dd>
|
|
1068
|
+
|
|
1069
|
+
```python
|
|
1070
|
+
from mirascope.api._generated import Mirascope
|
|
1071
|
+
|
|
1072
|
+
client = Mirascope()
|
|
1073
|
+
client.organizations.get(
|
|
1074
|
+
id="id",
|
|
1075
|
+
)
|
|
1076
|
+
|
|
1077
|
+
```
|
|
1078
|
+
</dd>
|
|
1079
|
+
</dl>
|
|
1080
|
+
</dd>
|
|
1081
|
+
</dl>
|
|
1082
|
+
|
|
1083
|
+
#### ⚙️ Parameters
|
|
1084
|
+
|
|
1085
|
+
<dl>
|
|
1086
|
+
<dd>
|
|
1087
|
+
|
|
1088
|
+
<dl>
|
|
1089
|
+
<dd>
|
|
1090
|
+
|
|
1091
|
+
**id:** `str`
|
|
1092
|
+
|
|
1093
|
+
</dd>
|
|
1094
|
+
</dl>
|
|
1095
|
+
|
|
1096
|
+
<dl>
|
|
1097
|
+
<dd>
|
|
1098
|
+
|
|
1099
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1100
|
+
|
|
1101
|
+
</dd>
|
|
1102
|
+
</dl>
|
|
1103
|
+
</dd>
|
|
1104
|
+
</dl>
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
</dd>
|
|
1108
|
+
</dl>
|
|
1109
|
+
</details>
|
|
1110
|
+
|
|
1111
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">update</a>(...)</code></summary>
|
|
1112
|
+
<dl>
|
|
1113
|
+
<dd>
|
|
1114
|
+
|
|
1115
|
+
#### 🔌 Usage
|
|
1116
|
+
|
|
1117
|
+
<dl>
|
|
1118
|
+
<dd>
|
|
1119
|
+
|
|
1120
|
+
<dl>
|
|
1121
|
+
<dd>
|
|
1122
|
+
|
|
1123
|
+
```python
|
|
1124
|
+
from mirascope.api._generated import Mirascope
|
|
1125
|
+
|
|
1126
|
+
client = Mirascope()
|
|
1127
|
+
client.organizations.update(
|
|
1128
|
+
id="id",
|
|
1129
|
+
)
|
|
1130
|
+
|
|
1131
|
+
```
|
|
1132
|
+
</dd>
|
|
1133
|
+
</dl>
|
|
1134
|
+
</dd>
|
|
1135
|
+
</dl>
|
|
1136
|
+
|
|
1137
|
+
#### ⚙️ Parameters
|
|
1138
|
+
|
|
1139
|
+
<dl>
|
|
1140
|
+
<dd>
|
|
1141
|
+
|
|
1142
|
+
<dl>
|
|
1143
|
+
<dd>
|
|
1144
|
+
|
|
1145
|
+
**id:** `str`
|
|
1146
|
+
|
|
1147
|
+
</dd>
|
|
1148
|
+
</dl>
|
|
1149
|
+
|
|
1150
|
+
<dl>
|
|
1151
|
+
<dd>
|
|
1152
|
+
|
|
1153
|
+
**name:** `typing.Optional[str]` — a string at most 100 character(s) long
|
|
1154
|
+
|
|
1155
|
+
</dd>
|
|
1156
|
+
</dl>
|
|
1157
|
+
|
|
1158
|
+
<dl>
|
|
1159
|
+
<dd>
|
|
1160
|
+
|
|
1161
|
+
**slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
1162
|
+
|
|
1163
|
+
</dd>
|
|
1164
|
+
</dl>
|
|
1165
|
+
|
|
1166
|
+
<dl>
|
|
1167
|
+
<dd>
|
|
1168
|
+
|
|
1169
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1170
|
+
|
|
1171
|
+
</dd>
|
|
1172
|
+
</dl>
|
|
1173
|
+
</dd>
|
|
1174
|
+
</dl>
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
</dd>
|
|
1178
|
+
</dl>
|
|
1179
|
+
</details>
|
|
1180
|
+
|
|
1181
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">delete</a>(...)</code></summary>
|
|
1182
|
+
<dl>
|
|
1183
|
+
<dd>
|
|
1184
|
+
|
|
1185
|
+
#### 🔌 Usage
|
|
1186
|
+
|
|
1187
|
+
<dl>
|
|
1188
|
+
<dd>
|
|
1189
|
+
|
|
1190
|
+
<dl>
|
|
1191
|
+
<dd>
|
|
1192
|
+
|
|
1193
|
+
```python
|
|
1194
|
+
from mirascope.api._generated import Mirascope
|
|
1195
|
+
|
|
1196
|
+
client = Mirascope()
|
|
1197
|
+
client.organizations.delete(
|
|
1198
|
+
id="id",
|
|
1199
|
+
)
|
|
1200
|
+
|
|
1201
|
+
```
|
|
1202
|
+
</dd>
|
|
1203
|
+
</dl>
|
|
1204
|
+
</dd>
|
|
1205
|
+
</dl>
|
|
1206
|
+
|
|
1207
|
+
#### ⚙️ Parameters
|
|
1208
|
+
|
|
1209
|
+
<dl>
|
|
1210
|
+
<dd>
|
|
1211
|
+
|
|
1212
|
+
<dl>
|
|
1213
|
+
<dd>
|
|
1214
|
+
|
|
1215
|
+
**id:** `str`
|
|
1216
|
+
|
|
1217
|
+
</dd>
|
|
1218
|
+
</dl>
|
|
1219
|
+
|
|
1220
|
+
<dl>
|
|
1221
|
+
<dd>
|
|
1222
|
+
|
|
1223
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1224
|
+
|
|
1225
|
+
</dd>
|
|
1226
|
+
</dl>
|
|
1227
|
+
</dd>
|
|
1228
|
+
</dl>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
</dd>
|
|
1232
|
+
</dl>
|
|
1233
|
+
</details>
|
|
1234
|
+
|
|
1235
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">routerbalance</a>(...)</code></summary>
|
|
1236
|
+
<dl>
|
|
1237
|
+
<dd>
|
|
1238
|
+
|
|
1239
|
+
#### 🔌 Usage
|
|
1240
|
+
|
|
1241
|
+
<dl>
|
|
1242
|
+
<dd>
|
|
1243
|
+
|
|
1244
|
+
<dl>
|
|
1245
|
+
<dd>
|
|
1246
|
+
|
|
1247
|
+
```python
|
|
1248
|
+
from mirascope.api._generated import Mirascope
|
|
1249
|
+
|
|
1250
|
+
client = Mirascope()
|
|
1251
|
+
client.organizations.routerbalance(
|
|
1252
|
+
id="id",
|
|
1253
|
+
)
|
|
1254
|
+
|
|
1255
|
+
```
|
|
1256
|
+
</dd>
|
|
1257
|
+
</dl>
|
|
1258
|
+
</dd>
|
|
1259
|
+
</dl>
|
|
1260
|
+
|
|
1261
|
+
#### ⚙️ Parameters
|
|
1262
|
+
|
|
1263
|
+
<dl>
|
|
1264
|
+
<dd>
|
|
1265
|
+
|
|
1266
|
+
<dl>
|
|
1267
|
+
<dd>
|
|
1268
|
+
|
|
1269
|
+
**id:** `str`
|
|
1270
|
+
|
|
1271
|
+
</dd>
|
|
1272
|
+
</dl>
|
|
1273
|
+
|
|
1274
|
+
<dl>
|
|
1275
|
+
<dd>
|
|
1276
|
+
|
|
1277
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1278
|
+
|
|
1279
|
+
</dd>
|
|
1280
|
+
</dl>
|
|
1281
|
+
</dd>
|
|
1282
|
+
</dl>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
</dd>
|
|
1286
|
+
</dl>
|
|
1287
|
+
</details>
|
|
1288
|
+
|
|
1289
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">createpaymentintent</a>(...)</code></summary>
|
|
1290
|
+
<dl>
|
|
1291
|
+
<dd>
|
|
1292
|
+
|
|
1293
|
+
#### 🔌 Usage
|
|
1294
|
+
|
|
1295
|
+
<dl>
|
|
1296
|
+
<dd>
|
|
1297
|
+
|
|
1298
|
+
<dl>
|
|
1299
|
+
<dd>
|
|
1300
|
+
|
|
1301
|
+
```python
|
|
1302
|
+
from mirascope.api._generated import Mirascope
|
|
1303
|
+
|
|
1304
|
+
client = Mirascope()
|
|
1305
|
+
client.organizations.createpaymentintent(
|
|
1306
|
+
id="id",
|
|
1307
|
+
amount=1.1,
|
|
1308
|
+
)
|
|
1309
|
+
|
|
1310
|
+
```
|
|
1311
|
+
</dd>
|
|
1312
|
+
</dl>
|
|
1313
|
+
</dd>
|
|
1314
|
+
</dl>
|
|
1315
|
+
|
|
1316
|
+
#### ⚙️ Parameters
|
|
1317
|
+
|
|
1318
|
+
<dl>
|
|
1319
|
+
<dd>
|
|
1320
|
+
|
|
1321
|
+
<dl>
|
|
1322
|
+
<dd>
|
|
1323
|
+
|
|
1324
|
+
**id:** `str`
|
|
1325
|
+
|
|
1326
|
+
</dd>
|
|
1327
|
+
</dl>
|
|
1328
|
+
|
|
1329
|
+
<dl>
|
|
1330
|
+
<dd>
|
|
1331
|
+
|
|
1332
|
+
**amount:** `float` — a positive number
|
|
1333
|
+
|
|
1334
|
+
</dd>
|
|
1335
|
+
</dl>
|
|
1336
|
+
|
|
1337
|
+
<dl>
|
|
1338
|
+
<dd>
|
|
1339
|
+
|
|
1340
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1341
|
+
|
|
1342
|
+
</dd>
|
|
1343
|
+
</dl>
|
|
1344
|
+
</dd>
|
|
1345
|
+
</dl>
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
</dd>
|
|
1349
|
+
</dl>
|
|
1350
|
+
</details>
|
|
1351
|
+
|
|
1352
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">subscription</a>(...)</code></summary>
|
|
1353
|
+
<dl>
|
|
1354
|
+
<dd>
|
|
1355
|
+
|
|
1356
|
+
#### 🔌 Usage
|
|
1357
|
+
|
|
1358
|
+
<dl>
|
|
1359
|
+
<dd>
|
|
1360
|
+
|
|
1361
|
+
<dl>
|
|
1362
|
+
<dd>
|
|
1363
|
+
|
|
1364
|
+
```python
|
|
1365
|
+
from mirascope.api._generated import Mirascope
|
|
1366
|
+
|
|
1367
|
+
client = Mirascope()
|
|
1368
|
+
client.organizations.subscription(
|
|
1369
|
+
id="id",
|
|
1370
|
+
)
|
|
1371
|
+
|
|
1372
|
+
```
|
|
1373
|
+
</dd>
|
|
1374
|
+
</dl>
|
|
1375
|
+
</dd>
|
|
1376
|
+
</dl>
|
|
1377
|
+
|
|
1378
|
+
#### ⚙️ Parameters
|
|
1379
|
+
|
|
1380
|
+
<dl>
|
|
1381
|
+
<dd>
|
|
1382
|
+
|
|
1383
|
+
<dl>
|
|
1384
|
+
<dd>
|
|
1385
|
+
|
|
1386
|
+
**id:** `str`
|
|
1387
|
+
|
|
1388
|
+
</dd>
|
|
1389
|
+
</dl>
|
|
1390
|
+
|
|
1391
|
+
<dl>
|
|
1392
|
+
<dd>
|
|
1393
|
+
|
|
1394
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1395
|
+
|
|
1396
|
+
</dd>
|
|
1397
|
+
</dl>
|
|
1398
|
+
</dd>
|
|
1399
|
+
</dl>
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
</dd>
|
|
1403
|
+
</dl>
|
|
1404
|
+
</details>
|
|
1405
|
+
|
|
1406
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">previewsubscriptionchange</a>(...)</code></summary>
|
|
1407
|
+
<dl>
|
|
1408
|
+
<dd>
|
|
1409
|
+
|
|
1410
|
+
#### 🔌 Usage
|
|
1411
|
+
|
|
1412
|
+
<dl>
|
|
1413
|
+
<dd>
|
|
1414
|
+
|
|
1415
|
+
<dl>
|
|
1416
|
+
<dd>
|
|
1417
|
+
|
|
1418
|
+
```python
|
|
1419
|
+
from mirascope.api._generated import Mirascope
|
|
1420
|
+
|
|
1421
|
+
client = Mirascope()
|
|
1422
|
+
client.organizations.previewsubscriptionchange(
|
|
1423
|
+
id="id",
|
|
1424
|
+
target_plan="free",
|
|
1425
|
+
)
|
|
1426
|
+
|
|
1427
|
+
```
|
|
1428
|
+
</dd>
|
|
1429
|
+
</dl>
|
|
1430
|
+
</dd>
|
|
1431
|
+
</dl>
|
|
1432
|
+
|
|
1433
|
+
#### ⚙️ Parameters
|
|
1434
|
+
|
|
1435
|
+
<dl>
|
|
1436
|
+
<dd>
|
|
1437
|
+
|
|
1438
|
+
<dl>
|
|
1439
|
+
<dd>
|
|
1440
|
+
|
|
1441
|
+
**id:** `str`
|
|
1442
|
+
|
|
1443
|
+
</dd>
|
|
1444
|
+
</dl>
|
|
1445
|
+
|
|
1446
|
+
<dl>
|
|
1447
|
+
<dd>
|
|
1448
|
+
|
|
1449
|
+
**target_plan:** `OrganizationsPreviewSubscriptionChangeRequestTargetPlan`
|
|
1450
|
+
|
|
1451
|
+
</dd>
|
|
1452
|
+
</dl>
|
|
1453
|
+
|
|
1454
|
+
<dl>
|
|
1455
|
+
<dd>
|
|
1456
|
+
|
|
1457
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1458
|
+
|
|
1459
|
+
</dd>
|
|
1460
|
+
</dl>
|
|
1461
|
+
</dd>
|
|
1462
|
+
</dl>
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
</dd>
|
|
1466
|
+
</dl>
|
|
1467
|
+
</details>
|
|
1468
|
+
|
|
1469
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">updatesubscription</a>(...)</code></summary>
|
|
1470
|
+
<dl>
|
|
1471
|
+
<dd>
|
|
1472
|
+
|
|
1473
|
+
#### 🔌 Usage
|
|
1474
|
+
|
|
1475
|
+
<dl>
|
|
1476
|
+
<dd>
|
|
1477
|
+
|
|
1478
|
+
<dl>
|
|
1479
|
+
<dd>
|
|
1480
|
+
|
|
1481
|
+
```python
|
|
1482
|
+
from mirascope.api._generated import Mirascope
|
|
1483
|
+
|
|
1484
|
+
client = Mirascope()
|
|
1485
|
+
client.organizations.updatesubscription(
|
|
1486
|
+
id="id",
|
|
1487
|
+
target_plan="free",
|
|
1488
|
+
)
|
|
1489
|
+
|
|
1490
|
+
```
|
|
1491
|
+
</dd>
|
|
1492
|
+
</dl>
|
|
1493
|
+
</dd>
|
|
1494
|
+
</dl>
|
|
1495
|
+
|
|
1496
|
+
#### ⚙️ Parameters
|
|
1497
|
+
|
|
1498
|
+
<dl>
|
|
1499
|
+
<dd>
|
|
1500
|
+
|
|
1501
|
+
<dl>
|
|
1502
|
+
<dd>
|
|
1503
|
+
|
|
1504
|
+
**id:** `str`
|
|
1505
|
+
|
|
1506
|
+
</dd>
|
|
1507
|
+
</dl>
|
|
1508
|
+
|
|
1509
|
+
<dl>
|
|
1510
|
+
<dd>
|
|
1511
|
+
|
|
1512
|
+
**target_plan:** `OrganizationsUpdateSubscriptionRequestTargetPlan`
|
|
1513
|
+
|
|
1514
|
+
</dd>
|
|
1515
|
+
</dl>
|
|
1516
|
+
|
|
1517
|
+
<dl>
|
|
1518
|
+
<dd>
|
|
1519
|
+
|
|
1520
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1521
|
+
|
|
1522
|
+
</dd>
|
|
1523
|
+
</dl>
|
|
1524
|
+
</dd>
|
|
1525
|
+
</dl>
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
</dd>
|
|
1529
|
+
</dl>
|
|
1530
|
+
</details>
|
|
1531
|
+
|
|
1532
|
+
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">cancelscheduleddowngrade</a>(...)</code></summary>
|
|
1533
|
+
<dl>
|
|
1534
|
+
<dd>
|
|
1535
|
+
|
|
1536
|
+
#### 🔌 Usage
|
|
1537
|
+
|
|
1538
|
+
<dl>
|
|
1539
|
+
<dd>
|
|
1540
|
+
|
|
1541
|
+
<dl>
|
|
1542
|
+
<dd>
|
|
1543
|
+
|
|
1544
|
+
```python
|
|
1545
|
+
from mirascope.api._generated import Mirascope
|
|
1546
|
+
|
|
1547
|
+
client = Mirascope()
|
|
1548
|
+
client.organizations.cancelscheduleddowngrade(
|
|
1549
|
+
id="id",
|
|
1550
|
+
)
|
|
1551
|
+
|
|
1552
|
+
```
|
|
1553
|
+
</dd>
|
|
1554
|
+
</dl>
|
|
1555
|
+
</dd>
|
|
1556
|
+
</dl>
|
|
1557
|
+
|
|
1558
|
+
#### ⚙️ Parameters
|
|
1559
|
+
|
|
1560
|
+
<dl>
|
|
1561
|
+
<dd>
|
|
1562
|
+
|
|
1563
|
+
<dl>
|
|
1564
|
+
<dd>
|
|
1565
|
+
|
|
1566
|
+
**id:** `str`
|
|
1567
|
+
|
|
1568
|
+
</dd>
|
|
1569
|
+
</dl>
|
|
1570
|
+
|
|
1571
|
+
<dl>
|
|
1572
|
+
<dd>
|
|
1573
|
+
|
|
1574
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1575
|
+
|
|
1576
|
+
</dd>
|
|
1577
|
+
</dl>
|
|
1578
|
+
</dd>
|
|
1579
|
+
</dl>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
</dd>
|
|
1583
|
+
</dl>
|
|
1584
|
+
</details>
|
|
1585
|
+
|
|
1586
|
+
## organization-invitations
|
|
1587
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">list</a>(...)</code></summary>
|
|
1588
|
+
<dl>
|
|
1589
|
+
<dd>
|
|
1590
|
+
|
|
1591
|
+
#### 🔌 Usage
|
|
1592
|
+
|
|
1593
|
+
<dl>
|
|
1594
|
+
<dd>
|
|
1595
|
+
|
|
1596
|
+
<dl>
|
|
1597
|
+
<dd>
|
|
1598
|
+
|
|
1599
|
+
```python
|
|
1600
|
+
from mirascope.api._generated import Mirascope
|
|
1601
|
+
|
|
1602
|
+
client = Mirascope()
|
|
1603
|
+
client.organization_invitations.list(
|
|
1604
|
+
organization_id="organizationId",
|
|
1605
|
+
)
|
|
1606
|
+
|
|
1607
|
+
```
|
|
1608
|
+
</dd>
|
|
1609
|
+
</dl>
|
|
1610
|
+
</dd>
|
|
1611
|
+
</dl>
|
|
1612
|
+
|
|
1613
|
+
#### ⚙️ Parameters
|
|
1614
|
+
|
|
1615
|
+
<dl>
|
|
1616
|
+
<dd>
|
|
1617
|
+
|
|
1618
|
+
<dl>
|
|
1619
|
+
<dd>
|
|
1620
|
+
|
|
1621
|
+
**organization_id:** `str`
|
|
1622
|
+
|
|
1623
|
+
</dd>
|
|
1624
|
+
</dl>
|
|
1625
|
+
|
|
1626
|
+
<dl>
|
|
1627
|
+
<dd>
|
|
1628
|
+
|
|
1629
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1630
|
+
|
|
1631
|
+
</dd>
|
|
1632
|
+
</dl>
|
|
1633
|
+
</dd>
|
|
1634
|
+
</dl>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
</dd>
|
|
1638
|
+
</dl>
|
|
1639
|
+
</details>
|
|
1640
|
+
|
|
1641
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">create</a>(...)</code></summary>
|
|
1642
|
+
<dl>
|
|
1643
|
+
<dd>
|
|
1644
|
+
|
|
1645
|
+
#### 🔌 Usage
|
|
1646
|
+
|
|
1647
|
+
<dl>
|
|
1648
|
+
<dd>
|
|
1649
|
+
|
|
1650
|
+
<dl>
|
|
1651
|
+
<dd>
|
|
1652
|
+
|
|
1653
|
+
```python
|
|
1654
|
+
from mirascope.api._generated import Mirascope
|
|
1655
|
+
|
|
1656
|
+
client = Mirascope()
|
|
1657
|
+
client.organization_invitations.create(
|
|
1658
|
+
organization_id="organizationId",
|
|
1659
|
+
recipient_email="recipientEmail",
|
|
1660
|
+
role="ADMIN",
|
|
1661
|
+
)
|
|
1662
|
+
|
|
1663
|
+
```
|
|
1664
|
+
</dd>
|
|
1665
|
+
</dl>
|
|
1666
|
+
</dd>
|
|
1667
|
+
</dl>
|
|
1668
|
+
|
|
1669
|
+
#### ⚙️ Parameters
|
|
1670
|
+
|
|
1671
|
+
<dl>
|
|
1672
|
+
<dd>
|
|
1673
|
+
|
|
1674
|
+
<dl>
|
|
1675
|
+
<dd>
|
|
1676
|
+
|
|
1677
|
+
**organization_id:** `str`
|
|
1678
|
+
|
|
1679
|
+
</dd>
|
|
1680
|
+
</dl>
|
|
1681
|
+
|
|
1682
|
+
<dl>
|
|
1683
|
+
<dd>
|
|
1684
|
+
|
|
1685
|
+
**recipient_email:** `str` — a string matching the pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$
|
|
1686
|
+
|
|
1687
|
+
</dd>
|
|
1688
|
+
</dl>
|
|
1689
|
+
|
|
1690
|
+
<dl>
|
|
1691
|
+
<dd>
|
|
1692
|
+
|
|
1693
|
+
**role:** `OrganizationInvitationsCreateRequestRole`
|
|
1694
|
+
|
|
1695
|
+
</dd>
|
|
1696
|
+
</dl>
|
|
1697
|
+
|
|
1698
|
+
<dl>
|
|
1699
|
+
<dd>
|
|
1700
|
+
|
|
1701
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1702
|
+
|
|
1703
|
+
</dd>
|
|
1704
|
+
</dl>
|
|
1705
|
+
</dd>
|
|
1706
|
+
</dl>
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
</dd>
|
|
1710
|
+
</dl>
|
|
1711
|
+
</details>
|
|
1712
|
+
|
|
1713
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">get</a>(...)</code></summary>
|
|
1714
|
+
<dl>
|
|
1715
|
+
<dd>
|
|
1716
|
+
|
|
1717
|
+
#### 🔌 Usage
|
|
1718
|
+
|
|
1719
|
+
<dl>
|
|
1720
|
+
<dd>
|
|
1721
|
+
|
|
1722
|
+
<dl>
|
|
1723
|
+
<dd>
|
|
1724
|
+
|
|
1725
|
+
```python
|
|
1726
|
+
from mirascope.api._generated import Mirascope
|
|
1727
|
+
|
|
1728
|
+
client = Mirascope()
|
|
1729
|
+
client.organization_invitations.get(
|
|
1730
|
+
organization_id="organizationId",
|
|
1731
|
+
invitation_id="invitationId",
|
|
1732
|
+
)
|
|
1733
|
+
|
|
1734
|
+
```
|
|
1735
|
+
</dd>
|
|
1736
|
+
</dl>
|
|
1737
|
+
</dd>
|
|
1738
|
+
</dl>
|
|
1739
|
+
|
|
1740
|
+
#### ⚙️ Parameters
|
|
1741
|
+
|
|
1742
|
+
<dl>
|
|
1743
|
+
<dd>
|
|
1744
|
+
|
|
1745
|
+
<dl>
|
|
1746
|
+
<dd>
|
|
1747
|
+
|
|
1748
|
+
**organization_id:** `str`
|
|
1749
|
+
|
|
1750
|
+
</dd>
|
|
1751
|
+
</dl>
|
|
1752
|
+
|
|
1753
|
+
<dl>
|
|
1754
|
+
<dd>
|
|
1755
|
+
|
|
1756
|
+
**invitation_id:** `str`
|
|
1757
|
+
|
|
1758
|
+
</dd>
|
|
1759
|
+
</dl>
|
|
1760
|
+
|
|
1761
|
+
<dl>
|
|
1762
|
+
<dd>
|
|
1763
|
+
|
|
1764
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1765
|
+
|
|
1766
|
+
</dd>
|
|
1767
|
+
</dl>
|
|
1768
|
+
</dd>
|
|
1769
|
+
</dl>
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
</dd>
|
|
1773
|
+
</dl>
|
|
1774
|
+
</details>
|
|
1775
|
+
|
|
1776
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">resend</a>(...)</code></summary>
|
|
1777
|
+
<dl>
|
|
1778
|
+
<dd>
|
|
1779
|
+
|
|
1780
|
+
#### 🔌 Usage
|
|
1781
|
+
|
|
1782
|
+
<dl>
|
|
1783
|
+
<dd>
|
|
1784
|
+
|
|
1785
|
+
<dl>
|
|
1786
|
+
<dd>
|
|
1787
|
+
|
|
1788
|
+
```python
|
|
1789
|
+
from mirascope.api._generated import Mirascope
|
|
1790
|
+
|
|
1791
|
+
client = Mirascope()
|
|
1792
|
+
client.organization_invitations.resend(
|
|
1793
|
+
organization_id="organizationId",
|
|
1794
|
+
invitation_id="invitationId",
|
|
1795
|
+
)
|
|
1796
|
+
|
|
1797
|
+
```
|
|
1798
|
+
</dd>
|
|
1799
|
+
</dl>
|
|
1800
|
+
</dd>
|
|
1801
|
+
</dl>
|
|
1802
|
+
|
|
1803
|
+
#### ⚙️ Parameters
|
|
1804
|
+
|
|
1805
|
+
<dl>
|
|
1806
|
+
<dd>
|
|
1807
|
+
|
|
1808
|
+
<dl>
|
|
1809
|
+
<dd>
|
|
1810
|
+
|
|
1811
|
+
**organization_id:** `str`
|
|
1812
|
+
|
|
1813
|
+
</dd>
|
|
1814
|
+
</dl>
|
|
1815
|
+
|
|
1816
|
+
<dl>
|
|
1817
|
+
<dd>
|
|
1818
|
+
|
|
1819
|
+
**invitation_id:** `str`
|
|
1820
|
+
|
|
1821
|
+
</dd>
|
|
1822
|
+
</dl>
|
|
1823
|
+
|
|
1824
|
+
<dl>
|
|
1825
|
+
<dd>
|
|
1826
|
+
|
|
1827
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1828
|
+
|
|
1829
|
+
</dd>
|
|
1830
|
+
</dl>
|
|
1831
|
+
</dd>
|
|
1832
|
+
</dl>
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
</dd>
|
|
1836
|
+
</dl>
|
|
1837
|
+
</details>
|
|
1838
|
+
|
|
1839
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">revoke</a>(...)</code></summary>
|
|
1840
|
+
<dl>
|
|
1841
|
+
<dd>
|
|
1842
|
+
|
|
1843
|
+
#### 🔌 Usage
|
|
1844
|
+
|
|
1845
|
+
<dl>
|
|
1846
|
+
<dd>
|
|
1847
|
+
|
|
1848
|
+
<dl>
|
|
1849
|
+
<dd>
|
|
1850
|
+
|
|
1851
|
+
```python
|
|
1852
|
+
from mirascope.api._generated import Mirascope
|
|
1853
|
+
|
|
1854
|
+
client = Mirascope()
|
|
1855
|
+
client.organization_invitations.revoke(
|
|
1856
|
+
organization_id="organizationId",
|
|
1857
|
+
invitation_id="invitationId",
|
|
1858
|
+
)
|
|
1859
|
+
|
|
1860
|
+
```
|
|
1861
|
+
</dd>
|
|
1862
|
+
</dl>
|
|
1863
|
+
</dd>
|
|
1864
|
+
</dl>
|
|
1865
|
+
|
|
1866
|
+
#### ⚙️ Parameters
|
|
1867
|
+
|
|
1868
|
+
<dl>
|
|
1869
|
+
<dd>
|
|
1870
|
+
|
|
1871
|
+
<dl>
|
|
1872
|
+
<dd>
|
|
1873
|
+
|
|
1874
|
+
**organization_id:** `str`
|
|
1875
|
+
|
|
1876
|
+
</dd>
|
|
1877
|
+
</dl>
|
|
1878
|
+
|
|
1879
|
+
<dl>
|
|
1880
|
+
<dd>
|
|
1881
|
+
|
|
1882
|
+
**invitation_id:** `str`
|
|
1883
|
+
|
|
1884
|
+
</dd>
|
|
1885
|
+
</dl>
|
|
1886
|
+
|
|
1887
|
+
<dl>
|
|
1888
|
+
<dd>
|
|
1889
|
+
|
|
1890
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1891
|
+
|
|
1892
|
+
</dd>
|
|
1893
|
+
</dl>
|
|
1894
|
+
</dd>
|
|
1895
|
+
</dl>
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
</dd>
|
|
1899
|
+
</dl>
|
|
1900
|
+
</details>
|
|
1901
|
+
|
|
1902
|
+
<details><summary><code>client.organization_invitations.<a href="src/mirascope/organization_invitations/client.py">accept</a>(...)</code></summary>
|
|
1903
|
+
<dl>
|
|
1904
|
+
<dd>
|
|
1905
|
+
|
|
1906
|
+
#### 🔌 Usage
|
|
1907
|
+
|
|
1908
|
+
<dl>
|
|
1909
|
+
<dd>
|
|
1910
|
+
|
|
1911
|
+
<dl>
|
|
1912
|
+
<dd>
|
|
1913
|
+
|
|
1914
|
+
```python
|
|
1915
|
+
from mirascope.api._generated import Mirascope
|
|
1916
|
+
|
|
1917
|
+
client = Mirascope()
|
|
1918
|
+
client.organization_invitations.accept(
|
|
1919
|
+
token="token",
|
|
1920
|
+
)
|
|
1921
|
+
|
|
1922
|
+
```
|
|
1923
|
+
</dd>
|
|
1924
|
+
</dl>
|
|
1925
|
+
</dd>
|
|
1926
|
+
</dl>
|
|
1927
|
+
|
|
1928
|
+
#### ⚙️ Parameters
|
|
1929
|
+
|
|
1930
|
+
<dl>
|
|
1931
|
+
<dd>
|
|
1932
|
+
|
|
1933
|
+
<dl>
|
|
1934
|
+
<dd>
|
|
1935
|
+
|
|
1936
|
+
**token:** `str`
|
|
1937
|
+
|
|
1938
|
+
</dd>
|
|
1939
|
+
</dl>
|
|
1940
|
+
|
|
1941
|
+
<dl>
|
|
1942
|
+
<dd>
|
|
1943
|
+
|
|
1944
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1945
|
+
|
|
1946
|
+
</dd>
|
|
1947
|
+
</dl>
|
|
1948
|
+
</dd>
|
|
1949
|
+
</dl>
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
</dd>
|
|
1953
|
+
</dl>
|
|
1954
|
+
</details>
|
|
1955
|
+
|
|
1956
|
+
## organization-memberships
|
|
1957
|
+
<details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">list</a>(...)</code></summary>
|
|
1958
|
+
<dl>
|
|
1959
|
+
<dd>
|
|
1960
|
+
|
|
1961
|
+
#### 🔌 Usage
|
|
1962
|
+
|
|
1963
|
+
<dl>
|
|
1964
|
+
<dd>
|
|
1965
|
+
|
|
1966
|
+
<dl>
|
|
1967
|
+
<dd>
|
|
1968
|
+
|
|
1969
|
+
```python
|
|
1970
|
+
from mirascope.api._generated import Mirascope
|
|
1971
|
+
|
|
1972
|
+
client = Mirascope()
|
|
1973
|
+
client.organization_memberships.list(
|
|
1974
|
+
organization_id="organizationId",
|
|
1975
|
+
)
|
|
1976
|
+
|
|
1977
|
+
```
|
|
1978
|
+
</dd>
|
|
1979
|
+
</dl>
|
|
1980
|
+
</dd>
|
|
1981
|
+
</dl>
|
|
1982
|
+
|
|
1983
|
+
#### ⚙️ Parameters
|
|
1984
|
+
|
|
1985
|
+
<dl>
|
|
1986
|
+
<dd>
|
|
1987
|
+
|
|
1988
|
+
<dl>
|
|
1989
|
+
<dd>
|
|
1990
|
+
|
|
1991
|
+
**organization_id:** `str`
|
|
1992
|
+
|
|
1993
|
+
</dd>
|
|
1994
|
+
</dl>
|
|
1995
|
+
|
|
1996
|
+
<dl>
|
|
1997
|
+
<dd>
|
|
1998
|
+
|
|
1999
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2000
|
+
|
|
2001
|
+
</dd>
|
|
2002
|
+
</dl>
|
|
2003
|
+
</dd>
|
|
2004
|
+
</dl>
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
</dd>
|
|
2008
|
+
</dl>
|
|
2009
|
+
</details>
|
|
2010
|
+
|
|
2011
|
+
<details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">delete</a>(...)</code></summary>
|
|
2012
|
+
<dl>
|
|
2013
|
+
<dd>
|
|
2014
|
+
|
|
2015
|
+
#### 🔌 Usage
|
|
2016
|
+
|
|
2017
|
+
<dl>
|
|
2018
|
+
<dd>
|
|
2019
|
+
|
|
2020
|
+
<dl>
|
|
2021
|
+
<dd>
|
|
2022
|
+
|
|
2023
|
+
```python
|
|
2024
|
+
from mirascope.api._generated import Mirascope
|
|
2025
|
+
|
|
2026
|
+
client = Mirascope()
|
|
2027
|
+
client.organization_memberships.delete(
|
|
2028
|
+
organization_id="organizationId",
|
|
2029
|
+
member_id="memberId",
|
|
2030
|
+
)
|
|
2031
|
+
|
|
2032
|
+
```
|
|
2033
|
+
</dd>
|
|
2034
|
+
</dl>
|
|
2035
|
+
</dd>
|
|
2036
|
+
</dl>
|
|
2037
|
+
|
|
2038
|
+
#### ⚙️ Parameters
|
|
2039
|
+
|
|
2040
|
+
<dl>
|
|
2041
|
+
<dd>
|
|
2042
|
+
|
|
2043
|
+
<dl>
|
|
2044
|
+
<dd>
|
|
2045
|
+
|
|
2046
|
+
**organization_id:** `str`
|
|
2047
|
+
|
|
2048
|
+
</dd>
|
|
2049
|
+
</dl>
|
|
2050
|
+
|
|
2051
|
+
<dl>
|
|
2052
|
+
<dd>
|
|
2053
|
+
|
|
2054
|
+
**member_id:** `str`
|
|
2055
|
+
|
|
2056
|
+
</dd>
|
|
2057
|
+
</dl>
|
|
2058
|
+
|
|
2059
|
+
<dl>
|
|
2060
|
+
<dd>
|
|
2061
|
+
|
|
2062
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2063
|
+
|
|
2064
|
+
</dd>
|
|
2065
|
+
</dl>
|
|
2066
|
+
</dd>
|
|
2067
|
+
</dl>
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
</dd>
|
|
2071
|
+
</dl>
|
|
2072
|
+
</details>
|
|
2073
|
+
|
|
2074
|
+
<details><summary><code>client.organization_memberships.<a href="src/mirascope/organization_memberships/client.py">update</a>(...)</code></summary>
|
|
2075
|
+
<dl>
|
|
2076
|
+
<dd>
|
|
2077
|
+
|
|
2078
|
+
#### 🔌 Usage
|
|
2079
|
+
|
|
2080
|
+
<dl>
|
|
2081
|
+
<dd>
|
|
2082
|
+
|
|
2083
|
+
<dl>
|
|
2084
|
+
<dd>
|
|
2085
|
+
|
|
2086
|
+
```python
|
|
2087
|
+
from mirascope.api._generated import Mirascope
|
|
2088
|
+
|
|
2089
|
+
client = Mirascope()
|
|
2090
|
+
client.organization_memberships.update(
|
|
2091
|
+
organization_id="organizationId",
|
|
2092
|
+
member_id="memberId",
|
|
2093
|
+
role="ADMIN",
|
|
2094
|
+
)
|
|
2095
|
+
|
|
2096
|
+
```
|
|
2097
|
+
</dd>
|
|
2098
|
+
</dl>
|
|
2099
|
+
</dd>
|
|
2100
|
+
</dl>
|
|
2101
|
+
|
|
2102
|
+
#### ⚙️ Parameters
|
|
2103
|
+
|
|
2104
|
+
<dl>
|
|
2105
|
+
<dd>
|
|
2106
|
+
|
|
2107
|
+
<dl>
|
|
2108
|
+
<dd>
|
|
2109
|
+
|
|
2110
|
+
**organization_id:** `str`
|
|
2111
|
+
|
|
2112
|
+
</dd>
|
|
2113
|
+
</dl>
|
|
2114
|
+
|
|
2115
|
+
<dl>
|
|
2116
|
+
<dd>
|
|
2117
|
+
|
|
2118
|
+
**member_id:** `str`
|
|
2119
|
+
|
|
2120
|
+
</dd>
|
|
2121
|
+
</dl>
|
|
2122
|
+
|
|
2123
|
+
<dl>
|
|
2124
|
+
<dd>
|
|
2125
|
+
|
|
2126
|
+
**role:** `OrganizationMembershipsUpdateRequestRole`
|
|
2127
|
+
|
|
2128
|
+
</dd>
|
|
2129
|
+
</dl>
|
|
2130
|
+
|
|
2131
|
+
<dl>
|
|
2132
|
+
<dd>
|
|
2133
|
+
|
|
2134
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2135
|
+
|
|
2136
|
+
</dd>
|
|
2137
|
+
</dl>
|
|
2138
|
+
</dd>
|
|
2139
|
+
</dl>
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
</dd>
|
|
2143
|
+
</dl>
|
|
2144
|
+
</details>
|
|
2145
|
+
|
|
2146
|
+
## projects
|
|
2147
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">list</a>(...)</code></summary>
|
|
2148
|
+
<dl>
|
|
2149
|
+
<dd>
|
|
2150
|
+
|
|
2151
|
+
#### 🔌 Usage
|
|
2152
|
+
|
|
2153
|
+
<dl>
|
|
2154
|
+
<dd>
|
|
2155
|
+
|
|
2156
|
+
<dl>
|
|
2157
|
+
<dd>
|
|
2158
|
+
|
|
2159
|
+
```python
|
|
2160
|
+
from mirascope.api._generated import Mirascope
|
|
2161
|
+
|
|
2162
|
+
client = Mirascope()
|
|
2163
|
+
client.projects.list(
|
|
2164
|
+
organization_id="organizationId",
|
|
2165
|
+
)
|
|
2166
|
+
|
|
2167
|
+
```
|
|
2168
|
+
</dd>
|
|
2169
|
+
</dl>
|
|
2170
|
+
</dd>
|
|
2171
|
+
</dl>
|
|
2172
|
+
|
|
2173
|
+
#### ⚙️ Parameters
|
|
2174
|
+
|
|
2175
|
+
<dl>
|
|
2176
|
+
<dd>
|
|
2177
|
+
|
|
2178
|
+
<dl>
|
|
2179
|
+
<dd>
|
|
2180
|
+
|
|
2181
|
+
**organization_id:** `str`
|
|
2182
|
+
|
|
2183
|
+
</dd>
|
|
2184
|
+
</dl>
|
|
2185
|
+
|
|
2186
|
+
<dl>
|
|
2187
|
+
<dd>
|
|
2188
|
+
|
|
2189
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2190
|
+
|
|
2191
|
+
</dd>
|
|
2192
|
+
</dl>
|
|
2193
|
+
</dd>
|
|
2194
|
+
</dl>
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
</dd>
|
|
2198
|
+
</dl>
|
|
2199
|
+
</details>
|
|
2200
|
+
|
|
2201
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">create</a>(...)</code></summary>
|
|
2202
|
+
<dl>
|
|
2203
|
+
<dd>
|
|
2204
|
+
|
|
2205
|
+
#### 🔌 Usage
|
|
2206
|
+
|
|
2207
|
+
<dl>
|
|
2208
|
+
<dd>
|
|
2209
|
+
|
|
2210
|
+
<dl>
|
|
2211
|
+
<dd>
|
|
2212
|
+
|
|
2213
|
+
```python
|
|
2214
|
+
from mirascope.api._generated import Mirascope
|
|
2215
|
+
|
|
2216
|
+
client = Mirascope()
|
|
2217
|
+
client.projects.create(
|
|
2218
|
+
organization_id="organizationId",
|
|
2219
|
+
name="name",
|
|
2220
|
+
slug="slug",
|
|
2221
|
+
)
|
|
2222
|
+
|
|
2223
|
+
```
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
</dd>
|
|
2227
|
+
</dl>
|
|
2228
|
+
|
|
2229
|
+
#### ⚙️ Parameters
|
|
2230
|
+
|
|
2231
|
+
<dl>
|
|
2232
|
+
<dd>
|
|
2233
|
+
|
|
2234
|
+
<dl>
|
|
2235
|
+
<dd>
|
|
2236
|
+
|
|
2237
|
+
**organization_id:** `str`
|
|
2238
|
+
|
|
2239
|
+
</dd>
|
|
2240
|
+
</dl>
|
|
2241
|
+
|
|
2242
|
+
<dl>
|
|
2243
|
+
<dd>
|
|
2244
|
+
|
|
2245
|
+
**name:** `str` — a string at most 100 character(s) long
|
|
2246
|
+
|
|
2247
|
+
</dd>
|
|
2248
|
+
</dl>
|
|
2249
|
+
|
|
2250
|
+
<dl>
|
|
2251
|
+
<dd>
|
|
2252
|
+
|
|
2253
|
+
**slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
2254
|
+
|
|
2255
|
+
</dd>
|
|
2256
|
+
</dl>
|
|
2257
|
+
|
|
2258
|
+
<dl>
|
|
2259
|
+
<dd>
|
|
2260
|
+
|
|
2261
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2262
|
+
|
|
2263
|
+
</dd>
|
|
2264
|
+
</dl>
|
|
2265
|
+
</dd>
|
|
2266
|
+
</dl>
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
</dd>
|
|
2270
|
+
</dl>
|
|
2271
|
+
</details>
|
|
2272
|
+
|
|
2273
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">get</a>(...)</code></summary>
|
|
2274
|
+
<dl>
|
|
2275
|
+
<dd>
|
|
2276
|
+
|
|
2277
|
+
#### 🔌 Usage
|
|
2278
|
+
|
|
2279
|
+
<dl>
|
|
2280
|
+
<dd>
|
|
2281
|
+
|
|
2282
|
+
<dl>
|
|
2283
|
+
<dd>
|
|
2284
|
+
|
|
2285
|
+
```python
|
|
2286
|
+
from mirascope.api._generated import Mirascope
|
|
2287
|
+
|
|
2288
|
+
client = Mirascope()
|
|
2289
|
+
client.projects.get(
|
|
2290
|
+
organization_id="organizationId",
|
|
2291
|
+
project_id="projectId",
|
|
2292
|
+
)
|
|
2293
|
+
|
|
2294
|
+
```
|
|
2295
|
+
</dd>
|
|
2296
|
+
</dl>
|
|
2297
|
+
</dd>
|
|
2298
|
+
</dl>
|
|
2299
|
+
|
|
2300
|
+
#### ⚙️ Parameters
|
|
2301
|
+
|
|
2302
|
+
<dl>
|
|
2303
|
+
<dd>
|
|
2304
|
+
|
|
2305
|
+
<dl>
|
|
2306
|
+
<dd>
|
|
2307
|
+
|
|
2308
|
+
**organization_id:** `str`
|
|
2309
|
+
|
|
2310
|
+
</dd>
|
|
2311
|
+
</dl>
|
|
2312
|
+
|
|
2313
|
+
<dl>
|
|
2314
|
+
<dd>
|
|
2315
|
+
|
|
2316
|
+
**project_id:** `str`
|
|
2317
|
+
|
|
2318
|
+
</dd>
|
|
2319
|
+
</dl>
|
|
2320
|
+
|
|
2321
|
+
<dl>
|
|
2322
|
+
<dd>
|
|
2323
|
+
|
|
2324
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2325
|
+
|
|
2326
|
+
</dd>
|
|
2327
|
+
</dl>
|
|
2328
|
+
</dd>
|
|
2329
|
+
</dl>
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
</dd>
|
|
2333
|
+
</dl>
|
|
2334
|
+
</details>
|
|
2335
|
+
|
|
2336
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">update</a>(...)</code></summary>
|
|
2337
|
+
<dl>
|
|
2338
|
+
<dd>
|
|
2339
|
+
|
|
2340
|
+
#### 🔌 Usage
|
|
2341
|
+
|
|
2342
|
+
<dl>
|
|
2343
|
+
<dd>
|
|
2344
|
+
|
|
2345
|
+
<dl>
|
|
2346
|
+
<dd>
|
|
2347
|
+
|
|
2348
|
+
```python
|
|
2349
|
+
from mirascope.api._generated import Mirascope
|
|
2350
|
+
|
|
2351
|
+
client = Mirascope()
|
|
2352
|
+
client.projects.update(
|
|
2353
|
+
organization_id="organizationId",
|
|
2354
|
+
project_id="projectId",
|
|
2355
|
+
)
|
|
2356
|
+
|
|
2357
|
+
```
|
|
2358
|
+
</dd>
|
|
2359
|
+
</dl>
|
|
2360
|
+
</dd>
|
|
2361
|
+
</dl>
|
|
2362
|
+
|
|
2363
|
+
#### ⚙️ Parameters
|
|
2364
|
+
|
|
2365
|
+
<dl>
|
|
2366
|
+
<dd>
|
|
2367
|
+
|
|
2368
|
+
<dl>
|
|
2369
|
+
<dd>
|
|
2370
|
+
|
|
2371
|
+
**organization_id:** `str`
|
|
2372
|
+
|
|
2373
|
+
</dd>
|
|
2374
|
+
</dl>
|
|
2375
|
+
|
|
2376
|
+
<dl>
|
|
2377
|
+
<dd>
|
|
2378
|
+
|
|
2379
|
+
**project_id:** `str`
|
|
2380
|
+
|
|
2381
|
+
</dd>
|
|
2382
|
+
</dl>
|
|
2383
|
+
|
|
2384
|
+
<dl>
|
|
2385
|
+
<dd>
|
|
2386
|
+
|
|
2387
|
+
**name:** `typing.Optional[str]` — a string at most 100 character(s) long
|
|
2388
|
+
|
|
2389
|
+
</dd>
|
|
2390
|
+
</dl>
|
|
2391
|
+
|
|
2392
|
+
<dl>
|
|
2393
|
+
<dd>
|
|
2394
|
+
|
|
2395
|
+
**slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
2396
|
+
|
|
2397
|
+
</dd>
|
|
2398
|
+
</dl>
|
|
2399
|
+
|
|
2400
|
+
<dl>
|
|
2401
|
+
<dd>
|
|
2402
|
+
|
|
2403
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2404
|
+
|
|
2405
|
+
</dd>
|
|
2406
|
+
</dl>
|
|
2407
|
+
</dd>
|
|
2408
|
+
</dl>
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
</dd>
|
|
2412
|
+
</dl>
|
|
2413
|
+
</details>
|
|
2414
|
+
|
|
2415
|
+
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">delete</a>(...)</code></summary>
|
|
2416
|
+
<dl>
|
|
2417
|
+
<dd>
|
|
2418
|
+
|
|
2419
|
+
#### 🔌 Usage
|
|
2420
|
+
|
|
2421
|
+
<dl>
|
|
2422
|
+
<dd>
|
|
2423
|
+
|
|
2424
|
+
<dl>
|
|
2425
|
+
<dd>
|
|
2426
|
+
|
|
2427
|
+
```python
|
|
2428
|
+
from mirascope.api._generated import Mirascope
|
|
2429
|
+
|
|
2430
|
+
client = Mirascope()
|
|
2431
|
+
client.projects.delete(
|
|
2432
|
+
organization_id="organizationId",
|
|
2433
|
+
project_id="projectId",
|
|
2434
|
+
)
|
|
2435
|
+
|
|
2436
|
+
```
|
|
2437
|
+
</dd>
|
|
2438
|
+
</dl>
|
|
2439
|
+
</dd>
|
|
2440
|
+
</dl>
|
|
2441
|
+
|
|
2442
|
+
#### ⚙️ Parameters
|
|
2443
|
+
|
|
2444
|
+
<dl>
|
|
2445
|
+
<dd>
|
|
2446
|
+
|
|
2447
|
+
<dl>
|
|
2448
|
+
<dd>
|
|
2449
|
+
|
|
2450
|
+
**organization_id:** `str`
|
|
2451
|
+
|
|
2452
|
+
</dd>
|
|
2453
|
+
</dl>
|
|
2454
|
+
|
|
2455
|
+
<dl>
|
|
2456
|
+
<dd>
|
|
2457
|
+
|
|
2458
|
+
**project_id:** `str`
|
|
2459
|
+
|
|
2460
|
+
</dd>
|
|
2461
|
+
</dl>
|
|
2462
|
+
|
|
2463
|
+
<dl>
|
|
2464
|
+
<dd>
|
|
2465
|
+
|
|
2466
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2467
|
+
|
|
2468
|
+
</dd>
|
|
2469
|
+
</dl>
|
|
2470
|
+
</dd>
|
|
2471
|
+
</dl>
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
</dd>
|
|
2475
|
+
</dl>
|
|
2476
|
+
</details>
|
|
2477
|
+
|
|
2478
|
+
## project-memberships
|
|
2479
|
+
<details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">list</a>(...)</code></summary>
|
|
2480
|
+
<dl>
|
|
2481
|
+
<dd>
|
|
2482
|
+
|
|
2483
|
+
#### 🔌 Usage
|
|
2484
|
+
|
|
2485
|
+
<dl>
|
|
2486
|
+
<dd>
|
|
2487
|
+
|
|
2488
|
+
<dl>
|
|
2489
|
+
<dd>
|
|
2490
|
+
|
|
2491
|
+
```python
|
|
2492
|
+
from mirascope.api._generated import Mirascope
|
|
2493
|
+
|
|
2494
|
+
client = Mirascope()
|
|
2495
|
+
client.project_memberships.list(
|
|
2496
|
+
organization_id="organizationId",
|
|
2497
|
+
project_id="projectId",
|
|
2498
|
+
)
|
|
2499
|
+
|
|
2500
|
+
```
|
|
2501
|
+
</dd>
|
|
2502
|
+
</dl>
|
|
2503
|
+
</dd>
|
|
2504
|
+
</dl>
|
|
2505
|
+
|
|
2506
|
+
#### ⚙️ Parameters
|
|
2507
|
+
|
|
2508
|
+
<dl>
|
|
2509
|
+
<dd>
|
|
2510
|
+
|
|
2511
|
+
<dl>
|
|
2512
|
+
<dd>
|
|
2513
|
+
|
|
2514
|
+
**organization_id:** `str`
|
|
2515
|
+
|
|
2516
|
+
</dd>
|
|
2517
|
+
</dl>
|
|
2518
|
+
|
|
2519
|
+
<dl>
|
|
2520
|
+
<dd>
|
|
2521
|
+
|
|
2522
|
+
**project_id:** `str`
|
|
2523
|
+
|
|
2524
|
+
</dd>
|
|
2525
|
+
</dl>
|
|
2526
|
+
|
|
2527
|
+
<dl>
|
|
2528
|
+
<dd>
|
|
2529
|
+
|
|
2530
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2531
|
+
|
|
2532
|
+
</dd>
|
|
2533
|
+
</dl>
|
|
2534
|
+
</dd>
|
|
2535
|
+
</dl>
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
</dd>
|
|
2539
|
+
</dl>
|
|
2540
|
+
</details>
|
|
2541
|
+
|
|
2542
|
+
<details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">create</a>(...)</code></summary>
|
|
2543
|
+
<dl>
|
|
2544
|
+
<dd>
|
|
2545
|
+
|
|
2546
|
+
#### 🔌 Usage
|
|
2547
|
+
|
|
2548
|
+
<dl>
|
|
2549
|
+
<dd>
|
|
2550
|
+
|
|
2551
|
+
<dl>
|
|
2552
|
+
<dd>
|
|
2553
|
+
|
|
2554
|
+
```python
|
|
2555
|
+
from mirascope.api._generated import Mirascope
|
|
2556
|
+
|
|
2557
|
+
client = Mirascope()
|
|
2558
|
+
client.project_memberships.create(
|
|
2559
|
+
organization_id="organizationId",
|
|
2560
|
+
project_id="projectId",
|
|
2561
|
+
member_id="memberId",
|
|
2562
|
+
role="ADMIN",
|
|
2563
|
+
)
|
|
2564
|
+
|
|
2565
|
+
```
|
|
2566
|
+
</dd>
|
|
2567
|
+
</dl>
|
|
2568
|
+
</dd>
|
|
2569
|
+
</dl>
|
|
2570
|
+
|
|
2571
|
+
#### ⚙️ Parameters
|
|
2572
|
+
|
|
2573
|
+
<dl>
|
|
2574
|
+
<dd>
|
|
2575
|
+
|
|
2576
|
+
<dl>
|
|
2577
|
+
<dd>
|
|
2578
|
+
|
|
2579
|
+
**organization_id:** `str`
|
|
2580
|
+
|
|
2581
|
+
</dd>
|
|
2582
|
+
</dl>
|
|
2583
|
+
|
|
2584
|
+
<dl>
|
|
2585
|
+
<dd>
|
|
2586
|
+
|
|
2587
|
+
**project_id:** `str`
|
|
2588
|
+
|
|
2589
|
+
</dd>
|
|
2590
|
+
</dl>
|
|
2591
|
+
|
|
2592
|
+
<dl>
|
|
2593
|
+
<dd>
|
|
2594
|
+
|
|
2595
|
+
**member_id:** `str`
|
|
2596
|
+
|
|
2597
|
+
</dd>
|
|
2598
|
+
</dl>
|
|
2599
|
+
|
|
2600
|
+
<dl>
|
|
2601
|
+
<dd>
|
|
2602
|
+
|
|
2603
|
+
**role:** `ProjectMembershipsCreateRequestRole`
|
|
2604
|
+
|
|
2605
|
+
</dd>
|
|
2606
|
+
</dl>
|
|
2607
|
+
|
|
2608
|
+
<dl>
|
|
2609
|
+
<dd>
|
|
2610
|
+
|
|
2611
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2612
|
+
|
|
2613
|
+
</dd>
|
|
2614
|
+
</dl>
|
|
2615
|
+
</dd>
|
|
2616
|
+
</dl>
|
|
2617
|
+
|
|
2618
|
+
|
|
2619
|
+
</dd>
|
|
2620
|
+
</dl>
|
|
2621
|
+
</details>
|
|
2622
|
+
|
|
2623
|
+
<details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">delete</a>(...)</code></summary>
|
|
2624
|
+
<dl>
|
|
2625
|
+
<dd>
|
|
2626
|
+
|
|
2627
|
+
#### 🔌 Usage
|
|
2628
|
+
|
|
2629
|
+
<dl>
|
|
2630
|
+
<dd>
|
|
2631
|
+
|
|
2632
|
+
<dl>
|
|
2633
|
+
<dd>
|
|
2634
|
+
|
|
2635
|
+
```python
|
|
2636
|
+
from mirascope.api._generated import Mirascope
|
|
2637
|
+
|
|
2638
|
+
client = Mirascope()
|
|
2639
|
+
client.project_memberships.delete(
|
|
2640
|
+
organization_id="organizationId",
|
|
2641
|
+
project_id="projectId",
|
|
2642
|
+
member_id="memberId",
|
|
2643
|
+
)
|
|
2644
|
+
|
|
2645
|
+
```
|
|
2646
|
+
</dd>
|
|
2647
|
+
</dl>
|
|
2648
|
+
</dd>
|
|
2649
|
+
</dl>
|
|
2650
|
+
|
|
2651
|
+
#### ⚙️ Parameters
|
|
2652
|
+
|
|
2653
|
+
<dl>
|
|
2654
|
+
<dd>
|
|
2655
|
+
|
|
2656
|
+
<dl>
|
|
2657
|
+
<dd>
|
|
2658
|
+
|
|
2659
|
+
**organization_id:** `str`
|
|
2660
|
+
|
|
2661
|
+
</dd>
|
|
2662
|
+
</dl>
|
|
2663
|
+
|
|
2664
|
+
<dl>
|
|
2665
|
+
<dd>
|
|
2666
|
+
|
|
2667
|
+
**project_id:** `str`
|
|
2668
|
+
|
|
2669
|
+
</dd>
|
|
2670
|
+
</dl>
|
|
2671
|
+
|
|
2672
|
+
<dl>
|
|
2673
|
+
<dd>
|
|
2674
|
+
|
|
2675
|
+
**member_id:** `str`
|
|
2676
|
+
|
|
2677
|
+
</dd>
|
|
2678
|
+
</dl>
|
|
2679
|
+
|
|
2680
|
+
<dl>
|
|
2681
|
+
<dd>
|
|
2682
|
+
|
|
2683
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2684
|
+
|
|
2685
|
+
</dd>
|
|
2686
|
+
</dl>
|
|
2687
|
+
</dd>
|
|
2688
|
+
</dl>
|
|
2689
|
+
|
|
2690
|
+
|
|
2691
|
+
</dd>
|
|
2692
|
+
</dl>
|
|
2693
|
+
</details>
|
|
2694
|
+
|
|
2695
|
+
<details><summary><code>client.project_memberships.<a href="src/mirascope/project_memberships/client.py">update</a>(...)</code></summary>
|
|
2696
|
+
<dl>
|
|
2697
|
+
<dd>
|
|
2698
|
+
|
|
2699
|
+
#### 🔌 Usage
|
|
2700
|
+
|
|
2701
|
+
<dl>
|
|
2702
|
+
<dd>
|
|
2703
|
+
|
|
2704
|
+
<dl>
|
|
2705
|
+
<dd>
|
|
2706
|
+
|
|
2707
|
+
```python
|
|
2708
|
+
from mirascope.api._generated import Mirascope
|
|
2709
|
+
|
|
2710
|
+
client = Mirascope()
|
|
2711
|
+
client.project_memberships.update(
|
|
2712
|
+
organization_id="organizationId",
|
|
2713
|
+
project_id="projectId",
|
|
2714
|
+
member_id="memberId",
|
|
2715
|
+
role="ADMIN",
|
|
2716
|
+
)
|
|
2717
|
+
|
|
2718
|
+
```
|
|
2719
|
+
</dd>
|
|
2720
|
+
</dl>
|
|
2721
|
+
</dd>
|
|
2722
|
+
</dl>
|
|
2723
|
+
|
|
2724
|
+
#### ⚙️ Parameters
|
|
2725
|
+
|
|
2726
|
+
<dl>
|
|
2727
|
+
<dd>
|
|
2728
|
+
|
|
2729
|
+
<dl>
|
|
2730
|
+
<dd>
|
|
2731
|
+
|
|
2732
|
+
**organization_id:** `str`
|
|
2733
|
+
|
|
2734
|
+
</dd>
|
|
2735
|
+
</dl>
|
|
2736
|
+
|
|
2737
|
+
<dl>
|
|
2738
|
+
<dd>
|
|
2739
|
+
|
|
2740
|
+
**project_id:** `str`
|
|
2741
|
+
|
|
2742
|
+
</dd>
|
|
2743
|
+
</dl>
|
|
2744
|
+
|
|
2745
|
+
<dl>
|
|
2746
|
+
<dd>
|
|
2747
|
+
|
|
2748
|
+
**member_id:** `str`
|
|
2749
|
+
|
|
2750
|
+
</dd>
|
|
2751
|
+
</dl>
|
|
2752
|
+
|
|
2753
|
+
<dl>
|
|
2754
|
+
<dd>
|
|
2755
|
+
|
|
2756
|
+
**role:** `ProjectMembershipsUpdateRequestRole`
|
|
2757
|
+
|
|
2758
|
+
</dd>
|
|
2759
|
+
</dl>
|
|
2760
|
+
|
|
2761
|
+
<dl>
|
|
2762
|
+
<dd>
|
|
2763
|
+
|
|
2764
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2765
|
+
|
|
2766
|
+
</dd>
|
|
2767
|
+
</dl>
|
|
2768
|
+
</dd>
|
|
2769
|
+
</dl>
|
|
2770
|
+
|
|
2771
|
+
|
|
2772
|
+
</dd>
|
|
2773
|
+
</dl>
|
|
2774
|
+
</details>
|
|
2775
|
+
|
|
2776
|
+
## environments
|
|
2777
|
+
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">list</a>(...)</code></summary>
|
|
2778
|
+
<dl>
|
|
2779
|
+
<dd>
|
|
2780
|
+
|
|
2781
|
+
#### 🔌 Usage
|
|
2782
|
+
|
|
2783
|
+
<dl>
|
|
2784
|
+
<dd>
|
|
2785
|
+
|
|
2786
|
+
<dl>
|
|
2787
|
+
<dd>
|
|
2788
|
+
|
|
2789
|
+
```python
|
|
2790
|
+
from mirascope.api._generated import Mirascope
|
|
2791
|
+
|
|
2792
|
+
client = Mirascope()
|
|
2793
|
+
client.environments.list(
|
|
2794
|
+
organization_id="organizationId",
|
|
2795
|
+
project_id="projectId",
|
|
2796
|
+
)
|
|
2797
|
+
|
|
2798
|
+
```
|
|
2799
|
+
</dd>
|
|
2800
|
+
</dl>
|
|
2801
|
+
</dd>
|
|
2802
|
+
</dl>
|
|
2803
|
+
|
|
2804
|
+
#### ⚙️ Parameters
|
|
2805
|
+
|
|
2806
|
+
<dl>
|
|
2807
|
+
<dd>
|
|
2808
|
+
|
|
2809
|
+
<dl>
|
|
2810
|
+
<dd>
|
|
2811
|
+
|
|
2812
|
+
**organization_id:** `str`
|
|
2813
|
+
|
|
2814
|
+
</dd>
|
|
2815
|
+
</dl>
|
|
2816
|
+
|
|
2817
|
+
<dl>
|
|
2818
|
+
<dd>
|
|
2819
|
+
|
|
2820
|
+
**project_id:** `str`
|
|
2821
|
+
|
|
2822
|
+
</dd>
|
|
2823
|
+
</dl>
|
|
2824
|
+
|
|
2825
|
+
<dl>
|
|
2826
|
+
<dd>
|
|
2827
|
+
|
|
2828
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2829
|
+
|
|
2830
|
+
</dd>
|
|
2831
|
+
</dl>
|
|
2832
|
+
</dd>
|
|
2833
|
+
</dl>
|
|
2834
|
+
|
|
2835
|
+
|
|
2836
|
+
</dd>
|
|
2837
|
+
</dl>
|
|
2838
|
+
</details>
|
|
2839
|
+
|
|
2840
|
+
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">create</a>(...)</code></summary>
|
|
2841
|
+
<dl>
|
|
2842
|
+
<dd>
|
|
2843
|
+
|
|
2844
|
+
#### 🔌 Usage
|
|
2845
|
+
|
|
2846
|
+
<dl>
|
|
2847
|
+
<dd>
|
|
2848
|
+
|
|
2849
|
+
<dl>
|
|
2850
|
+
<dd>
|
|
2851
|
+
|
|
2852
|
+
```python
|
|
2853
|
+
from mirascope.api._generated import Mirascope
|
|
2854
|
+
|
|
2855
|
+
client = Mirascope()
|
|
2856
|
+
client.environments.create(
|
|
2857
|
+
organization_id="organizationId",
|
|
2858
|
+
project_id="projectId",
|
|
2859
|
+
name="name",
|
|
2860
|
+
slug="slug",
|
|
2861
|
+
)
|
|
2862
|
+
|
|
2863
|
+
```
|
|
2864
|
+
</dd>
|
|
2865
|
+
</dl>
|
|
2866
|
+
</dd>
|
|
2867
|
+
</dl>
|
|
2868
|
+
|
|
2869
|
+
#### ⚙️ Parameters
|
|
2870
|
+
|
|
2871
|
+
<dl>
|
|
2872
|
+
<dd>
|
|
2873
|
+
|
|
2874
|
+
<dl>
|
|
2875
|
+
<dd>
|
|
2876
|
+
|
|
2877
|
+
**organization_id:** `str`
|
|
2878
|
+
|
|
2879
|
+
</dd>
|
|
2880
|
+
</dl>
|
|
2881
|
+
|
|
2882
|
+
<dl>
|
|
2883
|
+
<dd>
|
|
2884
|
+
|
|
2885
|
+
**project_id:** `str`
|
|
2886
|
+
|
|
2887
|
+
</dd>
|
|
2888
|
+
</dl>
|
|
2889
|
+
|
|
2890
|
+
<dl>
|
|
2891
|
+
<dd>
|
|
2892
|
+
|
|
2893
|
+
**name:** `str` — a string at most 100 character(s) long
|
|
2894
|
+
|
|
2895
|
+
</dd>
|
|
2896
|
+
</dl>
|
|
2897
|
+
|
|
2898
|
+
<dl>
|
|
2899
|
+
<dd>
|
|
2900
|
+
|
|
2901
|
+
**slug:** `str` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
2902
|
+
|
|
2903
|
+
</dd>
|
|
2904
|
+
</dl>
|
|
2905
|
+
|
|
2906
|
+
<dl>
|
|
2907
|
+
<dd>
|
|
2908
|
+
|
|
2909
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2910
|
+
|
|
2911
|
+
</dd>
|
|
2912
|
+
</dl>
|
|
2913
|
+
</dd>
|
|
2914
|
+
</dl>
|
|
2915
|
+
|
|
2916
|
+
|
|
2917
|
+
</dd>
|
|
2918
|
+
</dl>
|
|
2919
|
+
</details>
|
|
2920
|
+
|
|
2921
|
+
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">get</a>(...)</code></summary>
|
|
2922
|
+
<dl>
|
|
2923
|
+
<dd>
|
|
2924
|
+
|
|
2925
|
+
#### 🔌 Usage
|
|
2926
|
+
|
|
2927
|
+
<dl>
|
|
2928
|
+
<dd>
|
|
2929
|
+
|
|
2930
|
+
<dl>
|
|
2931
|
+
<dd>
|
|
2932
|
+
|
|
2933
|
+
```python
|
|
2934
|
+
from mirascope.api._generated import Mirascope
|
|
2935
|
+
|
|
2936
|
+
client = Mirascope()
|
|
2937
|
+
client.environments.get(
|
|
2938
|
+
organization_id="organizationId",
|
|
2939
|
+
project_id="projectId",
|
|
2940
|
+
environment_id="environmentId",
|
|
2941
|
+
)
|
|
2942
|
+
|
|
2943
|
+
```
|
|
2944
|
+
</dd>
|
|
2945
|
+
</dl>
|
|
2946
|
+
</dd>
|
|
2947
|
+
</dl>
|
|
2948
|
+
|
|
2949
|
+
#### ⚙️ Parameters
|
|
2950
|
+
|
|
2951
|
+
<dl>
|
|
2952
|
+
<dd>
|
|
2953
|
+
|
|
2954
|
+
<dl>
|
|
2955
|
+
<dd>
|
|
2956
|
+
|
|
2957
|
+
**organization_id:** `str`
|
|
2958
|
+
|
|
2959
|
+
</dd>
|
|
2960
|
+
</dl>
|
|
2961
|
+
|
|
2962
|
+
<dl>
|
|
2963
|
+
<dd>
|
|
2964
|
+
|
|
2965
|
+
**project_id:** `str`
|
|
2966
|
+
|
|
2967
|
+
</dd>
|
|
2968
|
+
</dl>
|
|
2969
|
+
|
|
2970
|
+
<dl>
|
|
2971
|
+
<dd>
|
|
2972
|
+
|
|
2973
|
+
**environment_id:** `str`
|
|
2974
|
+
|
|
2975
|
+
</dd>
|
|
2976
|
+
</dl>
|
|
2977
|
+
|
|
2978
|
+
<dl>
|
|
2979
|
+
<dd>
|
|
2980
|
+
|
|
2981
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2982
|
+
|
|
2983
|
+
</dd>
|
|
2984
|
+
</dl>
|
|
2985
|
+
</dd>
|
|
2986
|
+
</dl>
|
|
2987
|
+
|
|
2988
|
+
|
|
2989
|
+
</dd>
|
|
2990
|
+
</dl>
|
|
2991
|
+
</details>
|
|
2992
|
+
|
|
2993
|
+
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">update</a>(...)</code></summary>
|
|
2994
|
+
<dl>
|
|
2995
|
+
<dd>
|
|
2996
|
+
|
|
2997
|
+
#### 🔌 Usage
|
|
2998
|
+
|
|
2999
|
+
<dl>
|
|
3000
|
+
<dd>
|
|
3001
|
+
|
|
3002
|
+
<dl>
|
|
3003
|
+
<dd>
|
|
3004
|
+
|
|
3005
|
+
```python
|
|
3006
|
+
from mirascope.api._generated import Mirascope
|
|
3007
|
+
|
|
3008
|
+
client = Mirascope()
|
|
3009
|
+
client.environments.update(
|
|
3010
|
+
organization_id="organizationId",
|
|
3011
|
+
project_id="projectId",
|
|
3012
|
+
environment_id="environmentId",
|
|
3013
|
+
)
|
|
3014
|
+
|
|
3015
|
+
```
|
|
3016
|
+
</dd>
|
|
3017
|
+
</dl>
|
|
3018
|
+
</dd>
|
|
3019
|
+
</dl>
|
|
3020
|
+
|
|
3021
|
+
#### ⚙️ Parameters
|
|
3022
|
+
|
|
3023
|
+
<dl>
|
|
3024
|
+
<dd>
|
|
3025
|
+
|
|
3026
|
+
<dl>
|
|
3027
|
+
<dd>
|
|
3028
|
+
|
|
3029
|
+
**organization_id:** `str`
|
|
3030
|
+
|
|
3031
|
+
</dd>
|
|
3032
|
+
</dl>
|
|
3033
|
+
|
|
3034
|
+
<dl>
|
|
3035
|
+
<dd>
|
|
3036
|
+
|
|
3037
|
+
**project_id:** `str`
|
|
3038
|
+
|
|
3039
|
+
</dd>
|
|
3040
|
+
</dl>
|
|
3041
|
+
|
|
3042
|
+
<dl>
|
|
3043
|
+
<dd>
|
|
3044
|
+
|
|
3045
|
+
**environment_id:** `str`
|
|
3046
|
+
|
|
3047
|
+
</dd>
|
|
3048
|
+
</dl>
|
|
3049
|
+
|
|
3050
|
+
<dl>
|
|
3051
|
+
<dd>
|
|
3052
|
+
|
|
3053
|
+
**name:** `typing.Optional[str]` — a string at most 100 character(s) long
|
|
3054
|
+
|
|
3055
|
+
</dd>
|
|
3056
|
+
</dl>
|
|
3057
|
+
|
|
3058
|
+
<dl>
|
|
3059
|
+
<dd>
|
|
3060
|
+
|
|
3061
|
+
**slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
3062
|
+
|
|
3063
|
+
</dd>
|
|
3064
|
+
</dl>
|
|
3065
|
+
|
|
3066
|
+
<dl>
|
|
3067
|
+
<dd>
|
|
3068
|
+
|
|
3069
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
3070
|
+
|
|
3071
|
+
</dd>
|
|
3072
|
+
</dl>
|
|
3073
|
+
</dd>
|
|
3074
|
+
</dl>
|
|
3075
|
+
|
|
3076
|
+
|
|
3077
|
+
</dd>
|
|
3078
|
+
</dl>
|
|
3079
|
+
</details>
|
|
3080
|
+
|
|
3081
|
+
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">delete</a>(...)</code></summary>
|
|
3082
|
+
<dl>
|
|
3083
|
+
<dd>
|
|
3084
|
+
|
|
3085
|
+
#### 🔌 Usage
|
|
3086
|
+
|
|
3087
|
+
<dl>
|
|
3088
|
+
<dd>
|
|
3089
|
+
|
|
3090
|
+
<dl>
|
|
3091
|
+
<dd>
|
|
3092
|
+
|
|
3093
|
+
```python
|
|
3094
|
+
from mirascope.api._generated import Mirascope
|
|
3095
|
+
|
|
3096
|
+
client = Mirascope()
|
|
3097
|
+
client.environments.delete(
|
|
3098
|
+
organization_id="organizationId",
|
|
3099
|
+
project_id="projectId",
|
|
3100
|
+
environment_id="environmentId",
|
|
3101
|
+
)
|
|
3102
|
+
|
|
3103
|
+
```
|
|
3104
|
+
</dd>
|
|
3105
|
+
</dl>
|
|
3106
|
+
</dd>
|
|
3107
|
+
</dl>
|
|
3108
|
+
|
|
3109
|
+
#### ⚙️ Parameters
|
|
3110
|
+
|
|
3111
|
+
<dl>
|
|
3112
|
+
<dd>
|
|
3113
|
+
|
|
3114
|
+
<dl>
|
|
3115
|
+
<dd>
|
|
3116
|
+
|
|
3117
|
+
**organization_id:** `str`
|
|
3118
|
+
|
|
3119
|
+
</dd>
|
|
3120
|
+
</dl>
|
|
3121
|
+
|
|
3122
|
+
<dl>
|
|
3123
|
+
<dd>
|
|
3124
|
+
|
|
3125
|
+
**project_id:** `str`
|
|
3126
|
+
|
|
3127
|
+
</dd>
|
|
3128
|
+
</dl>
|
|
3129
|
+
|
|
3130
|
+
<dl>
|
|
3131
|
+
<dd>
|
|
3132
|
+
|
|
3133
|
+
**environment_id:** `str`
|
|
3134
|
+
|
|
3135
|
+
</dd>
|
|
3136
|
+
</dl>
|
|
3137
|
+
|
|
3138
|
+
<dl>
|
|
3139
|
+
<dd>
|
|
3140
|
+
|
|
3141
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
3142
|
+
|
|
3143
|
+
</dd>
|
|
3144
|
+
</dl>
|
|
3145
|
+
</dd>
|
|
3146
|
+
</dl>
|
|
3147
|
+
|
|
3148
|
+
|
|
3149
|
+
</dd>
|
|
3150
|
+
</dl>
|
|
3151
|
+
</details>
|
|
3152
|
+
|
|
3153
|
+
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">getanalytics</a>(...)</code></summary>
|
|
3154
|
+
<dl>
|
|
3155
|
+
<dd>
|
|
3156
|
+
|
|
3157
|
+
#### 🔌 Usage
|
|
3158
|
+
|
|
3159
|
+
<dl>
|
|
3160
|
+
<dd>
|
|
3161
|
+
|
|
3162
|
+
<dl>
|
|
3163
|
+
<dd>
|
|
3164
|
+
|
|
3165
|
+
```python
|
|
3166
|
+
from mirascope.api._generated import Mirascope
|
|
3167
|
+
|
|
3168
|
+
client = Mirascope()
|
|
3169
|
+
client.environments.getanalytics(
|
|
3170
|
+
organization_id="organizationId",
|
|
3171
|
+
project_id="projectId",
|
|
3172
|
+
environment_id="environmentId",
|
|
3173
|
+
start_time="startTime",
|
|
3174
|
+
end_time="endTime",
|
|
3175
|
+
)
|
|
3176
|
+
|
|
3177
|
+
```
|
|
3178
|
+
</dd>
|
|
3179
|
+
</dl>
|
|
3180
|
+
</dd>
|
|
3181
|
+
</dl>
|
|
3182
|
+
|
|
3183
|
+
#### ⚙️ Parameters
|
|
3184
|
+
|
|
3185
|
+
<dl>
|
|
3186
|
+
<dd>
|
|
3187
|
+
|
|
3188
|
+
<dl>
|
|
3189
|
+
<dd>
|
|
3190
|
+
|
|
3191
|
+
**organization_id:** `str`
|
|
3192
|
+
|
|
3193
|
+
</dd>
|
|
3194
|
+
</dl>
|
|
3195
|
+
|
|
3196
|
+
<dl>
|
|
3197
|
+
<dd>
|
|
3198
|
+
|
|
3199
|
+
**project_id:** `str`
|
|
3200
|
+
|
|
3201
|
+
</dd>
|
|
3202
|
+
</dl>
|
|
3203
|
+
|
|
3204
|
+
<dl>
|
|
3205
|
+
<dd>
|
|
3206
|
+
|
|
3207
|
+
**environment_id:** `str`
|
|
3208
|
+
|
|
3209
|
+
</dd>
|
|
3210
|
+
</dl>
|
|
3211
|
+
|
|
3212
|
+
<dl>
|
|
3213
|
+
<dd>
|
|
3214
|
+
|
|
3215
|
+
**start_time:** `str`
|
|
3216
|
+
|
|
3217
|
+
</dd>
|
|
3218
|
+
</dl>
|
|
3219
|
+
|
|
3220
|
+
<dl>
|
|
3221
|
+
<dd>
|
|
3222
|
+
|
|
3223
|
+
**end_time:** `str`
|
|
3224
|
+
|
|
3225
|
+
</dd>
|
|
3226
|
+
</dl>
|
|
3227
|
+
|
|
3228
|
+
<dl>
|
|
3229
|
+
<dd>
|
|
3230
|
+
|
|
3231
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
3232
|
+
|
|
3233
|
+
</dd>
|
|
3234
|
+
</dl>
|
|
3235
|
+
</dd>
|
|
3236
|
+
</dl>
|
|
3237
|
+
|
|
3238
|
+
|
|
3239
|
+
</dd>
|
|
3240
|
+
</dl>
|
|
3241
|
+
</details>
|
|
3242
|
+
|
|
3243
|
+
## apiKeys
|
|
3244
|
+
<details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_list_all_for_org</a>(...)</code></summary>
|
|
3245
|
+
<dl>
|
|
3246
|
+
<dd>
|
|
3247
|
+
|
|
3248
|
+
#### 🔌 Usage
|
|
3249
|
+
|
|
3250
|
+
<dl>
|
|
3251
|
+
<dd>
|
|
3252
|
+
|
|
3253
|
+
<dl>
|
|
3254
|
+
<dd>
|
|
3255
|
+
|
|
3256
|
+
```python
|
|
3257
|
+
from mirascope.api._generated import Mirascope
|
|
3258
|
+
|
|
3259
|
+
client = Mirascope()
|
|
3260
|
+
client.api_keys.api_keys_list_all_for_org(
|
|
3261
|
+
organization_id="organizationId",
|
|
3262
|
+
)
|
|
3263
|
+
|
|
3264
|
+
```
|
|
3265
|
+
</dd>
|
|
3266
|
+
</dl>
|
|
3267
|
+
</dd>
|
|
3268
|
+
</dl>
|
|
3269
|
+
|
|
3270
|
+
#### ⚙️ Parameters
|
|
3271
|
+
|
|
3272
|
+
<dl>
|
|
3273
|
+
<dd>
|
|
3274
|
+
|
|
3275
|
+
<dl>
|
|
3276
|
+
<dd>
|
|
3277
|
+
|
|
3278
|
+
**organization_id:** `str`
|
|
3279
|
+
|
|
3280
|
+
</dd>
|
|
3281
|
+
</dl>
|
|
3282
|
+
|
|
3283
|
+
<dl>
|
|
3284
|
+
<dd>
|
|
3285
|
+
|
|
3286
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
3287
|
+
|
|
3288
|
+
</dd>
|
|
3289
|
+
</dl>
|
|
3290
|
+
</dd>
|
|
3291
|
+
</dl>
|
|
3292
|
+
|
|
3293
|
+
|
|
3294
|
+
</dd>
|
|
3295
|
+
</dl>
|
|
3296
|
+
</details>
|
|
3297
|
+
|
|
3298
|
+
<details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_list</a>(...)</code></summary>
|
|
3299
|
+
<dl>
|
|
3300
|
+
<dd>
|
|
3301
|
+
|
|
3302
|
+
#### 🔌 Usage
|
|
3303
|
+
|
|
3304
|
+
<dl>
|
|
3305
|
+
<dd>
|
|
3306
|
+
|
|
3307
|
+
<dl>
|
|
3308
|
+
<dd>
|
|
3309
|
+
|
|
3310
|
+
```python
|
|
3311
|
+
from mirascope.api._generated import Mirascope
|
|
3312
|
+
|
|
3313
|
+
client = Mirascope()
|
|
3314
|
+
client.api_keys.api_keys_list(
|
|
3315
|
+
organization_id="organizationId",
|
|
3316
|
+
project_id="projectId",
|
|
3317
|
+
environment_id="environmentId",
|
|
3318
|
+
)
|
|
3319
|
+
|
|
3320
|
+
```
|
|
3321
|
+
</dd>
|
|
3322
|
+
</dl>
|
|
3323
|
+
</dd>
|
|
3324
|
+
</dl>
|
|
3325
|
+
|
|
3326
|
+
#### ⚙️ Parameters
|
|
3327
|
+
|
|
3328
|
+
<dl>
|
|
3329
|
+
<dd>
|
|
3330
|
+
|
|
3331
|
+
<dl>
|
|
3332
|
+
<dd>
|
|
3333
|
+
|
|
3334
|
+
**organization_id:** `str`
|
|
3335
|
+
|
|
3336
|
+
</dd>
|
|
3337
|
+
</dl>
|
|
3338
|
+
|
|
3339
|
+
<dl>
|
|
3340
|
+
<dd>
|
|
3341
|
+
|
|
3342
|
+
**project_id:** `str`
|
|
3343
|
+
|
|
3344
|
+
</dd>
|
|
3345
|
+
</dl>
|
|
3346
|
+
|
|
3347
|
+
<dl>
|
|
3348
|
+
<dd>
|
|
3349
|
+
|
|
3350
|
+
**environment_id:** `str`
|
|
3351
|
+
|
|
3352
|
+
</dd>
|
|
3353
|
+
</dl>
|
|
3354
|
+
|
|
3355
|
+
<dl>
|
|
3356
|
+
<dd>
|
|
3357
|
+
|
|
3358
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
3359
|
+
|
|
3360
|
+
</dd>
|
|
3361
|
+
</dl>
|
|
3362
|
+
</dd>
|
|
3363
|
+
</dl>
|
|
3364
|
+
|
|
3365
|
+
|
|
3366
|
+
</dd>
|
|
3367
|
+
</dl>
|
|
3368
|
+
</details>
|
|
3369
|
+
|
|
3370
|
+
<details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_create</a>(...)</code></summary>
|
|
3371
|
+
<dl>
|
|
3372
|
+
<dd>
|
|
3373
|
+
|
|
3374
|
+
#### 🔌 Usage
|
|
3375
|
+
|
|
3376
|
+
<dl>
|
|
3377
|
+
<dd>
|
|
3378
|
+
|
|
3379
|
+
<dl>
|
|
3380
|
+
<dd>
|
|
3381
|
+
|
|
3382
|
+
```python
|
|
3383
|
+
from mirascope.api._generated import Mirascope
|
|
3384
|
+
|
|
3385
|
+
client = Mirascope()
|
|
3386
|
+
client.api_keys.api_keys_create(
|
|
3387
|
+
organization_id="organizationId",
|
|
3388
|
+
project_id="projectId",
|
|
3389
|
+
environment_id="environmentId",
|
|
3390
|
+
name="name",
|
|
3391
|
+
)
|
|
141
3392
|
|
|
142
3393
|
```
|
|
143
3394
|
</dd>
|
|
@@ -153,6 +3404,38 @@ client.docs.openapi()
|
|
|
153
3404
|
<dl>
|
|
154
3405
|
<dd>
|
|
155
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
|
+
|
|
156
3439
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
157
3440
|
|
|
158
3441
|
</dd>
|
|
@@ -165,8 +3448,7 @@ client.docs.openapi()
|
|
|
165
3448
|
</dl>
|
|
166
3449
|
</details>
|
|
167
3450
|
|
|
168
|
-
|
|
169
|
-
<details><summary><code>client.organizations.<a href="src/mirascope/organizations/client.py">list</a>()</code></summary>
|
|
3451
|
+
<details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_get</a>(...)</code></summary>
|
|
170
3452
|
<dl>
|
|
171
3453
|
<dd>
|
|
172
3454
|
|
|
@@ -182,7 +3464,12 @@ client.docs.openapi()
|
|
|
182
3464
|
from mirascope.api._generated import Mirascope
|
|
183
3465
|
|
|
184
3466
|
client = Mirascope()
|
|
185
|
-
client.
|
|
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
|
+
)
|
|
186
3473
|
|
|
187
3474
|
```
|
|
188
3475
|
</dd>
|
|
@@ -198,6 +3485,38 @@ client.organizations.list()
|
|
|
198
3485
|
<dl>
|
|
199
3486
|
<dd>
|
|
200
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
|
+
|
|
201
3520
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
202
3521
|
|
|
203
3522
|
</dd>
|
|
@@ -210,7 +3529,7 @@ client.organizations.list()
|
|
|
210
3529
|
</dl>
|
|
211
3530
|
</details>
|
|
212
3531
|
|
|
213
|
-
<details><summary><code>client.
|
|
3532
|
+
<details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_delete</a>(...)</code></summary>
|
|
214
3533
|
<dl>
|
|
215
3534
|
<dd>
|
|
216
3535
|
|
|
@@ -226,9 +3545,11 @@ client.organizations.list()
|
|
|
226
3545
|
from mirascope.api._generated import Mirascope
|
|
227
3546
|
|
|
228
3547
|
client = Mirascope()
|
|
229
|
-
client.
|
|
230
|
-
|
|
231
|
-
|
|
3548
|
+
client.api_keys.api_keys_delete(
|
|
3549
|
+
organization_id="organizationId",
|
|
3550
|
+
project_id="projectId",
|
|
3551
|
+
environment_id="environmentId",
|
|
3552
|
+
api_key_id="apiKeyId",
|
|
232
3553
|
)
|
|
233
3554
|
|
|
234
3555
|
```
|
|
@@ -245,7 +3566,7 @@ client.organizations.create(
|
|
|
245
3566
|
<dl>
|
|
246
3567
|
<dd>
|
|
247
3568
|
|
|
248
|
-
**
|
|
3569
|
+
**organization_id:** `str`
|
|
249
3570
|
|
|
250
3571
|
</dd>
|
|
251
3572
|
</dl>
|
|
@@ -253,7 +3574,23 @@ client.organizations.create(
|
|
|
253
3574
|
<dl>
|
|
254
3575
|
<dd>
|
|
255
3576
|
|
|
256
|
-
**
|
|
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`
|
|
257
3594
|
|
|
258
3595
|
</dd>
|
|
259
3596
|
</dl>
|
|
@@ -273,7 +3610,52 @@ client.organizations.create(
|
|
|
273
3610
|
</dl>
|
|
274
3611
|
</details>
|
|
275
3612
|
|
|
276
|
-
|
|
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>
|
|
277
3659
|
<dl>
|
|
278
3660
|
<dd>
|
|
279
3661
|
|
|
@@ -285,29 +3667,99 @@ client.organizations.create(
|
|
|
285
3667
|
<dl>
|
|
286
3668
|
<dd>
|
|
287
3669
|
|
|
288
|
-
```python
|
|
289
|
-
from mirascope.api._generated import Mirascope
|
|
290
|
-
|
|
291
|
-
client = Mirascope()
|
|
292
|
-
client.
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
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
|
+
|
|
297
3738
|
</dd>
|
|
298
3739
|
</dl>
|
|
3740
|
+
|
|
3741
|
+
<dl>
|
|
3742
|
+
<dd>
|
|
3743
|
+
|
|
3744
|
+
**tags:** `typing.Optional[typing.Sequence[str]]`
|
|
3745
|
+
|
|
299
3746
|
</dd>
|
|
300
3747
|
</dl>
|
|
301
3748
|
|
|
302
|
-
#### ⚙️ Parameters
|
|
303
|
-
|
|
304
3749
|
<dl>
|
|
305
3750
|
<dd>
|
|
306
3751
|
|
|
3752
|
+
**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[str]]]`
|
|
3753
|
+
|
|
3754
|
+
</dd>
|
|
3755
|
+
</dl>
|
|
3756
|
+
|
|
307
3757
|
<dl>
|
|
308
3758
|
<dd>
|
|
309
3759
|
|
|
310
|
-
**
|
|
3760
|
+
**dependencies:** `typing.Optional[
|
|
3761
|
+
typing.Dict[str, typing.Optional[FunctionsCreateRequestDependenciesValue]]
|
|
3762
|
+
]`
|
|
311
3763
|
|
|
312
3764
|
</dd>
|
|
313
3765
|
</dl>
|
|
@@ -327,7 +3779,7 @@ client.organizations.get(
|
|
|
327
3779
|
</dl>
|
|
328
3780
|
</details>
|
|
329
3781
|
|
|
330
|
-
<details><summary><code>client.
|
|
3782
|
+
<details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">get</a>(...)</code></summary>
|
|
331
3783
|
<dl>
|
|
332
3784
|
<dd>
|
|
333
3785
|
|
|
@@ -343,7 +3795,7 @@ client.organizations.get(
|
|
|
343
3795
|
from mirascope.api._generated import Mirascope
|
|
344
3796
|
|
|
345
3797
|
client = Mirascope()
|
|
346
|
-
client.
|
|
3798
|
+
client.functions.get(
|
|
347
3799
|
id="id",
|
|
348
3800
|
)
|
|
349
3801
|
|
|
@@ -369,22 +3821,6 @@ client.organizations.update(
|
|
|
369
3821
|
<dl>
|
|
370
3822
|
<dd>
|
|
371
3823
|
|
|
372
|
-
**name:** `typing.Optional[str]` — a string at most 100 character(s) long
|
|
373
|
-
|
|
374
|
-
</dd>
|
|
375
|
-
</dl>
|
|
376
|
-
|
|
377
|
-
<dl>
|
|
378
|
-
<dd>
|
|
379
|
-
|
|
380
|
-
**slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
381
|
-
|
|
382
|
-
</dd>
|
|
383
|
-
</dl>
|
|
384
|
-
|
|
385
|
-
<dl>
|
|
386
|
-
<dd>
|
|
387
|
-
|
|
388
3824
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
389
3825
|
|
|
390
3826
|
</dd>
|
|
@@ -397,7 +3833,7 @@ client.organizations.update(
|
|
|
397
3833
|
</dl>
|
|
398
3834
|
</details>
|
|
399
3835
|
|
|
400
|
-
<details><summary><code>client.
|
|
3836
|
+
<details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">delete</a>(...)</code></summary>
|
|
401
3837
|
<dl>
|
|
402
3838
|
<dd>
|
|
403
3839
|
|
|
@@ -413,7 +3849,7 @@ client.organizations.update(
|
|
|
413
3849
|
from mirascope.api._generated import Mirascope
|
|
414
3850
|
|
|
415
3851
|
client = Mirascope()
|
|
416
|
-
client.
|
|
3852
|
+
client.functions.delete(
|
|
417
3853
|
id="id",
|
|
418
3854
|
)
|
|
419
3855
|
|
|
@@ -451,8 +3887,7 @@ client.organizations.delete(
|
|
|
451
3887
|
</dl>
|
|
452
3888
|
</details>
|
|
453
3889
|
|
|
454
|
-
|
|
455
|
-
<details><summary><code>client.projects.<a href="src/mirascope/projects/client.py">list</a>(...)</code></summary>
|
|
3890
|
+
<details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">findbyhash</a>(...)</code></summary>
|
|
456
3891
|
<dl>
|
|
457
3892
|
<dd>
|
|
458
3893
|
|
|
@@ -468,8 +3903,8 @@ client.organizations.delete(
|
|
|
468
3903
|
from mirascope.api._generated import Mirascope
|
|
469
3904
|
|
|
470
3905
|
client = Mirascope()
|
|
471
|
-
client.
|
|
472
|
-
|
|
3906
|
+
client.functions.findbyhash(
|
|
3907
|
+
hash="hash",
|
|
473
3908
|
)
|
|
474
3909
|
|
|
475
3910
|
```
|
|
@@ -486,7 +3921,7 @@ client.projects.list(
|
|
|
486
3921
|
<dl>
|
|
487
3922
|
<dd>
|
|
488
3923
|
|
|
489
|
-
**
|
|
3924
|
+
**hash:** `str`
|
|
490
3925
|
|
|
491
3926
|
</dd>
|
|
492
3927
|
</dl>
|
|
@@ -506,7 +3941,7 @@ client.projects.list(
|
|
|
506
3941
|
</dl>
|
|
507
3942
|
</details>
|
|
508
3943
|
|
|
509
|
-
<details><summary><code>client.
|
|
3944
|
+
<details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">getbyenv</a>(...)</code></summary>
|
|
510
3945
|
<dl>
|
|
511
3946
|
<dd>
|
|
512
3947
|
|
|
@@ -522,10 +3957,11 @@ client.projects.list(
|
|
|
522
3957
|
from mirascope.api._generated import Mirascope
|
|
523
3958
|
|
|
524
3959
|
client = Mirascope()
|
|
525
|
-
client.
|
|
3960
|
+
client.functions.getbyenv(
|
|
526
3961
|
organization_id="organizationId",
|
|
527
|
-
|
|
528
|
-
|
|
3962
|
+
project_id="projectId",
|
|
3963
|
+
environment_id="environmentId",
|
|
3964
|
+
function_id="functionId",
|
|
529
3965
|
)
|
|
530
3966
|
|
|
531
3967
|
```
|
|
@@ -550,7 +3986,7 @@ client.projects.create(
|
|
|
550
3986
|
<dl>
|
|
551
3987
|
<dd>
|
|
552
3988
|
|
|
553
|
-
**
|
|
3989
|
+
**project_id:** `str`
|
|
554
3990
|
|
|
555
3991
|
</dd>
|
|
556
3992
|
</dl>
|
|
@@ -558,7 +3994,15 @@ client.projects.create(
|
|
|
558
3994
|
<dl>
|
|
559
3995
|
<dd>
|
|
560
3996
|
|
|
561
|
-
**
|
|
3997
|
+
**environment_id:** `str`
|
|
3998
|
+
|
|
3999
|
+
</dd>
|
|
4000
|
+
</dl>
|
|
4001
|
+
|
|
4002
|
+
<dl>
|
|
4003
|
+
<dd>
|
|
4004
|
+
|
|
4005
|
+
**function_id:** `str`
|
|
562
4006
|
|
|
563
4007
|
</dd>
|
|
564
4008
|
</dl>
|
|
@@ -578,7 +4022,7 @@ client.projects.create(
|
|
|
578
4022
|
</dl>
|
|
579
4023
|
</details>
|
|
580
4024
|
|
|
581
|
-
<details><summary><code>client.
|
|
4025
|
+
<details><summary><code>client.functions.<a href="src/mirascope/functions/client.py">listbyenv</a>(...)</code></summary>
|
|
582
4026
|
<dl>
|
|
583
4027
|
<dd>
|
|
584
4028
|
|
|
@@ -594,9 +4038,10 @@ client.projects.create(
|
|
|
594
4038
|
from mirascope.api._generated import Mirascope
|
|
595
4039
|
|
|
596
4040
|
client = Mirascope()
|
|
597
|
-
client.
|
|
4041
|
+
client.functions.listbyenv(
|
|
598
4042
|
organization_id="organizationId",
|
|
599
4043
|
project_id="projectId",
|
|
4044
|
+
environment_id="environmentId",
|
|
600
4045
|
)
|
|
601
4046
|
|
|
602
4047
|
```
|
|
@@ -629,6 +4074,14 @@ client.projects.get(
|
|
|
629
4074
|
<dl>
|
|
630
4075
|
<dd>
|
|
631
4076
|
|
|
4077
|
+
**environment_id:** `str`
|
|
4078
|
+
|
|
4079
|
+
</dd>
|
|
4080
|
+
</dl>
|
|
4081
|
+
|
|
4082
|
+
<dl>
|
|
4083
|
+
<dd>
|
|
4084
|
+
|
|
632
4085
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
633
4086
|
|
|
634
4087
|
</dd>
|
|
@@ -641,7 +4094,8 @@ client.projects.get(
|
|
|
641
4094
|
</dl>
|
|
642
4095
|
</details>
|
|
643
4096
|
|
|
644
|
-
|
|
4097
|
+
## annotations
|
|
4098
|
+
<details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">list</a>(...)</code></summary>
|
|
645
4099
|
<dl>
|
|
646
4100
|
<dd>
|
|
647
4101
|
|
|
@@ -657,10 +4111,7 @@ client.projects.get(
|
|
|
657
4111
|
from mirascope.api._generated import Mirascope
|
|
658
4112
|
|
|
659
4113
|
client = Mirascope()
|
|
660
|
-
client.
|
|
661
|
-
organization_id="organizationId",
|
|
662
|
-
project_id="projectId",
|
|
663
|
-
)
|
|
4114
|
+
client.annotations.list()
|
|
664
4115
|
|
|
665
4116
|
```
|
|
666
4117
|
</dd>
|
|
@@ -676,7 +4127,7 @@ client.projects.update(
|
|
|
676
4127
|
<dl>
|
|
677
4128
|
<dd>
|
|
678
4129
|
|
|
679
|
-
**
|
|
4130
|
+
**otel_trace_id:** `typing.Optional[str]`
|
|
680
4131
|
|
|
681
4132
|
</dd>
|
|
682
4133
|
</dl>
|
|
@@ -684,7 +4135,7 @@ client.projects.update(
|
|
|
684
4135
|
<dl>
|
|
685
4136
|
<dd>
|
|
686
4137
|
|
|
687
|
-
**
|
|
4138
|
+
**otel_span_id:** `typing.Optional[str]`
|
|
688
4139
|
|
|
689
4140
|
</dd>
|
|
690
4141
|
</dl>
|
|
@@ -692,7 +4143,7 @@ client.projects.update(
|
|
|
692
4143
|
<dl>
|
|
693
4144
|
<dd>
|
|
694
4145
|
|
|
695
|
-
**
|
|
4146
|
+
**label:** `typing.Optional[AnnotationsListRequestLabel]`
|
|
696
4147
|
|
|
697
4148
|
</dd>
|
|
698
4149
|
</dl>
|
|
@@ -700,7 +4151,15 @@ client.projects.update(
|
|
|
700
4151
|
<dl>
|
|
701
4152
|
<dd>
|
|
702
4153
|
|
|
703
|
-
**
|
|
4154
|
+
**limit:** `typing.Optional[NumberFromString]`
|
|
4155
|
+
|
|
4156
|
+
</dd>
|
|
4157
|
+
</dl>
|
|
4158
|
+
|
|
4159
|
+
<dl>
|
|
4160
|
+
<dd>
|
|
4161
|
+
|
|
4162
|
+
**offset:** `typing.Optional[NumberFromString]`
|
|
704
4163
|
|
|
705
4164
|
</dd>
|
|
706
4165
|
</dl>
|
|
@@ -720,7 +4179,7 @@ client.projects.update(
|
|
|
720
4179
|
</dl>
|
|
721
4180
|
</details>
|
|
722
4181
|
|
|
723
|
-
<details><summary><code>client.
|
|
4182
|
+
<details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">create</a>(...)</code></summary>
|
|
724
4183
|
<dl>
|
|
725
4184
|
<dd>
|
|
726
4185
|
|
|
@@ -736,9 +4195,9 @@ client.projects.update(
|
|
|
736
4195
|
from mirascope.api._generated import Mirascope
|
|
737
4196
|
|
|
738
4197
|
client = Mirascope()
|
|
739
|
-
client.
|
|
740
|
-
|
|
741
|
-
|
|
4198
|
+
client.annotations.create(
|
|
4199
|
+
otel_span_id="otelSpanId",
|
|
4200
|
+
otel_trace_id="otelTraceId",
|
|
742
4201
|
)
|
|
743
4202
|
|
|
744
4203
|
```
|
|
@@ -755,7 +4214,7 @@ client.projects.delete(
|
|
|
755
4214
|
<dl>
|
|
756
4215
|
<dd>
|
|
757
4216
|
|
|
758
|
-
**
|
|
4217
|
+
**otel_span_id:** `str`
|
|
759
4218
|
|
|
760
4219
|
</dd>
|
|
761
4220
|
</dl>
|
|
@@ -763,7 +4222,39 @@ client.projects.delete(
|
|
|
763
4222
|
<dl>
|
|
764
4223
|
<dd>
|
|
765
4224
|
|
|
766
|
-
**
|
|
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]]`
|
|
767
4258
|
|
|
768
4259
|
</dd>
|
|
769
4260
|
</dl>
|
|
@@ -783,8 +4274,7 @@ client.projects.delete(
|
|
|
783
4274
|
</dl>
|
|
784
4275
|
</details>
|
|
785
4276
|
|
|
786
|
-
|
|
787
|
-
<details><summary><code>client.environments.<a href="src/mirascope/environments/client.py">list</a>(...)</code></summary>
|
|
4277
|
+
<details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">get</a>(...)</code></summary>
|
|
788
4278
|
<dl>
|
|
789
4279
|
<dd>
|
|
790
4280
|
|
|
@@ -800,9 +4290,8 @@ client.projects.delete(
|
|
|
800
4290
|
from mirascope.api._generated import Mirascope
|
|
801
4291
|
|
|
802
4292
|
client = Mirascope()
|
|
803
|
-
client.
|
|
804
|
-
|
|
805
|
-
project_id="projectId",
|
|
4293
|
+
client.annotations.get(
|
|
4294
|
+
id="id",
|
|
806
4295
|
)
|
|
807
4296
|
|
|
808
4297
|
```
|
|
@@ -819,15 +4308,7 @@ client.environments.list(
|
|
|
819
4308
|
<dl>
|
|
820
4309
|
<dd>
|
|
821
4310
|
|
|
822
|
-
**
|
|
823
|
-
|
|
824
|
-
</dd>
|
|
825
|
-
</dl>
|
|
826
|
-
|
|
827
|
-
<dl>
|
|
828
|
-
<dd>
|
|
829
|
-
|
|
830
|
-
**project_id:** `str`
|
|
4311
|
+
**id:** `str`
|
|
831
4312
|
|
|
832
4313
|
</dd>
|
|
833
4314
|
</dl>
|
|
@@ -847,7 +4328,7 @@ client.environments.list(
|
|
|
847
4328
|
</dl>
|
|
848
4329
|
</details>
|
|
849
4330
|
|
|
850
|
-
<details><summary><code>client.
|
|
4331
|
+
<details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">update</a>(...)</code></summary>
|
|
851
4332
|
<dl>
|
|
852
4333
|
<dd>
|
|
853
4334
|
|
|
@@ -863,11 +4344,8 @@ client.environments.list(
|
|
|
863
4344
|
from mirascope.api._generated import Mirascope
|
|
864
4345
|
|
|
865
4346
|
client = Mirascope()
|
|
866
|
-
client.
|
|
867
|
-
|
|
868
|
-
project_id="projectId",
|
|
869
|
-
name="name",
|
|
870
|
-
slug="slug",
|
|
4347
|
+
client.annotations.update(
|
|
4348
|
+
id="id",
|
|
871
4349
|
)
|
|
872
4350
|
|
|
873
4351
|
```
|
|
@@ -884,7 +4362,7 @@ client.environments.create(
|
|
|
884
4362
|
<dl>
|
|
885
4363
|
<dd>
|
|
886
4364
|
|
|
887
|
-
**
|
|
4365
|
+
**id:** `str`
|
|
888
4366
|
|
|
889
4367
|
</dd>
|
|
890
4368
|
</dl>
|
|
@@ -892,7 +4370,7 @@ client.environments.create(
|
|
|
892
4370
|
<dl>
|
|
893
4371
|
<dd>
|
|
894
4372
|
|
|
895
|
-
**
|
|
4373
|
+
**label:** `typing.Optional[AnnotationsUpdateRequestLabel]`
|
|
896
4374
|
|
|
897
4375
|
</dd>
|
|
898
4376
|
</dl>
|
|
@@ -900,7 +4378,7 @@ client.environments.create(
|
|
|
900
4378
|
<dl>
|
|
901
4379
|
<dd>
|
|
902
4380
|
|
|
903
|
-
**
|
|
4381
|
+
**reasoning:** `typing.Optional[str]`
|
|
904
4382
|
|
|
905
4383
|
</dd>
|
|
906
4384
|
</dl>
|
|
@@ -908,7 +4386,15 @@ client.environments.create(
|
|
|
908
4386
|
<dl>
|
|
909
4387
|
<dd>
|
|
910
4388
|
|
|
911
|
-
**
|
|
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]]`
|
|
912
4398
|
|
|
913
4399
|
</dd>
|
|
914
4400
|
</dl>
|
|
@@ -928,7 +4414,7 @@ client.environments.create(
|
|
|
928
4414
|
</dl>
|
|
929
4415
|
</details>
|
|
930
4416
|
|
|
931
|
-
<details><summary><code>client.
|
|
4417
|
+
<details><summary><code>client.annotations.<a href="src/mirascope/annotations/client.py">delete</a>(...)</code></summary>
|
|
932
4418
|
<dl>
|
|
933
4419
|
<dd>
|
|
934
4420
|
|
|
@@ -944,10 +4430,8 @@ client.environments.create(
|
|
|
944
4430
|
from mirascope.api._generated import Mirascope
|
|
945
4431
|
|
|
946
4432
|
client = Mirascope()
|
|
947
|
-
client.
|
|
948
|
-
|
|
949
|
-
project_id="projectId",
|
|
950
|
-
environment_id="environmentId",
|
|
4433
|
+
client.annotations.delete(
|
|
4434
|
+
id="id",
|
|
951
4435
|
)
|
|
952
4436
|
|
|
953
4437
|
```
|
|
@@ -964,23 +4448,7 @@ client.environments.get(
|
|
|
964
4448
|
<dl>
|
|
965
4449
|
<dd>
|
|
966
4450
|
|
|
967
|
-
**
|
|
968
|
-
|
|
969
|
-
</dd>
|
|
970
|
-
</dl>
|
|
971
|
-
|
|
972
|
-
<dl>
|
|
973
|
-
<dd>
|
|
974
|
-
|
|
975
|
-
**project_id:** `str`
|
|
976
|
-
|
|
977
|
-
</dd>
|
|
978
|
-
</dl>
|
|
979
|
-
|
|
980
|
-
<dl>
|
|
981
|
-
<dd>
|
|
982
|
-
|
|
983
|
-
**environment_id:** `str`
|
|
4451
|
+
**id:** `str`
|
|
984
4452
|
|
|
985
4453
|
</dd>
|
|
986
4454
|
</dl>
|
|
@@ -1000,7 +4468,8 @@ client.environments.get(
|
|
|
1000
4468
|
</dl>
|
|
1001
4469
|
</details>
|
|
1002
4470
|
|
|
1003
|
-
|
|
4471
|
+
## tags
|
|
4472
|
+
<details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">list</a>(...)</code></summary>
|
|
1004
4473
|
<dl>
|
|
1005
4474
|
<dd>
|
|
1006
4475
|
|
|
@@ -1016,10 +4485,9 @@ client.environments.get(
|
|
|
1016
4485
|
from mirascope.api._generated import Mirascope
|
|
1017
4486
|
|
|
1018
4487
|
client = Mirascope()
|
|
1019
|
-
client.
|
|
4488
|
+
client.tags.list(
|
|
1020
4489
|
organization_id="organizationId",
|
|
1021
4490
|
project_id="projectId",
|
|
1022
|
-
environment_id="environmentId",
|
|
1023
4491
|
)
|
|
1024
4492
|
|
|
1025
4493
|
```
|
|
@@ -1052,30 +4520,6 @@ client.environments.update(
|
|
|
1052
4520
|
<dl>
|
|
1053
4521
|
<dd>
|
|
1054
4522
|
|
|
1055
|
-
**environment_id:** `str`
|
|
1056
|
-
|
|
1057
|
-
</dd>
|
|
1058
|
-
</dl>
|
|
1059
|
-
|
|
1060
|
-
<dl>
|
|
1061
|
-
<dd>
|
|
1062
|
-
|
|
1063
|
-
**name:** `typing.Optional[str]` — a string at most 100 character(s) long
|
|
1064
|
-
|
|
1065
|
-
</dd>
|
|
1066
|
-
</dl>
|
|
1067
|
-
|
|
1068
|
-
<dl>
|
|
1069
|
-
<dd>
|
|
1070
|
-
|
|
1071
|
-
**slug:** `typing.Optional[str]` — a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
|
|
1072
|
-
|
|
1073
|
-
</dd>
|
|
1074
|
-
</dl>
|
|
1075
|
-
|
|
1076
|
-
<dl>
|
|
1077
|
-
<dd>
|
|
1078
|
-
|
|
1079
4523
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1080
4524
|
|
|
1081
4525
|
</dd>
|
|
@@ -1088,7 +4532,7 @@ client.environments.update(
|
|
|
1088
4532
|
</dl>
|
|
1089
4533
|
</details>
|
|
1090
4534
|
|
|
1091
|
-
<details><summary><code>client.
|
|
4535
|
+
<details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">create</a>(...)</code></summary>
|
|
1092
4536
|
<dl>
|
|
1093
4537
|
<dd>
|
|
1094
4538
|
|
|
@@ -1104,10 +4548,10 @@ client.environments.update(
|
|
|
1104
4548
|
from mirascope.api._generated import Mirascope
|
|
1105
4549
|
|
|
1106
4550
|
client = Mirascope()
|
|
1107
|
-
client.
|
|
4551
|
+
client.tags.create(
|
|
1108
4552
|
organization_id="organizationId",
|
|
1109
4553
|
project_id="projectId",
|
|
1110
|
-
|
|
4554
|
+
name="name",
|
|
1111
4555
|
)
|
|
1112
4556
|
|
|
1113
4557
|
```
|
|
@@ -1140,7 +4584,7 @@ client.environments.delete(
|
|
|
1140
4584
|
<dl>
|
|
1141
4585
|
<dd>
|
|
1142
4586
|
|
|
1143
|
-
**
|
|
4587
|
+
**name:** `str` — a string at most 100 character(s) long
|
|
1144
4588
|
|
|
1145
4589
|
</dd>
|
|
1146
4590
|
</dl>
|
|
@@ -1160,8 +4604,7 @@ client.environments.delete(
|
|
|
1160
4604
|
</dl>
|
|
1161
4605
|
</details>
|
|
1162
4606
|
|
|
1163
|
-
|
|
1164
|
-
<details><summary><code>client.api_keys.<a href="src/mirascope/api_keys/client.py">api_keys_list</a>(...)</code></summary>
|
|
4607
|
+
<details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">get</a>(...)</code></summary>
|
|
1165
4608
|
<dl>
|
|
1166
4609
|
<dd>
|
|
1167
4610
|
|
|
@@ -1177,10 +4620,10 @@ client.environments.delete(
|
|
|
1177
4620
|
from mirascope.api._generated import Mirascope
|
|
1178
4621
|
|
|
1179
4622
|
client = Mirascope()
|
|
1180
|
-
client.
|
|
4623
|
+
client.tags.get(
|
|
1181
4624
|
organization_id="organizationId",
|
|
1182
4625
|
project_id="projectId",
|
|
1183
|
-
|
|
4626
|
+
tag_id="tagId",
|
|
1184
4627
|
)
|
|
1185
4628
|
|
|
1186
4629
|
```
|
|
@@ -1213,7 +4656,7 @@ client.api_keys.api_keys_list(
|
|
|
1213
4656
|
<dl>
|
|
1214
4657
|
<dd>
|
|
1215
4658
|
|
|
1216
|
-
**
|
|
4659
|
+
**tag_id:** `str`
|
|
1217
4660
|
|
|
1218
4661
|
</dd>
|
|
1219
4662
|
</dl>
|
|
@@ -1233,7 +4676,7 @@ client.api_keys.api_keys_list(
|
|
|
1233
4676
|
</dl>
|
|
1234
4677
|
</details>
|
|
1235
4678
|
|
|
1236
|
-
<details><summary><code>client.
|
|
4679
|
+
<details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">update</a>(...)</code></summary>
|
|
1237
4680
|
<dl>
|
|
1238
4681
|
<dd>
|
|
1239
4682
|
|
|
@@ -1249,11 +4692,10 @@ client.api_keys.api_keys_list(
|
|
|
1249
4692
|
from mirascope.api._generated import Mirascope
|
|
1250
4693
|
|
|
1251
4694
|
client = Mirascope()
|
|
1252
|
-
client.
|
|
4695
|
+
client.tags.update(
|
|
1253
4696
|
organization_id="organizationId",
|
|
1254
4697
|
project_id="projectId",
|
|
1255
|
-
|
|
1256
|
-
name="name",
|
|
4698
|
+
tag_id="tagId",
|
|
1257
4699
|
)
|
|
1258
4700
|
|
|
1259
4701
|
```
|
|
@@ -1286,7 +4728,7 @@ client.api_keys.api_keys_create(
|
|
|
1286
4728
|
<dl>
|
|
1287
4729
|
<dd>
|
|
1288
4730
|
|
|
1289
|
-
**
|
|
4731
|
+
**tag_id:** `str`
|
|
1290
4732
|
|
|
1291
4733
|
</dd>
|
|
1292
4734
|
</dl>
|
|
@@ -1294,7 +4736,7 @@ client.api_keys.api_keys_create(
|
|
|
1294
4736
|
<dl>
|
|
1295
4737
|
<dd>
|
|
1296
4738
|
|
|
1297
|
-
**name:** `str` — a string at most 100 character(s) long
|
|
4739
|
+
**name:** `typing.Optional[str]` — a string at most 100 character(s) long
|
|
1298
4740
|
|
|
1299
4741
|
</dd>
|
|
1300
4742
|
</dl>
|
|
@@ -1314,7 +4756,7 @@ client.api_keys.api_keys_create(
|
|
|
1314
4756
|
</dl>
|
|
1315
4757
|
</details>
|
|
1316
4758
|
|
|
1317
|
-
<details><summary><code>client.
|
|
4759
|
+
<details><summary><code>client.tags.<a href="src/mirascope/tags/client.py">delete</a>(...)</code></summary>
|
|
1318
4760
|
<dl>
|
|
1319
4761
|
<dd>
|
|
1320
4762
|
|
|
@@ -1330,11 +4772,10 @@ client.api_keys.api_keys_create(
|
|
|
1330
4772
|
from mirascope.api._generated import Mirascope
|
|
1331
4773
|
|
|
1332
4774
|
client = Mirascope()
|
|
1333
|
-
client.
|
|
4775
|
+
client.tags.delete(
|
|
1334
4776
|
organization_id="organizationId",
|
|
1335
4777
|
project_id="projectId",
|
|
1336
|
-
|
|
1337
|
-
api_key_id="apiKeyId",
|
|
4778
|
+
tag_id="tagId",
|
|
1338
4779
|
)
|
|
1339
4780
|
|
|
1340
4781
|
```
|
|
@@ -1367,15 +4808,7 @@ client.api_keys.api_keys_get(
|
|
|
1367
4808
|
<dl>
|
|
1368
4809
|
<dd>
|
|
1369
4810
|
|
|
1370
|
-
**
|
|
1371
|
-
|
|
1372
|
-
</dd>
|
|
1373
|
-
</dl>
|
|
1374
|
-
|
|
1375
|
-
<dl>
|
|
1376
|
-
<dd>
|
|
1377
|
-
|
|
1378
|
-
**api_key_id:** `str`
|
|
4811
|
+
**tag_id:** `str`
|
|
1379
4812
|
|
|
1380
4813
|
</dd>
|
|
1381
4814
|
</dl>
|
|
@@ -1395,7 +4828,8 @@ client.api_keys.api_keys_get(
|
|
|
1395
4828
|
</dl>
|
|
1396
4829
|
</details>
|
|
1397
4830
|
|
|
1398
|
-
|
|
4831
|
+
## token-cost
|
|
4832
|
+
<details><summary><code>client.token_cost.<a href="src/mirascope/token_cost/client.py">calculate</a>(...)</code></summary>
|
|
1399
4833
|
<dl>
|
|
1400
4834
|
<dd>
|
|
1401
4835
|
|
|
@@ -1409,13 +4843,16 @@ client.api_keys.api_keys_get(
|
|
|
1409
4843
|
|
|
1410
4844
|
```python
|
|
1411
4845
|
from mirascope.api._generated import Mirascope
|
|
4846
|
+
from mirascope.api._generated.token_cost import TokenCostCalculateRequestUsage
|
|
1412
4847
|
|
|
1413
4848
|
client = Mirascope()
|
|
1414
|
-
client.
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
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
|
+
),
|
|
1419
4856
|
)
|
|
1420
4857
|
|
|
1421
4858
|
```
|
|
@@ -1432,7 +4869,7 @@ client.api_keys.api_keys_delete(
|
|
|
1432
4869
|
<dl>
|
|
1433
4870
|
<dd>
|
|
1434
4871
|
|
|
1435
|
-
**
|
|
4872
|
+
**provider:** `str` — a non empty string
|
|
1436
4873
|
|
|
1437
4874
|
</dd>
|
|
1438
4875
|
</dl>
|
|
@@ -1440,7 +4877,7 @@ client.api_keys.api_keys_delete(
|
|
|
1440
4877
|
<dl>
|
|
1441
4878
|
<dd>
|
|
1442
4879
|
|
|
1443
|
-
**
|
|
4880
|
+
**model:** `str` — a non empty string
|
|
1444
4881
|
|
|
1445
4882
|
</dd>
|
|
1446
4883
|
</dl>
|
|
@@ -1448,7 +4885,7 @@ client.api_keys.api_keys_delete(
|
|
|
1448
4885
|
<dl>
|
|
1449
4886
|
<dd>
|
|
1450
4887
|
|
|
1451
|
-
**
|
|
4888
|
+
**usage:** `TokenCostCalculateRequestUsage`
|
|
1452
4889
|
|
|
1453
4890
|
</dd>
|
|
1454
4891
|
</dl>
|
|
@@ -1456,7 +4893,7 @@ client.api_keys.api_keys_delete(
|
|
|
1456
4893
|
<dl>
|
|
1457
4894
|
<dd>
|
|
1458
4895
|
|
|
1459
|
-
**
|
|
4896
|
+
**via_router:** `typing.Optional[bool]`
|
|
1460
4897
|
|
|
1461
4898
|
</dd>
|
|
1462
4899
|
</dl>
|