Jump to

• Request
• Response

Get details of an ONNX model hosted in the database

get

/vecdb/models/{model_name}

Describe an ONNX model hosted in the database.

Request

Path Parameters

• model_name(required): string
  Name of the ONNX model.

There's no request body for this operation.

Security

• BasicAuth: http
  Type: http
• BearerAuth: http
  Type: http
• OAuth2: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json
• application/problem+json

200 Response

Details of the ONNX model hosted in the database.

Body ()

Root Schema : ModelItem

Type: object

Show Source

• algorithm: string
• attributes: array attributes
• creation_date: string
• mining_function: string
• model_name: string

{
    "type":"object",
    "properties":{
        "model_name":{
            "type":"string"
        },
        "algorithm":{
            "type":"string"
        },
        "mining_function":{
            "type":"string"
        },
        "creation_date":{
            "type":"string"
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ModelAttributeItem"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object ModelAttributeItem

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

Nested Schema : ModelAttributeItem

Type: object

Show Source

• data_length: number
• data_type: string
• name: string
• value: string
• vector_info: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "data_type":{
            "type":"string"
        },
        "data_length":{
            "type":"number"
        },
        "vector_info":{
            "type":"string",
            "nullable":true
        }
    }
}

404 Response

Model not found.

Body ()

Root Schema : ORDSErrorResponse

Type: object

Show Source

• code(required): string
• diagnosticTrace: string
• instance(required): string
• message(required): string
• stackTrace: string
• type(required): string

{
    "type":"object",
    "required":[
        "code",
        "message",
        "type",
        "instance"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "diagnosticTrace":{
            "type":"string"
        },
        "stackTrace":{
            "type":"string"
        }
    }
}

Back to Top