hello

command
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

README

Hello World Example

The simplest SDK example - open a conversation and send a message.

What You'll Learn

  • Opening a conversation from a pack file with sdk.Open()
  • Setting template variables with SetVar()
  • Sending messages with Send()
  • Multi-turn conversation context

Prerequisites

  • Go 1.21+
  • OpenAI API key

Running the Example

export OPENAI_API_KEY=your-key
go run .

Code Overview

// Open a conversation from a pack file
conv, err := sdk.Open("./hello.pack.json", "chat")
if err != nil {
    log.Fatal(err)
}
defer conv.Close()

// Set template variables (substituted in system prompt)
conv.SetVar("user_name", "World")

// Send a message and get a response
ctx := context.Background()
resp, err := conv.Send(ctx, "Say hello!")
fmt.Println(resp.Text())

// Context is maintained across turns
resp, _ = conv.Send(ctx, "What's my name?")
fmt.Println(resp.Text())  // Remembers "World"

Pack File Structure

The hello.pack.json defines:

  • Provider: OpenAI with gpt-4o-mini
  • Prompt: A friendly assistant with {{user_name}} template variable
{
  "prompts": {
    "chat": {
      "system_template": "You are a friendly assistant. The user's name is {{user_name}}."
    }
  }
}

Key Concepts

  1. Pack-First Design - All configuration lives in the pack file
  2. Template Variables - Use {{variable}} in prompts, set with SetVar()
  3. Conversation Context - Messages are remembered across Send() calls
  4. Resource Cleanup - Always defer conv.Close()

Next Steps

Documentation

Overview

Package main demonstrates the simplest PromptKit SDK usage.

This example shows:

  • Opening a conversation from a pack file
  • Sending a simple message
  • Reading the response

Run with:

export OPENAI_API_KEY=your-key
go run .

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL