UseCaseCreate

Schema for creating a use case.

Fields

Field	Type	Required	Default	Description
name	str	✓	None	-
description	str	✗	""	-
questionnaire_ids	List[str]	✗	None	-
custom_fields	List[UseCaseCustomField]	✗	None	-
questions	List[QuestionEvidenceCreate]	✗	None	-
source	Any	✗	None	-
user	str	✗	""	-
owner	Any	✗	None	-

Usage Example

from credoai.models import UseCaseCreate

# Create a new instance
model = UseCaseCreate(
    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 = UseCaseCreate(**data)

JSON Schema

{
  "type": "object",
  "title": "UseCaseCreate",
  "description": "Schema for creating a use case.",
  "properties": {
    "name": {
      "type": "str"
    },
    "description": {
      "type": "str"
    },
    "questionnaire_ids": {
      "type": "list[str]"
    },
    "custom_fields": {
      "type": "list[usecasecustomfield]"
    },
    "questions": {
      "type": "list[questionevidencecreate]"
    },
    "source": {
      "type": "any"
    },
    "user": {
      "type": "str"
    },
    "owner": {
      "type": "any"
    }
  },
  "required": ["name", ]
}