Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microsoft/prompty


https://github.com/microsoft/prompty

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README 

        
# Prompty



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.



This repo contains the following:



- [Prompty Language Specification](Prompty.yaml)

- [Documentation](https://github.com/microsoft/prompty/tree/main/web) site (visit [prompty.ai](https://prompty.ai) for the live site)

- (More on the way)



This Visual Studio Code extension offers an intuitive prompt playground within VS Code to streamline the prompt engineering process. You can find the Prompty extension in the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.prompty).



## What is Prompty?

### Specification

Prompty standardizes prompts and their execution into a single asset.



![Language Spec](img/vscode/readme_lang_spec.png)



## VSCode Extension Features

### Quickly Create

Quickly create a basic prompty by right-clicking in the VS Code explorer and selecting "New Prompty."



![Quick Create](img/vscode/image-2.png)



### Preview

Preview prompty similar to markdown with dynamic template rendering while typing, allowing you to see the prompt that will be sent to the model.



![Preview](img/vscode/readme_preview.png)



### Define and Switch Model Configurations

* Define your model configurations directly in VS Code.

* Quickly switch between different model configurations.



  ![Define Configuration](img/vscode/image-5.png)



  ![Switch Model Configuration](img/vscode/switchModelConfiguration.png)

* Use VS Code settings to define model configuration at:

  * User level for use across different prompty files.

  * Workspace level to share with team members via Git.



    ![ModelConfigurationSettings](img/vscode/modelConfigurationSettings.png)



* We strongly encourage using Azure Active Directory authentication for enhanced security. Leave the `api_key` empty to trigger AAD auth.

* OpenAI is also supported. You can store the key in VSCode settings or use `${env:xxx}` to read the API key from an environment variable.

  * You can put environment variables in `.env` file, in the same folder of the prompty file, or in the workspace root folder.

  * Alternatively, you can also specify it in system variables, follow [OpenAI's Guide](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety) for key safety, setting it through Control Panel/zsh/bash, and then restart VS Code to load new values.



### Quick Run

Hit **F5** or click the **Run** button at the top. There are two output windows:

* **Prompty Output** shows a concise view.



  ![Prompty Output](img/vscode/image-3.png)



* **Prompty Output (Verbose)** shows detailed requests sent and received.



  ![Prompty Output (Verbose)](img/vscode/image-8.png)



### Orchestrator Integration

Prompty is supported by popular orchestration frameworks:

* [Prompt flow](https://microsoft.github.io/promptflow/tutorials/prompty-quickstart.html)

* [Langchain](https://github.com/langchain-ai/langchain/tree/master/libs/partners/prompty)

* [Semantic Kernel](https://github.com/microsoft/semantic-kernel/blob/main/dotnet/samples/Concepts/PromptTemplates/PromptyFunction.cs)



Right-click on a `.prompty` file to quickly generate integration snippets.



![Orchestrator Integration](img/vscode/image-9.png)



## Feedback

Submit your feedback about Prompty or the VS Code extension to the [Microsoft/prompty](https://github.com/microsoft/prompty/issues) GitHub repository.



## Documentation

* https://prompty.ai