Models Questionnaires

Manage questionnaires associated with models.

Methods

list

List Model Questionnaires List all questionnaires attached to a model.

Python

model_id = "model_id-123"

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

TypeScript

const { data, error } = await client.models.questionnaires.list('model_id-123');

Parameters:

• model_id (str, required) - Resource identifier

Returns: Response object

---

attach

Attach Questionnaire to Model Attach a questionnaire to a model.

Python

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,
)

TypeScript

const { data, error } = await client.models.questionnaires.attach('model_id-123', {
  id: 'questionnaires-456',
});

Parameters:

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

Returns: Response object

---

update

Update Model Questionnaire Update a questionnaire attachment on a model.

Python

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,
)

TypeScript

const { data, error } = await client.models.questionnaires.update('model_id-123', 'attachment_id-123', {
  id: 'questionnaires-456',
});

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.

Python

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

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

TypeScript

const { data, error } = await client.models.questionnaires.detach('model_id-123', 'attachment_id-123');

Parameters:

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

Returns: Response object

---

Example: Working with Models Questionnaires

Python

from credoai import CredoAI, QuestionnaireAttachment

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}")

# Attach a questionnaire
client.model_questionnaires.attach(
    model_id="model-123",
    data=QuestionnaireAttachment(id="questionnaire-456")
)

# Detach a questionnaire
client.model_questionnaires.detach(
    model_id="model-123",
    attachment_id="questionnaire-456"
)

TypeScript

import { createCredoAIClient } from '@credo-ai/sdk';

const client = createCredoAIClient('your-tenant');

// List questionnaires for a model
const { data, error } = await client.models.questionnaires.list('model-123');
for (const item of data.items) {
  console.log(item.id);
}

// Attach a questionnaire
await client.models.questionnaires.attach('model-123', { id: 'questionnaire-456' });

// Detach a questionnaire
await client.models.questionnaires.detach('model-123', 'questionnaire-456');