Jump to

• Request
• Response

Get the ONNX models hosted in the database

get

/vecdb/models/

Describe the ONNX models hosted in the database.

Request

There are no request parameters for this operation.

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

200 Response

Details of the ONNX models hosted in the database.

Body ()

Root Schema : ModelsCollection

Type: object

Show Source

• count: number
• hasMore: boolean
• items: array items
• limit: number
• links: array links
• offset: number

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ModelItemWithLinks"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"number"
        },
        "offset":{
            "type":"number"
        },
        "count":{
            "type":"number"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ModelItemWithLinks

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : ModelItemWithLinks

Match All

Show Source

• object ModelItem
• object ModelItemWithLinks-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ModelItem"
        },
        {
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/LinkRelation"
                    }
                }
            }
        }
    ]
}

Nested 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 : ModelItemWithLinks-allOf[1]

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

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
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

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

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

Back to Top