feat: rename PromptService to ConversationPromptService

README.md

@@ -6,7 +6,7 @@ Types and utility functions to easily generate OpenAI GPT prompts for chatting w
 
 ```typescript
 import { Configuration, OpenAIApi } from "openai";
-import { AIPersona, ModelConfiguration, PromptService } from "@wisegpt/gpt-conversation-prompt";
+import { AIPersona, ModelConfiguration, ConversationPromptService } from "@wisegpt/gpt-conversation-prompt";
 
 const aiPersona: AIPersona = {
   name: "wiseGPT",
@@ -21,10 +21,10 @@ const modelConfiguration: ModelConfiguration = {
 };
 
 const openAIApi = new OpenAIApi(new Configuration({ apiKey: "<<your-secret>>" }));
-const promptService = new PromptService(openAIApi);
+const conversationPromptService = new ConversationPromptService(openAIApi);
 
 async function exampleUsage() {
-  const { text, usage } = await promptService.conversationCompletion({
+  const { text, usage } = await conversationPromptService.conversationCompletion({
     prompt: {
       conversation: {
         messages: [

src/prompt-service/prompt.service.ts → src/conversation-prompt/conversation-prompt.service.ts

@@ -6,7 +6,7 @@ import {
   ConversationCompleteOutput,
 } from "./prompt.dto";
 
-export class PromptService {
+export class ConversationPromptService {
   constructor(private readonly openAIApi: OpenAIApi) {}
 
   async conversationCompletion(

src/conversation-prompt/index.ts

@@ -0,0 +1,2 @@
+export * from "./prompt.dto";
+export { ConversationPromptService } from "./conversation-prompt.service";

src/index.ts

@@ -1,2 +1,2 @@
 export * from "./types";
-export * from "./prompt-service";
+export * from "./conversation-prompt";

test/prompt-service/create-conversation-completion-prompt.test.ts → test/conversation-prompt/create-conversation-completion-prompt.test.ts

@@ -1,5 +1,5 @@
 import { AIPersona } from "../../src";
-import { createConversationCompletionPrompt } from "../../src/prompt-service/create-conversation-completion-prompt";
+import { createConversationCompletionPrompt } from "../../src/conversation-prompt/create-conversation-completion-prompt";
 
 describe("createConversationCompletionPrompt", () => {
   it("should work with example conversations", () => {