Jump to

• Request
• Response

Store Model

post

/omlmod/v1/models

Store a model in the repository. A unique modelId will be assigned to the stored model, and the model's creator will be assigned from the access token used to authorize the request. This method takes the binary data for the model, model name, description, model version, model type, shared, and model namespace as inputs.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json
• multipart/form-data

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• dbModelName(required): string
  Pattern: ^[a-zA-Z0-9_#$]{1,123}$

  The name of the database model object that will be stored in the model repository.
• description: string
  Maximum Length: 4000

  Description of the model.
• modelName(required): string
  Pattern: ^[a-zA-Z0-9_#$]\d{1,50}$

  The name that will be assigned to the model in the repository.
• modelSchemaName: string
  Pattern: ^(?:[a-zA-Z0-9_$#]{1,128}|\"[^\"\\0]{1,128}\")$

  The name of the schema of the database model object that will be stored in the model repository.
• modelType(required): string
  Allowed Values: [ "OML", "ONNX", "ONNX_IMG" ]

  The type of the model being uploaded.
• namespace: string
  Pattern: [a-zA-Z0-9_]{0,50}

  Model namespace.
• shared: boolean
  Allowed Values: [ true, false ]

  If the model is shared or not. The Boolean value is false if the input (form data) string argument is null or is equal, ignoring case, to the string "false", otherwise true.
• version(required): string
  Pattern: ^[1-9]?[0-9](\\.[0-9][0-9]?$)?

  The version of the model being uploaded.

{
    "required":[
        "dbModelName",
        "modelName",
        "version",
        "modelType"
    ],
    "type":"object",
    "properties":{
        "dbModelName":{
            "pattern":"^[a-zA-Z0-9_#$]{1,123}$",
            "type":"string",
            "description":"The name of the database model object that will be stored in the model repository."
        },
        "modelSchemaName":{
            "pattern":"^(?:[a-zA-Z0-9_$#]{1,128}|\\\"[^\\\"\\\\0]{1,128}\\\")$",
            "type":"string",
            "description":"The name of the schema of the database model object that will be stored in the model repository."
        },
        "modelName":{
            "pattern":"^[a-zA-Z0-9_#$]\\d{1,50}$",
            "type":"string",
            "description":"The name that will be assigned to the model in the repository."
        },
        "description":{
            "type":"string",
            "maxLength":4000,
            "description":"Description of the model."
        },
        "modelType":{
            "type":"string",
            "description":"The type of the model being uploaded.",
            "enum":[
                "OML",
                "ONNX",
                "ONNX_IMG"
            ]
        },
        "version":{
            "pattern":"^[1-9]?[0-9](\\\\.[0-9][0-9]?$)?",
            "type":"string",
            "description":"The version of the model being uploaded."
        },
        "shared":{
            "type":"boolean",
            "description":"If the model is shared or not. The Boolean value is false if the input (form data) string argument is null or is equal, ignoring case, to the string \"false\", otherwise true.",
            "enum":[
                true,
                false
            ]
        },
        "namespace":{
            "pattern":"[a-zA-Z0-9_]{0,50}",
            "type":"string",
            "description":"Model namespace."
        }
    }
}

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• description: string
  Maximum Length: 4000

  Description of the model.
• modelData(required): string (binary)
  The model file to upload
• modelName(required): string
  Pattern: ^[a-zA-Z0-9_#$]\d{1,50}$

  Model name.
• modelType(required): string
  Allowed Values: [ "OML", "ONNX", "ONNX_IMG" ]

  The type of the model being uploaded.
• namespace: string
  Pattern: [a-zA-Z0-9_]{0,50}

  Model namespace.
• shared: boolean
  Allowed Values: [ true, false ]

  If the model is shared or not. The Boolean value is false if the input (form data) string argument is null or is equal, ignoring case, to the string "false", otherwise true.
• version(required): string
  Pattern: ^[1-9]?[0-9](\\.[0-9][0-9]?$)?

  The version of the model being uploaded.

{
    "required":[
        "modelData",
        "modelName",
        "version",
        "modelType"
    ],
    "type":"object",
    "properties":{
        "modelData":{
            "type":"string",
            "description":"The model file to upload",
            "format":"binary"
        },
        "modelName":{
            "pattern":"^[a-zA-Z0-9_#$]\\d{1,50}$",
            "type":"string",
            "description":"Model name."
        },
        "description":{
            "type":"string",
            "maxLength":4000,
            "description":"Description of the model."
        },
        "modelType":{
            "type":"string",
            "description":"The type of the model being uploaded.",
            "enum":[
                "OML",
                "ONNX",
                "ONNX_IMG"
            ]
        },
        "version":{
            "pattern":"^[1-9]?[0-9](\\\\.[0-9][0-9]?$)?",
            "type":"string",
            "description":"The version of the model being uploaded."
        },
        "shared":{
            "type":"boolean",
            "description":"If the model is shared or not. The Boolean value is false if the input (form data) string argument is null or is equal, ignoring case, to the string \"false\", otherwise true.",
            "enum":[
                true,
                false
            ]
        },
        "namespace":{
            "pattern":"[a-zA-Z0-9_]{0,50}",
            "type":"string",
            "description":"Model namespace."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful creation of a model.

Headers

• Location:

Body ()

Root Schema : CreateModelResponse

Type: object

Show Source

• links(required): array links
• modelId(required): string

{
    "required":[
        "modelId",
        "links"
    ],
    "properties":{
        "modelId":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object OMLResourceLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OMLResourceLink"
    }
}

Nested Schema : OMLResourceLink

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

404 Response

Resource not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

409 Response

Model already exists.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

500 Response

Problem connecting to the repository, executing an update, or other unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top