superwise_api.entities.model_provider

class ModelProviderApi(superwise_api.entities.base.BaseApi):
def create( self, name: str, config: Annotated[Union[superwise_api.models.model_provider.model_provider.OpenAIProviderConfig, superwise_api.models.model_provider.model_provider.OpenAICompatibleProviderConfig, superwise_api.models.model_provider.model_provider.GoogleAIProviderConfig, superwise_api.models.model_provider.model_provider.AnthropicProviderConfig, superwise_api.models.model_provider.model_provider.VertexAIProviderConfig], FieldInfo(annotation=NoneType, required=True, discriminator='provider')], **kwargs) -> superwise_api.models.model_provider.model_provider.ModelProvider:

Create a new model provider.

Arguments:
  • name: The name of the model provider.
  • config: The config of the model provider.
  • **kwargs: Arbitrary keyword arguments.
Returns:

The created model provider.

def get_by_id( self, model_provider_id: str, with_deleted: bool = False, **kwargs) -> superwise_api.models.model_provider.model_provider.ModelProvider:

Get a model provider by id.

Arguments:
  • model_provider_id: The id of the model provider.
  • with_deleted: Whether to include deleted model providers.
  • **kwargs: Arbitrary keyword arguments.
Returns:

The model provider.

def get( self, search: Optional[str] = None, page: Optional[Annotated[int, Strict(strict=True), Interval(gt=None, ge=1, lt=None, le=None), None]] = None, size: Optional[Annotated[int, Strict(strict=True), Interval(gt=None, ge=25, lt=None, le=500), None]] = None, with_deleted: bool = False, **kwargs) -> superwise_api.client.models.page.Page:

Gets model providers. Filter if any of the parameters are provided.

Arguments:
  • search (str, optional): The search query.
  • page (int, optional): The page number.
  • size (int, optional): The size of the page.
  • with_deleted: Whether to include deleted model providers.
Returns:

Page: A page of model providers.

def update( self, model_provider_id: str, name: Optional[str] = None, **kwargs) -> superwise_api.models.model_provider.model_provider.ModelProvider:

Update a model provider.

Arguments:
  • model_provider_id: The id of the model provider.
  • name: The name of the model provider.
  • **kwargs: Arbitrary keyword arguments.
Returns:

The updated model provider.

def delete(self, model_provider_id: str, **kwargs) -> None:

Delete a model provider.

Arguments:
  • model_provider_id: The id of the model provider.
  • **kwargs: Arbitrary keyword arguments.
Returns:

None

def prebuilt_provider_status( self, **kwargs) -> superwise_api.models.model_provider.model_provider.PrebuiltProviderStatus:

Get the status of the prebuilt model providers.

Returns:

The status of the prebuilt model providers.

Inherited Members
superwise_api.entities.base.BaseApi
BaseApi
api_client
wrap_api_calls
raise_exception