Skip to main content

UseCaseResponse

Schema for a use case response.

Fields

FieldTypeRequiredDefaultDescription
idstrNone-
namestrNone-
descriptionAny""-
questionnaire_idsList[str]None-
creator_idAnyNone-

Usage Example

from credoai.models import UseCaseResponse

# Create a new instance
model = UseCaseResponse(
id="example_value", # Required field
name="example_value", # Required field
questionnaire_ids=None, # Required field
)

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

# Create from dictionary
data = {
"id": "example_value",
"name": "example_value",
"questionnaire_ids": None,
}
model_from_dict = UseCaseResponse(**data)

JSON Schema

{
"type": "object",
"title": "UseCaseResponse",
"description": "Schema for a use case response.",
"properties": {
"id": {
"type": "str"
},
"name": {
"type": "str"
},
"description": {
"type": "any"
},
"questionnaire_ids": {
"type": "list[str]"
},
"creator_id": {
"type": "any"
}
},
"required": ["id", "name", "questionnaire_ids", ]
}