5a558eb09e
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / render-equality (push) Has been cancelled
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Has been cancelled
Python BE E2E Tests / Python BE E2E (push) Has been cancelled
Python Backend Tests / run-python-backend-tests (push) Has been cancelled
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
SDK E2E Libraries Integration Tests / Check Secrets (push) Has been cancelled
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Has been cancelled
SDK E2E Libraries Integration Tests / build-opik (push) Has been cancelled
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Has been cancelled
TypeScript SDK Build & Publish / build-and-publish (push) Has been cancelled
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Has been cancelled
Backend Tests / discover-tests (push) Has been cancelled
Backend Tests / ${{ matrix.name }} (push) Has been cancelled
Build and Publish SDK / build-and-publish (push) Has been cancelled
Build Opik Docker Images / set-version (push) Has been cancelled
Build Opik Docker Images / build-backend (push) Has been cancelled
Build Opik Docker Images / build-sandbox-executor-python (push) Has been cancelled
Build Opik Docker Images / build-python-backend (push) Has been cancelled
Build Opik Docker Images / build-frontend (push) Has been cancelled
Build Opik Docker Images / create-git-tag (push) Has been cancelled
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Has been cancelled
Docs - Publish / run (push) Has been cancelled
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Has been cancelled
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Has been cancelled
Frontend Unit Tests / Test on Node 20 (push) Has been cancelled
Guardrails E2E Tests / Select Python version matrix (push) Has been cancelled
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Guardrails E2E Tests / 📢 Slack Notification (push) Has been cancelled
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Has been cancelled
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Has been cancelled
Lint Opik Helm Chart / unittest-helm-chart (push) Has been cancelled
128 lines
3.4 KiB
Plaintext
128 lines
3.4 KiB
Plaintext
---
|
|
headline: Version Control | Opik Documentation
|
|
og:description: Create, fetch, and compare Prompt Library versions using the Opik UI
|
|
and SDK
|
|
og:site_name: Opik Documentation
|
|
og:title: Prompt Library Version Control
|
|
title: Version control
|
|
---
|
|
|
|
Every change to a prompt in the Prompt Library creates a new immutable version, numbered
|
|
sequentially as `v1`, `v2`, `v3`, … Once created, a version can't be modified — you always have
|
|
a full audit trail.
|
|
|
|
You can create new versions from the Opik UI or from code using the SDK.
|
|
|
|
## Creating a new version
|
|
|
|
<Tabs>
|
|
<Tab title="Opik UI">
|
|
To create a new version from the Opik platform:
|
|
|
|
1. Navigate to the **Prompt Library** for your project
|
|
2. Open the prompt you want to edit
|
|
3. Click **Edit** and update the template
|
|
4. Click **Create new version**
|
|
|
|
The new version is available immediately.
|
|
</Tab>
|
|
<Tab title="Python SDK">
|
|
Call `create_prompt` (or `create_chat_prompt`) again with the same `name` and the updated
|
|
template — the SDK creates the next sequential version automatically:
|
|
|
|
```python
|
|
import opik
|
|
|
|
client = opik.Opik()
|
|
|
|
# v1
|
|
client.create_prompt(
|
|
name="system_prompt",
|
|
prompt="You are a helpful assistant.",
|
|
project_name="my-agent",
|
|
)
|
|
|
|
# v2
|
|
client.create_prompt(
|
|
name="system_prompt",
|
|
prompt="You are a coding assistant specializing in {{language}}.",
|
|
project_name="my-agent",
|
|
)
|
|
```
|
|
|
|
If the template is identical to the latest version, no new version is created.
|
|
</Tab>
|
|
<Tab title="TypeScript SDK">
|
|
Call `createPrompt` (or `createChatPrompt`) again with the same `name` and the updated
|
|
template — the SDK creates the next sequential version automatically:
|
|
|
|
```ts
|
|
import { Opik } from "opik";
|
|
|
|
const client = new Opik();
|
|
|
|
// v1
|
|
await client.createPrompt({
|
|
name: "system_prompt",
|
|
prompt: "You are a helpful assistant.",
|
|
projectName: "my-agent",
|
|
});
|
|
|
|
// v2
|
|
await client.createPrompt({
|
|
name: "system_prompt",
|
|
prompt: "You are a coding assistant specializing in {{language}}.",
|
|
projectName: "my-agent",
|
|
});
|
|
```
|
|
|
|
If the template is identical to the latest version, no new version is created.
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Fetching a specific version
|
|
|
|
Pass the `version` parameter to fetch a specific version, or omit it to fetch the most recent:
|
|
|
|
<CodeBlocks>
|
|
```python title="Python"
|
|
import opik
|
|
|
|
client = opik.Opik()
|
|
|
|
# Fetch a specific version
|
|
v3 = client.get_prompt(name="system_prompt", version="v3", project_name="my-agent")
|
|
|
|
# Fetch the most recent version (omit `version`)
|
|
latest = client.get_prompt(name="system_prompt", project_name="my-agent")
|
|
```
|
|
|
|
```ts title="TypeScript"
|
|
import { Opik } from "opik";
|
|
|
|
const client = new Opik();
|
|
|
|
// Fetch a specific version
|
|
const v3 = await client.getPrompt({
|
|
name: "system_prompt",
|
|
version: "v3",
|
|
projectName: "my-agent",
|
|
});
|
|
|
|
// Fetch the most recent version (omit `version`)
|
|
const latest = await client.getPrompt({
|
|
name: "system_prompt",
|
|
projectName: "my-agent",
|
|
});
|
|
```
|
|
</CodeBlocks>
|
|
|
|
## Comparing versions
|
|
|
|
You can compare any two versions side-by-side in the Opik UI to see exactly what changed. This is
|
|
useful for reviewing changes before pointing your agent at a new version.
|
|
|
|
<Frame>
|
|
<img src="/img/v2/prompt-library/prompt-versions.png" alt="Version comparison view showing a diff of prompt changes between two versions" />
|
|
</Frame>
|