​
Why Deploy Prompts via Maxim

  • Prompt experimentation - Create multiple versions of your Prompts, and use a wide variety of models available on Maxim to test and compare their performance using your custom data.
  • Deploy without code changes - Deploy the final version directly from UI—no code changes required. Use Maxim’s RBAC support to limit deployment permission to key stakeholders.
  • Custom variables - Use custom variables to create rules to control which environments or user groups should receive the updates. This helps in setting up A/B tests or testing prompt variations internally before pushing to users.

​
Deploying a prompt

1

Select prompt version

Open the prompt version you want to deploy.Prompt version list
2

Access deployment options

Click the button in the header and choose to deploy the present version.
3

Configure deployment rules

Add one or more rules for deployment e.g. Environment = prod.Deployment rules selection
4

Manage deployment variables

Edit or define new variables by clicking Edit deployment variables
5

Define variable properties

Define the name and type of any variable.
  • For variables of type select provide possible options. e.g. Environment: Beta, Staging, Prod.
Add new deployment variable
  • For variables of type multiselect, configure when the deployment runs:
    • all selected options are present in the deployment rule using the = operator, or
    • any of the selected options are present in the deployment rule using the includes operator.
Multiselect deployment rule
6

Apply conditional deployments

Every time you have a new version to deploy, use the variable based rules to deploy conditionally.
7

Review existing deployments

View existing deployments for any prompt from the deploy button in the header.Deployments list

​
Fetching Prompts via SDK

For building query to get prompt with specific deployment variables, you can use QueryBuilder. 
import { Maxim, QueryBuilder } from "@maximai/maxim-js;

const maxim = new Maxim({ apiKey: "", promptManagement: true });

const prompt = await maxim.getPrompt("prompt-id",
                new QueryBuilder()
                  .and()
                  .deploymentVar("Environment", "prod")
                  .build());
Add multiple queries 
import { Maxim, QueryBuilder } from "@maximai/maxim-js;

const maxim = new Maxim({ apiKey: "", promptManagement: true });

const prompt = await maxim.getPrompt(
  "prompt-id",
  new QueryBuilder().and().deploymentVar("Environment", "prod").deploymentVar("CustomerId", "123").build(),
);
Add filters based on tags 
import { Maxim, QueryBuilder } from "@maximai/maxim-js;

const maxim = new Maxim({ apiKey: "", promptManagement: true});

const prompt = await maxim.getPrompt(
  "prompt-id",
  new QueryBuilder().and().deploymentVar("Environment", "prod").tag("TenantId", "3000").build(),
);
Use multiselect variables 
import { Maxim, QueryBuilder } from "@maximai/maxim-js;

const maxim = new Maxim({ apiKey: "", promptManagement: true});

const prompt = await maxim.getPrompt(
  "prompt-id",
  new QueryBuilder().and().deploymentVar("Tenant ID", ["Tenant1"]).build(),
);