Rename classes in OpenAI models (#11)

Author: mattjohnsonpint

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## UNRELEASED
+
+- Rename classes in OpenAI models [#11](https://github.com/hypermodeAI/models-as/pull/11)
+
 ## 2024-06-24 - Version 0.2.0
 
 - Update OpenAI Embeddings model to support all allowed types of input [#6](https://github.com/hypermodeAI/models-as/pull/6)

src/models/openai/chat.ts

@@ -5,24 +5,24 @@ import { Model } from "../..";
  *
  * Reference: https://platform.openai.com/docs/api-reference/chat
  */
-export class ChatModel extends Model<ChatInput, ChatOutput> {
+export class OpenAIChatModel extends Model<OpenAIChatInput, OpenAIChatOutput> {
   /**
    * Creates an input object for the OpenAI Chat API.
    *
    * @param messages: An array of messages to send to the chat model.
    * @returns An input object that can be passed to the `invoke` method.
    */
-  createInput(messages: Message[]): ChatInput {
+  createInput(messages: Message[]): OpenAIChatInput {
     const model = this.info.fullName;
-    return <ChatInput>{ model, messages };
+    return <OpenAIChatInput>{ model, messages };
   }
 }
 
 /**
  * The input object for the OpenAI Chat API.
  */
 @json
-class ChatInput {
+class OpenAIChatInput {
   /**
    * The name of the model to use for the chat.
    * Must be the exact string expected by the model provider.
@@ -234,7 +234,7 @@ export type ServiceTier = string;
  * The output object for the OpenAI Chat API.
  */
 @json
-class ChatOutput {
+class OpenAIChatOutput {
   /**
    * A unique identifier for the chat completion.
    */

src/models/openai/embeddings.ts

@@ -5,7 +5,10 @@ import { Model } from "../..";
  *
  * Reference: https://platform.openai.com/docs/api-reference/embeddings
  */
-export class EmbeddingsModel extends Model<EmbeddingsInput, EmbeddingsOutput> {
+export class OpenAIEmbeddingsModel extends Model<
+  OpenAIEmbeddingsInput,
+  OpenAIEmbeddingsOutput
+> {
   /**
    * Creates an input object for the OpenAI Embeddings API.
    *
@@ -20,7 +23,7 @@ export class EmbeddingsModel extends Model<EmbeddingsInput, EmbeddingsOutput> {
    * @remarks
    * The input content must not exceed the maximum token limit of the model.
    */
-  createInput<T>(content: T): EmbeddingsInput {
+  createInput<T>(content: T): OpenAIEmbeddingsInput {
     const model = this.info.fullName;
 
     switch (idof<T>()) {
@@ -53,7 +56,7 @@ export class EmbeddingsModel extends Model<EmbeddingsInput, EmbeddingsOutput> {
  * The input object for the OpenAI Embeddings API.
  */
 @json
-class EmbeddingsInput {
+class OpenAIEmbeddingsInput {
   /**
    * The name of the model to use for the embeddings.
    * Must be the exact string expected by the model provider.
@@ -97,7 +100,7 @@ class EmbeddingsInput {
  * The input object for the OpenAI Embeddings API.
  */
 @json
-class TypedEmbeddingsInput<T> extends EmbeddingsInput {
+class TypedEmbeddingsInput<T> extends OpenAIEmbeddingsInput {
   /**
    * The input content to vectorize.
    */
@@ -108,7 +111,7 @@ class TypedEmbeddingsInput<T> extends EmbeddingsInput {
  * The output object for the OpenAI Embeddings API.
  */
 @json
-class EmbeddingsOutput {
+class OpenAIEmbeddingsOutput {
   /**
    * The name of the output object type returned by the API.
    * Always `"list"`.