Opik Query Language (OQL)

1
// Exact match
2
'name = "greeting-prompt"';
3
4
// Not equal
5
'name != "old-prompt"';
6
7
// Contains substring (case-insensitive)
8
'name contains "greeting"';
9
10
// Does not contain substring
11
'name not_contains "deprecated"';
12
13
// Starts with prefix
14
'name starts_with "prod-"';
15
16
// Ends with suffix
17
'name ends_with "-v2"';

1
// Greater than (alphabetical for strings)
2
'name > "m"'; // Names starting with n-z
3
4
// Less than (alphabetical for strings)
5
'name < "m"'; // Names starting with a-l

1
// Check if list contains value
2
'tags contains "production"';
3
4
// Check if list does not contain value
5
'tags not_contains "experimental"';

1
// Multiple conditions with AND
2
'tags contains "production" AND name contains "greeting" AND created_by = "user@example.com"';
3
4
// Complex multi-field filtering
5
'name starts_with "prod-" AND tags contains "stable" AND name not_contains "deprecated"';

1
import { Opik } from "opik";
2
3
const client = new Opik();
4
5
// Filter by single tag
6
const prod = await client.searchPrompts('tags contains "production"');
7
8
// Combine name pattern and tag
9
const approved = await client.searchPrompts(
10
  'name starts_with "prod-" AND tags contains "qa-approved"'
11
);
12
13
// Multiple conditions
14
const results = await client.searchPrompts(
15
  'created_by = "user@example.com" AND tags contains "production" AND name not_contains "deprecated"'
16
);

1
// ✅ Correct - double quotes around values
2
await client.searchPrompts('name = "my-prompt"');
3
await client.searchPrompts('tags contains "production"');
4
5
// ❌ Incorrect - missing quotes
6
await client.searchPrompts("name = my-prompt"); // Will fail
7
8
// ❌ Incorrect - single quotes
9
await client.searchPrompts("name = 'my-prompt'"); // Will fail

1
try {
2
  const results = await client.searchPrompts("invalid syntax ===");
3
} catch (error) {
4
  console.error("Invalid OQL syntax:", error.message);
5
}