Skip to main content

​
Working with Models

The Models section of Kosmoy Studio is where you register and manage models from your integrated providers. This section provides a centralized repository of all your available models, allowing you to easily use them when building Assistants, configuring Gateways, defining Router logic, or applying Guardrails.

​
Prerequisites

Before you can register a model from a third-party provider (e.g., OpenAI, Cohere, Anthropic, MistralAI, xAI, Google Cloud, Microsoft Azure, Amazon, OpenRouter), you must have a corresponding integration already enabled. See the Managing Integrations section for more details.

​
Registering a Model

To register a model, follow these steps:
  1. Navigate to Models: From the Kosmoy Studio home page, click on the “Models” menu in the left-hand navigation bar.
  2. Add a New Model: Click the ”+ ADD” button located in the upper right corner of the Models section.
  3. Define Model Type: Select the type of model you want to register (e.g., LLM).
  4. Choose Provider and Integration: Select the provider (e.g., OpenAI, Google, Azure) and then choose the relevant integration from the dropdown. This integration must be active for the provider whose model you want to register.
  5. Select Model Version: Choose the specific model version you want to register (e.g., GPT-4o, Gemini Pro). The available options will depend on the selected provider and integration.
  6. Click “Next”: Proceed to the next step.
  7. Name and Describe the Model: Give your model a unique name and an optional description. This will help you identify the model later.
  8. Click “Review”: Review the model details.
  9. Click “Create”: Register the model.

​
Model Cards

The Models section displays each registered model as a card. Each card shows:
  • Model Icon: An icon representing the model type.
  • Model Name: The name you assigned to the model.
  • Description: The description you provided for the model.
  • Edit Icon (Pencil): Click this icon to update the model’s name or description (only if the model is not in use).
  • Delete Icon (Trash Bin): Click this icon to remove the model (only if the model is not in use).

​
Model Usage Restrictions

You cannot edit or delete a model if it is currently referenced by other entities within Kosmoy Studio. This includes being used in:
  • Assistants
  • Routers
  • Gateways
  • Guardrails
  • Vector Pipelines
  • Coded Apps
  • Any other Kosmoy Studio component that references models.
Before attempting to edit or delete a model, ensure it is not actively used in any of these areas. You may need to modify or remove the model from those components first.

​
Updating a Model

You can update the name and description of a registered model, provided it is not currently referenced by any other component.
  1. Navigate to Models: From the Kosmoy Studio home page, click on the “Models” icon in the left-hand navigation bar.
  2. Locate the Model Card: Find the card for the model you want to update.
  3. Click the Edit (Pencil) Icon: This will open the update dialog.
  4. Modify Name and/or Description: Update the model’s name and/or description as needed.
  5. Click “Save”: Save the changes.
Note: You cannot update the model’s provider, integration, or version after it has been registered. If you attempt to edit a model that is currently in use, a warning banner will be displayed at the top of the screen, preventing the modification.

​
Removing a Model

You can remove a registered model if it’s no longer needed. However, you cannot delete a model that is currently referenced by any other component.
  1. Navigate to Models: From the Kosmoy Studio home page, click on the “Models” icon in the left-hand navigation bar.
  2. Locate the Model Card: Find the card for the model you want to remove.
  3. Click the Delete (Trash Bin) Icon: This will trigger a confirmation prompt.
If you attempt to delete a model that is currently in use, a modal will appear, preventing the deletion and explaining that the model is in use.
  1. Confirm Deletion: Confirm that you want to delete the model.
Warning: Deleting a model is a permanent action and cannot be undone. Ensure that the model is not being referenced by any other component before proceeding.