Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

docs: DOC-121: Update Taxonomy tag page for external taxonomy #1577

Merged
merged 2 commits into from
Nov 13, 2023
Merged
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
9 changes: 6 additions & 3 deletions src/tags/control/Taxonomy/Taxonomy.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ import styles from './Taxonomy.styl';
/**
* The `Taxonomy` tag is used to create one or more hierarchical classifications, storing both choice selections and their ancestors in the results. Use for nested classification tasks with the `Choice` tag.
*
* You can define nested classifications using the `Choice` tag, or retrieve external classifications using the `apiUrl` parameter. For more information on these options, see the [Taxonomy template page](/templates/taxonomy).
*
* Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.
*
* [^FF_LSDV_4583]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality
Expand All @@ -54,18 +56,19 @@ import styles from './Taxonomy.styl';
* @meta_description Customize Label Studio with the Taxonomy tag and use hierarchical labels for machine learning and data science projects.
* @param {string} name - Name of the element
* @param {string} toName - Name of the element that you want to classify
* @param {string} [apiUrl] - URL to fetch taxonomy from remote source; API should accept optional array `path` param: `apiUrl?path[]=root&path[]=child1` to return only nested children of `child1` node[^FF_TAXONOMY_ASYNC]
* @param {string} [apiUrl] - Retrieve the taxonomy from a remote source. This can be a JSON-formatted file or a hierarchical data source read as an API.[^FF_TAXONOMY_ASYNC] For more information, see the [Taxonomy template page](/templates/taxonomy)
* @param {boolean} [leafsOnly=false] - Allow annotators to select only leaf nodes of taxonomy
* @param {boolean} [showFullPath=false] - Whether to show the full path of selected items
* @param {string} [pathSeparator= / ] - Separator to show in the full path (default is " / ")
* @param {number} [maxUsages] - Maximum number of times a choice can be selected per task
* @param {string} [pathSeparator= / ] - Separator to show in the full path (default is " / "). To avoid errors, ensure that your data does not include this separator
* @param {number} [maxUsages] - Maximum number of times a choice can be selected per task or per region
* @param {number} [maxWidth] - Maximum width for dropdown
* @param {number} [minWidth] - Minimum width for dropdown
* @param {boolean} [required=false] - Whether taxonomy validation is required
* @param {string} [requiredMessage] - Message to show if validation fails
* @param {string} [placeholder=] - What to display as prompt on the input
* @param {boolean} [perRegion] - Use this tag to classify specific regions instead of the whole object
* @param {boolean} [perItem] - Use this tag to classify specific items inside the object instead of the whole object[^FF_LSDV_4583]
* @param {boolean} [legacy] - Use this tag to enable the legacy version of the Taxonomy tag. When true, the `apiUrl` parameter is not useable[^FF_TAXONOMY_ASYNC]
*/
const TagAttrs = types.model({
toname: types.maybeNull(types.string),
Expand Down