Add experimental classification and embeddings models (#9)

* Add experimental classification and embeddings models

* Update CHANGELOG.md

Author: mattjohnsonpint

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Update OpenAI Embeddings model to support all allowed types of input [#6](https://github.com/hypermodeAI/models-as/pull/6)
 - More updates for OpenAI Embeddings model [#7](https://github.com/hypermodeAI/models-as/pull/7)
 - Add documentation comments for OpenAI Chat model [#8](https://github.com/hypermodeAI/models-as/pull/8)
+- Add experimental classification and embeddings models [#9](https://github.com/hypermodeAI/models-as/pull/9)
 
 ## 2024-06-28 - Version 0.1.6
 

src/models/experimental/classification.ts

@@ -0,0 +1,82 @@
+import { Model } from "../..";
+
+/**
+ * A model that returns classification results for a list of text strings.
+ *
+ * @remarks
+ * This model interface is experimental and may change in the future.
+ * It is primarily intended for use with with classification models hosted on Hypermode.
+ */
+export class ClassificationModel extends Model<
+  ClassificationInput,
+  ClassificationOutput
+> {
+  /**
+   * Creates an input object for the classification model.
+   *
+   * @param instances - A list of one or more text strings to classify.
+   * @returns An input object that can be passed to the `invoke` method.
+   */
+  createInput(instances: string[]): ClassificationInput {
+    return <ClassificationInput>{ instances };
+  }
+}
+
+/**
+ * An input object for the classification model.
+ */
+@json
+class ClassificationInput {
+  /**
+   * A list of one or more text strings of text to classify.
+   */
+  instances!: string[];
+}
+
+/**
+ * An output object for the classification model.
+ */
+@json
+class ClassificationOutput {
+  /**
+   * A list of prediction results that correspond to each input text string.
+   */
+  predictions!: ClassifierResult[];
+}
+
+/**
+ * A classification result for a single text string.
+ */
+@json
+export class ClassifierResult {
+  /**
+   * The classification label with the highest confidence.
+   */
+  label!: string;
+
+  /**
+   * The confidence score for the classification label.
+   */
+  confidence!: f32;
+
+  /**
+   * The list of all classification labels with their corresponding probabilities.
+   */
+  probabilities!: ClassifierLabel[];
+}
+
+/**
+ * A classification label with its corresponding probability.
+ */
+@json
+class ClassifierLabel {
+  /**
+   * The classification label.
+   */
+  label!: string;
+
+  /**
+   * The probability value.
+   */
+  probability!: f32;
+}

src/models/experimental/embeddings.ts

@@ -0,0 +1,42 @@
+import { Model } from "../..";
+
+/**
+ * A model that returns embeddings for a list of text strings.
+ *
+ * @remarks
+ * This model interface is experimental and may change in the future.
+ * It is primarily intended for use with with embedding models hosted on Hypermode.
+ */
+export class EmbeddingsModel extends Model<EmbeddingsInput, EmbeddingsOutput> {
+  /**
+   * Creates an input object for the embeddings model.
+   *
+   * @param instances - A list of one or more text strings to create vector embeddings for.
+   * @returns An input object that can be passed to the `invoke` method.
+   */
+  createInput(instances: string[]): EmbeddingsInput {
+    return <EmbeddingsInput>{ instances };
+  }
+}
+
+/**
+ * An input object for the embeddings model.
+ */
+@json
+class EmbeddingsInput {
+  /**
+   * A list of one or more text strings to create vector embeddings for.
+   */
+  instances!: string[];
+}
+
+/**
+ * An output object for the embeddings model.
+ */
+@json
+class EmbeddingsOutput {
+  /**
+   * A list of vector embeddings that correspond to each input text string.
+   */
+  predictions!: f32[][];
+}