moi-product-sdk 0.1.0__tar.gz
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.
- moi_product_sdk-0.1.0/LICENSE +201 -0
- moi_product_sdk-0.1.0/PKG-INFO +306 -0
- moi_product_sdk-0.1.0/README.md +91 -0
- moi_product_sdk-0.1.0/moi_product_sdk/__init__.py +1922 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/__init__.py +0 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/__init__.py +0 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/account_pb2.py +100 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/agent_pb2.py +142 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/audit_pb2.py +41 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/catalog_common_pb2.py +130 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/catalog_file_pb2.py +82 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/compute_pb2.py +68 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/connector_pb2.py +128 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/conversation_pb2.py +65 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/dashboard_pb2.py +83 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/data_share_pb2.py +69 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/iam_pb2.py +194 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/memory_pb2.py +42 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/model_pb2.py +78 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/plugin_pb2.py +128 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/resource_tag_pb2.py +77 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/runtime_gateway_pb2.py +58 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/semantic_pb2.py +128 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/sql_pb2.py +115 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/workflow_pb2.py +269 -0
- moi_product_sdk-0.1.0/moi_product_sdk/_proto/product/workspace_pb2.py +81 -0
- moi_product_sdk-0.1.0/moi_product_sdk/agent_browser.py +83 -0
- moi_product_sdk-0.1.0/moi_product_sdk/client.py +15823 -0
- moi_product_sdk-0.1.0/moi_product_sdk/errors.py +121 -0
- moi_product_sdk-0.1.0/moi_product_sdk/routes.py +913 -0
- moi_product_sdk-0.1.0/moi_product_sdk/runner.py +43 -0
- moi_product_sdk-0.1.0/moi_product_sdk/sandbox.py +94 -0
- moi_product_sdk-0.1.0/moi_product_sdk.egg-info/PKG-INFO +306 -0
- moi_product_sdk-0.1.0/moi_product_sdk.egg-info/SOURCES.txt +153 -0
- moi_product_sdk-0.1.0/moi_product_sdk.egg-info/dependency_links.txt +1 -0
- moi_product_sdk-0.1.0/moi_product_sdk.egg-info/requires.txt +3 -0
- moi_product_sdk-0.1.0/moi_product_sdk.egg-info/top_level.txt +1 -0
- moi_product_sdk-0.1.0/pyproject.toml +13 -0
- moi_product_sdk-0.1.0/setup.cfg +4 -0
- moi_product_sdk-0.1.0/tests/test_account_http_contract.py +141 -0
- moi_product_sdk-0.1.0/tests/test_account_native_http_contract.py +67 -0
- moi_product_sdk-0.1.0/tests/test_agent_a2a_fold.py +300 -0
- moi_product_sdk-0.1.0/tests/test_agent_account_resource_http_contract.py +117 -0
- moi_product_sdk-0.1.0/tests/test_agent_browser.py +232 -0
- moi_product_sdk-0.1.0/tests/test_agent_channel_callback_http_contract.py +155 -0
- moi_product_sdk-0.1.0/tests/test_agent_discovery_http_contract.py +141 -0
- moi_product_sdk-0.1.0/tests/test_agent_ingress_http_contract.py +161 -0
- moi_product_sdk-0.1.0/tests/test_agent_package_http_contract.py +115 -0
- moi_product_sdk-0.1.0/tests/test_agent_plugin_http_contract.py +172 -0
- moi_product_sdk-0.1.0/tests/test_agent_protocol.py +185 -0
- moi_product_sdk-0.1.0/tests/test_agent_public_callback_contract.py +106 -0
- moi_product_sdk-0.1.0/tests/test_agent_resource_http_contract.py +149 -0
- moi_product_sdk-0.1.0/tests/test_agent_skill_confirmation_http_contract.py +99 -0
- moi_product_sdk-0.1.0/tests/test_agent_skill_special_http_contract.py +131 -0
- moi_product_sdk-0.1.0/tests/test_agent_team.py +182 -0
- moi_product_sdk-0.1.0/tests/test_ai_studio_http_contract.py +86 -0
- moi_product_sdk-0.1.0/tests/test_aistudio_service_slots_contract.py +81 -0
- moi_product_sdk-0.1.0/tests/test_audit_log_contract.py +62 -0
- moi_product_sdk-0.1.0/tests/test_catalog_allowed_actions.py +21 -0
- moi_product_sdk-0.1.0/tests/test_catalog_download_http_contract.py +85 -0
- moi_product_sdk-0.1.0/tests/test_catalog_file_contract.py +57 -0
- moi_product_sdk-0.1.0/tests/test_catalog_folder_http_contract.py +308 -0
- moi_product_sdk-0.1.0/tests/test_catalog_list_contract.py +55 -0
- moi_product_sdk-0.1.0/tests/test_catalog_navigation_contract.py +54 -0
- moi_product_sdk-0.1.0/tests/test_catalog_navigation_pagination.py +51 -0
- moi_product_sdk-0.1.0/tests/test_catalog_upload_http_contract.py +110 -0
- moi_product_sdk-0.1.0/tests/test_compute_allowed_actions.py +32 -0
- moi_product_sdk-0.1.0/tests/test_compute_options_contract.py +104 -0
- moi_product_sdk-0.1.0/tests/test_compute_remaining_http_contract.py +191 -0
- moi_product_sdk-0.1.0/tests/test_compute_workers_contract.py +87 -0
- moi_product_sdk-0.1.0/tests/test_connector_file_http_contract.py +147 -0
- moi_product_sdk-0.1.0/tests/test_connector_list_contract.py +67 -0
- moi_product_sdk-0.1.0/tests/test_connector_options_http_contract.py +376 -0
- moi_product_sdk-0.1.0/tests/test_conversation_http_contract.py +95 -0
- moi_product_sdk-0.1.0/tests/test_conversation_remaining_http_contract.py +125 -0
- moi_product_sdk-0.1.0/tests/test_current_principal.py +45 -0
- moi_product_sdk-0.1.0/tests/test_current_role.py +72 -0
- moi_product_sdk-0.1.0/tests/test_custom_operator_source.py +37 -0
- moi_product_sdk-0.1.0/tests/test_custom_operator_test_run_contract.py +122 -0
- moi_product_sdk-0.1.0/tests/test_dashboard_http_contract.py +117 -0
- moi_product_sdk-0.1.0/tests/test_dashboard_list_contract.py +66 -0
- moi_product_sdk-0.1.0/tests/test_dashboard_source_contract.py +31 -0
- moi_product_sdk-0.1.0/tests/test_data_share_http_contract.py +153 -0
- moi_product_sdk-0.1.0/tests/test_error_correlation.py +82 -0
- moi_product_sdk-0.1.0/tests/test_export_task_stats.py +20 -0
- moi_product_sdk-0.1.0/tests/test_frontend_missing_contract.py +93 -0
- moi_product_sdk-0.1.0/tests/test_iam.py +937 -0
- moi_product_sdk-0.1.0/tests/test_iam_query_http_contract.py +121 -0
- moi_product_sdk-0.1.0/tests/test_iam_read_http_contract.py +127 -0
- moi_product_sdk-0.1.0/tests/test_iam_write_http_contract.py +130 -0
- moi_product_sdk-0.1.0/tests/test_import_export_create_contract.py +147 -0
- moi_product_sdk-0.1.0/tests/test_import_task_contract.py +155 -0
- moi_product_sdk-0.1.0/tests/test_ingress_callback.py +54 -0
- moi_product_sdk-0.1.0/tests/test_kafka_schema_contract.py +41 -0
- moi_product_sdk-0.1.0/tests/test_knowledge_create_options_contract.py +59 -0
- moi_product_sdk-0.1.0/tests/test_knowledge_create_spec_contract.py +55 -0
- moi_product_sdk-0.1.0/tests/test_knowledge_download_http_contract.py +88 -0
- moi_product_sdk-0.1.0/tests/test_knowledge_lifecycle_http_contract.py +288 -0
- moi_product_sdk-0.1.0/tests/test_knowledge_runtime_http_contract.py +58 -0
- moi_product_sdk-0.1.0/tests/test_knowledge_source_retry.py +42 -0
- moi_product_sdk-0.1.0/tests/test_lineage_overview_degraded.py +74 -0
- moi_product_sdk-0.1.0/tests/test_member_deletion_contract.py +48 -0
- moi_product_sdk-0.1.0/tests/test_member_feedback_contract.py +74 -0
- moi_product_sdk-0.1.0/tests/test_misc_management_http_contract.py +142 -0
- moi_product_sdk-0.1.0/tests/test_missing_route_contract.py +31 -0
- moi_product_sdk-0.1.0/tests/test_mysql_import_capability.py +25 -0
- moi_product_sdk-0.1.0/tests/test_native_bootstrap.py +16 -0
- moi_product_sdk-0.1.0/tests/test_nullable_response_contract.py +68 -0
- moi_product_sdk-0.1.0/tests/test_plugins.py +440 -0
- moi_product_sdk-0.1.0/tests/test_product_error_details_contract.py +78 -0
- moi_product_sdk-0.1.0/tests/test_provider_backend_http_contract.py +240 -0
- moi_product_sdk-0.1.0/tests/test_provider_model_contract.py +60 -0
- moi_product_sdk-0.1.0/tests/test_provider_model_reasoning_efforts.py +106 -0
- moi_product_sdk-0.1.0/tests/test_query_history_scope.py +32 -0
- moi_product_sdk-0.1.0/tests/test_resource_tags.py +56 -0
- moi_product_sdk-0.1.0/tests/test_resource_tags_http_contract.py +86 -0
- moi_product_sdk-0.1.0/tests/test_response_body_timeout.py +43 -0
- moi_product_sdk-0.1.0/tests/test_runner.py +99 -0
- moi_product_sdk-0.1.0/tests/test_runner_sandbox_http_contract.py +102 -0
- moi_product_sdk-0.1.0/tests/test_runtime_artifact.py +151 -0
- moi_product_sdk-0.1.0/tests/test_runtime_gateway_contract.py +141 -0
- moi_product_sdk-0.1.0/tests/test_runtime_mcp_cancellation.py +62 -0
- moi_product_sdk-0.1.0/tests/test_sandbox.py +60 -0
- moi_product_sdk-0.1.0/tests/test_sandbox_network_error_contract.py +23 -0
- moi_product_sdk-0.1.0/tests/test_sandbox_terminal.py +157 -0
- moi_product_sdk-0.1.0/tests/test_sdk_19808.py +202 -0
- moi_product_sdk-0.1.0/tests/test_semantic_model_list_contract.py +66 -0
- moi_product_sdk-0.1.0/tests/test_skill_creator_contract.py +52 -0
- moi_product_sdk-0.1.0/tests/test_sql_options_contract.py +95 -0
- moi_product_sdk-0.1.0/tests/test_sql_remaining_http_contract.py +155 -0
- moi_product_sdk-0.1.0/tests/test_sql_stream_http_contract.py +71 -0
- moi_product_sdk-0.1.0/tests/test_sql_websocket_contract.py +192 -0
- moi_product_sdk-0.1.0/tests/test_sql_workbook_contract.py +48 -0
- moi_product_sdk-0.1.0/tests/test_system_http_contract.py +65 -0
- moi_product_sdk-0.1.0/tests/test_webapp_public_file_http_contract.py +126 -0
- moi_product_sdk-0.1.0/tests/test_webapp_public_http_contract.py +150 -0
- moi_product_sdk-0.1.0/tests/test_workflow_batch_retry.py +40 -0
- moi_product_sdk-0.1.0/tests/test_workflow_candidate_deploy.py +273 -0
- moi_product_sdk-0.1.0/tests/test_workflow_deploy_facade.py +71 -0
- moi_product_sdk-0.1.0/tests/test_workflow_detail_contract.py +56 -0
- moi_product_sdk-0.1.0/tests/test_workflow_dispatch_contract.py +37 -0
- moi_product_sdk-0.1.0/tests/test_workflow_list_contract.py +136 -0
- moi_product_sdk-0.1.0/tests/test_workflow_mowl_deploy.py +134 -0
- moi_product_sdk-0.1.0/tests/test_workflow_template_options_contract.py +76 -0
- moi_product_sdk-0.1.0/tests/test_workflow_versions_http_contract.py +486 -0
- moi_product_sdk-0.1.0/tests/test_workflow_worker_task_http_contract.py +84 -0
- moi_product_sdk-0.1.0/tests/test_workspace_chat_completion.py +83 -0
- moi_product_sdk-0.1.0/tests/test_workspace_chat_completion_contract.py +54 -0
- moi_product_sdk-0.1.0/tests/test_workspace_delete.py +43 -0
- moi_product_sdk-0.1.0/tests/test_workspace_facade.py +5053 -0
- moi_product_sdk-0.1.0/tests/test_workspace_file_list.py +47 -0
- moi_product_sdk-0.1.0/tests/test_workspace_http_contract.py +123 -0
- moi_product_sdk-0.1.0/tests/test_workspace_list_contract.py +57 -0
- moi_product_sdk-0.1.0/tests/test_workspace_member_http_contract.py +162 -0
- moi_product_sdk-0.1.0/tests/test_workspace_model_http_contract.py +150 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: moi-product-sdk
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: MOI product-level SDK
|
|
5
|
+
Author: Matrixflow
|
|
6
|
+
License: Apache License
|
|
7
|
+
Version 2.0, January 2004
|
|
8
|
+
http://www.apache.org/licenses/
|
|
9
|
+
|
|
10
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
11
|
+
|
|
12
|
+
1. Definitions.
|
|
13
|
+
|
|
14
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
15
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
16
|
+
|
|
17
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
18
|
+
the copyright owner that is granting the License.
|
|
19
|
+
|
|
20
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
21
|
+
other entities that control, are controlled by, or are under common
|
|
22
|
+
control with that entity. For the purposes of this definition,
|
|
23
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
24
|
+
direction or management of such entity, whether by contract or
|
|
25
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
26
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
27
|
+
|
|
28
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
29
|
+
exercising permissions granted by this License.
|
|
30
|
+
|
|
31
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
32
|
+
including but not limited to software source code, documentation
|
|
33
|
+
source, and configuration files.
|
|
34
|
+
|
|
35
|
+
"Object" form shall mean any form resulting from mechanical
|
|
36
|
+
transformation or translation of a Source form, including but
|
|
37
|
+
not limited to compiled object code, generated documentation,
|
|
38
|
+
and conversions to other media types.
|
|
39
|
+
|
|
40
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
41
|
+
Object form, made available under the License, as indicated by a
|
|
42
|
+
copyright notice that is included in or attached to the work
|
|
43
|
+
(an example is provided in the Appendix below).
|
|
44
|
+
|
|
45
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
46
|
+
form, that is based on (or derived from) the Work and for which the
|
|
47
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
48
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
49
|
+
of this License, Derivative Works shall not include works that remain
|
|
50
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
51
|
+
the Work and Derivative Works thereof.
|
|
52
|
+
|
|
53
|
+
"Contribution" shall mean any work of authorship, including
|
|
54
|
+
the original version of the Work and any modifications or additions
|
|
55
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
56
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
57
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
58
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
59
|
+
means any form of electronic, verbal, or written communication sent
|
|
60
|
+
to the Licensor or its representatives, including but not limited to
|
|
61
|
+
communication on electronic mailing lists, source code control systems,
|
|
62
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
63
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
64
|
+
excluding communication that is conspicuously marked or otherwise
|
|
65
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
66
|
+
|
|
67
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
68
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
69
|
+
subsequently incorporated within the Work.
|
|
70
|
+
|
|
71
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
72
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
73
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
74
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
75
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
76
|
+
Work and such Derivative Works in Source or Object form.
|
|
77
|
+
|
|
78
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
79
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
80
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
81
|
+
(except as stated in this section) patent license to make, have made,
|
|
82
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
83
|
+
where such license applies only to those patent claims licensable
|
|
84
|
+
by such Contributor that are necessarily infringed by their
|
|
85
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
86
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
87
|
+
institute patent litigation against any entity (including a
|
|
88
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
89
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
90
|
+
or contributory patent infringement, then any patent licenses
|
|
91
|
+
granted to You under this License for that Work shall terminate
|
|
92
|
+
as of the date such litigation is filed.
|
|
93
|
+
|
|
94
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
95
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
96
|
+
modifications, and in Source or Object form, provided that You
|
|
97
|
+
meet the following conditions:
|
|
98
|
+
|
|
99
|
+
(a) You must give any other recipients of the Work or
|
|
100
|
+
Derivative Works a copy of this License; and
|
|
101
|
+
|
|
102
|
+
(b) You must cause any modified files to carry prominent notices
|
|
103
|
+
stating that You changed the files; and
|
|
104
|
+
|
|
105
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
106
|
+
that You distribute, all copyright, patent, trademark, and
|
|
107
|
+
attribution notices from the Source form of the Work,
|
|
108
|
+
excluding those notices that do not pertain to any part of
|
|
109
|
+
the Derivative Works; and
|
|
110
|
+
|
|
111
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
112
|
+
distribution, then any Derivative Works that You distribute must
|
|
113
|
+
include a readable copy of the attribution notices contained
|
|
114
|
+
within such NOTICE file, excluding those notices that do not
|
|
115
|
+
pertain to any part of the Derivative Works, in at least one
|
|
116
|
+
of the following places: within a NOTICE text file distributed
|
|
117
|
+
as part of the Derivative Works; within the Source form or
|
|
118
|
+
documentation, if provided along with the Derivative Works; or,
|
|
119
|
+
within a display generated by the Derivative Works, if and
|
|
120
|
+
wherever such third-party notices normally appear. The contents
|
|
121
|
+
of the NOTICE file are for informational purposes only and
|
|
122
|
+
do not modify the License. You may add Your own attribution
|
|
123
|
+
notices within Derivative Works that You distribute, alongside
|
|
124
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
125
|
+
that such additional attribution notices cannot be construed
|
|
126
|
+
as modifying the License.
|
|
127
|
+
|
|
128
|
+
You may add Your own copyright statement to Your modifications and
|
|
129
|
+
may provide additional or different license terms and conditions
|
|
130
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
131
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
132
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
133
|
+
the conditions stated in this License.
|
|
134
|
+
|
|
135
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
136
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
137
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
138
|
+
this License, without any additional terms or conditions.
|
|
139
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
140
|
+
the terms of any separate license agreement you may have executed
|
|
141
|
+
with Licensor regarding such Contributions.
|
|
142
|
+
|
|
143
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
144
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
145
|
+
except as required for reasonable and customary use in describing the
|
|
146
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
147
|
+
|
|
148
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
149
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
150
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
151
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
152
|
+
implied, including, without limitation, any warranties or conditions
|
|
153
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
154
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
155
|
+
appropriateness of using or redistributing the Work and assume any
|
|
156
|
+
risks associated with Your exercise of permissions under this License.
|
|
157
|
+
|
|
158
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
159
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
160
|
+
unless required by applicable law (such as deliberate and grossly
|
|
161
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
162
|
+
liable to You for damages, including any direct, indirect, special,
|
|
163
|
+
incidental, or consequential damages of any character arising as a
|
|
164
|
+
result of this License or out of the use or inability to use the
|
|
165
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
166
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
167
|
+
other commercial damages or losses), even if such Contributor
|
|
168
|
+
has been advised of the possibility of such damages.
|
|
169
|
+
|
|
170
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
171
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
172
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
173
|
+
or other liability obligations and/or rights consistent with this
|
|
174
|
+
License. However, in accepting such obligations, You may act only
|
|
175
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
176
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
177
|
+
defend, and hold each Contributor harmless for any liability
|
|
178
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
179
|
+
of your accepting any such warranty or additional liability.
|
|
180
|
+
|
|
181
|
+
END OF TERMS AND CONDITIONS
|
|
182
|
+
|
|
183
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
184
|
+
|
|
185
|
+
To apply the Apache License to your work, attach the following
|
|
186
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
187
|
+
replaced with your own identifying information. (Don't include
|
|
188
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
189
|
+
comment syntax for the file format. We also recommend that a
|
|
190
|
+
file or class name and description of purpose be included on the
|
|
191
|
+
same "printed page" as the copyright notice for easier
|
|
192
|
+
identification within third-party archives.
|
|
193
|
+
|
|
194
|
+
Copyright [yyyy] [name of copyright owner]
|
|
195
|
+
|
|
196
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
197
|
+
you may not use this file except in compliance with the License.
|
|
198
|
+
You may obtain a copy of the License at
|
|
199
|
+
|
|
200
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
201
|
+
|
|
202
|
+
Unless required by applicable law or agreed to in writing, software
|
|
203
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
204
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
205
|
+
See the License for the specific language governing permissions and
|
|
206
|
+
limitations under the License.
|
|
207
|
+
|
|
208
|
+
Requires-Python: >=3.11
|
|
209
|
+
Description-Content-Type: text/markdown
|
|
210
|
+
License-File: LICENSE
|
|
211
|
+
Requires-Dist: protobuf<7,>=6.31.1
|
|
212
|
+
Requires-Dist: websocket-client<2,>=1.8
|
|
213
|
+
Requires-Dist: websockets<16,>=15
|
|
214
|
+
Dynamic: license-file
|
|
215
|
+
|
|
216
|
+
# MOI Product Python SDK
|
|
217
|
+
|
|
218
|
+
[简体中文](README_zh-CN.md)
|
|
219
|
+
|
|
220
|
+
Use the MatrixOne Intelligence (MOI) 5.x AI Studio product API from Python to manage workspaces, Catalog resources and files, workflows, knowledge bases, SQL, and agents. The server enforces workspace and role permissions.
|
|
221
|
+
|
|
222
|
+
## Requirements and installation
|
|
223
|
+
|
|
224
|
+
Use Python 3.11 or newer. The distribution name is `moi-product-sdk` and the import name is `moi_product_sdk`.
|
|
225
|
+
|
|
226
|
+
Install a specific version from PyPI. First set `SDK_VERSION` to the published SDK version you need:
|
|
227
|
+
|
|
228
|
+
```sh
|
|
229
|
+
python -m pip install "moi-product-sdk==${SDK_VERSION}"
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
Alternatively, install an offline wheel:
|
|
233
|
+
|
|
234
|
+
Get the current offline archive from the [official SDK downloads page](https://docs.matrixorigin.cn/moi/en/5.0/developer/quickstart/downloads/ai-studio.html). Verify its SHA-256 checksum, extract it, and run these commands from the directory containing the wheel. On Windows CMD, activate with `.venv\Scripts\activate.bat`. pip needs access to the dependencies declared by the wheel.
|
|
235
|
+
|
|
236
|
+
```sh
|
|
237
|
+
python -m venv .venv
|
|
238
|
+
. .venv/bin/activate
|
|
239
|
+
python -m pip install ./moi_product_sdk-0.1.0-py3-none-any.whl
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
If you have the complete SDK source for this revision, run `python -m pip install .` from the directory containing `pyproject.toml`.
|
|
243
|
+
|
|
244
|
+
## Authentication and quickstart
|
|
245
|
+
|
|
246
|
+
Create an AI Studio personal access token (PAT) in the MOI console. The example reads the endpoint and token from the environment and passes them explicitly to the client. The SDK sends the raw token as `X-API-Key`, without a `Bearer` prefix. Use the hosted endpoint below or the full API endpoint and path prefix supplied by your deployment administrator. Send the token only to a trusted AI Studio product endpoint. Inject it through a protected environment and keep it out of source, shell history, and logs.
|
|
247
|
+
|
|
248
|
+
```sh
|
|
249
|
+
export PRODUCT_API_BASE_URL='https://api.moi.matrixorigin.cn/v5'
|
|
250
|
+
export PRODUCT_API_KEY='YOUR_PERSONAL_ACCESS_TOKEN'
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
Save the following as `bind_workspace.py` and run `python bind_workspace.py`. The example binds a workspace by name and prints its ID, using the promoted `ensure_workspace` user-story entry. Once you have a workspace, continue with `WorkspaceHandle` for workspace-scoped tasks. Use `client.workspace(workspace_id)` only when you already sourced the workspace id.
|
|
254
|
+
|
|
255
|
+
```python
|
|
256
|
+
import os
|
|
257
|
+
|
|
258
|
+
import moi_product_sdk as sdk
|
|
259
|
+
|
|
260
|
+
client = sdk.new_with_personal_access_token(
|
|
261
|
+
os.environ["PRODUCT_API_BASE_URL"],
|
|
262
|
+
os.environ["PRODUCT_API_KEY"],
|
|
263
|
+
)
|
|
264
|
+
workspace = client.ensure_workspace("my-first-workspace")
|
|
265
|
+
print(workspace.id, workspace.name)
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
Low-level route-aligned services stay available for explicit control:
|
|
269
|
+
|
|
270
|
+
```python
|
|
271
|
+
for workspace in client.workspaces().list().workspaces:
|
|
272
|
+
print(workspace.id, workspace.name)
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
The PAT identifies your account. Workspace requests use the server's Default Role unless you select a role for that workspace with `with_workspace_current_role_id` when constructing the client. Use an assigned role ID. The server validates the role and rejects invalid explicit selections.
|
|
276
|
+
|
|
277
|
+
## Compatibility and license
|
|
278
|
+
|
|
279
|
+
When a formal release is available, use its MOI version, SDK version, and source commit to select a compatible build. The docs archive revision `0.1.0-r2` is separate from SDK version `0.1.0`. API coverage can differ between the offline package and this source tree. Ask your deployment administrator for a matching build if an example uses an unavailable method.
|
|
280
|
+
|
|
281
|
+
The [legacy Catalog SDK](https://github.com/matrixorigin/moi-python-sdk/tree/legacy) targets MOI 4.0 and uses `moi-python-sdk`, `moi`, and `RawClient` / `SDKClient`. To migrate to MOI 5.x, switch to the Product SDK's package, import, API endpoint, and client methods, then verify each business operation.
|
|
282
|
+
|
|
283
|
+
This Product SDK is licensed under the [Apache License 2.0](LICENSE). Third-party dependencies retain their own licenses and copyright notices.
|
|
284
|
+
|
|
285
|
+
## Documentation
|
|
286
|
+
|
|
287
|
+
- [AI Studio SDK quickstart](https://docs.matrixorigin.cn/moi/en/5.0/developer/quickstart/ai-studio/sdk.html) and [API setup](https://docs.matrixorigin.cn/moi/en/5.0/developer/quickstart/ai-studio/http-api.html)
|
|
288
|
+
- [Tasks and API notes](#tasks-and-api-notes) for files, workflows, knowledge bases, and Agent A2A.
|
|
289
|
+
|
|
290
|
+
## Tasks and API notes
|
|
291
|
+
|
|
292
|
+
| Task | Entry point |
|
|
293
|
+
| --- | --- |
|
|
294
|
+
| Bind a workspace and select resources | `WorkspaceHandle` |
|
|
295
|
+
| Manage volumes and files | `VolumeHandle` / `FileHandle` |
|
|
296
|
+
| Deploy, run, and inspect workflows | `WorkflowHandle` / `WorkflowRunHandle` |
|
|
297
|
+
| Manage knowledge bases and semantic entries | `SemanticModelHandle` |
|
|
298
|
+
| Invoke agents and follow A2A tasks | `AgentHandle` / `send_text` |
|
|
299
|
+
|
|
300
|
+
- The SDK returns typed product results. `Error.details` retains structured diagnostics from the server.
|
|
301
|
+
- Pass capability IDs to `current_principal_capabilities` to check specific permissions. The server reports unrecognized IDs separately.
|
|
302
|
+
- `SQLService.download_query_result` streams the saved CSV result for a statement ID. Close the response stream after reading. [Run SQL queries](https://docs.matrixorigin.cn/moi/en/5.0/developer/sdk/ai-studio/%E6%95%B0%E6%8D%AE%E5%A4%84%E7%90%86/%E6%89%A7%E8%A1%8CSQL%E6%9F%A5%E8%AF%A2.html)
|
|
303
|
+
- A2A `message/send` responds at admission and may return a task in `submitted` or `working`. The server rejects `configuration.blocking: true` with HTTP 400, JSON-RPC `-32602`, and `BLOCKING_UNSUPPORTED`.
|
|
304
|
+
- `AgentHandle.send_text` and `AgentService.a2a` follow pending tasks with `tasks/resubscribe` and poll `tasks/get` every 2 seconds if streaming is unavailable. Handle the returned terminal state or `input-required` or `auth-required` status. `with_a2a_wait_timeout` defaults to 10 minutes for the whole follow, independent of per-request `with_timeout`. After `ErrTimeout`, use `task_id` in `Error.details` to query the same task.
|
|
305
|
+
- Set `no_wait=True` on an explicit A2A request to return at admission. The setting controls client-side following. Keep the returned task ID. [Invoke agents and track tasks](https://docs.matrixorigin.cn/moi/en/5.0/developer/sdk/ai-studio/%E6%99%BA%E8%83%BD%E4%BD%93/%E8%B0%83%E7%94%A8%E6%99%BA%E8%83%BD%E4%BD%93%E5%B9%B6%E8%B7%9F%E8%B8%AA%E4%BB%BB%E5%8A%A1.html)
|
|
306
|
+
- `MemoryService` and `ConsumerMemoryHandle` refer to the legacy Consumer Memory/Profile API. Current MOI product deployments do not expose those endpoints.
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# MOI Product Python SDK
|
|
2
|
+
|
|
3
|
+
[简体中文](README_zh-CN.md)
|
|
4
|
+
|
|
5
|
+
Use the MatrixOne Intelligence (MOI) 5.x AI Studio product API from Python to manage workspaces, Catalog resources and files, workflows, knowledge bases, SQL, and agents. The server enforces workspace and role permissions.
|
|
6
|
+
|
|
7
|
+
## Requirements and installation
|
|
8
|
+
|
|
9
|
+
Use Python 3.11 or newer. The distribution name is `moi-product-sdk` and the import name is `moi_product_sdk`.
|
|
10
|
+
|
|
11
|
+
Install a specific version from PyPI. First set `SDK_VERSION` to the published SDK version you need:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
python -m pip install "moi-product-sdk==${SDK_VERSION}"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Alternatively, install an offline wheel:
|
|
18
|
+
|
|
19
|
+
Get the current offline archive from the [official SDK downloads page](https://docs.matrixorigin.cn/moi/en/5.0/developer/quickstart/downloads/ai-studio.html). Verify its SHA-256 checksum, extract it, and run these commands from the directory containing the wheel. On Windows CMD, activate with `.venv\Scripts\activate.bat`. pip needs access to the dependencies declared by the wheel.
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
python -m venv .venv
|
|
23
|
+
. .venv/bin/activate
|
|
24
|
+
python -m pip install ./moi_product_sdk-0.1.0-py3-none-any.whl
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
If you have the complete SDK source for this revision, run `python -m pip install .` from the directory containing `pyproject.toml`.
|
|
28
|
+
|
|
29
|
+
## Authentication and quickstart
|
|
30
|
+
|
|
31
|
+
Create an AI Studio personal access token (PAT) in the MOI console. The example reads the endpoint and token from the environment and passes them explicitly to the client. The SDK sends the raw token as `X-API-Key`, without a `Bearer` prefix. Use the hosted endpoint below or the full API endpoint and path prefix supplied by your deployment administrator. Send the token only to a trusted AI Studio product endpoint. Inject it through a protected environment and keep it out of source, shell history, and logs.
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
export PRODUCT_API_BASE_URL='https://api.moi.matrixorigin.cn/v5'
|
|
35
|
+
export PRODUCT_API_KEY='YOUR_PERSONAL_ACCESS_TOKEN'
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Save the following as `bind_workspace.py` and run `python bind_workspace.py`. The example binds a workspace by name and prints its ID, using the promoted `ensure_workspace` user-story entry. Once you have a workspace, continue with `WorkspaceHandle` for workspace-scoped tasks. Use `client.workspace(workspace_id)` only when you already sourced the workspace id.
|
|
39
|
+
|
|
40
|
+
```python
|
|
41
|
+
import os
|
|
42
|
+
|
|
43
|
+
import moi_product_sdk as sdk
|
|
44
|
+
|
|
45
|
+
client = sdk.new_with_personal_access_token(
|
|
46
|
+
os.environ["PRODUCT_API_BASE_URL"],
|
|
47
|
+
os.environ["PRODUCT_API_KEY"],
|
|
48
|
+
)
|
|
49
|
+
workspace = client.ensure_workspace("my-first-workspace")
|
|
50
|
+
print(workspace.id, workspace.name)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Low-level route-aligned services stay available for explicit control:
|
|
54
|
+
|
|
55
|
+
```python
|
|
56
|
+
for workspace in client.workspaces().list().workspaces:
|
|
57
|
+
print(workspace.id, workspace.name)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The PAT identifies your account. Workspace requests use the server's Default Role unless you select a role for that workspace with `with_workspace_current_role_id` when constructing the client. Use an assigned role ID. The server validates the role and rejects invalid explicit selections.
|
|
61
|
+
|
|
62
|
+
## Compatibility and license
|
|
63
|
+
|
|
64
|
+
When a formal release is available, use its MOI version, SDK version, and source commit to select a compatible build. The docs archive revision `0.1.0-r2` is separate from SDK version `0.1.0`. API coverage can differ between the offline package and this source tree. Ask your deployment administrator for a matching build if an example uses an unavailable method.
|
|
65
|
+
|
|
66
|
+
The [legacy Catalog SDK](https://github.com/matrixorigin/moi-python-sdk/tree/legacy) targets MOI 4.0 and uses `moi-python-sdk`, `moi`, and `RawClient` / `SDKClient`. To migrate to MOI 5.x, switch to the Product SDK's package, import, API endpoint, and client methods, then verify each business operation.
|
|
67
|
+
|
|
68
|
+
This Product SDK is licensed under the [Apache License 2.0](LICENSE). Third-party dependencies retain their own licenses and copyright notices.
|
|
69
|
+
|
|
70
|
+
## Documentation
|
|
71
|
+
|
|
72
|
+
- [AI Studio SDK quickstart](https://docs.matrixorigin.cn/moi/en/5.0/developer/quickstart/ai-studio/sdk.html) and [API setup](https://docs.matrixorigin.cn/moi/en/5.0/developer/quickstart/ai-studio/http-api.html)
|
|
73
|
+
- [Tasks and API notes](#tasks-and-api-notes) for files, workflows, knowledge bases, and Agent A2A.
|
|
74
|
+
|
|
75
|
+
## Tasks and API notes
|
|
76
|
+
|
|
77
|
+
| Task | Entry point |
|
|
78
|
+
| --- | --- |
|
|
79
|
+
| Bind a workspace and select resources | `WorkspaceHandle` |
|
|
80
|
+
| Manage volumes and files | `VolumeHandle` / `FileHandle` |
|
|
81
|
+
| Deploy, run, and inspect workflows | `WorkflowHandle` / `WorkflowRunHandle` |
|
|
82
|
+
| Manage knowledge bases and semantic entries | `SemanticModelHandle` |
|
|
83
|
+
| Invoke agents and follow A2A tasks | `AgentHandle` / `send_text` |
|
|
84
|
+
|
|
85
|
+
- The SDK returns typed product results. `Error.details` retains structured diagnostics from the server.
|
|
86
|
+
- Pass capability IDs to `current_principal_capabilities` to check specific permissions. The server reports unrecognized IDs separately.
|
|
87
|
+
- `SQLService.download_query_result` streams the saved CSV result for a statement ID. Close the response stream after reading. [Run SQL queries](https://docs.matrixorigin.cn/moi/en/5.0/developer/sdk/ai-studio/%E6%95%B0%E6%8D%AE%E5%A4%84%E7%90%86/%E6%89%A7%E8%A1%8CSQL%E6%9F%A5%E8%AF%A2.html)
|
|
88
|
+
- A2A `message/send` responds at admission and may return a task in `submitted` or `working`. The server rejects `configuration.blocking: true` with HTTP 400, JSON-RPC `-32602`, and `BLOCKING_UNSUPPORTED`.
|
|
89
|
+
- `AgentHandle.send_text` and `AgentService.a2a` follow pending tasks with `tasks/resubscribe` and poll `tasks/get` every 2 seconds if streaming is unavailable. Handle the returned terminal state or `input-required` or `auth-required` status. `with_a2a_wait_timeout` defaults to 10 minutes for the whole follow, independent of per-request `with_timeout`. After `ErrTimeout`, use `task_id` in `Error.details` to query the same task.
|
|
90
|
+
- Set `no_wait=True` on an explicit A2A request to return at admission. The setting controls client-side following. Keep the returned task ID. [Invoke agents and track tasks](https://docs.matrixorigin.cn/moi/en/5.0/developer/sdk/ai-studio/%E6%99%BA%E8%83%BD%E4%BD%93/%E8%B0%83%E7%94%A8%E6%99%BA%E8%83%BD%E4%BD%93%E5%B9%B6%E8%B7%9F%E8%B8%AA%E4%BB%BB%E5%8A%A1.html)
|
|
91
|
+
- `MemoryService` and `ConsumerMemoryHandle` refer to the legacy Consumer Memory/Profile API. Current MOI product deployments do not expose those endpoints.
|