Models Use Cases

Manage use cases associated with models.

Methods

list

List Use Cases for Model List all use cases associated with a model.

Python

model_id = "model_id-123"

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

TypeScript

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

Parameters:

• model_id (str, required) - Resource identifier

Returns: Response object

---

add

Add Use Case to Model Add a use case to a model.

Python

from credoai import RelationshipAdd

model_id = "model_id-123"

data = RelationshipAdd(
    id="use_cases-456"
)

response = client.model_use_cases.add(
    model_id=model_id,
    data=data,
)

TypeScript

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

Parameters:

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

Returns: Response object

---

remove

Remove Use Case from Model Remove a use case from a model.

Python

model_id = "model_id-123"
use_case_id = "use_case_id-123"

response = client.model_use_cases.remove(
    model_id=model_id,
    use_case_id=use_case_id,
)

TypeScript

const { data, error } = await client.models.useCases.remove('model_id-123', 'use_case_id-123');

Parameters:

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

Returns: Response object

---

Example: Working with Models Use Cases

Python

from credoai import CredoAI, RelationshipAdd

client = CredoAI()

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

# Add a use case
client.model_use_cases.add(
    model_id="model-123",
    data=RelationshipAdd(id="use_case-456")
)

# Remove a use case
client.model_use_cases.remove(
    model_id="model-123",
    use_case_id="use_case-456"
)

TypeScript

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

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

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

// Add a use case
await client.models.useCases.add('model-123', { id: 'use_case-456' });

// Remove a use case
await client.models.useCases.remove('model-123', 'use_case-456');