AI models

This page explains how to manage AI models in Waterflai. Models are the core components that power your AI applications, and Waterflai provides flexible ways to import and create models.

Viewing Models

The Models table displays all the AI models available in your workspace. Each model entry includes:

  • Name of the model

  • Provider logo

  • Model type (e.g., Text Generation, Embeddings, Reranker)

  • A truncated description (hover over it to see the full description)

Adding Models

Waterflai offers two primary methods for adding models to your workspace:

1. Quick Import from Provider

This method allows you to quickly import multiple models from a configured provider.

  1. In the Providers table, locate the provider you want to import models from.

  2. Click the brain icon next to the provider's name.

  3. In the Import Models modal:

    • You'll see a list of available models not yet imported.

    • For each model, select its type from the dropdown (if not automatically detected).

    • Click "Add" for each model you want to import.

  4. The selected models will be immediately added to your workspace.

2. Manual Model Creation

This method allows for more detailed configuration of individual models.

  1. Click the "Add Model" button above the Models table.

  2. In the Model Form modal:

    • Select the Provider from the dropdown.

    • Choose the specific Model from the provider's available models.

    • The Model Type will be auto-selected if detected, or you can manually choose it.

    • Enter a Name for the model (auto-filled with the provider's model name, but you can customize it).

    • Optionally, add or edit the Description.

  3. Click "Create" to add the model to your workspace.

Managing Models

Editing a Model

  1. In the Models table, click the three-dot menu at the end of the model's row.

  2. Select "Edit" from the dropdown menu.

  3. In the Edit Model modal, you can modify the model's name and description.

  4. Click "Save" to apply your changes.

Deleting a Model

  1. In the Models table, click the three-dot menu at the end of the model's row.

  2. Select "Delete" from the dropdown menu.

  3. Confirm the deletion in the confirmation dialog.

Note: Deleting a model will remove it from your workspace. Ensure the model isn't being used in any active projects before deletion.

Best Practices

  1. Naming Convention: Use clear, descriptive names for your models to easily identify their purpose or capabilities.

  2. Descriptions: Provide detailed descriptions for your models, including their strengths, limitations, and ideal use cases.

  3. Regular Review: Periodically review your model list to remove unused models and keep your workspace organized.

  4. Testing: After adding a new model, test it in a sample project to ensure it performs as expected.

By following these instructions, you'll be able to efficiently manage AI models in your Waterflai workspace, enabling you to leverage a wide range of AI capabilities for your applications.

Last updated