Text and chat prompts

1
import opik
2
3
client = opik.Opik()
4
5
prompt = client.create_prompt(
6
    name="prompt-summary",
7
    prompt="Write a summary of the following text: {{text}}",
8
    metadata={"environment": "development"},
9
    project_name="my-agent",
10
)
11
12
# Render the template
13
print(prompt.format(text="Hello, world!"))

1
import opik
2
3
client = opik.Opik()
4
5
prompt = client.get_prompt(name="prompt-summary", project_name="my-agent")
6
7
# Render the template
8
print(prompt.format(text="Hello, world!"))

1
import opik
2
3
client = opik.Opik()
4
5
messages = [
6
    {"role": "system", "content": "You are a helpful assistant specializing in {{domain}}."},
7
    {"role": "user", "content": "Explain {{topic}} in simple terms."},
8
]
9
10
chat_prompt = client.create_chat_prompt(
11
    name="educational-assistant",
12
    messages=messages,
13
    metadata={"category": "education"},
14
    project_name="my-agent",
15
)
16
17
# Render the messages with variables
18
formatted_messages = chat_prompt.format(
19
    variables={
20
        "domain": "physics",
21
        "topic": "quantum entanglement",
22
    }
23
)
24
25
print(formatted_messages)
26
# [
27
#     {"role": "system", "content": "You are a helpful assistant specializing in physics."},
28
#     {"role": "user", "content": "Explain quantum entanglement in simple terms."},
29
# ]

1
import opik
2
from openai import OpenAI
3
4
client = opik.Opik()
5
openai_client = OpenAI()
6
7
chat_prompt = client.get_chat_prompt(
8
    name="educational-assistant",
9
    project_name="my-agent",
10
)
11
12
formatted_messages = chat_prompt.format(
13
    variables={"domain": "physics", "topic": "quantum entanglement"},
14
)
15
16
response = openai_client.chat.completions.create(
17
    model="gpt-4o-mini",
18
    messages=formatted_messages,
19
)
20
21
print(response.choices[0].message.content)

1
import opik
2
3
client = opik.Opik()
4
5
messages = [
6
    {"role": "system", "content": "You are a customer support agent for {{company}}."},
7
    {"role": "user", "content": "I have an issue with {{product}}."},
8
    {"role": "assistant", "content": "I'd be happy to help with your {{product}}. Can you describe the issue?"},
9
    {"role": "user", "content": "{{issue_description}}"},
10
]
11
12
chat_prompt = client.create_chat_prompt(
13
    name="customer-support-flow",
14
    messages=messages,
15
    project_name="my-agent",
16
)
17
18
formatted = chat_prompt.format(
19
    variables={
20
        "company": "Acme Corp",
21
        "product": "Widget Pro",
22
        "issue_description": "It won't turn on",
23
    }
24
)

1
import opik
2
3
client = opik.Opik()
4
5
messages = [
6
    {"role": "system", "content": "You analyze images and provide detailed descriptions."},
7
    {
8
        "role": "user",
9
        "content": [
10
            {"type": "text", "text": "What's in this image of {{subject}}?"},
11
            {
12
                "type": "image_url",
13
                "image_url": {
14
                    "url": "{{image_url}}",
15
                    "detail": "high",
16
                },
17
            },
18
        ],
19
    },
20
]
21
22
chat_prompt = client.create_chat_prompt(
23
    name="image-analyzer",
24
    messages=messages,
25
    project_name="my-agent",
26
)
27
28
formatted = chat_prompt.format(
29
    variables={
30
        "subject": "a sunset",
31
        "image_url": "https://example.com/sunset.jpg",
32
    },
33
    supported_modalities={"vision": True},
34
)

1
import opik
2
3
client = opik.Opik()
4
5
messages = [
6
    {"role": "system", "content": "You analyze videos and provide insights."},
7
    {
8
        "role": "user",
9
        "content": [
10
            {"type": "text", "text": "Analyze this video: {{description}}"},
11
            {
12
                "type": "video_url",
13
                "video_url": {
14
                    "url": "{{video_url}}",
15
                    "mime_type": "video/mp4",
16
                },
17
            },
18
        ],
19
    },
20
]
21
22
chat_prompt = client.create_chat_prompt(
23
    name="video-analyzer",
24
    messages=messages,
25
    project_name="my-agent",
26
)
27
28
formatted = chat_prompt.format(
29
    variables={
30
        "description": "traffic analysis",
31
        "video_url": "https://example.com/traffic.mp4",
32
    },
33
    supported_modalities={"vision": True},
34
)

1
import opik
2
3
client = opik.Opik()
4
5
messages = [
6
    {
7
        "role": "user",
8
        "content": [
9
            {"type": "text", "text": "Compare these two images:"},
10
            {"type": "image_url", "image_url": {"url": "{{image1_url}}"}},
11
            {"type": "text", "text": "and"},
12
            {"type": "image_url", "image_url": {"url": "{{image2_url}}"}},
13
            {"type": "text", "text": "What are the main differences?"},
14
        ],
15
    },
16
]
17
18
chat_prompt = client.create_chat_prompt(
19
    name="image-comparison",
20
    messages=messages,
21
    project_name="my-agent",
22
)
23
24
formatted = chat_prompt.format(
25
    variables={
26
        "image1_url": "https://example.com/before.jpg",
27
        "image2_url": "https://example.com/after.jpg",
28
    },
29
    supported_modalities={"vision": True},
30
)

1
import opik
2
from opik.api_objects.prompt import PromptType
3
4
client = opik.Opik()
5
6
chat_prompt = client.create_chat_prompt(
7
    name="mustache-example",
8
    messages=[
9
        {"role": "user", "content": "Hello {{name}}, you live in {{city}}."},
10
    ],
11
    type=PromptType.MUSTACHE,  # Default
12
    project_name="my-agent",
13
)
14
15
formatted = chat_prompt.format(variables={"name": "Alice", "city": "Paris"})
16
# [{"role": "user", "content": "Hello Alice, you live in Paris."}]

1
import opik
2
from opik.api_objects.prompt import PromptType
3
4
client = opik.Opik()
5
6
chat_prompt = client.create_chat_prompt(
7
    name="jinja-example",
8
    messages=[
9
        {
10
            "role": "user",
11
            "content": """
12
            {% if is_premium %}
13
            Hello {{ name }}, welcome to our premium service!
14
            {% else %}
15
            Hello {{ name }}, welcome!
16
            {% endif %}
17
            """,
18
        },
19
    ],
20
    type=PromptType.JINJA2,
21
    project_name="my-agent",
22
)
23
24
# Premium user
25
chat_prompt.format(variables={"name": "Alice", "is_premium": True})
26
# Regular user
27
chat_prompt.format(variables={"name": "Bob", "is_premium": False})

1
import opik
2
3
client = opik.Opik()
4
5
# Search by name substring
6
summaries = client.search_prompts(
7
    filter_string='name contains "summary"'
8
)
9
10
# Combine name + tags
11
filtered = client.search_prompts(
12
    filter_string='name contains "summary" AND tags contains "alpha" AND tags contains "beta"',
13
)
14
15
# Only text prompts
16
text_prompts = client.search_prompts(
17
    filter_string='template_structure = "text"'
18
)
19
20
# Only chat prompts
21
chat_prompts = client.search_prompts(
22
    filter_string='template_structure = "chat" AND name contains "assistant"'
23
)
24
25
for prompt in filtered:
26
    print(prompt.name, prompt.version, prompt.prompt)