describe_model

Use the describe model operation to retrieve detailed metadata for a loaded model.

Returns comprehensive information about the model including its type, parameters, attributes, and usage statistics.

Parameters

Parameter	Type	Value Range	Required	Default	Description	Notes
model_name	str	Valid model identifier	Yes	No default	Name of the model to describe.	Model must exist in the database schema.

Raises Exception – InvalidModelNameFormatError may be raised when the model name is invalid. The operation also fails if the model does not exist.

Describe a model

model = client.describe_model(model_name="ALL_MINILM_L12_V2")

Returns Example response:

• JSON response containing:
• Model name and type
• Algorithm and mining function
• Input/output attributes
• Creation timestamp
• Model parameters

{
    "model_name": "ALL_MINILM_L12_V2",
    "algorithm": "ONNX",
    "mining_function": "EMBEDDING",
    "creation_date": "2026-01-27T07:23:21Z",
    "attributes": [
        {
            "name": "DATA",
            "value": "TEXT",
            "data_type": "VARCHAR2",
            "data_length": 32767
        },
        {
            "name": "ORA$ONNXTARGET",
            "value": "VECTOR",
            "data_type": "VECTOR",
            "data_length": 1593,
            "vector_info": "VECTOR(384,FLOAT32)"
        }
    ]
}

Return type ModelResponse