1. Introduction

Prompty is an asset class and format for LLM prompts designed to enhance observability, understandability, and portability for developers. The primary goal is to accelerate the developer inner loop of prompt engineering and prompt source management in a cross-language and cross-platform implementation.

The implementation currently supports popular runtimes (Python, C#) and frameworks (LangChain, Semantic Kernel, Prompt flow) with plans to add more. The project is open source and we encourage developers to extend the capabilities to new runtimes and tooling and contribute those back to the core for use by the community.

2. Prompty Components

The Prompty implementation consists of three core components - the specification (file format), the tooling (developer experience) and the runtime (executable code). Let's review these briefly.

2.1 The Prompty Specification

The Prompty specification defines the core .prompty asset file format. We'll look at this in more detail in the Prompty File Spec section of the documentation. For now, click to expand the section below to see a basic.prompty sample and get an intuitive sense for what an asset file looks like.

---
name: Basic Prompt
description: A basic prompt that uses the GPT-3 chat API to answer questions
authors:
  - sethjuarez
  - jietong
model:
  api: chat
  configuration:
    api_version: 2023-12-01-preview
    azure_endpoint: ${env:AZURE_OPENAI_ENDPOINT}
    azure_deployment: ${env:AZURE_OPENAI_DEPLOYMENT:gpt-35-turbo}
sample:
  firstName: Jane
  lastName: Doe
  question: What is the meaning of life?
---
system:
You are an AI assistant who helps people find information.
As the assistant, you answer questions briefly, succinctly, 
and in a personable manner using markdown and even add some personal flair with appropriate emojis.

# Customer
You are helping {{firstName}} {{lastName}} to find answers to their questions.
Use their name to address them in your responses.

user:
{{question}}

2.2 The Prompty Tooling

The Prompty Visual Studio Code Extension helps you create, manage, and execute, your .prompty assets - effectively giving you a playground right in your editor, to streamline your prompt engineering workflow and speed up your prototype iterations. We'll get hands-on experience with this in the Tutorials section. For now, click to expand the section and get an intutive sense for how this enhances your developer experience.

2.3 The Prompty Runtime

The Prompty Runtime helps you make the transition from static asset (.prompty file) to executable code (using a preferred language and framework) that you can test interactively from the commandline, and integrate seamlessly into end-to-end development workflows for automation. We'll have a dedicated documentation on this soon. In the meantime, click to expand the section below to learn about supported runtimes today, and check back for updates on new runtime releases.

3. Developer Workflow

Prompty is ideal for rapid prototyping and iteration of a new generative AI application, using rich developer tooling and a local development runtime. It fits best into the ideation and evaluation phases of the GenAIOps application lifecycle as shown:

1. Start by creating & testing a simple prompt in VS Code
2. Develop by iterating config & content, use tracing to debug
3. Evaluate prompts with AI assistance, saved locally or to cloud

4. Developer Mindset

As an AI application developer, you are likely already using a number of tools and frameworks to enhance your developer experience. So, where does Prompty fit into you developer toolchain?

Think of it as a micro-orchestrator focused on a single LLM invocation putting it at a step above the basic API call and positioned to support more complex orchestration frameworks above it. With Prompty, you can:

• configure the right model for that specific invocation
• engineer the prompt (system, user, context, instructions) for that request
• shape the data used to "render" the template on execution by the runtime

5. Developer Resources

Check back for updates to the documentation site with tutorials (coming soon) and deep-dives (for contributors). In the meantime, here are four key resources to get you started:

Next Steps

Start with the Getting Started section to validate your development setup and build your first Prompty sample.

Want to Contribute To the Project? - Guidance coming soon.