ジャンプ先

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

エンドポイント詳細の取得

get

/omlmod/v1/deployment/{uri}

URIで識別されるエンドポイントの詳細を取得します。コール元に表示されるのは、共有エンドポイントおよびコール元が作成したエンドポイントのみです。詳細には、モデル・メタデータとその他の説明情報が含まれます。

リクエスト

パス・パラメータ

• uri(required): string
  エンドポイントの一意のURI。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

モデル・エンドポイントの詳細。

本文()

ルート・スキーマ : EndpointWithDetails

型: object

ソースの表示

• metadata(required): ModelMetadata

{
    "required":[
        "metadata"
    ],
    "properties":{
        "metadata":{
            "$ref":"#/components/schemas/ModelMetadata"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentEndpoint"
        }
    ]
}

すべて一致

ソースの表示

• object allOf DeploymentEndpoint

{
    "required":[
        "metadata"
    ],
    "properties":{
        "metadata":{
            "$ref":"#/components/schemas/ModelMetadata"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentEndpoint"
        }
    ]
}

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

型: object

ソースの表示

• algorithm(required): string
  使用可能な値: [ "NAIVE_BAYES", "DECISION_TREE", "SUPPORT_VECTOR_MACHINES", "K_MEANS", "NON_NEGATIVE_MATRIX_FACTORIZATION", "GENERALIZED_LINEAR_MODEL", "SINGULAR_VALUE_DECOMPOSITION", "EXPECTATION_MAXIMIZATION", "EXPLICIT_SEMANTIC_ANALYSIS", "RANDOM_FOREST", "NEURAL_NETWORK", "XGBOOST", "ONNX" ]
• attributes(required): array attributes
• labels: array labels
• miningFunction(required): string
  使用可能な値: [ "CLASSIFICATION", "REGRESSION", "CLUSTERING", "FEATURE_EXTRACTION" ]
• modelName(required): string
• output: MetadataAttribute
• outputs: array outputs
  ONNX/ONNX_IMGモデルの場合のみ。ONNX/ONNX_IMGモデルの出力のリスト。

{
    "required":[
        "modelName",
        "miningFunction",
        "algorithm",
        "attributes"
    ],
    "properties":{
        "modelName":{
            "type":"string"
        },
        "miningFunction":{
            "type":"string",
            "enum":[
                "CLASSIFICATION",
                "REGRESSION",
                "CLUSTERING",
                "FEATURE_EXTRACTION"
            ]
        },
        "algorithm":{
            "type":"string",
            "enum":[
                "NAIVE_BAYES",
                "DECISION_TREE",
                "SUPPORT_VECTOR_MACHINES",
                "K_MEANS",
                "NON_NEGATIVE_MATRIX_FACTORIZATION",
                "GENERALIZED_LINEAR_MODEL",
                "SINGULAR_VALUE_DECOMPOSITION",
                "EXPECTATION_MAXIMIZATION",
                "EXPLICIT_SEMANTIC_ANALYSIS",
                "RANDOM_FOREST",
                "NEURAL_NETWORK",
                "XGBOOST",
                "ONNX"
            ]
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetadataAttribute"
            }
        },
        "output":{
            "$ref":"#/components/schemas/MetadataAttribute",
            "description":"Only for OML models. The single output for OML models."
        },
        "outputs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetadataAttribute"
            },
            "description":"Only for ONNX/ONNX_IMG models. List of outputs for ONNX/ONNX_IMG models."
        },
        "labels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: object

ソースの表示

• createdBy(required): string
  パターン: [a-zA-Z][a-zA-Z0-9_$#]{1,127}
• description: string
• modelName(required): string
  パターン: [a-zA-Z0-9_]{1,50}
• modelType(required): string
  使用可能な値: [ "OML", "ONNX", "ONNX_IMG" ]
• namespace: string
  パターン: [a-zA-Z0-9_]{0,50}
• shared(required): boolean
  許容値: [ true, false ]
• version(required): string
  パターン: ^[1-9]?[0-9](\\.[0-9][0-9]?$)?

{
    "required":[
        "modelName",
        "version",
        "modelType",
        "createdBy",
        "shared"
    ],
    "properties":{
        "modelName":{
            "pattern":"[a-zA-Z0-9_]{1,50}",
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "version":{
            "pattern":"^[1-9]?[0-9](\\\\.[0-9][0-9]?$)?",
            "type":"string"
        },
        "modelType":{
            "type":"string",
            "enum":[
                "OML",
                "ONNX",
                "ONNX_IMG"
            ]
        },
        "createdBy":{
            "pattern":"[a-zA-Z][a-zA-Z0-9_$#]{1,127}",
            "type":"string"
        },
        "namespace":{
            "pattern":"[a-zA-Z0-9_]{0,50}",
            "type":"string"
        },
        "shared":{
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/CreatedEndpoint"
        }
    ]
}

すべて一致

ソースの表示

• object CreatedEndpoint

{
    "required":[
        "modelName",
        "version",
        "modelType",
        "createdBy",
        "shared"
    ],
    "properties":{
        "modelName":{
            "pattern":"[a-zA-Z0-9_]{1,50}",
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "version":{
            "pattern":"^[1-9]?[0-9](\\\\.[0-9][0-9]?$)?",
            "type":"string"
        },
        "modelType":{
            "type":"string",
            "enum":[
                "OML",
                "ONNX",
                "ONNX_IMG"
            ]
        },
        "createdBy":{
            "pattern":"[a-zA-Z][a-zA-Z0-9_$#]{1,127}",
            "type":"string"
        },
        "namespace":{
            "pattern":"[a-zA-Z0-9_]{0,50}",
            "type":"string"
        },
        "shared":{
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/CreatedEndpoint"
        }
    ]
}

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

型: object

ソースの表示

• deployedOn(required): string (date-time)
• links(required): array links
• modelId(required): string
• uri(required): string
  パターン: [a-zA-Z0-9_]{1,200}

{
    "required":[
        "modelId",
        "deployedOn",
        "uri",
        "links"
    ],
    "properties":{
        "modelId":{
            "type":"string"
        },
        "deployedOn":{
            "type":"string",
            "format":"date-time"
        },
        "uri":{
            "pattern":"[a-zA-Z0-9_]{1,200}",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object MetadataAttribute

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

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースの表示

• attributeType(required): string
  使用可能な値: [ "CATEGORICAL", "NUMERICAL", "TEXT", "BINARY", "NESTED_NUMERICAL", "NESTED_CATEGORICAL", "FLOAT", "DOUBLE", "INT8", "INT16", "INT32", "INT64", "BOOL", "STRING", "UNKNOWN" ]
• name(required): string
• shape: array shape
  ONNX/ONNX_IMGモデルの場合のみ。ONNX/ONNX_IMGモデルの属性形状を示しています。

{
    "required":[
        "name",
        "attributeType"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "attributeType":{
            "type":"string",
            "enum":[
                "CATEGORICAL",
                "NUMERICAL",
                "TEXT",
                "BINARY",
                "NESTED_NUMERICAL",
                "NESTED_CATEGORICAL",
                "FLOAT",
                "DOUBLE",
                "INT8",
                "INT16",
                "INT32",
                "INT64",
                "BOOL",
                "STRING",
                "UNKNOWN"
            ]
        },
        "shape":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            },
            "description":"Only for ONNX/ONNX_IMG models. It shows the attribute shape for ONNX/ONNX_IMG models."
        }
    }
}

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

型: array

ONNX/ONNX_IMGモデルの場合のみ。ONNX/ONNX_IMGモデルの出力のリスト。

ソースの表示

• 配列: object MetadataAttribute

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MetadataAttribute"
    },
    "description":"Only for ONNX/ONNX_IMG models. List of outputs for ONNX/ONNX_IMG models."
}

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

型: array

ONNX/ONNX_IMGモデルの場合のみ。ONNX/ONNX_IMGモデルの属性形状を示しています。

ソースの表示

• 配列: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    },
    "description":"Only for ONNX/ONNX_IMG models. It shows the attribute shape for ONNX/ONNX_IMG models."
}

ネストされたスキーマ : 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"
        }
    }
}

500レスポンス

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

本文()

ルート・スキーマ : Error

型: object

ソースの表示

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

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

先頭に戻る