prompty 0.1.10__tar.gz → 0.1.13__tar.gz

prompty-0.1.13/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.1
+Name: prompty
+Version: 0.1.13
+Summary: Prompty is a new asset class and format for LLM prompts that aims to provide observability, understandability, and portability for developers. It includes spec, tooling, and a runtime. This Prompty runtime supports Python
+Author-Email: Seth Juarez <seth.juarez@microsoft.com>
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: click>=8.1.7
+Requires-Dist: azure-identity>=1.17.1; extra == "azure"
+Requires-Dist: openai>=1.35.10; extra == "azure"
+Requires-Dist: openai>=1.35.10; extra == "openai"
+Requires-Dist: azure-ai-inference>=1.0.0b3; extra == "serverless"
+Provides-Extra: azure
+Provides-Extra: openai
+Provides-Extra: serverless
+Description-Content-Type: text/markdown
+
+
+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 file format has a supporting toolchain with a VS Code extension and runtimes in multiple programming languages to simplify and accelerate your AI application development.
+
+The tooling comes together in three ways: the *prompty file asset*, the *VS Code extension tool*, and *runtimes* in multiple programming languges.
+
+## The Prompty File Format
+Prompty is a language agnostic prompt asset for creating prompts and engineering the responses. Learn more about the format [here](https://prompty.ai/docs/prompty-file-spec).
+
+Examples prompty file:
+```markdown
+---
+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_deployment: gpt-35-turbo
+    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}}
+```
+
+
+## The Prompty VS Code Extension
+Run Prompty files directly in VS Code. 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.
+
+Download the [VS Code extension here](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.prompty).
+
+
+## Using this Prompty Runtime
+The Python runtime is a simple way to run your prompts in Python. The runtime is available as a Python package and can be installed using pip. Depending on the type of prompt you are running, you may need to install additional dependencies. The runtime is designed to be extensible and can be customized to fit your needs.
+
+```bash
+pip install prompty[azure]
+```
+
+Simple usage example:
+
+```python
+import prompty
+# import invoker
+import prompty.azure
+
+# execute the prompt
+response = prompty.execute("path/to/prompty/file")
+
+print(response)
+```
+
+## Available Invokers
+The Prompty runtime comes with a set of built-in invokers that can be used to execute prompts. These include:
+
+- `azure`: Invokes the Azure OpenAI API
+- `openai`: Invokes the OpenAI API
+- `serverless`: Invokes serverless models (like the ones on GitHub) using the [Azure AI Inference client library](https://learn.microsoft.com/en-us/python/api/overview/azure/ai-inference-readme?view=azure-python-preview) (currently only key based authentication is supported with more managed identity support coming soon)
+
+
+## Using Tracing in Prompty
+Prompty supports tracing to help you understand the execution of your prompts. This functionality is customizeable and can be used to trace the execution of your prompts in a way that makes sense to you. Prompty has two default traces built in: `console_tracer` and `PromptyTracer`. The `console_tracer` writes the trace to the console, and the `PromptyTracer` writes the trace to a JSON file. You can also create your own tracer by creating your own hook.
+
+```python
+import prompty
+# import invoker
+import prompty.azure
+from prompty.tracer import trace, Tracer, console_tracer, PromptyTracer
+
+# add console tracer
+Tracer.add("console", console_tracer)
+
+# add PromptyTracer
+json_tracer = PromptyTracer(output_dir="path/to/output")
+Tracer.add("console", json_tracer.tracer)
+
+# execute the prompt
+response = prompty.execute("path/to/prompty/file")
+
+print(response)
+```
+
+You can also bring your own tracer by your own tracing hook. The `console_tracer` is the simplest example of a tracer. It writes the trace to the console.
+This is what it loks like:
+
+```python
+@contextlib.contextmanager
+def console_tracer(name: str) -> Iterator[Callable[[str, Any], None]]:
+    try:
+        print(f"Starting {name}")
+        yield lambda key, value: print(f"{key}:\n{json.dumps(value, indent=4)}")
+    finally:
+        print(f"Ending {name}")
+
+```
+
+It uses a context manager to define the start and end of the trace so you can do whatever setup and teardown you need. The `yield` statement returns a function that you can use to write the trace. The `console_tracer` writes the trace to the console using the `print` function.
+
+The `PromptyTracer` is a more complex example of a tracer. This tracer manages its internal state using a full class. Here's an example of the class based approach that writes each function trace to a JSON file:
+
+```python
+class SimplePromptyTracer:
+    def __init__(self, output_dir: str):
+        self.output_dir = output_dir
+        self.tracer = self._tracer
+
+    @contextlib.contextmanager
+    def tracer(self, name: str) -> Iterator[Callable[[str, Any], None]]:
+        trace = {}
+        try:
+            yield lambda key, value: trace.update({key: value})
+        finally:
+            with open(os.path.join(self.output_dir, f"{name}.json"), "w") as f:
+                json.dump(trace, f, indent=4)
+```
+
+The tracing mechanism is supported for all of the prompty runtime internals and can be used to trace the execution of the prompt along with all of the paramters. There is also a `@trace` decorator that can be used to trace the execution of any function external to the runtime. This is provided as a facility to trace the execution of the prompt and whatever supporting code you have.
+
+```python
+import prompty
+# import invoker
+import prompty.azure
+from prompty.tracer import trace, Tracer, PromptyTracer
+
+json_tracer = PromptyTracer(output_dir="path/to/output")
+Tracer.add("PromptyTracer", json_tracer.tracer)
+
+@trace
+def get_customer(customerId):
+    return {"id": customerId, "firstName": "Sally", "lastName": "Davis"}
+
+@trace
+def get_response(customerId, prompt):
+    customer = get_customer(customerId)
+
+    result = prompty.execute(
+        prompt,
+        inputs={"question": question, "customer": customer},
+    )
+    return {"question": question, "answer": result}
+
+```
+
+In this case, whenever this code is executed, a `.ptrace` file will be created in the `path/to/output` directory. This file will contain the trace of the execution of the `get_response` function, the execution of the `get_customer` function, and the prompty internals that generated the response.
+
+## OpenTelemetry Tracing
+You can add OpenTelemetry tracing to your application using the same hook mechanism. In your application, you might create something like `trace_span` to trace the execution of your prompts:
+
+```python
+from opentelemetry import trace as oteltrace
+
+_tracer = "prompty"
+
+@contextlib.contextmanager
+def trace_span(name: str):
+    tracer = oteltrace.get_tracer(_tracer)
+    with tracer.start_as_current_span(name) as span:
+        yield lambda key, value: span.set_attribute(
+            key, json.dumps(value).replace("\n", "")
+        )
+
+# adding this hook to the prompty runtime
+Tracer.add("OpenTelemetry", trace_span)
+
+```
+
+This will produce spans during the execution of the prompt that can be sent to an OpenTelemetry collector for further analysis.
+
+## CLI
+The Prompty runtime also comes with a CLI tool that allows you to run prompts from the command line. The CLI tool is installed with the Python package.
+
+```bash
+prompty -s path/to/prompty/file
+```
+
+This will execute the prompt and print the response to the console. It also has default tracing enabled.
+
+## Contributing
+We welcome contributions to the Prompty project! This community led project is open to all contributors. The project cvan be found on [GitHub](https://github.com/Microsoft/prompty).

prompty-0.1.13/README.md

@@ -0,0 +1,197 @@
+
+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 file format has a supporting toolchain with a VS Code extension and runtimes in multiple programming languages to simplify and accelerate your AI application development.
+
+The tooling comes together in three ways: the *prompty file asset*, the *VS Code extension tool*, and *runtimes* in multiple programming languges.
+
+## The Prompty File Format
+Prompty is a language agnostic prompt asset for creating prompts and engineering the responses. Learn more about the format [here](https://prompty.ai/docs/prompty-file-spec).
+
+Examples prompty file:
+```markdown
+---
+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_deployment: gpt-35-turbo
+    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}}
+```
+
+
+## The Prompty VS Code Extension
+Run Prompty files directly in VS Code. 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.
+
+Download the [VS Code extension here](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.prompty).
+
+
+## Using this Prompty Runtime
+The Python runtime is a simple way to run your prompts in Python. The runtime is available as a Python package and can be installed using pip. Depending on the type of prompt you are running, you may need to install additional dependencies. The runtime is designed to be extensible and can be customized to fit your needs.
+
+```bash
+pip install prompty[azure]
+```
+
+Simple usage example:
+
+```python
+import prompty
+# import invoker
+import prompty.azure
+
+# execute the prompt
+response = prompty.execute("path/to/prompty/file")
+
+print(response)
+```
+
+## Available Invokers
+The Prompty runtime comes with a set of built-in invokers that can be used to execute prompts. These include:
+
+- `azure`: Invokes the Azure OpenAI API
+- `openai`: Invokes the OpenAI API
+- `serverless`: Invokes serverless models (like the ones on GitHub) using the [Azure AI Inference client library](https://learn.microsoft.com/en-us/python/api/overview/azure/ai-inference-readme?view=azure-python-preview) (currently only key based authentication is supported with more managed identity support coming soon)
+
+
+## Using Tracing in Prompty
+Prompty supports tracing to help you understand the execution of your prompts. This functionality is customizeable and can be used to trace the execution of your prompts in a way that makes sense to you. Prompty has two default traces built in: `console_tracer` and `PromptyTracer`. The `console_tracer` writes the trace to the console, and the `PromptyTracer` writes the trace to a JSON file. You can also create your own tracer by creating your own hook.
+
+```python
+import prompty
+# import invoker
+import prompty.azure
+from prompty.tracer import trace, Tracer, console_tracer, PromptyTracer
+
+# add console tracer
+Tracer.add("console", console_tracer)
+
+# add PromptyTracer
+json_tracer = PromptyTracer(output_dir="path/to/output")
+Tracer.add("console", json_tracer.tracer)
+
+# execute the prompt
+response = prompty.execute("path/to/prompty/file")
+
+print(response)
+```
+
+You can also bring your own tracer by your own tracing hook. The `console_tracer` is the simplest example of a tracer. It writes the trace to the console.
+This is what it loks like:
+
+```python
+@contextlib.contextmanager
+def console_tracer(name: str) -> Iterator[Callable[[str, Any], None]]:
+    try:
+        print(f"Starting {name}")
+        yield lambda key, value: print(f"{key}:\n{json.dumps(value, indent=4)}")
+    finally:
+        print(f"Ending {name}")
+
+```
+
+It uses a context manager to define the start and end of the trace so you can do whatever setup and teardown you need. The `yield` statement returns a function that you can use to write the trace. The `console_tracer` writes the trace to the console using the `print` function.
+
+The `PromptyTracer` is a more complex example of a tracer. This tracer manages its internal state using a full class. Here's an example of the class based approach that writes each function trace to a JSON file:
+
+```python
+class SimplePromptyTracer:
+    def __init__(self, output_dir: str):
+        self.output_dir = output_dir
+        self.tracer = self._tracer
+
+    @contextlib.contextmanager
+    def tracer(self, name: str) -> Iterator[Callable[[str, Any], None]]:
+        trace = {}
+        try:
+            yield lambda key, value: trace.update({key: value})
+        finally:
+            with open(os.path.join(self.output_dir, f"{name}.json"), "w") as f:
+                json.dump(trace, f, indent=4)
+```
+
+The tracing mechanism is supported for all of the prompty runtime internals and can be used to trace the execution of the prompt along with all of the paramters. There is also a `@trace` decorator that can be used to trace the execution of any function external to the runtime. This is provided as a facility to trace the execution of the prompt and whatever supporting code you have.
+
+```python
+import prompty
+# import invoker
+import prompty.azure
+from prompty.tracer import trace, Tracer, PromptyTracer
+
+json_tracer = PromptyTracer(output_dir="path/to/output")
+Tracer.add("PromptyTracer", json_tracer.tracer)
+
+@trace
+def get_customer(customerId):
+    return {"id": customerId, "firstName": "Sally", "lastName": "Davis"}
+
+@trace
+def get_response(customerId, prompt):
+    customer = get_customer(customerId)
+
+    result = prompty.execute(
+        prompt,
+        inputs={"question": question, "customer": customer},
+    )
+    return {"question": question, "answer": result}
+
+```
+
+In this case, whenever this code is executed, a `.ptrace` file will be created in the `path/to/output` directory. This file will contain the trace of the execution of the `get_response` function, the execution of the `get_customer` function, and the prompty internals that generated the response.
+
+## OpenTelemetry Tracing
+You can add OpenTelemetry tracing to your application using the same hook mechanism. In your application, you might create something like `trace_span` to trace the execution of your prompts:
+
+```python
+from opentelemetry import trace as oteltrace
+
+_tracer = "prompty"
+
+@contextlib.contextmanager
+def trace_span(name: str):
+    tracer = oteltrace.get_tracer(_tracer)
+    with tracer.start_as_current_span(name) as span:
+        yield lambda key, value: span.set_attribute(
+            key, json.dumps(value).replace("\n", "")
+        )
+
+# adding this hook to the prompty runtime
+Tracer.add("OpenTelemetry", trace_span)
+
+```
+
+This will produce spans during the execution of the prompt that can be sent to an OpenTelemetry collector for further analysis.
+
+## CLI
+The Prompty runtime also comes with a CLI tool that allows you to run prompts from the command line. The CLI tool is installed with the Python package.
+
+```bash
+prompty -s path/to/prompty/file
+```
+
+This will execute the prompt and print the response to the console. It also has default tracing enabled.
+
+## Contributing
+We welcome contributions to the Prompty project! This community led project is open to all contributors. The project cvan be found on [GitHub](https://github.com/Microsoft/prompty).

{prompty-0.1.10 → prompty-0.1.13}/prompty/__init__.py

@@ -3,8 +3,8 @@ import traceback
 from pathlib import Path
 from typing import Dict, List, Union
 
-from .tracer import trace
-from .core import (
+from prompty.tracer import trace
+from prompty.core import (
     Frontmatter,
     InvokerFactory,
     ModelSettings,
@@ -16,8 +16,6 @@ from .core import (
 
 from .renderers import *
 from .parsers import *
-from .executors import *
-from .processors import *
 
 
 def load_global_config(

prompty-0.1.13/prompty/azure/__init__.py

@@ -0,0 +1,3 @@
+# __init__.py
+from .executor import AzureOpenAIExecutor
+from .processor import AzureOpenAIProcessor

prompty-0.1.10/prompty/executors.py → prompty-0.1.13/prompty/azure/executor.py

@@ -2,7 +2,7 @@ import azure.identity
 import importlib.metadata
 from typing import Iterator
 from openai import AzureOpenAI
-from .core import Invoker, InvokerFactory, Prompty, PromptyStream
+from ..core import Invoker, InvokerFactory, Prompty, PromptyStream
 
 VERSION = importlib.metadata.version("prompty")
 
@@ -10,7 +10,8 @@ VERSION = importlib.metadata.version("prompty")
 @InvokerFactory.register_executor("azure")
 @InvokerFactory.register_executor("azure_openai")
 class AzureOpenAIExecutor(Invoker):
-    """ Azure OpenAI Executor  """
+    """Azure OpenAI Executor"""
+
     def __init__(self, prompty: Prompty) -> None:
         super().__init__(prompty)
         kwargs = {
@@ -40,7 +41,7 @@ class AzureOpenAIExecutor(Invoker):
 
         self.client = AzureOpenAI(
             default_headers={
-                "User-Agent": f"prompty{VERSION}",
+                "User-Agent": f"prompty/{VERSION}",
                 "x-ms-useragent": f"prompty/{VERSION}",
             },
             **kwargs,
@@ -51,7 +52,7 @@ class AzureOpenAIExecutor(Invoker):
         self.parameters = self.prompty.model.parameters
 
     def invoke(self, data: any) -> any:
-        """ Invoke the Azure OpenAI API
+        """Invoke the Azure OpenAI API
 
         Parameters
         ----------

prompty-0.1.10/prompty/processors.py → prompty-0.1.13/prompty/azure/processor.py

@@ -1,22 +1,14 @@
 from typing import Iterator
-from pydantic import BaseModel
 from openai.types.completion import Completion
 from openai.types.chat.chat_completion import ChatCompletion
-from .core import Invoker, InvokerFactory, Prompty, PromptyStream
+from ..core import Invoker, InvokerFactory, Prompty, PromptyStream, ToolCall
 from openai.types.create_embedding_response import CreateEmbeddingResponse
 
 
-class ToolCall(BaseModel):
-    id: str
-    name: str
-    arguments: str
-
-
-@InvokerFactory.register_processor("openai")
 @InvokerFactory.register_processor("azure")
 @InvokerFactory.register_processor("azure_openai")
-class OpenAIProcessor(Invoker):
-    """OpenAI/Azure Processor"""
+class AzureOpenAIProcessor(Invoker):
+    """Azure OpenAI Processor"""
 
     def __init__(self, prompty: Prompty) -> None:
         super().__init__(prompty)
@@ -62,10 +54,13 @@ class OpenAIProcessor(Invoker):
 
             def generator():
                 for chunk in data:
-                    if len(chunk.choices) == 1 and chunk.choices[0].delta.content != None:
+                    if (
+                        len(chunk.choices) == 1
+                        and chunk.choices[0].delta.content != None
+                    ):
                         content = chunk.choices[0].delta.content
                         yield content
 
-            return PromptyStream("OpenAIProcessor", generator())
+            return PromptyStream("AzureOpenAIProcessor", generator())
         else:
             return data

prompty-0.1.13/prompty/cli.py

@@ -0,0 +1,117 @@
+import os
+import json
+import click
+import importlib
+
+from pathlib import Path
+from pydantic import BaseModel
+
+import prompty
+from prompty.tracer import trace, PromptyTracer, console_tracer, Tracer
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+def normalize_path(p, create_dir=False) -> Path:
+    path = Path(p)
+    if not path.is_absolute():
+        path = Path(os.getcwd()).joinpath(path).absolute().resolve()
+    else:
+        path = path.absolute().resolve()
+
+    if create_dir:
+        if not path.exists():
+            print(f"Creating directory {str(path)}")
+            os.makedirs(str(path))
+
+    return path
+
+def dynamic_import(module: str):
+    t = module if "." in module else f"prompty.{module}"
+    print(f"Loading invokers from {t}")
+    importlib.import_module(t)
+
+
+@trace
+def chat_mode(prompt_path: str):
+    W = "\033[0m"  # white (normal)
+    R = "\033[31m"  # red
+    G = "\033[32m"  # green
+    O = "\033[33m"  # orange
+    B = "\033[34m"  # blue
+    P = "\033[35m"  # purple
+    print(f"Executing {str(prompt_path)} in chat mode...")
+    p = prompty.load(str(prompt_path))
+    if "chat_history" not in p.sample:
+        print(
+            f"{R}{str(prompt_path)} needs to have a chat_history input to work in chat mode{W}"
+        )
+        return
+    else:
+
+        try:
+            # load executor / processor types
+            dynamic_import(p.model.configuration["type"])
+            chat_history = p.sample["chat_history"]
+            while True:
+                user_input = input(f"\n{B}User:{W} ")
+                if user_input == "exit":
+                    break
+                # reloadable prompty file
+                chat_history.append({"role": "user", "content": user_input})
+                result = prompty.execute(prompt_path, inputs={"chat_history": chat_history})
+                print(f"\n{G}Assistant:{W} {result}")
+                chat_history.append({"role": "assistant", "content": result})
+        except Exception as e:
+            print(f"{type(e).__qualname__}: {e}")
+
+    print(f"\n{R}Goodbye!{W}\n")
+
+
+@trace
+def execute(prompt_path: str, raw=False):
+    p = prompty.load(prompt_path)
+
+    try:
+        # load executor / processor types
+        dynamic_import(p.model.configuration["type"])
+
+        result = prompty.execute(p, raw=raw)
+        if issubclass(type(result), BaseModel):
+            print("\n", json.dumps(result.model_dump(), indent=4), "\n")
+        elif isinstance(result, list):
+            print(
+                "\n", json.dumps([item.model_dump() for item in result], indent=4), "\n"
+            )
+        else:
+            print("\n", result, "\n")
+    except Exception as e:
+        print(f"{type(e).__qualname__}: {e}", "\n")
+
+
+@click.command()
+@click.option("--source", "-s", required=True)
+@click.option("--verbose", "-v", is_flag=True)
+@click.option("--chat", "-c", is_flag=True)
+@click.version_option()
+def run(source, verbose, chat):
+    prompt_path = normalize_path(source)
+    if not prompt_path.exists():
+        print(f"{str(prompt_path)} does not exist")
+        return
+
+    if verbose:
+        Tracer.add("console", console_tracer)
+
+    ptrace = PromptyTracer()
+    Tracer.add("prompty", ptrace.tracer)
+
+    if chat:
+        chat_mode(str(prompt_path))
+    else:
+        execute(str(prompt_path), raw=verbose)
+
+
+if __name__ == "__main__":
+    chat_mode(source="./tests/prompts/basic.prompt")