Skip to main content

Use Cases Models

Manage models associated with use cases.

Methods​

list​

List Models for Use Case List all models associated with a use case.

use_case_id = "use_case_id-123"

response = client.use_case_models.list(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

add​

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

from credoai import RelationshipAdd

use_case_id = "use_case_id-123"

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

response = client.use_case_models.add(
    use_case_id=use_case_id,
    data=data,
)

Parameters:

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

Returns: Response object

remove​

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

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

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

Parameters:

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

Returns: Response object

Example: Working with Use Cases Models​

from credoai import CredoAI, RelationshipAdd

client = CredoAI()

# List models for a use_case
models = client.use_case_models.list(use_case_id="use_case-123")
for item in models.items:
    print(f"\\{item.id}")

# Add a model
client.use_case_models.add(
    use_case_id="use_case-123",
    data=RelationshipAdd(id="model-456")
)

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