ModelResponse

Schema for a model response.

Fields

Field	Type	Required	Default	Description
id	str	✓	None	-
name	str	✓	None	-
summary	Any	✗	None	-
source	Any	✗	None	-
status	str	✓	None	-
questionnaire_ids	List[str]	✗	None	-
custom	bool	✗	True	-
has_use_cases	bool	✗	False	-

custom

Example: True

Usage Example

from credoai.models import ModelResponse

# Create a new instance
model = ModelResponse(
    id="example_value",  # Required field
    name="example_value",  # Required field
    status="example_value",  # Required field
)

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

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

JSON Schema

{
  "type": "object",
  "title": "ModelResponse",
  "description": "Schema for a model response.",
  "properties": {
    "id": {
      "type": "str"
    },
    "name": {
      "type": "str"
    },
    "summary": {
      "type": "any"
    },
    "source": {
      "type": "any"
    },
    "status": {
      "type": "str"
    },
    "questionnaire_ids": {
      "type": "list[str]"
    },
    "custom": {
      "type": "bool",
      "example": true
    },
    "has_use_cases": {
      "type": "bool"
    }
  },
  "required": ["id", "name", "status", ]
}