Prompts

1
import { Opik, PromptType } from "opik";
2
3
const client = new Opik();
4
5
const prompt = await client.createPrompt({
6
  name: "greeting-prompt",
7
  prompt: "Hello {{name}}, your score is {{score}}",
8
  type: PromptType.MUSTACHE,
9
  metadata: { version: "1.0" },
10
  tags: ["greetings"],
11
});
12
13
console.log(`Created prompt with commit: ${prompt.commit}`);

1
// Get latest version
2
const prompt = await client.getPrompt({ name: "greeting-prompt" });
3
4
if (prompt) {
5
  console.log(`Template: ${prompt.prompt}`);
6
  console.log(`Commit: ${prompt.commit}`);
7
}
8
9
// Get specific version
10
const oldVersion = await client.getPrompt({
11
  name: "greeting-prompt",
12
  commit: "abc123de",
13
});

1
const prompt = await client.getPrompt({ name: "greeting-prompt" });
2
3
// Format with variables
4
const text = prompt.format({ name: "Alice", score: 95 });
5
// Returns: "Hello Alice, your score is 95"
6
7
// Format also works on PromptVersion objects
8
const versions = await prompt.getVersions();
9
const previousVersion = versions[1];
10
const oldText = previousVersion.format({ name: "Alice", score: 95 });

1
// Mustache syntax (default)
2
await client.createPrompt({
3
  name: "mustache-prompt",
4
  prompt: "Hello {{name}}, your score is {{score}}",
5
  type: PromptType.MUSTACHE,
6
});
7
8
// Jinja2 syntax for advanced templating
9
await client.createPrompt({
10
  name: "jinja2-prompt",
11
  prompt: "Hello {{ name }}! {% if premium %}Premium user{% endif %}",
12
  type: PromptType.JINJA2,
13
});

1
// First call - creates new prompt with version 1
2
const prompt1 = await client.createPrompt({
3
  name: "greeting-prompt",
4
  prompt: "Hello {{name}}, your score is {{score}}",
5
  type: PromptType.MUSTACHE,
6
  metadata: { version: "1.0" },
7
  tags: ["greetings"],
8
});
9
10
// Same template, metadata, and type - returns existing version
11
const prompt2 = await client.createPrompt({
12
  name: "greeting-prompt",
13
  prompt: "Hello {{name}}, your score is {{score}}", // Same
14
  metadata: { version: "1.0" }, // Same
15
  type: PromptType.MUSTACHE, // Same
16
  tags: ["updated-tags"], // Different tags don't trigger new version
17
});
18
console.log(prompt2.commit === prompt1.commit); // true
19
20
// Changed template - creates new version 2
21
const prompt3 = await client.createPrompt({
22
  name: "greeting-prompt",
23
  prompt: "Hi {{name}}, score: {{score}}", // Different template
24
  changeDescription: "Simplified greeting message",
25
});
26
27
// Changed metadata - creates new version 3
28
const prompt4 = await client.createPrompt({
29
  name: "greeting-prompt",
30
  prompt: "Hi {{name}}, score: {{score}}", // Same as version 2
31
  metadata: { version: "2.0" }, // Different metadata triggers new version
32
  changeDescription: "Updated metadata",
33
});

1
const prompt = await client.getPrompt({ name: "greeting-prompt" });
2
3
// Update name, description, or tags
4
await prompt.updateProperties({
5
  name: "welcome-prompt",
6
  description: "Updated greeting template",
7
  tags: ["welcome", "production", "v2"],
8
});
9
10
console.log(`Updated prompt name: ${prompt.name}`);

1
// Search all prompts (no filter)
2
const allPrompts = await client.searchPrompts();
3
4
// Search by exact name
5
const prompts = await client.searchPrompts('name = "greeting-prompt"');
6
7
// Search by name pattern
8
const chatPrompts = await client.searchPrompts('name contains "chat"');
9
10
// Search by tags
11
const prodPrompts = await client.searchPrompts('tags contains "production"');
12
13
// Search by creator
14
const myPrompts = await client.searchPrompts(
15
  'created_by = "alice@company.com"'
16
);

1
const prompt = await client.getPrompt({ name: "greeting-prompt" });
2
3
// Delete prompt and all its versions
4
await prompt.delete();
5
6
// Or delete multiple prompts by ID
7
await client.deletePrompts([prompt.id, anotherPrompt.id]);

1
const prompt = await client.getPrompt({ name: "greeting-prompt" });
2
const versions = await prompt.getVersions();
3
const latest = versions[0];
4
5
// Version properties
6
console.log(`ID: ${latest.id}`);
7
console.log(`Commit: ${latest.commit}`);
8
console.log(`Template: ${latest.prompt}`);
9
console.log(`Created: ${latest.createdAt}`);
10
console.log(`Creator: ${latest.createdBy}`);
11
console.log(`Type: ${latest.type}`);
12
console.log(`Change: ${latest.changeDescription}`);
13
14
// Formatted version info
15
console.log(latest.getVersionInfo());
16
// Output: [abc123de] 2024-01-15 by user@example.com - Initial version
17
18
// Human-readable age
19
console.log(latest.getVersionAge());
20
// Output: "2 days ago"

1
const prompt = await client.getPrompt({ name: "greeting-prompt" });
2
3
// Get all versions
4
const versions = await prompt.getVersions();
5
6
console.log(`Total versions: ${versions.length}`);
7
8
versions.forEach((version) => {
9
  console.log(version.getVersionInfo());
10
  // Output: [abc123de] 2024-01-15 by user@example.com - Initial version
11
});

1
const prompt = await client.getPrompt({ name: "greeting-prompt" });
2
3
// Option 1: Get version as Prompt instance (recommended for formatting)
4
const oldVersion = await prompt.getVersion("abc123de");
5
6
if (oldVersion) {
7
  const text = oldVersion.format({ name: "Bob", score: 88 });
8
  console.log(`Old version output: ${text}`);
9
}
10
11
// Option 2: Use format directly on PromptVersion objects
12
const versions = await prompt.getVersions();
13
const secondVersion = versions[1];
14
15
// PromptVersion also has format() method
16
const formattedText = secondVersion.format({ name: "Charlie", score: 92 });
17
console.log(`Version ${secondVersion.commit}: ${formattedText}`);

1
const versions = await prompt.getVersions();
2
3
if (versions.length >= 2) {
4
  const current = versions[0];
5
  const previous = versions[1];
6
7
  // Compare versions (logs diff and returns it)
8
  const diff = current.compareTo(previous);
9
  console.log(diff);
10
  /* Output:
11
   * - Current version [abc123de]
12
   * + Other version [def456gh]
13
   * @@ -1,2 +1,2 @@
14
   * - Hello {{name}}, welcome!
15
   * + Hello {{name}}, your score is {{score}}
16
   */
17
}

1
const prompt = await client.getPrompt({ name: "greeting-prompt" });
2
const versions = await prompt.getVersions();
3
4
// Find specific version to restore
5
const targetVersion = versions.find((v) => v.commit === "abc123de");
6
7
if (targetVersion) {
8
  // Restore creates a new version with the old content
9
  const restoredPrompt = await prompt.useVersion(targetVersion);
10
11
  console.log(`Restored to commit: ${restoredPrompt.commit}`);
12
  console.log(`Template: ${restoredPrompt.prompt}`);
13
}

1
import { Opik, track } from "opik";
2
3
const client = new Opik();
4
5
@track
6
async function generateGreeting(userName: string, userScore: number) {
7
  // Get the prompt
8
  const prompt = await client.getPrompt({ name: "greeting-prompt" });
9
10
  // Format it
11
  const message = prompt.format({
12
    name: userName,
13
    score: userScore,
14
  });
15
16
  // Use with your LLM
17
  const response = await llmClient.complete(message);
18
19
  return response;
20
}

1
// prompts/greeting.ts
2
export const GREETING_TEMPLATE = "Hello {{name}}, your score is {{score}}";
3
4
// In your application
5
import { GREETING_TEMPLATE } from "./prompts/greeting";
6
7
const prompt = await client.createPrompt({
8
  name: "greeting",
9
  prompt: GREETING_TEMPLATE,
10
  metadata: { version: "1.0" },
11
});

1
const prompt = await client.createPrompt({
2
  name: "summary-prompt",
3
  prompt: updatedTemplate,
4
  changeDescription: "Added support for multi-language summaries",
5
  metadata: { sprint: "Q1-2024" },
6
});

1
const prompt = await client.createPrompt({
2
  name: "production-greeting",
3
  prompt: template,
4
  tags: ["production", "customer-facing", "v2"],
5
});
6
7
// Later, search by tags
8
const prodPrompts = await client.searchPrompts('tags contains "production"');