openai/

README

OpenAI AI Examples

This directory contains examples demonstrating how to use the AI library with OpenAI-compatible APIs (including LM Studio).

Prerequisites

1. Install LM Studio - Download from lmstudio.ai
2. Start LM Studio server:
   • Open LM Studio
   • Go to the "Local Server" tab
   • Start the server on 127.0.0.1:1234
3. Load a model (e.g., mistralai/ministral-3-3b)

Examples

shared/ - Using a Wrapped Client

This example demonstrates the wrapped client pattern where the OpenAI client is configured in Go code, wrapped as a scriptling object, and passed to the script as a global variable.

cd shared
go run main.go

How it works:

• Go code creates an openai.Client configured for the OpenAI API
• Client is wrapped via ai.WrapClient() and set as a global variable via p.SetObjectVar()
• Script uses instance methods like ai_client.models() and ai_client.chat() directly
• This pattern allows multiple clients to be used simultaneously

Use this pattern when:

• You want to manage the client configuration in Go
• Multiple scripts need to share the same client
• You want to keep API keys out of scripts
• You need to support multiple different clients simultaneously

instance/ - Creating Client from Script

This example demonstrates creating a client instance directly from the script without any pre-configuration in Go.

cd instance
go run main.go

How it works:

• No client is configured in Go
• Script creates its own client via ai.Client()
• Script uses instance methods like client.models() and client.completion()
• The example.py script handles all connection details

Use this pattern when:

• You want scripts to be self-contained
• Each script needs different client configurations
• You're writing scripts that can run standalone

streaming/ - Streaming Chat Completions

This example demonstrates streaming responses from an OpenAI-compatible API, which is ideal for interactive applications and long-form content generation.

cd streaming
go run main.go

How it works:

• Script creates a client via ai.Client()
• Uses client.completion_stream() to get streaming responses
• Iterates through chunks with stream.next()
• Prints content in real-time as it arrives

Use this pattern when:

• You want real-time response streaming
• Building interactive chat applications
• Generating long-form content with progressive display
• Providing immediate feedback to users

scriptlingcoder/ - AI Coding Assistant with Custom Tools

An interactive AI coding assistant that can read, write, and modify files using custom tools. Inspired by nanocode.

cd scriptlingcoder
../../../bin/scriptling scriptlingcoder.py

⚠️ WARNING: This example executes AI-generated code and shell commands. Use at your own risk!

How it works:

• Defines custom tools (read, write, edit, glob, grep, bash)
• Registers tools via tools parameter in completion() - tools are sent to AI but NOT executed by client
• AI can call tools, script executes them locally and returns results
• Supports multi-turn conversations with tool execution

Use this pattern when:

• You need custom tools that aren't MCP servers
• You want full control over tool execution
• Building AI agents that interact with local systems
• Creating specialized coding assistants

Features:

• File operations (read, write, edit)
• Search (glob patterns, regex grep)
• Shell command execution
• Interactive chat interface
• Conversation history

Scripts

shared/example.py

Uses the wrapped client passed from Go:

print("Using the AI client from the wrapped global variable...")
print()

print("Fetching available models from LM Studio...")
models = ai_client.models()
print(f"Found {len(models)} models:")

print()
print("Running chat completion...")
response = ai_client.completion(
    "mistralai/ministral-3-3b",
    [{"role": "user", "content": "What is 2 + 2?"}]
)

instance/example.py

Creates its own client instance:

import scriptling.ai as ai

print("Creating OpenAI client for LM Studio...")
client = ai.Client("http://127.0.0.1:1234/v1")

print()
print("Fetching available models...")
models = client.models()

print()
print("Running chat completion...")
response = client.completion(
    "mistralai/ministral-3-3b",
    [{"role": "user", "content": "What is 2 + 2?"}]
)

streaming/example.py

Demonstrates streaming responses:

import scriptling.ai as ai

client = ai.Client("http://127.0.0.1:1234/v1")

# Create a streaming completion
stream = client.completion_stream(
    "mistralai/ministral-3-3b",
    [{"role": "user", "content": "Write a short haiku about coding in Python."}]
)

# Stream the response chunks
while True:
    chunk = stream.next()
    if chunk is None:
        break

    if chunk.choices and len(chunk.choices) > 0:
        delta = chunk.choices[0].delta
        if delta and delta.content:
            print(delta.content, end='', flush=True)

Expected Output

Both examples will produce similar output:

Fetching available models from LM Studio...
Found 1 models:
  - mistralai/ministral-3b

Running chat completion with mistralai/ministral-3-3b...

Response:
4

Troubleshooting

Connection refused: Make sure LM Studio server is running on port 1234

Model not found: Make sure the model is loaded in LM Studio

Empty response: Try a different model or adjust the prompt