Skip to main content

Models Use Cases

Manage use cases associated with models.

Methods​

list​

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

model_id = "model_id-123"

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

Parameters:

  • model_id (str, required) - Resource identifier

Returns: Response object

add​

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

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

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.

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

Parameters:

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

Returns: Response object

Example: Working with Models Use Cases​

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 ue_cae
client.model_use_cases.add(
    model_id="model-123",
    data=RelationshipAdd(id="ue_cae-456")
)

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