Class swarmauri_core.ensembles.IEnsemble.IEnsemble

swarmauri_core.ensembles.IEnsemble.IEnsemble

Bases: ABC

Interface for routing predictions across multiple providers.

add_model abstractmethod

add_model(name, model)

Add a provider to the ensemble.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
def add_model(self, name: str, model: IPredict) -> None:
    """Add a provider to the ensemble."""
    pass

remove_model abstractmethod

remove_model(name)

Remove a provider from the ensemble.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
def remove_model(self, name: str) -> bool:
    """Remove a provider from the ensemble."""
    pass

list_models abstractmethod

list_models()

Return the registered providers.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
def list_models(self) -> Dict[str, IPredict]:
    """Return the registered providers."""
    pass

route_by_provider abstractmethod

route_by_provider(provider, prompt, **kwargs)

Route a request to a specific provider.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
def route_by_provider(self, provider: str, prompt: str, **kwargs: Any) -> Any:
    """Route a request to a specific provider."""
    pass

aroute_by_provider abstractmethod async

aroute_by_provider(provider, prompt, **kwargs)

Asynchronously route a request to a specific provider.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
async def aroute_by_provider(
    self, provider: str, prompt: str, **kwargs: Any
) -> Any:
    """Asynchronously route a request to a specific provider."""
    pass

route abstractmethod

route(prompt, **kwargs)

Route a request to a chosen provider.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
def route(self, prompt: str, **kwargs: Any) -> Any:
    """Route a request to a chosen provider."""
    pass

aroute abstractmethod async

aroute(prompt, **kwargs)

Asynchronously route a request to a chosen provider.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
async def aroute(self, prompt: str, **kwargs: Any) -> Any:
    """Asynchronously route a request to a chosen provider."""
    pass

broadcast abstractmethod

broadcast(prompt, **kwargs)

Send a request to all providers and return their responses.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
def broadcast(self, prompt: str, **kwargs: Any) -> Dict[str, Any]:
    """Send a request to all providers and return their responses."""
    pass

abroadcast abstractmethod async

abroadcast(prompt, **kwargs)

Asynchronously broadcast a request to all providers.

Source code in swarmauri_core/ensembles/IEnsemble.py

@abstractmethod
async def abroadcast(self, prompt: str, **kwargs: Any) -> Dict[str, Any]:
    """Asynchronously broadcast a request to all providers."""
    pass