synapse-sdk 1.0.0a35__py3-none-any.whl → 2025.11.7__py3-none-any.whl

synapse_sdk/devtools/docs/i18n/ko/code.json

@@ -0,0 +1,325 @@
+{
+  "theme.ErrorPageContent.title": {
+    "message": "This page crashed.",
+    "description": "The title of the fallback page when the page crashed"
+  },
+  "theme.BackToTopButton.buttonAriaLabel": {
+    "message": "Scroll back to top",
+    "description": "The ARIA label for the back to top button"
+  },
+  "theme.blog.archive.title": {
+    "message": "Archive",
+    "description": "The page & hero title of the blog archive page"
+  },
+  "theme.blog.archive.description": {
+    "message": "Archive",
+    "description": "The page & hero description of the blog archive page"
+  },
+  "theme.blog.paginator.navAriaLabel": {
+    "message": "Blog list page navigation",
+    "description": "The ARIA label for the blog pagination"
+  },
+  "theme.blog.paginator.newerEntries": {
+    "message": "Newer entries",
+    "description": "The label used to navigate to the newer blog posts page (previous page)"
+  },
+  "theme.blog.paginator.olderEntries": {
+    "message": "Older entries",
+    "description": "The label used to navigate to the older blog posts page (next page)"
+  },
+  "theme.blog.post.paginator.navAriaLabel": {
+    "message": "Blog post page navigation",
+    "description": "The ARIA label for the blog posts pagination"
+  },
+  "theme.blog.post.paginator.newerPost": {
+    "message": "Newer post",
+    "description": "The blog post button label to navigate to the newer/previous post"
+  },
+  "theme.blog.post.paginator.olderPost": {
+    "message": "Older post",
+    "description": "The blog post button label to navigate to the older/next post"
+  },
+  "theme.tags.tagsPageLink": {
+    "message": "View all tags",
+    "description": "The label of the link targeting the tag list page"
+  },
+  "theme.colorToggle.ariaLabel.mode.system": {
+    "message": "system mode",
+    "description": "The name for the system color mode"
+  },
+  "theme.colorToggle.ariaLabel.mode.light": {
+    "message": "light mode",
+    "description": "The name for the light color mode"
+  },
+  "theme.colorToggle.ariaLabel.mode.dark": {
+    "message": "dark mode",
+    "description": "The name for the dark color mode"
+  },
+  "theme.colorToggle.ariaLabel": {
+    "message": "Switch between dark and light mode (currently {mode})",
+    "description": "The ARIA label for the color mode toggle"
+  },
+  "theme.docs.breadcrumbs.navAriaLabel": {
+    "message": "Breadcrumbs",
+    "description": "The ARIA label for the breadcrumbs"
+  },
+  "theme.docs.DocCard.categoryDescription.plurals": {
+    "message": "1 item|{count} items",
+    "description": "The default description for a category card in the generated index about how many items this category includes"
+  },
+  "theme.docs.paginator.navAriaLabel": {
+    "message": "Docs pages",
+    "description": "The ARIA label for the docs pagination"
+  },
+  "theme.docs.paginator.previous": {
+    "message": "Previous",
+    "description": "The label used to navigate to the previous doc"
+  },
+  "theme.docs.paginator.next": {
+    "message": "Next",
+    "description": "The label used to navigate to the next doc"
+  },
+  "theme.docs.tagDocListPageTitle.nDocsTagged": {
+    "message": "One doc tagged|{count} docs tagged",
+    "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)"
+  },
+  "theme.docs.tagDocListPageTitle": {
+    "message": "{nDocsTagged} with \"{tagName}\"",
+    "description": "The title of the page for a docs tag"
+  },
+  "theme.docs.versionBadge.label": {
+    "message": "Version: {versionLabel}"
+  },
+  "theme.docs.versions.unreleasedVersionLabel": {
+    "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.",
+    "description": "The label used to tell the user that he's browsing an unreleased doc version"
+  },
+  "theme.docs.versions.unmaintainedVersionLabel": {
+    "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.",
+    "description": "The label used to tell the user that he's browsing an unmaintained doc version"
+  },
+  "theme.docs.versions.latestVersionSuggestionLabel": {
+    "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).",
+    "description": "The label used to tell the user to check the latest version"
+  },
+  "theme.docs.versions.latestVersionLinkLabel": {
+    "message": "latest version",
+    "description": "The label used for the latest version suggestion link label"
+  },
+  "theme.common.editThisPage": {
+    "message": "Edit this page",
+    "description": "The link label to edit the current page"
+  },
+  "theme.common.headingLinkTitle": {
+    "message": "Direct link to {heading}",
+    "description": "Title for link to heading"
+  },
+  "theme.lastUpdated.atDate": {
+    "message": " on {date}",
+    "description": "The words used to describe on which date a page has been last updated"
+  },
+  "theme.lastUpdated.byUser": {
+    "message": " by {user}",
+    "description": "The words used to describe by who the page has been last updated"
+  },
+  "theme.lastUpdated.lastUpdatedAtBy": {
+    "message": "Last updated{atDate}{byUser}",
+    "description": "The sentence used to display when a page has been last updated, and by who"
+  },
+  "theme.navbar.mobileVersionsDropdown.label": {
+    "message": "Versions",
+    "description": "The label for the navbar versions dropdown on mobile view"
+  },
+  "theme.NotFound.title": {
+    "message": "Page Not Found",
+    "description": "The title of the 404 page"
+  },
+  "theme.tags.tagsListLabel": {
+    "message": "Tags:",
+    "description": "The label alongside a tag list"
+  },
+  "theme.AnnouncementBar.closeButtonAriaLabel": {
+    "message": "Close",
+    "description": "The ARIA label for close button of announcement bar"
+  },
+  "theme.admonition.caution": {
+    "message": "caution",
+    "description": "The default label used for the Caution admonition (:::caution)"
+  },
+  "theme.admonition.danger": {
+    "message": "danger",
+    "description": "The default label used for the Danger admonition (:::danger)"
+  },
+  "theme.admonition.info": {
+    "message": "info",
+    "description": "The default label used for the Info admonition (:::info)"
+  },
+  "theme.admonition.note": {
+    "message": "note",
+    "description": "The default label used for the Note admonition (:::note)"
+  },
+  "theme.admonition.tip": {
+    "message": "tip",
+    "description": "The default label used for the Tip admonition (:::tip)"
+  },
+  "theme.admonition.warning": {
+    "message": "warning",
+    "description": "The default label used for the Warning admonition (:::warning)"
+  },
+  "theme.blog.sidebar.navAriaLabel": {
+    "message": "Blog recent posts navigation",
+    "description": "The ARIA label for recent posts in the blog sidebar"
+  },
+  "theme.DocSidebarItem.expandCategoryAriaLabel": {
+    "message": "Expand sidebar category '{label}'",
+    "description": "The ARIA label to expand the sidebar category"
+  },
+  "theme.DocSidebarItem.collapseCategoryAriaLabel": {
+    "message": "Collapse sidebar category '{label}'",
+    "description": "The ARIA label to collapse the sidebar category"
+  },
+  "theme.NavBar.navAriaLabel": {
+    "message": "Main",
+    "description": "The ARIA label for the main navigation"
+  },
+  "theme.navbar.mobileLanguageDropdown.label": {
+    "message": "Languages",
+    "description": "The label for the mobile language switcher dropdown"
+  },
+  "theme.NotFound.p1": {
+    "message": "We could not find what you were looking for.",
+    "description": "The first paragraph of the 404 page"
+  },
+  "theme.NotFound.p2": {
+    "message": "Please contact the owner of the site that linked you to the original URL and let them know their link is broken.",
+    "description": "The 2nd paragraph of the 404 page"
+  },
+  "theme.TOCCollapsible.toggleButtonLabel": {
+    "message": "On this page",
+    "description": "The label used by the button on the collapsible TOC component"
+  },
+  "theme.blog.post.readMore": {
+    "message": "Read more",
+    "description": "The label used in blog post item excerpts to link to full blog posts"
+  },
+  "theme.blog.post.readMoreLabel": {
+    "message": "Read more about {title}",
+    "description": "The ARIA label for the link to full blog posts from excerpts"
+  },
+  "theme.blog.post.readingTime.plurals": {
+    "message": "One min read|{readingTime} min read",
+    "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)"
+  },
+  "theme.CodeBlock.copy": {
+    "message": "Copy",
+    "description": "The copy button label on code blocks"
+  },
+  "theme.CodeBlock.copied": {
+    "message": "Copied",
+    "description": "The copied button label on code blocks"
+  },
+  "theme.CodeBlock.copyButtonAriaLabel": {
+    "message": "Copy code to clipboard",
+    "description": "The ARIA label for copy code blocks button"
+  },
+  "theme.CodeBlock.wordWrapToggle": {
+    "message": "Toggle word wrap",
+    "description": "The title attribute for toggle word wrapping button of code block lines"
+  },
+  "theme.docs.breadcrumbs.home": {
+    "message": "Home page",
+    "description": "The ARIA label for the home page in the breadcrumbs"
+  },
+  "theme.docs.sidebar.collapseButtonTitle": {
+    "message": "Collapse sidebar",
+    "description": "The title attribute for collapse button of doc sidebar"
+  },
+  "theme.docs.sidebar.collapseButtonAriaLabel": {
+    "message": "Collapse sidebar",
+    "description": "The title attribute for collapse button of doc sidebar"
+  },
+  "theme.docs.sidebar.navAriaLabel": {
+    "message": "Docs sidebar",
+    "description": "The ARIA label for the sidebar navigation"
+  },
+  "theme.docs.sidebar.closeSidebarButtonAriaLabel": {
+    "message": "Close navigation bar",
+    "description": "The ARIA label for close button of mobile sidebar"
+  },
+  "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": {
+    "message": "← Back to main menu",
+    "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)"
+  },
+  "theme.docs.sidebar.toggleSidebarButtonAriaLabel": {
+    "message": "Toggle navigation bar",
+    "description": "The ARIA label for hamburger menu button of mobile navigation"
+  },
+  "theme.navbar.mobileDropdown.collapseButton.expandAriaLabel": {
+    "message": "Expand the dropdown",
+    "description": "The ARIA label of the button to expand the mobile dropdown navbar item"
+  },
+  "theme.navbar.mobileDropdown.collapseButton.collapseAriaLabel": {
+    "message": "Collapse the dropdown",
+    "description": "The ARIA label of the button to collapse the mobile dropdown navbar item"
+  },
+  "theme.docs.sidebar.expandButtonTitle": {
+    "message": "Expand sidebar",
+    "description": "The ARIA label and title attribute for expand button of doc sidebar"
+  },
+  "theme.docs.sidebar.expandButtonAriaLabel": {
+    "message": "Expand sidebar",
+    "description": "The ARIA label and title attribute for expand button of doc sidebar"
+  },
+  "theme.blog.post.plurals": {
+    "message": "One post|{count} posts",
+    "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)"
+  },
+  "theme.blog.tagTitle": {
+    "message": "{nPosts} tagged with \"{tagName}\"",
+    "description": "The title of the page for a blog tag"
+  },
+  "theme.blog.author.pageTitle": {
+    "message": "{authorName} - {nPosts}",
+    "description": "The title of the page for a blog author"
+  },
+  "theme.blog.authorsList.pageTitle": {
+    "message": "Authors",
+    "description": "The title of the authors page"
+  },
+  "theme.blog.authorsList.viewAll": {
+    "message": "View all authors",
+    "description": "The label of the link targeting the blog authors page"
+  },
+  "theme.blog.author.noPosts": {
+    "message": "This author has not written any posts yet.",
+    "description": "The text for authors with 0 blog post"
+  },
+  "theme.contentVisibility.unlistedBanner.title": {
+    "message": "Unlisted page",
+    "description": "The unlisted content banner title"
+  },
+  "theme.contentVisibility.unlistedBanner.message": {
+    "message": "This page is unlisted. Search engines will not index it, and only users having a direct link can access it.",
+    "description": "The unlisted content banner message"
+  },
+  "theme.contentVisibility.draftBanner.title": {
+    "message": "Draft page",
+    "description": "The draft content banner title"
+  },
+  "theme.contentVisibility.draftBanner.message": {
+    "message": "This page is a draft. It will only be visible in dev and be excluded from the production build.",
+    "description": "The draft content banner message"
+  },
+  "theme.ErrorPageContent.tryAgain": {
+    "message": "Try again",
+    "description": "The label of the button to try again rendering when the React error boundary captures an error"
+  },
+  "theme.common.skipToMainContent": {
+    "message": "Skip to main content",
+    "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation"
+  },
+  "theme.tags.tagsPageTitle": {
+    "message": "Tags",
+    "description": "The title of the tag list page"
+  }
+}

synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/agent.md

@@ -0,0 +1,43 @@
+---
+id: agent
+title: AgentClient
+sidebar_position: 2
+---
+
+# AgentClient
+
+Agent 전용 작업 및 분산 실행을 위한 클라이언트입니다.
+
+## 개요
+
+`AgentClient`는 플러그인 실행, 작업 관리, 분산 컴퓨팅 통합을 포함한 agent 작업에 대한 액세스를 제공합니다.
+
+## Constructor
+
+```python
+AgentClient(
+    base_url: str,
+    agent_token: str = None,
+    timeout: dict = None
+)
+```
+
+## 사용법
+
+```python
+from synapse_sdk.clients.agent import AgentClient
+
+client = AgentClient(
+    base_url="https://api.synapse.sh",
+    agent_token="your-agent-token"
+)
+```
+
+## Methods
+
+곧 제공 예정 - AgentClient 메서드에 대한 상세 API 문서.
+
+## 참고
+
+- [BackendClient](./backend.md) - Backend 작업을 위한 클라이언트
+- [BaseClient](./base.md) - 기본 클라이언트 구현

synapse_sdk/devtools/docs/i18n/ko/docusaurus-plugin-content-docs/current/api/clients/annotation-mixin.md

@@ -0,0 +1,289 @@
+---
+id: annotation-mixin
+title: AnnotationClientMixin
+sidebar_position: 11
+---
+
+# AnnotationClientMixin
+
+Synapse 백엔드를 위한 어노테이션 및 태스크 관리 작업을 제공합니다.
+
+## 개요
+
+`AnnotationClientMixin`은 태스크, 어노테이션, 프로젝트, 태스크 태깅과 관련된 모든 작업을 처리합니다. 이 믹스인은 `BackendClient`에 자동으로 포함되며 어노테이션 워크플로를 위한 메서드를 제공합니다.
+
+## 프로젝트 작업
+
+### `get_project(pk)`
+
+특정 프로젝트에 대한 상세 정보를 가져옵니다.
+
+```python
+project = client.get_project(123)
+print(f"프로젝트: {project['name']}")
+print(f"설명: {project['description']}")
+```
+
+**매개변수:**
+
+- `pk` (int): 프로젝트 ID
+
+**반환값:**
+
+- `dict`: 구성, 메타데이터, 설정을 포함한 프로젝트 상세정보
+
+## 태스크 작업
+
+### `get_task(pk, params)`
+
+특정 태스크에 대한 상세 정보를 가져옵니다.
+
+```python
+# 기본 태스크 상세정보
+task = client.get_task(456)
+
+# 확장된 데이터 유닛이 포함된 태스크
+task = client.get_task(456, params={'expand': 'data_unit'})
+
+# 여러 확장이 포함된 태스크
+task = client.get_task(456, params={
+    'expand': ['data_unit', 'assignment', 'annotations']
+})
+```
+
+**매개변수:**
+
+- `pk` (int): 태스크 ID
+- `params` (dict): 필터링 및 확장을 위한 쿼리 매개변수
+
+**일반적인 params:**
+
+- `expand`: 포함할 관련 객체의 목록 또는 문자열
+- `include_annotations`: 어노테이션 데이터 포함 여부
+
+### `annotate_task_data(pk, data)`
+
+태스크에 대한 어노테이션 데이터를 제출합니다.
+
+```python
+# 바운딩 박스 어노테이션 제출
+annotation_data = {
+    'annotations': [
+        {
+            'type': 'bbox',
+            'coordinates': [10, 10, 100, 100],
+            'label': 'person',
+            'confidence': 0.95
+        },
+        {
+            'type': 'polygon',
+            'points': [[0, 0], [50, 0], [50, 50], [0, 50]],
+            'label': 'vehicle'
+        }
+    ],
+    'metadata': {
+        'annotator_id': 'user123',
+        'timestamp': '2023-10-01T12:00:00Z'
+    }
+}
+
+result = client.annotate_task_data(456, annotation_data)
+```
+
+**매개변수:**
+
+- `pk` (int): 태스크 ID
+- `data` (dict): 어노테이션 데이터 구조
+
+**반환값:**
+
+- `dict`: 제출된 어노테이션이 포함된 업데이트된 태스크
+
+### `list_tasks(params=None, url_conversion=None, list_all=False)`
+
+필터링 및 페이지네이션 지원과 함께 태스크를 나열합니다.
+
+```python
+# 특정 프로젝트의 태스크 나열
+tasks = client.list_tasks(params={'project': 123})
+
+# 상태 필터가 적용된 태스크 나열
+tasks = client.list_tasks(params={
+    'project': 123,
+    'status': 'pending'
+})
+
+# 모든 태스크 가져오기 (페이지네이션 자동 처리)
+all_tasks = client.list_tasks(list_all=True)
+
+# 파일에 대한 사용자 정의 URL 변환과 함께 태스크 나열
+tasks = client.list_tasks(
+    params={'project': 123},
+    url_conversion={'files': lambda url: f"https://cdn.example.com{url}"}
+)
+```
+
+**매개변수:**
+
+- `params` (dict, 선택사항): 필터링 매개변수
+- `url_conversion` (dict, 선택사항): 파일 필드에 대한 사용자 정의 URL 변환
+- `list_all` (bool): True인 경우, 모든 결과를 가져오기 위해 페이지네이션을 자동 처리
+
+**일반적인 필터링 params:**
+
+- `project`: 프로젝트 ID로 필터링
+- `status`: 태스크 상태로 필터링 (`pending`, `in_progress`, `completed`)
+- `assignee`: 할당된 사용자 ID로 필터링
+- `created_after`: 생성 날짜로 필터링
+- `search`: 태스크 내용에서 텍스트 검색
+
+**반환값:**
+
+- `tuple`: `list_all=False`인 경우 (tasks_list, total_count)
+- `list`: `list_all=True`인 경우 모든 태스크
+
+### `create_tasks(data)`
+
+하나 이상의 새 태스크를 생성합니다.
+
+```python
+# 단일 태스크 생성
+new_task = client.create_tasks({
+    'project': 123,
+    'data_unit': 789,
+    'priority': 'high',
+    'metadata': {'batch': 'batch_001'}
+})
+
+# 여러 태스크 생성
+new_tasks = client.create_tasks([
+    {'project': 123, 'data_unit': 789},
+    {'project': 123, 'data_unit': 790},
+    {'project': 123, 'data_unit': 791}
+])
+```
+
+**매개변수:**
+
+- `data` (dict 또는 list): 태스크 데이터 또는 태스크 데이터 목록
+
+**태스크 데이터 구조:**
+
+- `project` (int, 필수): 프로젝트 ID
+- `data_unit` (int, 필수): 데이터 유닛 ID
+- `priority` (str, 선택사항): 태스크 우선순위 (`low`, `normal`, `high`)
+- `assignee` (int, 선택사항): 태스크를 할당할 사용자 ID
+- `metadata` (dict, 선택사항): 추가 태스크 메타데이터
+
+**반환값:**
+
+- `dict` 또는 `list`: 생성된 ID가 포함된 생성된 태스크
+
+### `set_tags_tasks(data, params=None)`
+
+여러 태스크에 일괄적으로 태그를 설정합니다.
+
+```python
+# 여러 태스크에 태그 설정
+client.set_tags_tasks({
+    'task_ids': [456, 457, 458],
+    'tag_ids': [1, 2, 3]  # 적용할 태그 ID
+})
+
+# 추가 매개변수와 함께 태그 설정
+client.set_tags_tasks(
+    {
+        'task_ids': [456, 457],
+        'tag_ids': [1, 2]
+    },
+    params={'replace': True}  # 기존 태그 교체
+)
+```
+
+**매개변수:**
+
+- `data` (dict): 일괄 태깅 데이터
+- `params` (dict, 선택사항): 추가 매개변수
+
+**데이터 구조:**
+
+- `task_ids` (list): 태그를 설정할 태스크 ID 목록
+- `tag_ids` (list): 적용할 태그 ID 목록
+
+**선택적 params:**
+
+- `replace` (bool): True인 경우 기존 태그 교체, False인 경우 기존 태그에 추가
+
+## 태스크 태그 작업
+
+### `get_task_tag(pk)`
+
+특정 태스크 태그에 대한 상세정보를 가져옵니다.
+
+```python
+tag = client.get_task_tag(123)
+print(f"태그: {tag['name']} - {tag['description']}")
+```
+
+**매개변수:**
+
+- `pk` (int): 태그 ID
+
+**반환값:**
+
+- `dict`: 이름, 설명, 메타를 포함한 태그 상세정보
+
+### `list_task_tags(params)`
+
+필터링과 함께 사용 가능한 태스크 태그를 나열합니다.
+
+```python
+# 모든 태그 나열
+tags = client.list_task_tags({})
+
+# 특정 프로젝트의 태그 나열
+project_tags = client.list_task_tags({
+    'project': 123
+})
+
+# 이름으로 태그 검색
+search_tags = client.list_task_tags({
+    'search': 'quality'
+})
+```
+
+**매개변수:**
+
+- `params` (dict): 필터링 매개변수
+
+**일반적인 필터링 params:**
+
+- `project`: 프로젝트 ID로 필터링
+- `search`: 태그 이름에서 텍스트 검색
+- `color`: 태그 색상으로 필터링
+
+**반환값:**
+
+- `tuple`: (tags_list, total_count)
+
+## 오류 처리
+
+```python
+from synapse_sdk.clients.exceptions import ClientError
+
+try:
+    task = client.get_task(999999)
+except ClientError as e:
+    if e.status_code == 404:
+        print("태스크를 찾을 수 없음")
+    elif e.status_code == 403:
+        print("권한이 거부됨")
+    else:
+        print(f"API 오류: {e}")
+```
+
+## 참고
+
+- [BackendClient](./backend.md) - 메인 백엔드 클라이언트
+- [HITLClientMixin](./hitl-mixin.md) - Human-in-the-loop 작업
+- [DataCollectionClientMixin](./data-collection-mixin.md) - 데이터 관리