modzyClient.getModels

Get some

modzyClient.getModels(modelId = null, author = null, createdByEmail = null, name = null, description = null, isActive = null, isExpired = null, isRecommended = null, lastActiveDateTime = null, expirationDateTime = null, page = null, perPage = 1000, direction = null, sortBy = null)

Returns a list of models. The list includes each model’s modelId, versions, and latestVersion.

Parameters

ParameterTypeDescriptionExample
modelIdstringFilters models by identifier. Separaete multuple values with ;.'ed542963de'
authorstringFilters models by the organization that created them. Separate multiple values with ;.'Open Source'
createdByEmailstringFilters models by creator’s email. Separate multiple values with ;.'[email protected]'
namestringFilters models by name. Separate multiple values with ;.'Sentiment Analysis'
descriptionstringFilters models by description.'Sentiment Analysis'
isActivestring
boolean
Filters models by status.true
isExpiredstring
boolean
Filters models by expired status.false
isRecommendedstring
boolean
Filters models recommended by Modzy.false
lastActiveDateTimestring
Date
Filters models by the latest use date. It requires ISO8601 formated string (YYYY-MM-DDThh:mm:ss.sTZD) or a date object.new Date()
'2021-08-13T07:28:03.831'
expirationDateTimestring
Date
Filters models by the expiration date. It requires ISO8601 formated string (YYYY-MM-DDThh:mm:ss.sTZD) or a date object.new Date()
'2021-08-13T07:28:03.831'
pagenumberThe page number to be returned. Defaults to 0.10
perPagenumberThe number of records returned per page. Defaults to 10.5
directionstringOrders the records in ascending (ASC) or descending (DESC) order. It defaults to ASC.ASC
sortBystringModels can be sorted by modelId, author, submittedByEmail, name, isExpired, isActive, latestVersion, isRecommended, lastActiveDateTime, expirationDateTime.name

Returns

{
    "$schema": "http://json-schema.org/draft-06/schema#",
    "type": "array",
    "items": {
        "$ref": "#/definitions/ModelItem"
    },
    "definitions": {
        "ModelItem": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "modelId": {
                    "type": "string"
                },
                "latestVersion": {
                    "type": "string"
                },
                "versions": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "required": [
                "latestVersion",
                "modelId",
                "versions"
            ]
        }
    }
}

Examples

Search by author

models = await modzyClient.getModels(
         /*modelId*/null, /*author*/'Open Source', /*createdByEmail*/null, /*name*/null, /*description*/null, 
         /*isActive*/null, /*isExpired*/null, /*isRecommended*/null, /*lastActiveDateTime*/null, /*expirationDateTime*/null,
         /*page*/null, /*perPage*/100, /*direction*/null, /*sortBy*/null);
console.log( `Open Source models ${models.length}` );

Active models

models = await modzyClient.getModels(
        /*modelId*/null, /*author*/null, /*createdByEmail*/null, /*name*/null, /*description*/null, 
        /*isActive*/true, /*isExpired*/null, /*isRecommended*/null, /*lastActiveDateTime*/null, /*expirationDateTime*/null,
        /*page*/null, /*perPage*/100, /*direction*/null, /*sortBy*/null);
console.log( `Active models ${models.length}` );

Search by name

models = await modzyClient.getModels(
        /*modelId*/null, /*author*/null, /*createdByEmail*/null, /*name*/'Image', /*description*/null, 
        /*isActive*/true, /*isExpired*/null, /*isRecommended*/null, /*lastActiveDateTime*/null, /*expirationDateTime*/null,
        /*page*/null, /*perPage*/5, /*direction*/null, /*sortBy*/null);
 console.log( `Models with name start with 'Image' ${models.length}` );

Combined search

models = await modzyClient.getModels(
         /*modelId*/null, /*author*/'Open Source', /*createdByEmail*/null, /*name*/'Image', /*description*/null, 
         /*isActive*/true, /*isExpired*/null, /*isRecommended*/null, /*lastActiveDateTime*/null, /*expirationDateTime*/null,
         /*page*/null, /*perPage*/1, /*direction*/null, /*sortBy*/null);
console.log( `Active open source models which name starts with 'Image' ${models.length}` );