synapse-sdk 1.0.0b13__py3-none-any.whl → 1.0.0b14__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.

Potentially problematic release.


This version of synapse-sdk might be problematic. Click here for more details.

Files changed (85) hide show
  1. locale/ko/LC_MESSAGES/messages.mo +0 -0
  2. synapse_sdk/clients/agent/ray.py +9 -11
  3. synapse_sdk/clients/backend/annotation.py +1 -1
  4. synapse_sdk/clients/backend/core.py +31 -4
  5. synapse_sdk/clients/backend/data_collection.py +78 -5
  6. synapse_sdk/clients/backend/hitl.py +1 -1
  7. synapse_sdk/clients/backend/ml.py +1 -1
  8. synapse_sdk/clients/base.py +23 -16
  9. synapse_sdk/devtools/docs/docs/api/clients/agent.md +43 -0
  10. synapse_sdk/devtools/docs/docs/api/clients/backend.md +53 -0
  11. synapse_sdk/devtools/docs/docs/api/clients/base.md +35 -0
  12. synapse_sdk/devtools/docs/docs/api/clients/ray.md +321 -0
  13. synapse_sdk/devtools/docs/docs/api/index.md +52 -0
  14. synapse_sdk/devtools/docs/docs/api/plugins/categories.md +43 -0
  15. synapse_sdk/devtools/docs/docs/api/plugins/models.md +59 -0
  16. synapse_sdk/devtools/docs/docs/api/plugins/utils.md +328 -0
  17. synapse_sdk/devtools/docs/docs/api/utils/file.md +195 -0
  18. synapse_sdk/devtools/docs/docs/api/utils/network.md +378 -0
  19. synapse_sdk/devtools/docs/docs/api/utils/storage.md +57 -0
  20. synapse_sdk/devtools/docs/docs/api/utils/types.md +51 -0
  21. synapse_sdk/devtools/docs/docs/categories.md +0 -0
  22. synapse_sdk/devtools/docs/docs/cli-usage.md +280 -0
  23. synapse_sdk/devtools/docs/docs/concepts/index.md +38 -0
  24. synapse_sdk/devtools/docs/docs/configuration.md +83 -0
  25. synapse_sdk/devtools/docs/docs/contributing.md +306 -0
  26. synapse_sdk/devtools/docs/docs/examples/index.md +29 -0
  27. synapse_sdk/devtools/docs/docs/faq.md +179 -0
  28. synapse_sdk/devtools/docs/docs/features/converters/index.md +455 -0
  29. synapse_sdk/devtools/docs/docs/features/index.md +24 -0
  30. synapse_sdk/devtools/docs/docs/features/plugins/index.md +509 -0
  31. synapse_sdk/devtools/docs/docs/installation.md +94 -0
  32. synapse_sdk/devtools/docs/docs/introduction.md +47 -0
  33. synapse_sdk/devtools/docs/docs/quickstart.md +78 -0
  34. synapse_sdk/devtools/docs/docs/troubleshooting.md +519 -0
  35. synapse_sdk/devtools/docs/docs/tutorial-basics/_category_.json +8 -0
  36. synapse_sdk/devtools/docs/docs/tutorial-basics/congratulations.md +23 -0
  37. synapse_sdk/devtools/docs/docs/tutorial-basics/create-a-blog-post.md +34 -0
  38. synapse_sdk/devtools/docs/docs/tutorial-basics/create-a-document.md +57 -0
  39. synapse_sdk/devtools/docs/docs/tutorial-basics/create-a-page.md +43 -0
  40. synapse_sdk/devtools/docs/docs/tutorial-basics/deploy-your-site.md +31 -0
  41. synapse_sdk/devtools/docs/docs/tutorial-basics/markdown-features.mdx +152 -0
  42. synapse_sdk/devtools/docs/docs/tutorial-extras/_category_.json +7 -0
  43. synapse_sdk/devtools/docs/docs/tutorial-extras/img/docsVersionDropdown.png +0 -0
  44. synapse_sdk/devtools/docs/docs/tutorial-extras/img/localeDropdown.png +0 -0
  45. synapse_sdk/devtools/docs/docs/tutorial-extras/manage-docs-versions.md +55 -0
  46. synapse_sdk/devtools/docs/docs/tutorial-extras/translate-your-site.md +88 -0
  47. synapse_sdk/devtools/docs/docusaurus.config.ts +5 -3
  48. synapse_sdk/devtools/docs/i18n/ko/code.json +325 -0
  49. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/agent.md +43 -0
  50. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/backend.md +53 -0
  51. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/base.md +35 -0
  52. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/ray.md +321 -0
  53. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/index.md +52 -0
  54. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/utils/file.md +195 -0
  55. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/utils/network.md +378 -0
  56. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/utils/storage.md +60 -0
  57. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/utils/types.md +51 -0
  58. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/categories.md +0 -0
  59. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/cli-usage.md +280 -0
  60. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/concepts/index.md +38 -0
  61. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/configuration.md +83 -0
  62. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/contributing.md +306 -0
  63. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/examples/index.md +29 -0
  64. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/faq.md +179 -0
  65. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/features/converters/index.md +30 -0
  66. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/features/index.md +24 -0
  67. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/features/plugins/index.md +30 -0
  68. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/installation.md +94 -0
  69. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/introduction.md +47 -0
  70. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/quickstart.md +78 -0
  71. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/troubleshooting.md +519 -0
  72. synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current.json +22 -0
  73. synapse_sdk/devtools/docs/i18n/ko/docusaurus-theme-classic/footer.json +42 -0
  74. synapse_sdk/devtools/docs/i18n/ko/docusaurus-theme-classic/navbar.json +18 -0
  75. synapse_sdk/devtools/docs/node_modules/shell-quote/print.py +3 -0
  76. synapse_sdk/devtools/docs/package.json +1 -1
  77. synapse_sdk/plugins/categories/export/actions/export.py +3 -0
  78. synapse_sdk/plugins/categories/upload/actions/upload.py +9 -4
  79. synapse_sdk/utils/file.py +77 -0
  80. {synapse_sdk-1.0.0b13.dist-info → synapse_sdk-1.0.0b14.dist-info}/METADATA +1 -1
  81. {synapse_sdk-1.0.0b13.dist-info → synapse_sdk-1.0.0b14.dist-info}/RECORD +85 -19
  82. {synapse_sdk-1.0.0b13.dist-info → synapse_sdk-1.0.0b14.dist-info}/WHEEL +0 -0
  83. {synapse_sdk-1.0.0b13.dist-info → synapse_sdk-1.0.0b14.dist-info}/entry_points.txt +0 -0
  84. {synapse_sdk-1.0.0b13.dist-info → synapse_sdk-1.0.0b14.dist-info}/licenses/LICENSE +0 -0
  85. {synapse_sdk-1.0.0b13.dist-info → synapse_sdk-1.0.0b14.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,325 @@
1
+ {
2
+ "theme.ErrorPageContent.title": {
3
+ "message": "This page crashed.",
4
+ "description": "The title of the fallback page when the page crashed"
5
+ },
6
+ "theme.BackToTopButton.buttonAriaLabel": {
7
+ "message": "Scroll back to top",
8
+ "description": "The ARIA label for the back to top button"
9
+ },
10
+ "theme.blog.archive.title": {
11
+ "message": "Archive",
12
+ "description": "The page & hero title of the blog archive page"
13
+ },
14
+ "theme.blog.archive.description": {
15
+ "message": "Archive",
16
+ "description": "The page & hero description of the blog archive page"
17
+ },
18
+ "theme.blog.paginator.navAriaLabel": {
19
+ "message": "Blog list page navigation",
20
+ "description": "The ARIA label for the blog pagination"
21
+ },
22
+ "theme.blog.paginator.newerEntries": {
23
+ "message": "Newer entries",
24
+ "description": "The label used to navigate to the newer blog posts page (previous page)"
25
+ },
26
+ "theme.blog.paginator.olderEntries": {
27
+ "message": "Older entries",
28
+ "description": "The label used to navigate to the older blog posts page (next page)"
29
+ },
30
+ "theme.blog.post.paginator.navAriaLabel": {
31
+ "message": "Blog post page navigation",
32
+ "description": "The ARIA label for the blog posts pagination"
33
+ },
34
+ "theme.blog.post.paginator.newerPost": {
35
+ "message": "Newer post",
36
+ "description": "The blog post button label to navigate to the newer/previous post"
37
+ },
38
+ "theme.blog.post.paginator.olderPost": {
39
+ "message": "Older post",
40
+ "description": "The blog post button label to navigate to the older/next post"
41
+ },
42
+ "theme.tags.tagsPageLink": {
43
+ "message": "View all tags",
44
+ "description": "The label of the link targeting the tag list page"
45
+ },
46
+ "theme.colorToggle.ariaLabel.mode.system": {
47
+ "message": "system mode",
48
+ "description": "The name for the system color mode"
49
+ },
50
+ "theme.colorToggle.ariaLabel.mode.light": {
51
+ "message": "light mode",
52
+ "description": "The name for the light color mode"
53
+ },
54
+ "theme.colorToggle.ariaLabel.mode.dark": {
55
+ "message": "dark mode",
56
+ "description": "The name for the dark color mode"
57
+ },
58
+ "theme.colorToggle.ariaLabel": {
59
+ "message": "Switch between dark and light mode (currently {mode})",
60
+ "description": "The ARIA label for the color mode toggle"
61
+ },
62
+ "theme.docs.breadcrumbs.navAriaLabel": {
63
+ "message": "Breadcrumbs",
64
+ "description": "The ARIA label for the breadcrumbs"
65
+ },
66
+ "theme.docs.DocCard.categoryDescription.plurals": {
67
+ "message": "1 item|{count} items",
68
+ "description": "The default description for a category card in the generated index about how many items this category includes"
69
+ },
70
+ "theme.docs.paginator.navAriaLabel": {
71
+ "message": "Docs pages",
72
+ "description": "The ARIA label for the docs pagination"
73
+ },
74
+ "theme.docs.paginator.previous": {
75
+ "message": "Previous",
76
+ "description": "The label used to navigate to the previous doc"
77
+ },
78
+ "theme.docs.paginator.next": {
79
+ "message": "Next",
80
+ "description": "The label used to navigate to the next doc"
81
+ },
82
+ "theme.docs.tagDocListPageTitle.nDocsTagged": {
83
+ "message": "One doc tagged|{count} docs tagged",
84
+ "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
85
+ },
86
+ "theme.docs.tagDocListPageTitle": {
87
+ "message": "{nDocsTagged} with \"{tagName}\"",
88
+ "description": "The title of the page for a docs tag"
89
+ },
90
+ "theme.docs.versionBadge.label": {
91
+ "message": "Version: {versionLabel}"
92
+ },
93
+ "theme.docs.versions.unreleasedVersionLabel": {
94
+ "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.",
95
+ "description": "The label used to tell the user that he's browsing an unreleased doc version"
96
+ },
97
+ "theme.docs.versions.unmaintainedVersionLabel": {
98
+ "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.",
99
+ "description": "The label used to tell the user that he's browsing an unmaintained doc version"
100
+ },
101
+ "theme.docs.versions.latestVersionSuggestionLabel": {
102
+ "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).",
103
+ "description": "The label used to tell the user to check the latest version"
104
+ },
105
+ "theme.docs.versions.latestVersionLinkLabel": {
106
+ "message": "latest version",
107
+ "description": "The label used for the latest version suggestion link label"
108
+ },
109
+ "theme.common.editThisPage": {
110
+ "message": "Edit this page",
111
+ "description": "The link label to edit the current page"
112
+ },
113
+ "theme.common.headingLinkTitle": {
114
+ "message": "Direct link to {heading}",
115
+ "description": "Title for link to heading"
116
+ },
117
+ "theme.lastUpdated.atDate": {
118
+ "message": " on {date}",
119
+ "description": "The words used to describe on which date a page has been last updated"
120
+ },
121
+ "theme.lastUpdated.byUser": {
122
+ "message": " by {user}",
123
+ "description": "The words used to describe by who the page has been last updated"
124
+ },
125
+ "theme.lastUpdated.lastUpdatedAtBy": {
126
+ "message": "Last updated{atDate}{byUser}",
127
+ "description": "The sentence used to display when a page has been last updated, and by who"
128
+ },
129
+ "theme.navbar.mobileVersionsDropdown.label": {
130
+ "message": "Versions",
131
+ "description": "The label for the navbar versions dropdown on mobile view"
132
+ },
133
+ "theme.NotFound.title": {
134
+ "message": "Page Not Found",
135
+ "description": "The title of the 404 page"
136
+ },
137
+ "theme.tags.tagsListLabel": {
138
+ "message": "Tags:",
139
+ "description": "The label alongside a tag list"
140
+ },
141
+ "theme.AnnouncementBar.closeButtonAriaLabel": {
142
+ "message": "Close",
143
+ "description": "The ARIA label for close button of announcement bar"
144
+ },
145
+ "theme.admonition.caution": {
146
+ "message": "caution",
147
+ "description": "The default label used for the Caution admonition (:::caution)"
148
+ },
149
+ "theme.admonition.danger": {
150
+ "message": "danger",
151
+ "description": "The default label used for the Danger admonition (:::danger)"
152
+ },
153
+ "theme.admonition.info": {
154
+ "message": "info",
155
+ "description": "The default label used for the Info admonition (:::info)"
156
+ },
157
+ "theme.admonition.note": {
158
+ "message": "note",
159
+ "description": "The default label used for the Note admonition (:::note)"
160
+ },
161
+ "theme.admonition.tip": {
162
+ "message": "tip",
163
+ "description": "The default label used for the Tip admonition (:::tip)"
164
+ },
165
+ "theme.admonition.warning": {
166
+ "message": "warning",
167
+ "description": "The default label used for the Warning admonition (:::warning)"
168
+ },
169
+ "theme.blog.sidebar.navAriaLabel": {
170
+ "message": "Blog recent posts navigation",
171
+ "description": "The ARIA label for recent posts in the blog sidebar"
172
+ },
173
+ "theme.DocSidebarItem.expandCategoryAriaLabel": {
174
+ "message": "Expand sidebar category '{label}'",
175
+ "description": "The ARIA label to expand the sidebar category"
176
+ },
177
+ "theme.DocSidebarItem.collapseCategoryAriaLabel": {
178
+ "message": "Collapse sidebar category '{label}'",
179
+ "description": "The ARIA label to collapse the sidebar category"
180
+ },
181
+ "theme.NavBar.navAriaLabel": {
182
+ "message": "Main",
183
+ "description": "The ARIA label for the main navigation"
184
+ },
185
+ "theme.navbar.mobileLanguageDropdown.label": {
186
+ "message": "Languages",
187
+ "description": "The label for the mobile language switcher dropdown"
188
+ },
189
+ "theme.NotFound.p1": {
190
+ "message": "We could not find what you were looking for.",
191
+ "description": "The first paragraph of the 404 page"
192
+ },
193
+ "theme.NotFound.p2": {
194
+ "message": "Please contact the owner of the site that linked you to the original URL and let them know their link is broken.",
195
+ "description": "The 2nd paragraph of the 404 page"
196
+ },
197
+ "theme.TOCCollapsible.toggleButtonLabel": {
198
+ "message": "On this page",
199
+ "description": "The label used by the button on the collapsible TOC component"
200
+ },
201
+ "theme.blog.post.readMore": {
202
+ "message": "Read more",
203
+ "description": "The label used in blog post item excerpts to link to full blog posts"
204
+ },
205
+ "theme.blog.post.readMoreLabel": {
206
+ "message": "Read more about {title}",
207
+ "description": "The ARIA label for the link to full blog posts from excerpts"
208
+ },
209
+ "theme.blog.post.readingTime.plurals": {
210
+ "message": "One min read|{readingTime} min read",
211
+ "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
212
+ },
213
+ "theme.CodeBlock.copy": {
214
+ "message": "Copy",
215
+ "description": "The copy button label on code blocks"
216
+ },
217
+ "theme.CodeBlock.copied": {
218
+ "message": "Copied",
219
+ "description": "The copied button label on code blocks"
220
+ },
221
+ "theme.CodeBlock.copyButtonAriaLabel": {
222
+ "message": "Copy code to clipboard",
223
+ "description": "The ARIA label for copy code blocks button"
224
+ },
225
+ "theme.CodeBlock.wordWrapToggle": {
226
+ "message": "Toggle word wrap",
227
+ "description": "The title attribute for toggle word wrapping button of code block lines"
228
+ },
229
+ "theme.docs.breadcrumbs.home": {
230
+ "message": "Home page",
231
+ "description": "The ARIA label for the home page in the breadcrumbs"
232
+ },
233
+ "theme.docs.sidebar.collapseButtonTitle": {
234
+ "message": "Collapse sidebar",
235
+ "description": "The title attribute for collapse button of doc sidebar"
236
+ },
237
+ "theme.docs.sidebar.collapseButtonAriaLabel": {
238
+ "message": "Collapse sidebar",
239
+ "description": "The title attribute for collapse button of doc sidebar"
240
+ },
241
+ "theme.docs.sidebar.navAriaLabel": {
242
+ "message": "Docs sidebar",
243
+ "description": "The ARIA label for the sidebar navigation"
244
+ },
245
+ "theme.docs.sidebar.closeSidebarButtonAriaLabel": {
246
+ "message": "Close navigation bar",
247
+ "description": "The ARIA label for close button of mobile sidebar"
248
+ },
249
+ "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": {
250
+ "message": "← Back to main menu",
251
+ "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"
252
+ },
253
+ "theme.docs.sidebar.toggleSidebarButtonAriaLabel": {
254
+ "message": "Toggle navigation bar",
255
+ "description": "The ARIA label for hamburger menu button of mobile navigation"
256
+ },
257
+ "theme.navbar.mobileDropdown.collapseButton.expandAriaLabel": {
258
+ "message": "Expand the dropdown",
259
+ "description": "The ARIA label of the button to expand the mobile dropdown navbar item"
260
+ },
261
+ "theme.navbar.mobileDropdown.collapseButton.collapseAriaLabel": {
262
+ "message": "Collapse the dropdown",
263
+ "description": "The ARIA label of the button to collapse the mobile dropdown navbar item"
264
+ },
265
+ "theme.docs.sidebar.expandButtonTitle": {
266
+ "message": "Expand sidebar",
267
+ "description": "The ARIA label and title attribute for expand button of doc sidebar"
268
+ },
269
+ "theme.docs.sidebar.expandButtonAriaLabel": {
270
+ "message": "Expand sidebar",
271
+ "description": "The ARIA label and title attribute for expand button of doc sidebar"
272
+ },
273
+ "theme.blog.post.plurals": {
274
+ "message": "One post|{count} posts",
275
+ "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
276
+ },
277
+ "theme.blog.tagTitle": {
278
+ "message": "{nPosts} tagged with \"{tagName}\"",
279
+ "description": "The title of the page for a blog tag"
280
+ },
281
+ "theme.blog.author.pageTitle": {
282
+ "message": "{authorName} - {nPosts}",
283
+ "description": "The title of the page for a blog author"
284
+ },
285
+ "theme.blog.authorsList.pageTitle": {
286
+ "message": "Authors",
287
+ "description": "The title of the authors page"
288
+ },
289
+ "theme.blog.authorsList.viewAll": {
290
+ "message": "View all authors",
291
+ "description": "The label of the link targeting the blog authors page"
292
+ },
293
+ "theme.blog.author.noPosts": {
294
+ "message": "This author has not written any posts yet.",
295
+ "description": "The text for authors with 0 blog post"
296
+ },
297
+ "theme.contentVisibility.unlistedBanner.title": {
298
+ "message": "Unlisted page",
299
+ "description": "The unlisted content banner title"
300
+ },
301
+ "theme.contentVisibility.unlistedBanner.message": {
302
+ "message": "This page is unlisted. Search engines will not index it, and only users having a direct link can access it.",
303
+ "description": "The unlisted content banner message"
304
+ },
305
+ "theme.contentVisibility.draftBanner.title": {
306
+ "message": "Draft page",
307
+ "description": "The draft content banner title"
308
+ },
309
+ "theme.contentVisibility.draftBanner.message": {
310
+ "message": "This page is a draft. It will only be visible in dev and be excluded from the production build.",
311
+ "description": "The draft content banner message"
312
+ },
313
+ "theme.ErrorPageContent.tryAgain": {
314
+ "message": "Try again",
315
+ "description": "The label of the button to try again rendering when the React error boundary captures an error"
316
+ },
317
+ "theme.common.skipToMainContent": {
318
+ "message": "Skip to main content",
319
+ "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation"
320
+ },
321
+ "theme.tags.tagsPageTitle": {
322
+ "message": "Tags",
323
+ "description": "The title of the tag list page"
324
+ }
325
+ }
@@ -0,0 +1,43 @@
1
+ ---
2
+ id: agent
3
+ title: AgentClient
4
+ sidebar_position: 2
5
+ ---
6
+
7
+ # AgentClient
8
+
9
+ Agent 전용 작업 및 분산 실행을 위한 클라이언트입니다.
10
+
11
+ ## 개요
12
+
13
+ `AgentClient`는 플러그인 실행, 작업 관리, 분산 컴퓨팅 통합을 포함한 agent 작업에 대한 액세스를 제공합니다.
14
+
15
+ ## Constructor
16
+
17
+ ```python
18
+ AgentClient(
19
+ base_url: str,
20
+ agent_token: str = None,
21
+ timeout: dict = None
22
+ )
23
+ ```
24
+
25
+ ## 사용법
26
+
27
+ ```python
28
+ from synapse_sdk.clients.agent import AgentClient
29
+
30
+ client = AgentClient(
31
+ base_url="https://api.synapse.sh",
32
+ agent_token="your-agent-token"
33
+ )
34
+ ```
35
+
36
+ ## Methods
37
+
38
+ 곧 제공 예정 - AgentClient 메서드에 대한 상세 API 문서.
39
+
40
+ ## 참고
41
+
42
+ - [BackendClient](./backend.md) - Backend 작업을 위한 클라이언트
43
+ - [BaseClient](./base.md) - 기본 클라이언트 구현
@@ -0,0 +1,53 @@
1
+ ---
2
+ id: backend
3
+ title: BackendClient
4
+ sidebar_position: 1
5
+ ---
6
+
7
+ # BackendClient
8
+
9
+ Synapse backend API와 상호작용하기 위한 메인 클라이언트입니다.
10
+
11
+ ## 개요
12
+
13
+ `BackendClient`는 데이터 관리, 플러그인 실행, 어노테이션, 머신러닝 워크플로우를 포함한 모든 backend 작업에 대한 포괄적인 액세스를 제공합니다. 여러 전문화된 mixin의 기능을 집계합니다.
14
+
15
+ ## Constructor
16
+
17
+ ```python
18
+ BackendClient(
19
+ base_url: str,
20
+ api_token: str = None,
21
+ agent_token: str = None,
22
+ timeout: dict = None
23
+ )
24
+ ```
25
+
26
+ ### Parameters
27
+
28
+ - **base_url** (`str`): Synapse backend API의 기본 URL
29
+ - **api_token** (`str`, 선택사항): API 인증 토큰. `SYNAPSE_API_TOKEN` 환경변수로도 설정 가능
30
+ - **agent_token** (`str`, 선택사항): Agent 인증 토큰. `SYNAPSE_AGENT_TOKEN` 환경변수로도 설정 가능
31
+ - **timeout** (`dict`, 선택사항): 사용자 정의 timeout 설정. 기본값은 `{'connect': 5, 'read': 30}`
32
+
33
+ ### 예제
34
+
35
+ ```python
36
+ from synapse_sdk.clients.backend import BackendClient
37
+
38
+ # 명시적 토큰으로 클라이언트 생성
39
+ client = BackendClient(
40
+ base_url="https://api.synapse.sh",
41
+ api_token="your-api-token"
42
+ )
43
+
44
+ # 또는 환경변수 사용
45
+ import os
46
+ os.environ['SYNAPSE_API_TOKEN'] = "your-api-token"
47
+ client = BackendClient(base_url="https://api.synapse.sh")
48
+ ```
49
+
50
+ ## 참고
51
+
52
+ - [AgentClient](./agent.md) - Agent 전용 작업을 위한 클라이언트
53
+ - [BaseClient](./base.md) - 기본 클라이언트 구현
@@ -0,0 +1,35 @@
1
+ ---
2
+ id: base
3
+ title: BaseClient
4
+ sidebar_position: 3
5
+ ---
6
+
7
+ # BaseClient
8
+
9
+ 모든 Synapse SDK 클라이언트의 기본 클래스입니다.
10
+
11
+ ## 개요
12
+
13
+ `BaseClient`는 다른 모든 클라이언트에서 사용하는 HTTP 작업, 오류 처리 및 요청 관리를 위한 공통 기능을 제공합니다.
14
+
15
+ ## 기능
16
+
17
+ - 재시도 로직이 있는 HTTP 요청 처리
18
+ - 자동 timeout 관리
19
+ - 파일 업로드/다운로드 기능
20
+ - Pydantic 모델 유효성 검사
21
+ - 연결 풀링
22
+
23
+ ## 사용법
24
+
25
+ ```python
26
+ from synapse_sdk.clients.base import BaseClient
27
+
28
+ # BaseClient는 일반적으로 직접 사용되지 않습니다
29
+ # 대신 BackendClient 또는 AgentClient를 사용하세요
30
+ ```
31
+
32
+ ## 참고
33
+
34
+ - [BackendClient](./backend.md) - 메인 클라이언트 구현
35
+ - [AgentClient](./agent.md) - Agent 전용 작업