Skip to main content

ModelCreate

Schema for creating a model.

Fields​

FieldTypeRequiredDefaultDescription
namestr✓None-
summaryAny✗None-
sourceAny✗None-
questionnaire_idsList[str]✗None-
statusAny✗"none"-

status​

Example: none

Usage Example​

from credoai.models import ModelCreate

# Create a new instance
model = ModelCreate(
name="example_value", # Required field
)

# Convert to dictionary
model_dict = model.model_dump()
print(model_dict)

# Create from dictionary
data = {
"name": "example_value",
}
model_from_dict = ModelCreate(**data)

JSON Schema​

{
"type": "object",
"title": "ModelCreate",
"description": "Schema for creating a model.",
"properties": {
"name": {
"type": "str"
},
"summary": {
"type": "any"
},
"source": {
"type": "any"
},
"questionnaire_ids": {
"type": "list[str]"
},
"status": {
"type": "any",
"example": "none"
}
},
"required": ["name", ]
}