Skip to content

rg.User

A user in Argilla is a profile that uses the SDK or UI. Their profile can be used to track their feedback activity and to manage their access to the Argilla server.

Usage Examples

To create a new user, instantiate the User object with the client and the username:

user = rg.User(username="my_username", password="my_password")
user.create()

Existing users can be retrieved by their username:

user = client.users("my_username")

The current user of the rg.Argilla client can be accessed using the me attribute:

client.me

Class Reference

rg.User

Bases: Resource

Class for interacting with Argilla users in the Argilla server. User profiles are used to manage access to the Argilla server and track responses to records.

Attributes:

Name Type Description
username str

The username of the user.
first_name str

The first name of the user.
last_name str

The last name of the user.
role str

The role of the user, either 'annotator' or 'admin'.
password str

The password of the user.
id UUID

The ID of the user.
Source code in src/argilla_sdk/users/_resource.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
class User(Resource):
    """Class for interacting with Argilla users in the Argilla server. User profiles \
        are used to manage access to the Argilla server and track responses to records.

    Attributes:
        username (str): The username of the user.
        first_name (str): The first name of the user.
        last_name (str): The last name of the user.
        role (str): The role of the user, either 'annotator' or 'admin'.
        password (str): The password of the user.
        id (UUID): The ID of the user.
    """

    _model: UserModel
    _api: UsersAPI

    def __init__(
        self,
        username: Optional[str] = None,
        first_name: Optional[str] = None,
        last_name: Optional[str] = None,
        role: Optional[str] = None,
        password: Optional[str] = None,
        client: Optional["Argilla"] = None,
        id: Optional[UUID] = None,
        _model: Optional[UserModel] = None,
    ) -> None:
        """Initializes a User object with a client and a username

        Parameters:
            username (str): The username of the user
            first_name (str): The first name of the user
            last_name (str): The last name of the user
            role (str): The role of the user, either 'annotator', admin, or 'owner'
            password (str): The password of the user. If not provided, a random password will be generated
            client (Argilla): The client used to interact with Argilla

        Returns:
            User: The initialized user object
        ```
        """
        client = client or Argilla._get_default()
        super().__init__(client=client, api=client.api.users)

        if _model is None:
            _model = UserModel(
                username=username,
                password=password or self._generate_random_password(),
                first_name=first_name or username,
                last_name=last_name,
                role=role or Role.annotator,
                id=id,
            )
            self._log_message(f"Initialized user with username {username}")
        self._model = _model

    def create(self) -> "User":
        """Creates the user in Argilla. After creating a user, it will be able to log in to the Argilla server.

        Returns:
            User: The user that was created in Argilla.

        """
        model_create = self.api_model()
        model = self._api.create(model_create)
        # The password is not returned in the response
        model.password = model_create.password
        self._model = model
        return self

    def delete(self) -> None:
        """Deletes the user from Argilla. After deleting a user, it will no longer be able to log in to the Argilla server."""
        super().delete()
        # exists relies on the id, so we need to set it to None
        self._model = UserModel(username=self.username)

    def exists(self) -> bool:
        """Checks if the user exists in Argilla

        Returns:
            bool: True if the user exists, False otherwise.
        """
        # TODO - Implement the exist method in the API
        return self.id is not None

    def add_to_workspace(self, workspace: "Workspace") -> "User":
        """Adds the user to a workspace. After adding a user to a workspace, it will have access to the datasets
        in the workspace.

        Args:
            workspace (Workspace): The workspace to add the user to.

        Returns:
            User: The user that was added to the workspace.
        """
        self._model = self._api.add_to_workspace(workspace.id, self.id)
        return self

    def remove_from_workspace(self, workspace: "Workspace") -> "User":
        """Removes the user from a workspace. After removing a user from a workspace, it will no longer have access to
        the datasets in the workspace.

        Args:
            workspace (Workspace): The workspace to remove the user from.

        Returns:
            User: The user that was removed from the workspace.

        """
        self._model = self._api.delete_from_workspace(workspace.id, self.id)
        return self

    ############################
    # Properties
    ############################
    @property
    def username(self) -> str:
        return self._model.username

    @username.setter
    def username(self, value: str) -> None:
        self._model.username = value

    @property
    def password(self) -> str:
        return self._model.password

    @password.setter
    def password(self, value: str) -> None:
        self._model.password = value

    @property
    def first_name(self) -> str:
        return self._model.first_name

    @first_name.setter
    def first_name(self, value: str) -> None:
        self._model.first_name = value

    @property
    def last_name(self) -> str:
        return self._model.last_name

    @last_name.setter
    def last_name(self, value: str) -> None:
        self._model.last_name = value

    @property
    def role(self) -> Role:
        return self._model.role

    @role.setter
    def role(self, value: Role) -> None:
        self._model.role = value

    ############################
    # Private methods
    ############################

    @staticmethod
    def _generate_random_password(n: int = 12) -> str:
        """Generates a random password for the user"""
        import random
        import string

        return "".join(random.choices(string.ascii_letters + string.digits, k=n))

__init__(username=None, first_name=None, last_name=None, role=None, password=None, client=None, id=None, _model=None)

Initializes a User object with a client and a username

Parameters:

Name Type Description Default
username str

The username of the user

 None
first_name str

The first name of the user

 None
last_name str

The last name of the user

 None
role str

The role of the user, either 'annotator', admin, or 'owner'

 None
password str

The password of the user. If not provided, a random password will be generated

 None
client Argilla

The client used to interact with Argilla

 None

Returns:

Name Type Description
User None

The initialized user object

```

Source code in src/argilla_sdk/users/_resource.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def __init__(
    self,
    username: Optional[str] = None,
    first_name: Optional[str] = None,
    last_name: Optional[str] = None,
    role: Optional[str] = None,
    password: Optional[str] = None,
    client: Optional["Argilla"] = None,
    id: Optional[UUID] = None,
    _model: Optional[UserModel] = None,
) -> None:
    """Initializes a User object with a client and a username

    Parameters:
        username (str): The username of the user
        first_name (str): The first name of the user
        last_name (str): The last name of the user
        role (str): The role of the user, either 'annotator', admin, or 'owner'
        password (str): The password of the user. If not provided, a random password will be generated
        client (Argilla): The client used to interact with Argilla

    Returns:
        User: The initialized user object
    ```
    """
    client = client or Argilla._get_default()
    super().__init__(client=client, api=client.api.users)

    if _model is None:
        _model = UserModel(
            username=username,
            password=password or self._generate_random_password(),
            first_name=first_name or username,
            last_name=last_name,
            role=role or Role.annotator,
            id=id,
        )
        self._log_message(f"Initialized user with username {username}")
    self._model = _model

add_to_workspace(workspace)

Adds the user to a workspace. After adding a user to a workspace, it will have access to the datasets in the workspace.

Parameters:

Name Type Description Default
workspace Workspace

The workspace to add the user to.

 required

Returns:

Name Type Description
User User

The user that was added to the workspace.
Source code in src/argilla_sdk/users/_resource.py 
110
111
112
113
114
115
116
117
118
119
120
121
def add_to_workspace(self, workspace: "Workspace") -> "User":
    """Adds the user to a workspace. After adding a user to a workspace, it will have access to the datasets
    in the workspace.

    Args:
        workspace (Workspace): The workspace to add the user to.

    Returns:
        User: The user that was added to the workspace.
    """
    self._model = self._api.add_to_workspace(workspace.id, self.id)
    return self

create()

Creates the user in Argilla. After creating a user, it will be able to log in to the Argilla server.

Returns:

Name Type Description
User User

The user that was created in Argilla.
Source code in src/argilla_sdk/users/_resource.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
def create(self) -> "User":
    """Creates the user in Argilla. After creating a user, it will be able to log in to the Argilla server.

    Returns:
        User: The user that was created in Argilla.

    """
    model_create = self.api_model()
    model = self._api.create(model_create)
    # The password is not returned in the response
    model.password = model_create.password
    self._model = model
    return self

delete()

Deletes the user from Argilla. After deleting a user, it will no longer be able to log in to the Argilla server.

Source code in src/argilla_sdk/users/_resource.py 
95
96
97
98
99
def delete(self) -> None:
    """Deletes the user from Argilla. After deleting a user, it will no longer be able to log in to the Argilla server."""
    super().delete()
    # exists relies on the id, so we need to set it to None
    self._model = UserModel(username=self.username)

exists()

Checks if the user exists in Argilla

Returns:

Name Type Description
bool bool

True if the user exists, False otherwise.
Source code in src/argilla_sdk/users/_resource.py 
101
102
103
104
105
106
107
108
def exists(self) -> bool:
    """Checks if the user exists in Argilla

    Returns:
        bool: True if the user exists, False otherwise.
    """
    # TODO - Implement the exist method in the API
    return self.id is not None

remove_from_workspace(workspace)

Removes the user from a workspace. After removing a user from a workspace, it will no longer have access to the datasets in the workspace.

Parameters:

Name Type Description Default
workspace Workspace

The workspace to remove the user from.

 required

Returns:

Name Type Description
User User

The user that was removed from the workspace.
Source code in src/argilla_sdk/users/_resource.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
def remove_from_workspace(self, workspace: "Workspace") -> "User":
    """Removes the user from a workspace. After removing a user from a workspace, it will no longer have access to
    the datasets in the workspace.

    Args:
        workspace (Workspace): The workspace to remove the user from.

    Returns:
        User: The user that was removed from the workspace.

    """
    self._model = self._api.delete_from_workspace(workspace.id, self.id)
    return self