@prompt-template/openai

@prompt-template/openai provides an adapter for integrating @prompt-template/core with OpenAI's chat completion API. This adapter allows you to define chat prompt templates and formatting them into OpenAI-compliant chat completion messages.

Installation

npm i @prompt-template/core @prompt-template/openai

Usage

import { PromptTemplate } from '@prompt-template/core'
import { ChatPromptTemplate } from '@prompt-template/openai'

const chatPromptTemplate = ChatPromptTemplate.from([
  {
    role: 'system',
    content: 'You are a friendly assistant.',
  },
  {
    role: 'user',
    promptTemplate: PromptTemplate.create`
      Brainstorm 3 names for a superhero ${'animal'}.
    `,
  },
])

const messages = chatPromptTemplate.format({
  animal: 'cat',
})
//=> [
//     { role: 'system', content: 'You are a friendly assistant.' },
//     { role: 'user', content: 'Brainstorm 3 names for a superhero cat.' }
//   ]

API

ChatPromptTemplate.from

A static method that creates a ChatPromptTemplate instance from an array of chat prompt template messages.

const chatPromptTemplate = ChatPromptTemplate.from([
  {
    role: 'system',
    content: 'You are a friendly assistant.',
  },
  {
    role: 'user',
    promptTemplate: PromptTemplate.create`
      Brainstorm 3 names for a superhero ${'animal'}.
    `,
  },
])

ChatPromptTemplate.format

A method that formats the ChatPromptTemplate instances into OpenAI-compliant chat completion messages.

const messages = chatPromptTemplate.format({
  animal: 'cat',
})
//=> [
//     { role: 'system', content: 'You are a friendly assistant.' },
//     { role: 'user', content: 'Brainstorm 3 names for a superhero cat.' }
//   ]