Prompt SDK

This SDK allows developers to easily fetch and manage prompt templates from a remote server. It works in both Node.js and browser environments, making it versatile for different projects. The package was developed as part of the Goman.live SaaS product, which functions as a prompt management platform.

Features

• Cross-environment Support: Works seamlessly in both Node.js and browser environments.
• Flexible Fetching: Fetch prompt templates by their IDs with the ability to customize placeholders using environment variables or a provided context.
• Template Parsing: Templates containing placeholders (e.g., {{{PLACEHOLDER}}}) are automatically replaced with corresponding values from environment variables or user-provided contexts.

Installation

To use this SDK in your project, install it via npm:

npm install prompt-sdk

Initialization

Before using any of the SDK functions, it must be initialized with the required configuration.

import { init } from 'goman-live';

init({
  applicationId: 'your-application-id',
  apiKey: 'your-api-key',
  baseUrl: 'https://your-api-url.com',
});

Parameters

• applicationId: The unique ID for your application.
• apiKey: The API key required for authentication when communicating with the API.
• baseUrl: The base URL for the API from where prompt templates will be fetched.

Usage

Fetching a Prompt Template

Use the getPromptFromRemote function to fetch a template by its ID. The function also supports replacing placeholders in the template with values from either environment variables (Node.js) or user-provided contexts.

import { getPromptFromRemote } from 'goman-live';

(async () => {
  try {
    const promptId = '1234';
    const context = { USERNAME: 'JohnDoe' };
    const template = await getPromptFromRemote(promptId, context);
    console.log(template);
  } catch (error) {
    console.error(error.message);
  }
})();

Parameters

• promptId: The ID of the prompt template you want to fetch.
• context (optional): An object with key-value pairs that can be used to replace placeholders in the template.
• options (optional): An optional object for configuration overrides. Currently supports overriding the url.

Example Template

If the fetched template contains placeholders like {{{USERNAME}}}, they will be replaced based on the provided context:

Hello, {{{USERNAME}}}! Welcome to our service.

For example, using the context { USERNAME: 'JohnDoe' }, the final output will be:

Hello, JohnDoe! Welcome to our service.

Error Handling

If the SDK is not initialized or there is an issue fetching the template, an error will be thrown. Ensure you handle errors appropriately in your application.

License

This package is part of the Goman.live SaaS platform and is licensed under MIT License.

For any additional support or feature requests, feel free to contact Goman.live.