Consulta de la lista de conjuntos de datos
Función
Esta API se utiliza para consultar los conjuntos de datos creados que cumplen los criterios de búsqueda por página.
URI
GET /v2/{project_id}/datasets
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
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 |
---|---|---|---|
check_running_task |
No |
Boolean |
Si se deben detectar las tareas (incluidas las tareas de inicialización) que se están ejecutando en un conjunto de datos. Opciones:
|
contain_versions |
No |
Boolean |
Si el conjunto de datos contiene una versión. |
dataset_type |
No |
Integer |
Tipo de conjunto de datos. Opciones:
|
file_preview |
No |
Boolean |
Si un conjunto de datos admite la vista previa cuando se consulta. Opciones:
|
limit |
No |
Integer |
Número máximo de registros devueltos en cada página. El valor varía de 1 a 100. El valor predeterminado es 10. |
offset |
No |
Integer |
Página de inicio de la lista de paginación. El valor predeterminado es 0. |
order |
No |
String |
Secuencia de clasificación de la consulta. Opciones:
|
running_task_type |
No |
Integer |
Tipo de las tareas en ejecución (incluidas las tareas de inicialización) que se van a detectar. Opciones:
|
search_content |
No |
String |
Palabra clave de búsqueda difusa. De forma predeterminada, este parámetro se deja en blanco. |
sort_by |
No |
String |
Modo de clasificación de la consulta. Opciones:
|
train_evaluate_ratio |
No |
String |
Relación de división de versiones para el filtrado de conjuntos de datos. Los números antes y después de la coma indican las relaciones de división mínima y máxima, y las versiones cuyas relaciones de división están dentro del intervalo se filtran, por ejemplo, 0.0,1.0. Nota: Si este parámetro se deja en blanco o no está disponible, el sistema no filtra los conjuntos de datos basados en la relación de división de versiones de forma predeterminada. |
version_format |
No |
Integer |
Formato de la versión del conjunto de datos para el filtrado del conjunto de datos. Este parámetro se utiliza para filtrar conjuntos de datos que cumplen los criterios de filtro. Opciones:
|
with_labels |
No |
Boolean |
Si se devuelven las etiquetas del conjunto de datos. Opciones:
|
workspace_id |
No |
String |
ID del espacio de trabajo. Si no se crea ningún espacio de trabajo, el valor predeterminado es 0. Si se crea y utiliza un espacio de trabajo, utilice el valor real. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
datasets |
Array of DatasetAndFilePreview objects |
Lista de conjuntos de datos consultada por página. |
total_number |
Integer |
Número total de conjuntos de datos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
annotated_sample_count |
Integer |
Número de muestras etiquetadas en un conjunto de datos. |
annotated_sub_sample_count |
Integer |
Número de submuestras etiquetadas. |
content_labeling |
Boolean |
Si se habilita el etiquetado de contenido para el conjunto de datos de etiquetado de párrafos de voz. Esta función está habilitada por defecto. |
create_time |
Long |
Hora en la que se crea un conjunto de datos. |
current_version_id |
String |
ID de versión actual de un conjunto de datos. |
current_version_name |
String |
Nombre de la versión actual de un conjunto de datos. |
data_format |
String |
Formato de datos. |
data_sources |
Array of DataSource objects |
Lista de orígenes de datos. |
data_statistics |
Map<String,Object> |
Estadísticas de ejemplo en un conjunto de datos, incluidas las estadísticas de metadatos de ejemplo en formato JSON. |
data_update_time |
Long |
Hora en que se actualizan una muestra y una etiqueta. |
data_url |
String |
Ruta de datos para el entrenamiento. |
dataset_format |
Integer |
Formato de conjunto de datos. Opciones:
|
dataset_id |
String |
ID de conjunto de datos. |
dataset_name |
String |
Nombre del conjunto de datos. |
dataset_tags |
Array of strings |
Lista de identificadores de clave de un conjunto de datos, por ejemplo, ["Image","Object detection"]. |
dataset_type |
Integer |
Tipo de conjunto de datos. Opciones:
|
dataset_version_count |
Integer |
Número de versión de un conjunto de datos. |
deleted_sample_count |
Integer |
Número de muestras eliminadas. |
deletion_stats |
Map<String,Integer> |
Estadísticas de motivos de eliminación. |
description |
String |
Descripción del conjunto de datos. |
enterprise_project_id |
String |
ID del proyecto de empresa. |
exist_running_task |
Boolean |
Si el conjunto de datos contiene tareas en ejecución (incluidas las de inicialización). Opciones:
|
exist_workforce_task |
Boolean |
Si el conjunto de datos contiene tareas de etiquetado de equipo. Opciones:
|
feature_supports |
Array of strings |
Lista de características admitidas por el conjunto de datos. Actualmente, solo se admite el valor 0, lo que indica que el tamaño del archivo OBS es limitado. |
import_data |
Boolean |
Si se van a importar datos. Opciones:
|
import_task_id |
String |
ID de una tarea de importación. |
inner_annotation_path |
String |
Ruta de acceso para almacenar el resultado de etiquetado de un conjunto de datos. |
inner_data_path |
String |
Ruta para almacenar los datos internos de un conjunto de datos. |
inner_log_path |
String |
Ruta para almacenar registros internos de un conjunto de datos. |
inner_task_path |
String |
Ruta de acceso para la tarea interna de un conjunto de datos. |
inner_temp_path |
String |
Ruta para almacenar archivos temporales internos de un conjunto de datos. |
inner_work_path |
String |
Directorio de salida de un conjunto de datos. |
label_task_count |
Integer |
Número de tareas de etiquetado. |
labels |
Array of Label objects |
Lista de etiqueta de conjunto de datos. |
loading_sample_count |
Integer |
Número de muestras de carga. |
managed |
Boolean |
Si un conjunto de datos está alojado. Opciones:
|
next_version_num |
Integer |
Número de versiones siguientes de un conjunto de datos. |
running_tasks_id |
Array of strings |
Lista de ID de las tareas en ejecución (incluida la inicialización). |
samples |
Array of AnnotationFile objects |
Lista de muestra. |
schema |
Array of Field objects |
Lista de esquemas. |
status |
Integer |
Estado del conjunto de datos. Opciones:
|
third_path |
String |
Ruta de terceros. |
total_sample_count |
Integer |
Número total de muestras de conjuntos de datos. |
total_sub_sample_count |
Integer |
Número total de submuestras generadas a partir de las muestras prinicpales. Por ejemplo, el número total de imágenes de fotograma clave extraídas del conjunto de datos de etiquetado de vídeo es el de submuestras. |
unconfirmed_sample_count |
Integer |
Número de muestras de etiquetado automático a confirmar. |
update_time |
Long |
Hora en la que se actualiza un conjunto de datos. |
versions |
Array of DatasetVersion objects |
Información sobre la versión del conjunto de datos. Actualmente, solo se registra la información de la versión actual de un conjunto de datos. |
work_path |
String |
Ruta del conjunto de datos de salida, que se utiliza para almacenar archivos de salida, como archivos de etiquetas. La ruta es una ruta de OBS con el formato de /Bucket name/File path. Por ejemplo: /obs-bucket. |
work_path_type |
Integer |
Tipo de la ruta de salida del conjunto de datos. Opciones:
|
workforce_descriptor |
WorkforceDescriptor object |
Información de etiquetado del equipo. |
workforce_task_count |
Integer |
Número de tareas de etiquetado de equipo de un conjunto de datos. |
workspace_id |
String |
ID del espacio de trabajo. Si no se crea ningún espacio de trabajo, el valor predeterminado es 0. Si se crea y utiliza un espacio de trabajo, utilice el valor real. |
Parámetro |
Tipo |
Descripción |
---|---|---|
data_path |
String |
Ruta de origen de datos. |
data_type |
Integer |
Tipo de datos. Opciones:
|
schema_maps |
Array of SchemaMap objects |
Información de asignación de esquemas correspondiente a los datos de la tabla. |
source_info |
SourceInfo object |
Información necesaria para importar un origen de datos de tabla. |
with_column_header |
Boolean |
Si la primera fila del archivo es un nombre de columna. Este campo es válido para el conjunto de datos de la tabla. Opciones:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
dest_name |
String |
Nombre de la columna de destino. |
src_name |
String |
Nombre de la columna de origen. |
Parámetro |
Tipo |
Descripción |
---|---|---|
cluster_id |
String |
ID de un clúster MRS. |
cluster_mode |
String |
Modo de ejecución de un clúster MRS. Opciones:
|
cluster_name |
String |
Nombre de un clúster MRS. |
database_name |
String |
Nombre de la base de datos a la que se importa el conjunto de datos de la tabla. |
input |
String |
Ruta HDFS de un conjunto de datos de tabla. |
ip |
String |
Dirección IP del clúster de GaussDB(DWS). |
port |
String |
Número de puerto del clúster GaussDB(DWS). |
queue_name |
String |
Nombre de la cola DLI de un conjunto de datos de tabla. |
subnet_id |
String |
ID de subred de un clúster MRS. |
table_name |
String |
Nombre de la tabla a la que se importa un conjunto de datos de tabla. |
user_name |
String |
Nombre de usuario, que es obligatorio para los datos de GaussDB(DWS). |
user_password |
String |
Contraseña de usuario, que es obligatoria para los datos de GaussDB(DWS). |
vpc_id |
String |
ID de la VPC donde reside un clúster MRS. |
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 |
---|---|---|
@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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
create_time |
Long |
Hora en la que se crea una muestra. |
dataset_id |
String |
ID de conjunto de datos. |
depth |
Integer |
Número de canales de muestra de imagen. |
file_Name |
String |
Nombre de muestra. |
file_id |
String |
ID de muestra. |
file_type |
String |
Tipo de archivo. |
height |
Integer |
Altura de la muestra de la imagen. |
size |
Long |
Tamaño de muestra de imagen. |
tags |
Map<String,String> |
Información de etiqueta de una muestra. |
url |
String |
Dirección OBS de la muestra de vista previa. |
width |
Integer |
Anchura de la muestra de la imagen. |
Parámetro |
Tipo |
Descripción |
---|---|---|
description |
String |
Descripción del esquema. |
name |
String |
Nombre del esquema. |
schema_id |
Integer |
ID de esquema. |
type |
String |
Tipo de valor de esquema. |
Parámetro |
Tipo |
Descripción |
---|---|---|
add_sample_count |
Integer |
Número de muestras añadidas. |
analysis_cache_path |
String |
Ruta de caché para el análisis de características. |
analysis_status |
Integer |
Estado de una tarea de análisis de elementos. Opciones:
|
analysis_task_id |
String |
ID de una tarea de análisis de características. |
annotated_sample_count |
Integer |
Número de muestras con versiones etiquetadas. |
annotated_sub_sample_count |
Integer |
Número de submuestras etiquetadas. |
clear_hard_property |
Boolean |
Si se deben borrar las propiedades del ejemplo duro durante la publicación. Opciones:
|
code |
String |
Código de estado de una tarea de preprocesamiento, como rotación y recorte. |
create_time |
Long |
Hora en que se crea una versión. |
crop |
Boolean |
Si desea recortar la imagen. Este campo sólo es válido para el conjunto de datos de detección de objetos cuyo cuadro de etiquetado está en forma de rectángulo. Opciones:
|
crop_path |
String |
Ruta para almacenar archivos recortados. |
crop_rotate_cache_path |
String |
Directorio temporal para ejecutar la tarea de rotación y recorte. |
data_analysis |
Map<String,Object> |
Resultado del análisis de características en formato JSON. |
data_path |
String |
Ruta para almacenar datos. |
data_statistics |
Map<String,Object> |
Estadísticas de ejemplo en un conjunto de datos, incluidas las estadísticas de metadatos de ejemplo en formato JSON. |
data_validate |
Boolean |
Si los datos son validados por el algoritmo de validación antes de publicación. Opciones:
|
deleted_sample_count |
Integer |
Número de muestras eliminadas. |
deletion_stats |
Map<String,Integer> |
Estadísticas de motivos de eliminación. |
description |
String |
Descripción de una versión. |
export_images |
Boolean |
Si desea exportar imágenes al directorio de salida de la versión durante el lanzamiento. Opciones:
|
extract_serial_number |
Boolean |
Si se va a analizar el número de submuestra durante la publicación. El campo es válido para el conjunto de datos de atención médica. Opciones:
|
include_dataset_data |
Boolean |
Si desea incluir los datos de origen de un conjunto de datos durante la publicación. Opciones:
|
is_current |
Boolean |
Si se utiliza la versión actual del conjunto de datos. Opciones:
|
label_stats |
Array of LabelStats objects |
Lista de estadísticas de etiquetas de una versión publicada. |
label_type |
String |
Tipo de etiqueta de una versión publicada. Opciones:
|
manifest_cache_input_path |
String |
Ruta de entrada para la caché del archivo de manifest durante la publicación de la versión. |
manifest_path |
String |
Ruta de acceso para almacenar el archivo de manifest con la versión publicada. |
message |
String |
Información de la tarea registrada durante la liberación (por ejemplo, información de error). |
modified_sample_count |
Integer |
Número de muestras modificadas. |
previous_annotated_sample_count |
Integer |
Número de muestras etiquetadas de versiones principales. |
previous_total_sample_count |
Integer |
Muestras totales de versiones principales. |
previous_version_id |
String |
ID de versión principal |
processor_task_id |
String |
ID de una tarea de preprocesamiento, como rotación y recorte. |
processor_task_status |
Integer |
Estado de una tarea de preprocesamiento, como rotación y recorte. Opciones:
|
remove_sample_usage |
Boolean |
Si se debe borrar la información de uso existente de un conjunto de datos durante el lanzamiento. Opciones:
|
rotate |
Boolean |
Si desea girar la imagen. Opciones:
|
rotate_path |
String |
Ruta de acceso para almacenar el archivo rotado. |
sample_state |
String |
Estado de la muestra. Opciones:
|
start_processor_task |
Boolean |
Si se debe iniciar una tarea de análisis de datos durante la publicación. Opciones:
|
status |
Integer |
Estado de una versión de conjunto de datos. Opciones:
|
tags |
Array of strings |
Lista de identificadores de clave del conjunto de datos. El tipo de etiquetado se utiliza como etiqueta predeterminada cuando la tarea de etiquetado publica una versión. Por ejemplo, ["Image","Object detection"]. |
task_type |
Integer |
Tipo de tarea de etiquetado de la versión publicada, que es el mismo que el tipo de conjunto de datos. |
total_sample_count |
Integer |
Número total de muestras de versión. |
total_sub_sample_count |
Integer |
Número total de submuestras generadas a partir de las muestras prinicpales. |
train_evaluate_sample_ratio |
String |
Dividir la relación de entrenamiento y verificación durante el lanzamiento de la versión. El valor predeterminado es 1.00, lo que indica que todas las versiones publicadas son conjuntos de entrenamiento. |
update_time |
Long |
Hora en que se actualiza una versión. |
version_format |
String |
Formato de una versión de conjunto de datos. Opciones:
|
version_id |
String |
ID de versión del conjunto de datos. |
version_name |
String |
Nombre de la versión del conjunto de datos. |
with_column_header |
Boolean |
Si la primera fila del archivo CSV publicada es un nombre de columna. Este campo es válido para el conjunto de datos de la tabla. Opciones:
|
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. |
count |
Integer |
Número de etiquetas. |
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. |
sample_count |
Integer |
Número de muestras que contienen la etiqueta. |
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 |
---|---|---|
current_task_id |
String |
ID de una tarea de etiquetado de equipo. |
current_task_name |
String |
Nombre de una tarea de etiquetado de equipo. |
reject_num |
Integer |
Número de muestras rechazadas. |
repetition |
Integer |
Número de personas que etiquetan cada muestra. El valor mínimo es 1. |
is_synchronize_auto_labeling_data |
Boolean |
Si se deben actualizar sincrónicamente los datos de etiquetado automático. Opciones:
|
is_synchronize_data |
Boolean |
Si desea sincronizar datos actualizados, como cargar archivos, sincronizar orígenes de datos y asignar archivos importados sin etiqueta a los miembros del equipo. Opciones:
|
workers |
Array of Worker objects |
Lista de miembros del equipo de etiquetado. |
workforce_id |
String |
ID de un equipo de etiquetado. |
workforce_name |
String |
Nombre de un equipo de etiquetado. |
Parámetro |
Tipo |
Descripción |
---|---|---|
create_time |
Long |
Tiempo de creación. |
description |
String |
Descripción del miembro del equipo de etiquetado. El valor contiene de 0 a 256 caracteres y no admite los siguientes caracteres especiales: ^!<>=&"' |
|
String |
Dirección de correo electrónico de un miembro del equipo de etiquetado. |
role |
Integer |
Rol. Opciones:
|
status |
Integer |
Estado actual de inicio de sesión de un miembro del equipo de etiquetado. Opciones:
|
update_time |
Long |
Tiempo de actualización. |
worker_id |
String |
ID de un miembro del equipo de etiquetado. |
workforce_id |
String |
ID de un equipo de etiquetado. |
Solicitudes de ejemplo
Consulta de la lista de conjuntos de datos
GET https://{endpoint}/v2/{project_id}/datasets?offset=0&limit=10&sort_by=create_time&order=desc&dataset_type=0&file_preview=true
Ejemplo de respuestas
Código de estado: 200
OK
{ "total_number" : 1, "datasets" : [ { "dataset_id" : "gfghHSokody6AJigS5A", "dataset_name" : "dataset-f9e8", "dataset_type" : 0, "data_format" : "Default", "next_version_num" : 4, "status" : 1, "data_sources" : [ { "data_type" : 0, "data_path" : "/test-obs/classify/input/catDog4/" } ], "create_time" : 1605690595404, "update_time" : 1605690595404, "description" : "", "current_version_id" : "54IXbeJhfttGpL46lbv", "current_version_name" : "V003", "total_sample_count" : 10, "annotated_sample_count" : 10, "work_path" : "/test-obs/classify/output/", "inner_work_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/", "inner_annotation_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/", "inner_data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/data/", "inner_log_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/logs/", "inner_temp_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/temp/", "inner_task_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/task/", "work_path_type" : 0, "workspace_id" : "0", "enterprise_project_id" : "0", "exist_running_task" : false, "exist_workforce_task" : false, "running_tasks_id" : [ ], "workforce_task_count" : 0, "feature_supports" : [ "0" ], "managed" : false, "import_data" : false, "label_task_count" : 1, "dataset_format" : 0, "content_labeling" : true, "samples" : [ { "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/15.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tuUo9jl6lqoMKAwNBz5g8dxO%2FdE%3D", "create_time" : 1605690596035 }, { "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/8.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=NITOdBnkUXtdnKuEgDzZpkQzNfM%3D", "create_time" : 1605690596046 }, { "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/9.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=%2BwUo1BL38%2F2d7p7anPi4fNzm1VU%3D", "create_time" : 1605690596050 }, { "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/7.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tOrHfcWo%2FEJ0wRzfi1M5Wk2MrXg%3D", "create_time" : 1605690596043 } ] } ] }
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.