Consulta de una lista de modelos
Función
Esta API se utiliza para consultar los modelos que cumplen con los criterios de búsqueda.
URI
GET /v1/{project_id}/models
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID y un nombre de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
model_name |
No |
String |
Nombre del modelo. Se admite la coincidencia difusa.
NOTA:
Si un nombre de modelo contiene un guion bajo (_), agregue el parámetro exacta_match a la solicitud y establezca el valor del parámetro en true porque el guion bajo debe escaparse. Esto asegura que la operación de consulta se puede realizar correctamente. |
model_version |
No |
String |
Versión modelo |
model_status |
No |
String |
Estado del modelo. Puede consultar modelos basados en el estado del modelo. Opciones:
|
model_type |
No |
String |
Tipo de modelo. Se consultan los modelos de este tipo. model_type y not_model_type son mutuamente excluyentes y no pueden coexistir. |
not_model_type |
No |
String |
Tipo de modelo. Se consulta una lista de modelos de tipos a excepción de este tipo. |
description |
No |
String |
Descripción. Se admite la coincidencia difusa. |
offset |
No |
Integer |
Índice de la página a consultar. Valor predeterminado: 0 |
limit |
No |
Integer |
Número máximo de registros devueltos en cada página. El valor predeterminado es 100. El valor recomendado oscila entre 10 y 50. |
sort_by |
No |
String |
Modo de clasificación. El valor puede ser create_at, model_version o model_size. Valor predeterminado: create_at |
order |
No |
String |
Orden de clasificación. El valor puede ser asc o desc, indicando el orden ascendente o descendente. Valor predeterminado: desc |
workspace_id |
No |
String |
ID del espacio de trabajo al que pertenece un servicio. El valor predeterminado es 0, que indica el espacio de trabajo predeterminado. |
Cuerpo de la solicitud
No hay
Cuerpo de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
total_count |
Integer |
Número total de modelos que cumplen los criterios de búsqueda cuando no se implementa ninguna paginación |
count |
Integer |
Número de modelos |
models |
model array |
Metadatos de modelo. Para más detalles, consulte Tabla 4. |
Parámetro |
Tipo |
Descripción |
---|---|---|
model_id |
String |
ID del modelo |
model_name |
String |
Nombre del modelo |
model_version |
String |
Versión modelo |
model_status |
String |
Estado del modelo |
model_type |
String |
Tipo de modelo. El valor puede ser TensorFlow, MXNet, Caffe, Spark_MLlib, Scikit_Learn, XGBoost, MindSpore, Image, o PyTorch. |
model_size |
Long |
Tamaño del modelo, en bytes |
tenant |
String |
Tenant al que pertenece un modelo |
project |
String |
Proyecto al que pertenece un modelo |
owner |
String |
Usuario al que pertenece un modelo |
create_at |
Long |
Tiempo en que se crea un modelo, en milisegundos calculados a partir de 1970.1.1 0:0:0 UTC |
description |
String |
Descripción del modelo |
workspace_id |
String |
ID del espacio de trabajo. |
model_source |
String |
Fuente del modelo. Opciones:
|
tunable |
Boolean |
Si un modelo se puede ajustar. Opciones:
|
market_flag |
Boolean |
Si un modelo está suscrito desde el mercado. Opciones:
|
publishable_flag |
Boolean |
Si un modelo se puede publicar en el mercado. Opciones:
|
install_type |
String array |
Tipo de implementación de modelo, determinando qué servicio se puede implementar un modelo. Los valores posibles son real-time (servicio en tiempo real) y batch (servicio por lotes). |
subscription_id |
String |
ID de suscripción del modelo. |
extra |
String |
Campo extendido. |
source_type |
String |
Tipo de origen del modelo. Este parámetro es válido y su valor es auto solo si el modelo se implementa mediante ExeML. |
specification |
Object |
Especificación mínima de implementación. Para más detalles, consulte Tabla 5. |
Muestras
A continuación se muestra cómo consultar modelos.
- Modelo de solicitud
GET https://endpoint/v1/{project_id}/models
- Modelo de respuesta
{ "total_count": 1, "count": 1, "models": [ { "model_name": "mnist", "model_version": "1.0.0", "model_id": "10eb0091-887f-4839-9929-cbc884f1e20e", "model_type": "tensorflow", "model_size": 5012312, "tenant": "6d28e85aa78b4e1a9b4bd83501bcd4a1", "project": "d04c10db1f264cfeb1966deff1a3527c", "owner": "6d28e85aa78b4e1a9b4bd83501bcd4a1", "create_at": 1533041553000, "description": "mnist model", "workspace_id": "0", "specification":{} } ] }
Código de estado
Para obtener más información sobre el código de estado, consulte Tabla 1.