ジャンプ先

• リクエスト
• レスポンス

モデルの格納

post

/omlmod/v1/models

リポジトリにモデルを格納します。格納されたモデルには一意のmodelIdが割り当てられ、モデルの作成者はリクエストの認可に使用されたアクセス・トークンから割り当てられます。このメソッドは、モデル、モデル名、説明、モデル・バージョン、モデル・タイプ、共有およびモデル・ネームスペースのバイナリ・データを入力として受け取ります。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされているメディア・タイプ

• application/json
• multipart/form-data

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: object

ソースの表示

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

  モデル・リポジトリに格納されるデータベース・モデル・オブジェクトの名前。
• description: string
  最大長: 4000

  モデルの説明。
• modelName(required): string
  パターン: ^[a-zA-Z0-9_#$]\d{1,50}$

  リポジトリ内のモデルに割り当てられる名前。
• modelSchemaName: string
  パターン: ^(?:[a-zA-Z0-9_$#]{1,128}|\"[^\"\\0]{1,128}\")$

  モデル・リポジトリに格納されるデータベース・モデル・オブジェクトのスキーマの名前。
• modelType(required): string
  使用可能な値: [ "OML", "ONNX", "ONNX_IMG", "ONNX_TEXT" ]

  アップロードするモデルのタイプ。
• namespace: string
  パターン: [a-zA-Z0-9_]{0,50}

  モデル・ネームスペース。
• shared: boolean
  許容値: [ true, false ]

  モデルが共有かどうか。ブール値は、入力(フォーム・データ)文字列引数がnull、または大/小文字を無視して"false"と等しい場合はfalse、それ以外の場合はtrueです。
• version(required): string
  パターン: ^[1-9]?[0-9](\\.[0-9][0-9]?$)?

  アップロードするモデルのバージョン。

{
    "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",
                "ONNX_TEXT"
            ]
        },
        "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."
        }
    }
}

リクエスト本文 - multipart/form-data ()

ルート・スキーマ : schema

型: object

ソースの表示

• description: string
  最大長: 4000

  モデルの説明。
• modelData(required): string (binary)
  アップロードするモデル・ファイル
• modelName(required): string
  パターン: ^[a-zA-Z0-9_#$]\d{1,50}$

  モデル名。
• modelType(required): string
  使用可能な値: [ "OML", "ONNX", "ONNX_IMG", "ONNX_TEXT" ]

  アップロードするモデルのタイプ。
• namespace: string
  パターン: [a-zA-Z0-9_]{0,50}

  モデル・ネームスペース。
• shared: boolean
  許容値: [ true, false ]

  モデルが共有かどうか。ブール値は、入力(フォーム・データ)文字列引数がnull、または大/小文字を無視して"false"と等しい場合はfalse、それ以外の場合はtrueです。
• version(required): string
  パターン: ^[1-9]?[0-9](\\.[0-9][0-9]?$)?

  アップロードするモデルのバージョン。

{
    "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",
                "ONNX_TEXT"
            ]
        },
        "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."
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

201レスポンス

モデルの作成に成功しました。

ヘッダー

• Location(required):

本文()

ルート・スキーマ : CreateModelResponse

型: object

ソースの表示

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

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

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object OMLResourceLink

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

ネストされたスキーマ : OMLResourceLink

型: object

ソースの表示

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

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

400レスポンス

不正なリクエストです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

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

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

401レスポンス

認可されていません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

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

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

404レスポンス

リソースが見つかりません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

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

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

409レスポンス

モデルはすでに存在します。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

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

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

500レスポンス

リポジトリへの接続中の問題、更新実行中の問題、またはその他の予期しないエラーの問題です。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

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

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

先頭に戻る