Skip to main content

Models Questionnaires

Manage questionnaires associated with models.

Methods​

list​

List Model Questionnaires List all questionnaires attached to a model.

model_id = "model_id-123"

response = client.model_questionnaires.list(
    model_id=model_id,
)

Parameters:

  • model_id (str, required) - Resource identifier

Returns: Response object

attach​

Attach Questionnaire to Model Attach a questionnaire to a model.

from credoai import QuestionnaireAttachment

model_id = "model_id-123"

data = QuestionnaireAttachment(
    id="questionnaires-456"
)

response = client.model_questionnaires.attach(
    model_id=model_id,
    data=data,
)

Parameters:

Returns: Response object

update​

Update Model Questionnaire Update a questionnaire attachment on a model.

from credoai import QuestionnaireAttachmentUpdate

model_id = "model_id-123"
attachment_id = "attachment_id-123"

data = QuestionnaireAttachmentUpdate(
    id="questionnaires-456"
)

response = client.model_questionnaires.update(
    model_id=model_id,
    attachment_id=attachment_id,
    data=data,
)

Parameters:

  • model_id (str, required) - Resource identifier
  • attachment_id (str, required) - Resource identifier
  • data (QuestionnaireAttachmentUpdate, required) - Request payload

Returns: Response object

detach​

Detach Questionnaire from Model Detach a questionnaire from a model.

model_id = "model_id-123"
attachment_id = "attachment_id-123"

response = client.model_questionnaires.detach(
    model_id=model_id,
    attachment_id=attachment_id,
)

Parameters:

  • model_id (str, required) - Resource identifier
  • attachment_id (str, required) - Resource identifier

Returns: Response object

Example: Working with Models Questionnaires​

from credoai import CredoAI, RelationshipAdd

client = CredoAI()

# List questionnaires for a model
questionnaires = client.model_questionnaires.list(model_id="model-123")
for item in questionnaires.items:
    print(f"\\{item.id}")

# Add a quetionnaire
client.model_questionnaires.add(
    model_id="model-123",
    data=RelationshipAdd(id="quetionnaire-456")
)

# Remove a quetionnaire
client.model_questionnaires.remove(
    model_id="model-123",
    questionnaire_id="quetionnaire-456"
)