Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 188 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -29651,6 +29651,194 @@ client.organizations.member_tags.assign(
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.organizations.member_tags.<a href="src/label_studio_sdk/organizations/member_tags/client.py">import_</a>(...) -&gt; AsyncHttpResponse[ImportMemberTagsResponse]</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Upload a CSV file to bulk import member tags and assign them to organization members.

The CSV file must contain `email` and `tags` columns. The `tags` column should contain comma-separated tag labels (quoted if they contain commas). Tags that do not exist will be created.

Optionally, you can specify `bulk_tags` as a comma-separated list of tags to apply to all users in the CSV file.

The import runs asynchronously. Use the returned import job ID to check the status.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from label_studio_sdk import LabelStudio

client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.member_tags.import_(
id=1,
bulk_tags="bulk_tags",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `int` — A unique integer value identifying this organization.

</dd>
</dl>

<dl>
<dd>

**bulk_tags:** `str`

</dd>
</dl>

<dl>
<dd>

**file:** `from __future__ import annotations

core.File` — See core.File for more documentation

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.organizations.member_tags.<a href="src/label_studio_sdk/organizations/member_tags/client.py">get_import</a>(...) -&gt; AsyncHttpResponse[OrganizationMemberTagImportStatus]</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve the status and results of a member tag import job.

The response includes the current status (created, in_progress, completed, failed), timestamps, and counts of tags created, assignments made, and users skipped.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from label_studio_sdk import LabelStudio

client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.member_tags.get_import(
id=1,
import_pk=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `int` — A unique integer value identifying this organization.

</dd>
</dl>

<dl>
<dd>

**import_pk:** `int` — A unique integer value identifying this import job.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down
6 changes: 6 additions & 0 deletions src/label_studio_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@
OrganizationMemberCreatedProjectsItem,
OrganizationMemberTag,
OrganizationMemberTagAssignmentRequest,
OrganizationMemberTagImportStatus,
OrganizationMemberTagImportStatusStatusEnum,
OrganizationMembership,
OrganizationPermission,
OrganizationPermissionRequest,
Expand Down Expand Up @@ -505,6 +507,8 @@
"OrganizationMemberCreatedProjectsItem": ".types",
"OrganizationMemberTag": ".types",
"OrganizationMemberTagAssignmentRequest": ".types",
"OrganizationMemberTagImportStatus": ".types",
"OrganizationMemberTagImportStatusStatusEnum": ".types",
"OrganizationMembership": ".types",
"OrganizationPermission": ".types",
"OrganizationPermissionRequest": ".types",
Expand Down Expand Up @@ -839,6 +843,8 @@ def __dir__():
"OrganizationMemberCreatedProjectsItem",
"OrganizationMemberTag",
"OrganizationMemberTagAssignmentRequest",
"OrganizationMemberTagImportStatus",
"OrganizationMemberTagImportStatusStatusEnum",
"OrganizationMembership",
"OrganizationPermission",
"OrganizationPermissionRequest",
Expand Down
5 changes: 3 additions & 2 deletions src/label_studio_sdk/organizations/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@

if typing.TYPE_CHECKING:
from . import invites, member_tags, members, permissions
from .member_tags import AssignMemberTagsResponse
from .member_tags import AssignMemberTagsResponse, ImportMemberTagsResponse
_dynamic_imports: typing.Dict[str, str] = {
"AssignMemberTagsResponse": ".member_tags",
"ImportMemberTagsResponse": ".member_tags",
"invites": ".invites",
"member_tags": ".member_tags",
"members": ".members",
Expand Down Expand Up @@ -38,4 +39,4 @@ def __dir__():
return sorted(lazy_attrs)


__all__ = ["AssignMemberTagsResponse", "invites", "member_tags", "members", "permissions"]
__all__ = ["AssignMemberTagsResponse", "ImportMemberTagsResponse", "invites", "member_tags", "members", "permissions"]
5 changes: 3 additions & 2 deletions src/label_studio_sdk/organizations/member_tags/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@
from importlib import import_module

if typing.TYPE_CHECKING:
from .types import AssignMemberTagsResponse
from .types import AssignMemberTagsResponse, ImportMemberTagsResponse
from . import bulk
from .bulk import DeleteBulkResponse, PostBulkResponse
_dynamic_imports: typing.Dict[str, str] = {
"AssignMemberTagsResponse": ".types",
"DeleteBulkResponse": ".bulk",
"ImportMemberTagsResponse": ".types",
"PostBulkResponse": ".bulk",
"bulk": ".bulk",
}
Expand All @@ -38,4 +39,4 @@ def __dir__():
return sorted(lazy_attrs)


__all__ = ["AssignMemberTagsResponse", "DeleteBulkResponse", "PostBulkResponse", "bulk"]
__all__ = ["AssignMemberTagsResponse", "DeleteBulkResponse", "ImportMemberTagsResponse", "PostBulkResponse", "bulk"]
Loading
Loading