Skip to content

Questions

Questions in Argilla are the questions that will be answered as feedback. They are used to define the questions that will be answered by users or models.

Usage Examples

To define a label question, for example, instantiate the LabelQuestion class and pass it to the Settings class.

label_question = rg.LabelQuestion(name="label", labels=["positive", "negative"])

settings = rg.Settings(
    fields=[
        rg.TextField(name="text"),
    ],
    questions=[
        label_question,
    ],
)

Questions can be combined in extensible ways based on the type of feedback you want to collect. For example, you can combine a label question with a text question to collect both a label and a text response.

label_question = rg.LabelQuestion(name="label", labels=["positive", "negative"])
text_question = rg.TextQuestion(name="response")

settings = rg.Settings(
    fields=[
        rg.TextField(name="text"),
    ],
    questions=[
        label_question,
        text_question,
    ],
)

dataset = rg.Dataset(
    name="my_dataset",
    settings=settings,
)

To add records with responses to questions, refer to the rg.Response class documentation.

Class References

rg.LabelQuestion

Bases: SettingsPropertyBase

Source code in src/argilla_sdk/settings/_question.py 
 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
class LabelQuestion(SettingsPropertyBase):
    _model: LabelQuestionModel

    def __init__(
        self,
        name: str,
        labels: List[str],
        title: Optional[str] = None,
        description: Optional[str] = None,
        required: bool = True,
        visible_labels: Optional[int] = None,
    ) -> None:
        """ Define a new label question for `Settings` of a `Dataset`. A label \
            question is a question where the user can select one label from \
            a list of available labels.

        Parameters:
            name: str: The name of the question to be used as a reference.
            labels: List[str]: The list of available labels for the question.
            title: Optional[str]: The title of the question to be shown in the UI.
            description: Optional[str]: The description of the question to be shown in the UI.
            required: bool: If the question is required for a record to be valid.
            visible_labels: Optional[int]: The number of visible labels for the question.
        """
        self._model = LabelQuestionModel(
            name=name,
            title=title,
            description=description,
            required=required,
            settings=LabelQuestionSettings(options=_render_values_as_options(labels), visible_options=visible_labels),
        )

    @classmethod
    def from_model(cls, model: LabelQuestionModel) -> "LabelQuestion":
        instance = cls(name=model.name, labels=_render_options_as_values(model.settings.options))
        instance._model = model
        return instance

    ##############################
    # Public properties
    ##############################

    @property
    def labels(self) -> List[str]:
        return _render_options_as_values(self._model.settings.options)

    @labels.setter
    def labels(self, labels: List[str]) -> None:
        self._model.settings.options = _render_values_as_options(labels)

    @property
    def visible_labels(self) -> Optional[int]:
        return self._model.settings.visible_options

    @visible_labels.setter
    def visible_labels(self, visible_labels: Optional[int]) -> None:
        self._model.settings.visible_options = visible_labels

__init__(name, labels, title=None, description=None, required=True, visible_labels=None)

Define a new label question for Settings of a Dataset. A label question is a question where the user can select one label from a list of available labels.

Parameters:

Name Type Description Default
name str

str: The name of the question to be used as a reference.

 required
labels List[str]

List[str]: The list of available labels for the question.

 required
title Optional[str]

Optional[str]: The title of the question to be shown in the UI.

 None
description Optional[str]

Optional[str]: The description of the question to be shown in the UI.

 None
required bool

bool: If the question is required for a record to be valid.

 True
visible_labels Optional[int]

Optional[int]: The number of visible labels for the question.

 None
Source code in src/argilla_sdk/settings/_question.py 
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
def __init__(
    self,
    name: str,
    labels: List[str],
    title: Optional[str] = None,
    description: Optional[str] = None,
    required: bool = True,
    visible_labels: Optional[int] = None,
) -> None:
    """ Define a new label question for `Settings` of a `Dataset`. A label \
        question is a question where the user can select one label from \
        a list of available labels.

    Parameters:
        name: str: The name of the question to be used as a reference.
        labels: List[str]: The list of available labels for the question.
        title: Optional[str]: The title of the question to be shown in the UI.
        description: Optional[str]: The description of the question to be shown in the UI.
        required: bool: If the question is required for a record to be valid.
        visible_labels: Optional[int]: The number of visible labels for the question.
    """
    self._model = LabelQuestionModel(
        name=name,
        title=title,
        description=description,
        required=required,
        settings=LabelQuestionSettings(options=_render_values_as_options(labels), visible_options=visible_labels),
    )

rg.MultiLabelQuestion

Bases: LabelQuestion

Source code in src/argilla_sdk/settings/_question.py 
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
class MultiLabelQuestion(LabelQuestion):
    _model: MultiLabelQuestionModel

    def __init__(
        self,
        name: str,
        labels: List[str],
        visible_labels: Optional[int] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        required: bool = True,
    ) -> None:
        """Create a new multilabel question for `Settings` of a `Dataset`. A \
            multilabel question is a question where the user can select multiple \
            labels from a list of available labels.

        Parameters:
            name: str: The name of the question to be used as a reference.
            labels: List[str]: The list of available labels for the question.
            title: Optional[str]: The title of the question to be shown in the UI.
            description: Optional[str]: The description of the question to be shown in the UI.
            required: bool: If the question is required for a record to be valid.
            visible_labels: Optional[int]: The number of visible labels for the question.
        """
        self._model = MultiLabelQuestionModel(
            name=name,
            title=title,
            description=description,
            required=required,
            settings=MultiLabelQuestionSettings(
                options=_render_values_as_options(labels), visible_options=visible_labels
            ),
        )

    @classmethod
    def from_model(cls, model: MultiLabelQuestionModel) -> "MultiLabelQuestion":
        instance = cls(name=model.name, labels=_render_options_as_values(model.settings.options))
        instance._model = model

        return instance

__init__(name, labels, visible_labels=None, title=None, description=None, required=True)

Create a new multilabel question for Settings of a Dataset. A multilabel question is a question where the user can select multiple labels from a list of available labels.

Parameters:

Name Type Description Default
name str

str: The name of the question to be used as a reference.

 required
labels List[str]

List[str]: The list of available labels for the question.

 required
title Optional[str]

Optional[str]: The title of the question to be shown in the UI.

 None
description Optional[str]

Optional[str]: The description of the question to be shown in the UI.

 None
required bool

bool: If the question is required for a record to be valid.

 True
visible_labels Optional[int]

Optional[int]: The number of visible labels for the question.

 None
Source code in src/argilla_sdk/settings/_question.py 
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
def __init__(
    self,
    name: str,
    labels: List[str],
    visible_labels: Optional[int] = None,
    title: Optional[str] = None,
    description: Optional[str] = None,
    required: bool = True,
) -> None:
    """Create a new multilabel question for `Settings` of a `Dataset`. A \
        multilabel question is a question where the user can select multiple \
        labels from a list of available labels.

    Parameters:
        name: str: The name of the question to be used as a reference.
        labels: List[str]: The list of available labels for the question.
        title: Optional[str]: The title of the question to be shown in the UI.
        description: Optional[str]: The description of the question to be shown in the UI.
        required: bool: If the question is required for a record to be valid.
        visible_labels: Optional[int]: The number of visible labels for the question.
    """
    self._model = MultiLabelQuestionModel(
        name=name,
        title=title,
        description=description,
        required=required,
        settings=MultiLabelQuestionSettings(
            options=_render_values_as_options(labels), visible_options=visible_labels
        ),
    )

rg.RankingQuestion

Bases: SettingsPropertyBase

Source code in src/argilla_sdk/settings/_question.py 
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
class RankingQuestion(SettingsPropertyBase):
    _model: RankingQuestionModel

    def __init__(
        self,
        name: str,
        values: List[str],
        title: Optional[str] = None,
        description: Optional[str] = None,
        required: bool = True,
    ) -> None:
        """Create a new ranking question for `Settings` of a `Dataset`. A ranking question \
            is a question where the user can rank a list of options.

        Parameters:
            name: str: The name of the question to be used as a reference.
            values: List[str]: The list of available values for the question.
            title: Optional[str]: The title of the question to be shown in the UI.
            description: Optional[str]: The description of the question to be shown in the UI.
            required: bool: If the question is required for a record to be valid.
        """
        self._model = RankingQuestionModel(
            name=name,
            title=title,
            description=description,
            required=required,
            settings=RankingQuestionSettings(options=_render_values_as_options(values)),
        )

    @classmethod
    def from_model(cls, model: RankingQuestionModel) -> "RankingQuestion":
        instance = cls(name=model.name, values=_render_options_as_values(model.settings.options))
        instance._model = model

        return instance

    @property
    def values(self) -> List[str]:
        return _render_options_as_values(self._model.settings.options)

    @values.setter
    def values(self, values: List[int]) -> None:
        self._model.settings.options = _render_values_as_options(values)

__init__(name, values, title=None, description=None, required=True)

Create a new ranking question for Settings of a Dataset. A ranking question is a question where the user can rank a list of options.

Parameters:

Name Type Description Default
name str

str: The name of the question to be used as a reference.

 required
values List[str]

List[str]: The list of available values for the question.

 required
title Optional[str]

Optional[str]: The title of the question to be shown in the UI.

 None
description Optional[str]

Optional[str]: The description of the question to be shown in the UI.

 None
required bool

bool: If the question is required for a record to be valid.

 True
Source code in src/argilla_sdk/settings/_question.py 
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
def __init__(
    self,
    name: str,
    values: List[str],
    title: Optional[str] = None,
    description: Optional[str] = None,
    required: bool = True,
) -> None:
    """Create a new ranking question for `Settings` of a `Dataset`. A ranking question \
        is a question where the user can rank a list of options.

    Parameters:
        name: str: The name of the question to be used as a reference.
        values: List[str]: The list of available values for the question.
        title: Optional[str]: The title of the question to be shown in the UI.
        description: Optional[str]: The description of the question to be shown in the UI.
        required: bool: If the question is required for a record to be valid.
    """
    self._model = RankingQuestionModel(
        name=name,
        title=title,
        description=description,
        required=required,
        settings=RankingQuestionSettings(options=_render_values_as_options(values)),
    )

rg.TextQuestion

Bases: SettingsPropertyBase

Source code in src/argilla_sdk/settings/_question.py 
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
191
192
class TextQuestion(SettingsPropertyBase):
    _model: TextQuestionModel

    def __init__(
        self,
        name: str,
        title: Optional[str] = None,
        description: Optional[str] = None,
        required: bool = True,
        use_markdown: bool = False,
    ) -> None:
        """Create a new text question for `Settings` of a `Dataset`. A text question \
            is a question where the user can input text.

        Parameters:
            name: str: The name of the question to be used as a reference.
            title: Optional[str]: The title of the question to be shown in the UI.
            description: Optional[str]: The description of the question to be shown in the UI.
            required: bool: If the question is required for a record to be valid.
            use_markdown: bool: If the question should use markdown for the description.
        """
        self._model = TextQuestionModel(
            name=name,
            title=title,
            description=description,
            required=required,
            settings=TextQuestionSettings(use_markdown=use_markdown),
        )

    @classmethod
    def from_model(cls, model: TextQuestionModel) -> "TextQuestion":
        instance = cls(name=model.name)
        instance._model = model

        return instance

    @property
    def use_markdown(self) -> bool:
        return self._model.settings.use_markdown

    @use_markdown.setter
    def use_markdown(self, use_markdown: bool) -> None:
        self._model.settings.use_markdown = use_markdown

__init__(name, title=None, description=None, required=True, use_markdown=False)

Create a new text question for Settings of a Dataset. A text question is a question where the user can input text.

Parameters:

Name Type Description Default
name str

str: The name of the question to be used as a reference.

 required
title Optional[str]

Optional[str]: The title of the question to be shown in the UI.

 None
description Optional[str]

Optional[str]: The description of the question to be shown in the UI.

 None
required bool

bool: If the question is required for a record to be valid.

 True
use_markdown bool

bool: If the question should use markdown for the description.

 False
Source code in src/argilla_sdk/settings/_question.py 
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
def __init__(
    self,
    name: str,
    title: Optional[str] = None,
    description: Optional[str] = None,
    required: bool = True,
    use_markdown: bool = False,
) -> None:
    """Create a new text question for `Settings` of a `Dataset`. A text question \
        is a question where the user can input text.

    Parameters:
        name: str: The name of the question to be used as a reference.
        title: Optional[str]: The title of the question to be shown in the UI.
        description: Optional[str]: The description of the question to be shown in the UI.
        required: bool: If the question is required for a record to be valid.
        use_markdown: bool: If the question should use markdown for the description.
    """
    self._model = TextQuestionModel(
        name=name,
        title=title,
        description=description,
        required=required,
        settings=TextQuestionSettings(use_markdown=use_markdown),
    )

rg.RatingQuestion

Bases: SettingsPropertyBase

Source code in src/argilla_sdk/settings/_question.py 
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
class RatingQuestion(SettingsPropertyBase):
    _model: RatingQuestionModel

    def __init__(
        self,
        name: str,
        values: List[int],
        title: Optional[str] = None,
        description: Optional[str] = None,
        required: bool = True,
    ) -> None:
        """Create a new rating question for `Settings` of a `Dataset`. A rating question \
            is a question where the user can select a value from a sequential list of options.

        Parameters:
            name: str: The name of the question to be used as a reference.
            values: List[int]: The list of available values for the question.
            title: Optional[str]: The title of the question to be shown in the UI.
            description: Optional[str]: The description of the question to be shown in the UI.
            required: bool: If the question is required for a record to be valid.
        """
        self._model = RatingQuestionModel(
            name=name,
            title=title,
            description=description,
            required=required,
            values=values,
            settings=RatingQuestionSettings(options=_render_values_as_options(values)),
        )

    @classmethod
    def from_model(cls, model: RatingQuestionModel) -> "RatingQuestion":
        instance = cls(name=model.name, values=_render_options_as_values(model.settings.options))
        instance._model = model

        return instance

    @property
    def values(self) -> List[int]:
        return _render_options_as_values(self._model.settings.options)

    @values.setter
    def values(self, values: List[int]) -> None:
        self._model.values = _render_values_as_options(values)

__init__(name, values, title=None, description=None, required=True)

Create a new rating question for Settings of a Dataset. A rating question is a question where the user can select a value from a sequential list of options.

Parameters:

Name Type Description Default
name str

str: The name of the question to be used as a reference.

 required
values List[int]

List[int]: The list of available values for the question.

 required
title Optional[str]

Optional[str]: The title of the question to be shown in the UI.

 None
description Optional[str]

Optional[str]: The description of the question to be shown in the UI.

 None
required bool

bool: If the question is required for a record to be valid.

 True
Source code in src/argilla_sdk/settings/_question.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def __init__(
    self,
    name: str,
    values: List[int],
    title: Optional[str] = None,
    description: Optional[str] = None,
    required: bool = True,
) -> None:
    """Create a new rating question for `Settings` of a `Dataset`. A rating question \
        is a question where the user can select a value from a sequential list of options.

    Parameters:
        name: str: The name of the question to be used as a reference.
        values: List[int]: The list of available values for the question.
        title: Optional[str]: The title of the question to be shown in the UI.
        description: Optional[str]: The description of the question to be shown in the UI.
        required: bool: If the question is required for a record to be valid.
    """
    self._model = RatingQuestionModel(
        name=name,
        title=title,
        description=description,
        required=required,
        values=values,
        settings=RatingQuestionSettings(options=_render_values_as_options(values)),
    )

rg.SpanQuestion

Bases: SettingsPropertyBase

Source code in src/argilla_sdk/settings/_question.py 
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
class SpanQuestion(SettingsPropertyBase):
    _model: SpanQuestionModel

    def __init__(
        self,
        name: str,
        field: str,
        labels: List[str],
        allow_overlapping: bool = False,
        visible_labels: Optional[int] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        required: bool = True,
    ):
        """ Create a new span question for `Settings` of a `Dataset`. A span question \
            is a question where the user can select a section of text within a text field \
            and assign it a label.

            Parameters:
                name: str: The name of the question to be used as a reference.
                field: str: The name of the text field to apply the span question to.
                labels: List[str]: The list of available labels for the question.
                allow_overlapping: bool: If the user can select overlapping spans.
                visible_labels: Optional[int]: The number of labels to show at once.
                title: Optional[str]: The title of the question to be shown in the UI.
                description: Optional[str]: The description of the question to be shown in the UI.
                required: bool: If the question is required for a record to be valid.
            """
        self._model = SpanQuestionModel(
            name=name,
            title=title,
            description=description,
            required=required,
            settings=SpanQuestionSettings(
                field=field,
                allow_overlapping=allow_overlapping,
                visible_options=visible_labels,
                options=_render_values_as_options(labels),
            ),
        )

    @property
    def name(self):
        return self._model.name

    @property
    def field(self):
        return self._model.settings.field

    @field.setter
    def field(self, field: str):
        self._model.settings.field = field

    @property
    def allow_overlapping(self):
        return self._model.settings.allow_overlapping

    @allow_overlapping.setter
    def allow_overlapping(self, allow_overlapping: bool):
        self._model.settings.allow_overlapping = allow_overlapping

    @property
    def visible_labels(self) -> Optional[int]:
        return self._model.settings.visible_options

    @visible_labels.setter
    def visible_labels(self, visible_labels: Optional[int]) -> None:
        self._model.settings.visible_options = visible_labels

    @property
    def labels(self) -> List[str]:
        return _render_options_as_values(self._model.settings.options)

    @labels.setter
    def labels(self, labels: List[str]) -> None:
        self._model.settings.options = _render_values_as_options(labels)

    @classmethod
    def from_model(cls, model: SpanQuestionModel) -> "SpanQuestion":
        instance = cls(
            name=model.name,
            field=model.settings.field,
            labels=_render_options_as_values(model.settings.options),
        )
        instance._model = model

        return instance

__init__(name, field, labels, allow_overlapping=False, visible_labels=None, title=None, description=None, required=True)

Create a new span question for Settings of a Dataset. A span question is a question where the user can select a section of text within a text field and assign it a label.

Parameters:

Name Type Description Default
name str

str: The name of the question to be used as a reference.

 required
field str

str: The name of the text field to apply the span question to.

 required
labels List[str]

List[str]: The list of available labels for the question.

 required
allow_overlapping bool

bool: If the user can select overlapping spans.

 False
visible_labels Optional[int]

Optional[int]: The number of labels to show at once.

 None
title Optional[str]

Optional[str]: The title of the question to be shown in the UI.

 None
description Optional[str]

Optional[str]: The description of the question to be shown in the UI.

 None
required bool

bool: If the question is required for a record to be valid.

 True
Source code in src/argilla_sdk/settings/_question.py 
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def __init__(
    self,
    name: str,
    field: str,
    labels: List[str],
    allow_overlapping: bool = False,
    visible_labels: Optional[int] = None,
    title: Optional[str] = None,
    description: Optional[str] = None,
    required: bool = True,
):
    """ Create a new span question for `Settings` of a `Dataset`. A span question \
        is a question where the user can select a section of text within a text field \
        and assign it a label.

        Parameters:
            name: str: The name of the question to be used as a reference.
            field: str: The name of the text field to apply the span question to.
            labels: List[str]: The list of available labels for the question.
            allow_overlapping: bool: If the user can select overlapping spans.
            visible_labels: Optional[int]: The number of labels to show at once.
            title: Optional[str]: The title of the question to be shown in the UI.
            description: Optional[str]: The description of the question to be shown in the UI.
            required: bool: If the question is required for a record to be valid.
        """
    self._model = SpanQuestionModel(
        name=name,
        title=title,
        description=description,
        required=required,
        settings=SpanQuestionSettings(
            field=field,
            allow_overlapping=allow_overlapping,
            visible_options=visible_labels,
            options=_render_values_as_options(labels),
        ),
    )