用户#
在此处，我们描述如何通过 Python 客户端管理 Argilla 中的用户。
- class argilla.client.users.User(name=None, *, id=None)#
User 类用于管理 Argilla 中的用户。它提供了创建新用户、列出所有用户、通过名称或 ID 获取用户以及删除用户的方法。目前不允许更新用户信息。
- 参数:
name (Optional[str]) – 要管理的用户的名称。默认为 None。
id (Optional[Union[str, UUID]]) – 要管理的用户的 ID。默认为 None。
- _client#
初始化用于与 Argilla API 交互的 httpx.Client。
- 类型:
httpx.Client
- id#
用户的 ID。
- 类型:
uuid.UUID
- username#
用户的用户名。
- 类型:
str
- first_name#
用户的名字。
- 类型:
str
- last_name#
用户的姓氏。默认为 None。
- 类型:
Optional[str]
- full_name#
用户的全名。默认为 None。
- 类型:
Optional[str]
- role#
用户的角色。
- 类型:
argilla.client.sdk.users.models.UserRole
- api_key#
用户的 API 密钥。
- 类型:
str
- inserted_at#
用户创建的日期时间。
- 类型:
datetime.datetime
- updated_at#
用户上次更新的日期时间。
- 类型:
datetime.datetime
示例
>>> from argilla import rg >>> user = rg.User.from_name("my-user") # or `User.from_id("...")` >>> print(user) User(id='...', username='my-user', role='annotator', first_name='Luke', last_name="Skywalker', full_name='Luke Skywalker', role='annotator', api_key='...', inserted_at=datetime.datetime(2021, 8, 31, 10, 0, 0), updated_at=datetime.datetime(2021, 8, 31, 10, 0, 0))
- classmethod create(username, password, *, first_name=None, last_name=None, role=None, workspaces=None)#
在 Argilla 中创建新用户。
- 参数:
username (str) – 要创建的用户的用户名。
password (str) – 要创建的用户的密码。
first_name (Optional[str]) – 要创建的用户的名字。默认为 None。
last_name (Optional[str]) – 要创建的用户的姓氏。默认为 None。
role (Optional[UserRole]) – 要创建的用户的角色。默认为 None。
workspaces (Optional[List[str]]) – 要创建的用户链接到的工作区名称列表。默认为 None。
- 返回值:
一个新的 User 实例。
- Raises:
KeyError – 如果用户已存在于 Argilla 中。
ValueError – 如果提供的参数无效。
RuntimeError – 如果无法在 Argilla 中创建用户。
- Return type:
示例
>>> from argilla import rg >>> user = rg.User.create("my-user", "my-password", role="admin")
- delete()#
从 Argilla 中删除用户。
- Raises:
ValueError – 如果用户在 Argilla 中不存在。
RuntimeError – 如果无法从 Argilla 中删除用户。
- Return type:
None
示例
>>> from argilla import rg >>> user = rg.User.from_name("my-user") >>> user.delete()
- classmethod from_id(id)#
通过 ID 从 Argilla 获取现有用户。
- 参数:
id (UUID) – 要检索的用户的 ID。
- 返回值:
一个 User 实例。
- Raises:
ValueError – 如果具有提供的 ID 的用户不存在。
RuntimeError – 如果在检索用户时发生错误。
- Return type:
示例
>>> from argilla import rg >>> user = rg.User.from_id("my-user")
- classmethod from_name(name)#
通过名称从 Argilla 获取现有用户。
- 参数:
name (str) – 要检索的用户的名称。
- 返回值:
一个 User 实例。
- Raises:
ValueError – 如果具有提供的名称的用户不存在。
RuntimeError – 如果在检索用户时发生错误。
- Return type:
示例
>>> from argilla import rg >>> user = rg.User.from_name("my-user")
- property is_admin: bool#
返回当前用户是否为管理员。
- 返回值:
一个布尔值，指示当前用户是否为管理员。
- property is_annotator: bool#
返回当前用户是否为注释者。
- 返回值:
一个布尔值，指示当前用户是否为注释者。
- property is_owner: bool#
返回当前用户是否为所有者。
- 返回值:
一个布尔值，指示当前用户是否为所有者。
- classmethod list()#
列出 Argilla 中的所有用户。
- 返回值:
一个 User 实例的迭代器。
- Raises:
RuntimeError – 如果在列出用户时发生错误。
- Return type:
Iterator[User]
示例
>>> from argilla import rg >>> for user in rg.User.list(): ... print(user)
- classmethod me()#
从 Argilla 获取当前用户。
- 返回值:
一个 User 实例。
- Raises:
RuntimeError – 如果在检索当前用户时发生错误。
- Return type:
示例
>>> from argilla import rg >>> user = rg.User.me()
- property workspaces: Optional[List[WorkspaceModel]]#
返回当前用户链接到的工作区名称。
- 返回值:
当前用户链接到的 WorkspaceModel 列表。