Consulta de la lista de etiquetas de conjunto de datos
Función
Esta API se utiliza para consultar todas las etiquetas de un conjunto de datos.
URI
GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
dataset_id |
Sí |
String |
ID de conjunto de datos. |
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
version_id |
No |
String |
ID de versión del conjunto de datos. |
offset |
No |
Integer |
Página de inicio para la visualización de paginación. El valor predeterminado es 0. |
limit |
No |
Integer |
Número máximo de registros devueltos en cada página. El valor varía de 1 a 100000. El valor predeterminado es 100000. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total_number |
Integer |
Número de etiquetas |
labels |
Array of Label objects |
Lista de etiquetas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
attributes |
Array of LabelAttribute objects |
Atributo multidimensional de una etiqueta. Por ejemplo, si la etiqueta es música, se pueden incluir atributos como el estilo y el artista. |
name |
String |
Nombre de la etiqueta. |
property |
LabelProperty object |
Par clave-valor de atributo básico de una etiqueta, como el color y las teclas de método abreviado. |
type |
Integer |
Tipo de etiqueta. Opciones:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
default_value |
String |
Valor predeterminado de un atributo de etiqueta. |
id |
String |
ID de atributo de etiqueta. |
name |
String |
Nombre del atributo de etiqueta. |
type |
String |
Tipo de atributo de etiqueta. Opciones:
|
values |
Array of LabelAttributeValue objects |
Lista de valores de atributo de etiqueta. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de valor de atributo de etiqueta. |
value |
String |
Valor del atributo de etiqueta. |
Parámetro |
Tipo |
Descripción |
---|---|---|
@modelarts:color |
String |
Atributo predeterminado: Color de etiqueta, que es un código hexadecimal del color. De forma predeterminada, este parámetro se deja en blanco. Ejemplo: #FFFFF0. |
@modelarts:default_shape |
String |
Atributo predeterminado: forma predeterminada de una etiqueta de detección de objeto (atributo dedicado). De forma predeterminada, este parámetro se deja en blanco. Opciones:
|
@modelarts:from_type |
String |
Atributo por defecto: Tipo de la entidad de cabecera en la etiqueta de relación de triplete. Este atributo debe especificarse cuando se crea una etiqueta de relación. Este parámetro solo se utiliza para el conjunto de datos de texto triplete. |
@modelarts:rename_to |
String |
Atributo predeterminado: el nuevo nombre de la etiqueta. |
@modelarts:shortcut |
String |
Atributo predeterminado: Tecla de método abreviado de etiqueta. De forma predeterminada, este parámetro se deja en blanco. Por ejemplo: D. |
@modelarts:to_type |
String |
Atributo por defecto: Tipo de la entidad de cola en la etiqueta de relación de triplete. Este atributo debe especificarse cuando se crea una etiqueta de relación. Este parámetro solo se utiliza para el conjunto de datos de texto triplete. |
Solicitudes de ejemplo
Consulta de todas las etiquetas de un conjunto de datos
GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels
Ejemplo de respuestas
Código de estado: 200
OK
{ "total_number" : 2, "labels" : [ { "name" : "Cat", "type" : 1, "property" : { "@modelarts:color" : "#3399ff" } }, { "name" : "Dog", "type" : 1, "property" : { "@modelarts:color" : "#3399ff" } } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Códigos de error
Consulte Códigos de error.