Skip to content
Merged
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
author_id: 15914823752205
category_id: 39646615083277
created_at: '2025-01-09T16:24:44Z'
labels: []
locale: en-us
position: 0
section_id: 39649211977869
title: A Guide to Filter inside of annotation.results object
updated_at: '2025-09-17T18:44:48Z'
zendesk_article_id: 33346631335565
---

# Understanding Annotation Results


A Label Studio annotation consists of regions, stored as a list in the `annotation.result` field. For instance:

```
"annotations": [
{
"id": 44553935,
"result": [
{
"id": "zLSY-XLk64",
"type": "choices",
"value": {
"choices": [
"yes"
]
},
"origin": "manual",
"to_name": "query",
"from_name": "understand"
},
{
"id": "uh87CbF1k3",
"type": "choices",
"value": {
"choices": [
"no"
]
},
"origin": "manual",
"to_name": "query",
"from_name": "consistency"
},
{
"id": "Yd_BW-pLht",
"type": "choices",
"value": {
"choices": [
"other"
]
},
"origin": "manual",
"to_name": "query",
"from_name": "consistency_reason"
},
...
]
```


In most cases, regions have a `from_name` field, which links to the control tag from your labeling config. Each region's `value` stores the control's response.


# Building the filter


As follows from annotation result understanding, our can identify your answers using a pair `(from_name, value)`. 

Based on the `annotation.result`, you can identify answers using a `(from_name, value)` pair. The `annotation.result` is stored as a JSON string in the Label Studio database, allowing us to search like a simple string. To construct a filter let's consider this region:

```
{
"id": "uh87CbF1k3",
"type": "choices",
"value": {
"choices": ["no"]
},
"origin": "manual",
"to_name": "query",
"from_name": "consistency"
}
```



1. Keep only the part that has value and control tag name.
2. Remove `\n` and spaces that surround `{` and `}`.


As the result we have: 

```
["no"]}, "origin": "manual", "to_name": "query", "from_name": "consistency"
```



# Use the filter in the Data Manager


Now, copy this filter into the **Data Manager.** Go to **Filter** → **Annotation Result** → **Contains** and paste `["no"]}, "origin": "manual", "to_name": "query", "from_name": "consistency"`:

![](https://labelstudio.zendesk.com/attachments/token/BDMVDE9r5o05xmlHxm66kCIJB/?name=image.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
author_id: 18127715992333
category_id: 39646615083277
created_at: '2024-01-30T01:22:16Z'
labels: []
locale: en-us
position: 0
section_id: 39649206773773
title: Audio wave doesn't match annotations
updated_at: '2025-09-17T17:46:42Z'
zendesk_article_id: 23638672221325
---

If you find that after annotating audio data, the visible audio wave doesn’t match the timestamps and the sound, try converting the audio to a different format. For example, if you are annotating mp3 files, try converting them to wav files.

```
ffmpeg -y -i audio.mp3 -ar 8k -ac 1 audio.wav
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
author_id: 16760288545421
category_id: 39646615083277
created_at: '2023-12-07T17:24:16Z'
labels: []
locale: en-us
position: 0
section_id: 39649206773773
title: 'How do I get all Choice items to render in a single line? '
updated_at: '2025-09-17T17:46:20Z'
zendesk_article_id: 22052885933325
---

To display the choices in a single line, you can use the `showInline="true"` attribute within your `<Choices>` tag. This will render the choices horizontally instead of vertically. Here's how you can modify your existing `<Choices>` tag:

```
<Choices name="is_useful" toName="item" required="true" showInline="true">
<Choice value="yes"/>
<Choice value="no"/>
</Choices>
```

By adding `showInline="true"`, the choices "yes" and "no" will be displayed in a single line, achieving the layout you're looking for.
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
author_id: 16760288545421
category_id: 39646615083277
created_at: '2024-06-24T16:23:59Z'
labels: []
locale: en-us
position: 0
section_id: 39649206773773
title: How do I limit the max width of taxonomy fields?
updated_at: '2025-09-17T17:45:28Z'
zendesk_article_id: 27845825489677
---

### Summary

This article provides guidance on using CSS adjustments to limit the maximum width of taxonomy fields in Label Studio. By setting the `maxWidth` attribute, users can control the width of taxonomy dropdowns to ensure that long texts do not overflow or cause layout issues. This is particularly useful for maintaining a clean and readable interface when dealing with extensive taxonomy options.

### Troubleshooting steps

1. **Identify the Taxonomy Field:** Locate the taxonomy field in your labeling interface configuration. It will look something like this:

```
<Taxonomy name="media" toName="title" maxUsages="1" leafsOnly="true" />
```
2. **Add the `maxWidth` Attribute:** To limit the maximum width of the taxonomy field, add the `maxWidth` attribute with a desired value. For example, to set the maximum width to 300 pixels:

```
<Taxonomy name="media" toName="title" maxUsages="1" leafsOnly="true" maxWidth="300px" />
```
3. **Adjust the Dropdown Width (if necessary):** If the dropdown list is too narrow, you can also set the `dropdownWidth` attribute to ensure it fits the content. For example, to set the dropdown width to 500 pixels:

```
<Taxonomy name="media" toName="title" maxUsages="1" leafsOnly="true" maxWidth="300px" dropdownWidth="500" />
```
4. **Test the Changes:** Save your changes and reload the Label Studio interface to ensure that the taxonomy field and dropdown now adhere to the specified width constraints.
5. **Fallback to Old Version (if needed):** If the new taxonomy settings do not meet your requirements, you can revert to the previous version by using the `legacy` attribute:

```
<Taxonomy name="media" toName="title" legacy="true" />
```

### More resources

- [Label Studio Taxonomy Tag Documentation](https://docs.humansignal.com/tags/taxonomy)

By following these steps, you can effectively manage the width of taxonomy fields in Label Studio, ensuring a better user experience and interface layout.
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
author_id: 16760288545421
category_id: 39646615083277
created_at: '2024-06-17T16:38:33Z'
labels: []
locale: en-us
position: 0
section_id: 39649206773773
title: How to Display Long Texts in a Separate Static Text Field
updated_at: '2025-09-17T17:44:43Z'
zendesk_article_id: 27641232245517
---

## Summary

This article provides a step-by-step guide on how to display long texts in a separate static text field within Label Studio. This approach helps prevent long texts from spreading outside the labeling interface and ensures that users can view the entire text without scrolling issues. Follow these troubleshooting steps to implement this solution effectively.

## Troubleshooting Steps

### Step 1: Modify the Labeling Configuration

To display long texts in a separate static text field, you need to adjust the labeling configuration in your project. Use the `<View>` and `<Text>` tags to create a static text field.

1. Open your project’s labeling configuration.
2. Add a new `<View>` tag to wrap the text field.
3. Use the `<Text>` tag to display the long text within the `<View>` tag.

```
<View>
<Header value="Please read the text" />
<View style="height: 300px; overflow: auto;">
<Text name="text" value="$longText" />
</View>
<Header value="Provide one sentence summary" />
<TextArea name="answer" toName="text"
showSubmitButton="true" maxSubmissions="1" editable="true"
required="true" />
</View>
```

### Step 2: Apply CSS Styling

To ensure the text wraps correctly and does not overflow, apply CSS styling to the `<View>` tag. This will constrain the text sample to a specific height and make it easier to keep the text summary visible.

```
<View style="height: 300px; overflow: auto;">
<Text name="text" value="$longText" />
</View>
```

### Step 3: Test the Configuration

After modifying the labeling configuration, test it to ensure that the long text displays correctly within the static text field. Make sure the text wraps appropriately and does not cause any scrolling issues.

1. Save the changes to your labeling configuration.
2. Open a task in your project to verify the display of the long text.
3. Ensure that the text is fully visible and does not overflow the designated area.

## More Resources

For more information on customizing labeling configurations and using different tags in Label Studio, refer to the following resources:

- [Label Studio Tag Documentation](https://docs.humansignal.com/tags/)
- [Text Summarization Template](https://docs.humansignal.com/templates/text_summarization)

By following these steps, you can effectively display long texts in a separate static text field, ensuring a better user experience for annotators.
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
author_id: 16760288545421
category_id: 39646615083277
created_at: '2024-07-09T22:11:55Z'
labels: []
locale: en-us
position: 0
section_id: 39649206773773
title: How to ensure labeling interface settings are saved correctly
updated_at: '2025-09-17T17:44:11Z'
zendesk_article_id: 28278631494541
---

**Summary:** This article provides steps to troubleshoot and resolve issues related to labeling interface settings not being saved correctly in Label Studio. Users often encounter problems where settings like "Show line numbers" and "Show region labels" revert to default options upon reentering the queue. Follow these steps to ensure your settings are retained.

**Troubleshooting Steps:**

1. **Clear Browser Cache:**

- Sometimes, browser cache can cause settings to revert. Clear your browser cache and cookies, then try setting your preferences again.
2. **Verify User Permissions:**

- Ensure that you have the necessary permissions to change and save settings. Check with your administrator if you are unsure about your permission levels.
3. **Save Settings Properly:**

- After adjusting your settings, make sure to click the "Save" button. Double-check that the settings are saved by navigating away from the page and returning to see if the changes persist.
4. **Check for Conflicting Extensions:**

- Browser extensions can sometimes interfere with the functionality of web applications. Disable any extensions that might be causing conflicts and try saving your settings again.
5. **Inspect Browser Console for Errors:**

- Open your browser's developer tools (usually by pressing F12 or right-clicking and selecting "Inspect") and check the console for any error messages when you try to save your settings. This can provide clues about what might be going wrong.
6. **Reset to Default and Reconfigure:**

- If the issue persists, try resetting the settings to their default values and then reconfigure them. This can sometimes resolve issues caused by corrupted settings.
7. **Contact Support:**

- If none of the above steps work, reach out to Label Studio support with detailed information about the issue, including any error messages from the browser console. They can provide further assistance and investigate the problem.

**More Resources:**

- [Label Studio Documentation](https://labelstud.io/guide/FAQ.html)
- [HumanSignal Support Center](https://support.humansignal.com/hc/en-us)
- [Label Studio GitHub Issues](https://github.com/HumanSignal/label-studio/issues)

By following these steps, you should be able to ensure that your labeling interface settings are saved correctly and persist across sessions. If you continue to experience issues, the provided resources and support channels can offer additional help.
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
author_id: 15914823752205
category_id: 39646615083277
created_at: '2024-07-18T17:10:47Z'
labels: []
locale: en-us
position: 0
section_id: 39649206773773
title: How to Use the Ranker Component
updated_at: '2025-09-17T17:35:35Z'
zendesk_article_id: 28531985845389
---

**Summary**

The Ranker tag in Label Studio allows users to rank items in a list or distribute them into predefined buckets. This tag is particularly useful for tasks like evaluating LLM responses, sorting search results, or categorizing items based on relevance. The Ranker tag works in conjunction with the List tag and can be customized with various parameters and styles to fit specific project needs.

**Steps to Implement:**

1. **Ensure Proper Data Format:**
- Verify that your task data is correctly formatted. The List tag should contain an array of objects with required fields like id, and optional fields like title, body, or html.

               Example data format:

```
{
"items":
[
{"id": "item1", "title": "Title 1", "body": "Body 1" },
{"id": "item2", "title": "Title 2", "body": "Body 2" }
]
}
```

1. **Correct Labeling Interface Configuration:**
- Ensure that the Ranker tag is correctly connected to the List tag using the toName attribute.
- Example configuration:

```
<View>
  <List name="results" value="$items"
title="Search Results" />
  <Ranker name="rank" toName="results">
    <Bucket name="best"
title="Best results" />
    <Bucket name="ads"
title="Paid results" />
  </Ranker>
</View>
```

1. **Check for Browser Compatibility:**
- If the Ranker component is not rendering, try using a different browser. Some users have reported issues with non-Chromium based browsers like Safari and Firefox.
- Example issue: [GitHub Issue #995](https://github.com/HumanSignal/label-studio/issues/995)
2. **Inspect Console for Errors:**
- Open the browser's developer console to check for any errors that might indicate issues with the Ranker component.
- Common errors might include missing or undefined properties.
3. **Update to Latest Version:**
- Ensure you are using the latest version of Label Studio, as updates often include bug fixes and improvements for components like Ranker.
- Example: Users found that updating to the latest Docker image resolved issues with Ranker not loading.
4. **Styling and Customization:**
- Use the <Style> tag to customize the appearance of columns and items within the Ranker component.
- Example styling:

```
<Style>
  .htx-ranker-column { background:
cornflowerblue; }
  .htx-ranker-item { background:
lightgoldenrodyellow; }
</Style>
```

**More resources**

- [Ranker Tag Documentation](https://labelstud.io/tags/ranker.html)
- [LLM Ranker Template](https://labelstud.io/templates/generative-llm-ranker.html)
- [Label Studio GitHub Repository](https://github.com/HumanSignal/label-studio)
- [Label Studio Blog: Five Large Language Models You Can Fine-Tune Today](https://labelstud.io/blog/five-large-language-models-you-can-fine-tune-today/)
- [Label Studio Zero to One Tutorial](https://labelstud.io/blog/zero-to-one-getting-started-with-label-studio/)
Loading
Loading