Skip to main content
Prompt Bundling enables you to fetch prompt templates once from the Freeplay server during your build process and then store them directly in the filesystem of your deployed artifact. You can then configure the Freeplay client to call prompt templates and model configuration directly from your code, rather than the Freeplay server.

​
Advantages of Prompt Bundling

  • Release Management Controls
    • This approach to deployment provides full control over what’s running in production, since all prompt & model iterations managed in Freeplay get treated like any other part of your code.
    • Facilitates compliance obligations for peer review, use of established version control systems like GitHub, etc. A detailed guide on using prompt bundling with GitHub Actions is here.
  • Increased Production Resilience
    • By decoupling the fetching of prompt templates from Freeplay, you ensure your application can keep serving requests if Freeplay is unavailable.
    • Unintended prompt changes cannot hurt production because prompts are only refreshed during your application build process.
  • Reduced Latency
    • By reading the prompt template from your application filesystem instead of fetching it from Freeplay on each request, you can slightly reduce latency overhead.

​
Disadvantages of Prompt Bundling

  • Increased Cycle Time from Experimentation to Production
    • Requiring a build process to get new prompts into production, increasing cycle time between prompt updates and the deployment of those updates into production.
    • NOTE: Many Freeplay customers choose to rely on server-side prompt management in lower level environments (e.g. dev/staging) for quick experimentation, and then configure prompt bundling in their code for production.

​
Implementation

Downloading of prompts is handled by the Freeplay Python SDK

​
Install the Python SDK

Python will be used for to download the prompts for all SDKs 
bash bash pip install freeplay

​
Download the Prompt Templates

Usage: freeplay download [OPTIONS]

Options:
--project-id TEXT The Freeplay project ID. [required]
--environment TEXT The environment from which the prompts will be pulled.
[required]
--output-dir TEXT The directory where the prompts will be saved.
[required]
--help Show this message and exit.


# Set necessary enviornment variables
export FREEPLAY_API_KEY=$FREEPLAY_API_KEY
export FREEPLAY_SUBDOMAIN=$FREEPLAY_SUBDOMAIN
export FREEPLAY_PROJECT_ID=$FREEPLAY_PROJECT_ID

# Run the command with your project and environment settings, specifying where you want the prompts to be placed.
freeplay download --project-id=<your-project-id> --output-dir=my_freeplay_prompts --environment=prod

​
Download all Prompt Templates

To download all prompt templates in your account, you can use the download-all option for the API. This will download all prompts and store them by project id. For private projects, prompts will only be downloaded if the user has access to that project. 
# Set necessary enviornment variables
export FREEPLAY_API_KEY=$FREEPLAY_API_KEY
export FREEPLAY_SUBDOMAIN=$FREEPLAY_SUBDOMAIN

# Run the command with your project and environment settings, specifying where you want the prompts to be placed.

freeplay download-all --output-dir=my_freeplay_prompts --environment=prod

​
Point your Freeplay Client at your Prompt Directory

from freeplay import Freeplay
from freeplay.resources.prompts import FilesystemTemplateResolver
from pathlib import Path

# create a freeplay client link to local filesystem
fpClientLocal = Freeplay(
    freeplay_api_key=freeplay_key,
    api_base=freeplay_api_base,
    template_resolver=FilesystemTemplateResolver(Path(freeplay_template_path))
)
What’s Next Learn how to use Mustache syntax for advanced prompt templating or move onto the next section on Evaluations. Ask AI