openlayer 0.1.11 → 0.1.12

package/dist/index.d.ts

@@ -28,39 +28,6 @@ export interface ChatCompletionData {
      */
     tokens?: number;
 }
-/**
- * Configuration settings for uploading chat completion data to Openlayer.
- */
-export interface ChatCompletionConfig {
-    /**
-     * The name of the column that stores the ground truth data. Can be null.
-     */
-    groundTruthColumnName: string | null;
-    /**
-     * The name of the column that stores inference IDs. Can be null.
-     */
-    inferenceIdColumnName: string | null;
-    /**
-     * An array of names for input variable columns. Can be null.
-     */
-    inputVariableNames: string[] | null;
-    /**
-     * The name of the column that stores latency data. Can be null.
-     */
-    latencyColumnName: string | null;
-    /**
-     * The name of the column that stores the number of tokens. Can be null.
-     */
-    numOfTokenColumnName: string | null;
-    /**
-     * The name of the column that stores output data. Can be null.
-     */
-    outputColumnName: string | null;
-    /**
-     * The name of the column that stores timestamp data. Can be null.
-     */
-    timestampColumnName: string | null;
-}
 type OpenlayerClientConstructorProps = {
     openlayerApiKey?: string;
     openlayerInferencePipelineName?: string;
@@ -132,42 +99,52 @@ export declare class OpenlayerClient {
     private openlayerDefaultDataConfig;
     private openlayerServerUrl;
     private version;
+    /**
+     * Constructs an OpenlayerClient instance.
+     * @param {OpenlayerClientConstructorProps} props - The config for the Openlayer client. The API key is required.
+     * @throws {Error} Throws an error if the Openlayer API key is not provided.
+     */
     constructor({ openlayerApiKey, openlayerServerUrl, }: OpenlayerClientConstructorProps);
     private resolvedQuery;
     /**
-     * Uploads data to Openlayer. This function takes ChatCompletionData and an optional
-     * ChatCompletionConfig, then uploads the data to the specified Openlayer Inference Pipeline.
-     * @param data The ChatCompletionData to be uploaded.
-     * @param config Configuration for the data upload.
-     * @throws Throws an error if Openlayer API key or project name are not set.
-     * @returns A promise that resolves when the data has been successfully uploaded.
+     * Streams data to the Openlayer inference pipeline.
+     * @param {ChatCompletionData} data - The chat completion data to be streamed.
+     * @param {string} inferencePipelineId - The ID of the Openlayer inference pipeline to which data is streamed.
+     * @returns {Promise<void>} A promise that resolves when the data has been successfully streamed.
+     * @throws {Error} Throws an error if the Openlayer API key is not set or an error occurs in the streaming process.
      */
     streamData: (data: ChatCompletionData, inferencePipelineId: string) => Promise<void>;
     /**
-     * Creates a new inference pipeline in Openlayer, or loads an existing one if it already exists.
-     * @param name The name of the inference pipeline.
-     * @param projectId The project ID containing the inference pipeline.
-     * @throws Throws an error if the inference pipeline cannot be created or found.
-     * @returns A promise that resolves to an OpenlayerInferencePipeline object.
+     * Creates a new inference pipeline in Openlayer or loads an existing one.
+     * @param {string} projectId - The ID of the project containing the inference pipeline.
+     * @param {string} [name='production'] - The name of the inference pipeline, defaults to 'production'.
+     * @returns {Promise<OpenlayerInferencePipeline>} A promise that resolves to an OpenlayerInferencePipeline object.
+     * @throws {Error} Throws an error if the inference pipeline cannot be created or found.
      */
     createInferencePipeline: (projectId: string, name?: string) => Promise<OpenlayerInferencePipeline>;
     /**
-     * Creates a new project in Openlayer, or loads an existing one if it already exists.
-     * @param name The name of the project.
-     * @param taskType The type of task associated with the project.
-     * @param description Optional description of the project.
-     * @throws Throws an error if the project cannot be created or found.
-     * @returns A promise that resolves to an OpenlayerProject object.
+     * Creates a new project in Openlayer or loads an existing one.
+     * @param {string} name - The name of the project.
+     * @param {OpenlayerTaskType} taskType - The type of task associated with the project.
+     * @param {string} [description] - Optional description of the project.
+     * @returns {Promise<OpenlayerProject>} A promise that resolves to an OpenlayerProject object.
+     * @throws {Error} Throws an error if the project cannot be created or found.
      */
     createProject: (name: string, taskType: OpenlayerTaskType, description?: string) => Promise<OpenlayerProject>;
     /**
      * Loads an existing inference pipeline from Openlayer based on its name and project ID.
-     * @param name The name of the inference pipeline.
-     * @param projectId The project ID containing the inference pipeline.
-     * @throws Throws an error if the inference pipeline is not found.
-     * @returns A promise that resolves to an OpenlayerInferencePipeline object.
+     * @param {string} projectId - The ID of the project containing the inference pipeline.
+     * @param {string} [name='production'] - The name of the inference pipeline, defaults to 'production'.
+     * @returns {Promise<OpenlayerInferencePipeline>} A promise that resolves to an OpenlayerInferencePipeline object.
+     * @throws {Error} Throws an error if the inference pipeline is not found.
      */
     loadInferencePipeline: (projectId: string, name?: string) => Promise<OpenlayerInferencePipeline>;
+    /**
+     * Loads an existing project from Openlayer based on its name.
+     * @param {string} name - The name of the project.
+     * @returns {Promise<OpenlayerProject>} A promise that resolves to an OpenlayerProject object.
+     * @throws {Error} Throws an error if the project is not found.
+     */
     loadProject: (name: string) => Promise<OpenlayerProject>;
 }
 export declare class OpenAIMonitor {
@@ -176,24 +153,26 @@ export declare class OpenAIMonitor {
     private openlayerProjectName;
     private openlayerInferencePipelineName;
     private monitoringOn;
+    /**
+     * Constructs an OpenAIMonitor instance.
+     * @param {OpenAIMonitorConstructorProps} props - The configuration properties for the OpenAI and Openlayer clients.
+     */
     constructor({ openAiApiKey, openlayerApiKey, openlayerProjectName, openlayerInferencePipelineName, openlayerServerUrl, }: OpenAIMonitorConstructorProps);
     private formatChatCompletionInput;
     /**
-     * Creates a new ChatCompletion instance. If monitoring is not active, an error is thrown.
-     * This function also measures latency and uploads data to Openlayer.
-     * @param body The parameters for creating a chat completion.
-     * @param options Optional request options.
-     * @throws Throws an error if monitoring is not active or if there is no output received from OpenAI.
-     * @returns A promise that resolves to a ChatCompletion or a Stream of ChatCompletionChunks.
+     * Creates a chat completion using the OpenAI client and streams the result to Openlayer.
+     * @param {ChatCompletionCreateParams} body - The parameters for creating a chat completion.
+     * @param {RequestOptions} [options] - Optional request options.
+     * @returns {Promise<ChatCompletion | Stream<ChatCompletionChunk>>} Promise of a ChatCompletion or a Stream
+     * @throws {Error} Throws an error if monitoring is not active or if no output is received from OpenAI.
      */
     createChatCompletion: (body: ChatCompletionCreateParams, options?: RequestOptions) => Promise<ChatCompletion | Stream<ChatCompletionChunk>>;
     /**
-     * Creates a new Completion instance. If monitoring is not active, an error is thrown.
-     * This function also measures latency and uploads data to Openlayer.
-     * @param body The parameters for creating a completion.
-     * @param options Optional request options.
-     * @throws Throws an error if monitoring is not active or if no prompt is provided.
-     * @returns A promise that resolves to a Completion or a Stream of Completions.
+     * Creates a completion using the OpenAI client and streams the result to Openlayer.
+     * @param {CompletionCreateParams} body - The parameters for creating a completion.
+     * @param {RequestOptions} [options] - Optional request options.
+     * @returns {Promise<Completion | Stream<Completion>>} Promise that resolves to a Completion or a Stream.
+     * @throws {Error} Throws an error if monitoring is not active or if no prompt is provided.
      */
     createCompletion: (body: CompletionCreateParams, options?: RequestOptions) => Promise<Completion | Stream<Completion>>;
     /**

package/dist/index.js

@@ -21,6 +21,11 @@ const openai_1 = require("openai");
 const uuid_1 = require("uuid");
 const request_1 = require("./utils/request");
 class OpenlayerClient {
+    /**
+     * Constructs an OpenlayerClient instance.
+     * @param {OpenlayerClientConstructorProps} props - The config for the Openlayer client. The API key is required.
+     * @throws {Error} Throws an error if the Openlayer API key is not provided.
+     */
     constructor({ openlayerApiKey, openlayerServerUrl, }) {
         this.openlayerDefaultDataConfig = {
             groundTruthColumnName: null,
@@ -35,12 +40,11 @@ class OpenlayerClient {
         this.version = '0.1.0a16';
         this.resolvedQuery = (endpoint, args = {}) => (0, request_1.resolvedQuery)(this.openlayerServerUrl, endpoint, args);
         /**
-         * Uploads data to Openlayer. This function takes ChatCompletionData and an optional
-         * ChatCompletionConfig, then uploads the data to the specified Openlayer Inference Pipeline.
-         * @param data The ChatCompletionData to be uploaded.
-         * @param config Configuration for the data upload.
-         * @throws Throws an error if Openlayer API key or project name are not set.
-         * @returns A promise that resolves when the data has been successfully uploaded.
+         * Streams data to the Openlayer inference pipeline.
+         * @param {ChatCompletionData} data - The chat completion data to be streamed.
+         * @param {string} inferencePipelineId - The ID of the Openlayer inference pipeline to which data is streamed.
+         * @returns {Promise<void>} A promise that resolves when the data has been successfully streamed.
+         * @throws {Error} Throws an error if the Openlayer API key is not set or an error occurs in the streaming process.
          */
         this.streamData = (data, inferencePipelineId) => __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -75,11 +79,11 @@ class OpenlayerClient {
             }
         });
         /**
-         * Creates a new inference pipeline in Openlayer, or loads an existing one if it already exists.
-         * @param name The name of the inference pipeline.
-         * @param projectId The project ID containing the inference pipeline.
-         * @throws Throws an error if the inference pipeline cannot be created or found.
-         * @returns A promise that resolves to an OpenlayerInferencePipeline object.
+         * Creates a new inference pipeline in Openlayer or loads an existing one.
+         * @param {string} projectId - The ID of the project containing the inference pipeline.
+         * @param {string} [name='production'] - The name of the inference pipeline, defaults to 'production'.
+         * @returns {Promise<OpenlayerInferencePipeline>} A promise that resolves to an OpenlayerInferencePipeline object.
+         * @throws {Error} Throws an error if the inference pipeline cannot be created or found.
          */
         this.createInferencePipeline = (projectId, name = 'production') => __awaiter(this, void 0, void 0, function* () {
             try {
@@ -107,12 +111,12 @@ class OpenlayerClient {
             }
         });
         /**
-         * Creates a new project in Openlayer, or loads an existing one if it already exists.
-         * @param name The name of the project.
-         * @param taskType The type of task associated with the project.
-         * @param description Optional description of the project.
-         * @throws Throws an error if the project cannot be created or found.
-         * @returns A promise that resolves to an OpenlayerProject object.
+         * Creates a new project in Openlayer or loads an existing one.
+         * @param {string} name - The name of the project.
+         * @param {OpenlayerTaskType} taskType - The type of task associated with the project.
+         * @param {string} [description] - Optional description of the project.
+         * @returns {Promise<OpenlayerProject>} A promise that resolves to an OpenlayerProject object.
+         * @throws {Error} Throws an error if the project cannot be created or found.
          */
         this.createProject = (name, taskType, description) => __awaiter(this, void 0, void 0, function* () {
             try {
@@ -146,10 +150,10 @@ class OpenlayerClient {
         });
         /**
          * Loads an existing inference pipeline from Openlayer based on its name and project ID.
-         * @param name The name of the inference pipeline.
-         * @param projectId The project ID containing the inference pipeline.
-         * @throws Throws an error if the inference pipeline is not found.
-         * @returns A promise that resolves to an OpenlayerInferencePipeline object.
+         * @param {string} projectId - The ID of the project containing the inference pipeline.
+         * @param {string} [name='production'] - The name of the inference pipeline, defaults to 'production'.
+         * @returns {Promise<OpenlayerInferencePipeline>} A promise that resolves to an OpenlayerInferencePipeline object.
+         * @throws {Error} Throws an error if the inference pipeline is not found.
          */
         this.loadInferencePipeline = (projectId, name = 'production') => __awaiter(this, void 0, void 0, function* () {
             const inferencePipelineEndpoint = `/projects/${projectId}/inference-pipelines`;
@@ -174,6 +178,12 @@ class OpenlayerClient {
             }
             return inferencePipeline;
         });
+        /**
+         * Loads an existing project from Openlayer based on its name.
+         * @param {string} name - The name of the project.
+         * @returns {Promise<OpenlayerProject>} A promise that resolves to an OpenlayerProject object.
+         * @throws {Error} Throws an error if the project is not found.
+         */
         this.loadProject = (name) => __awaiter(this, void 0, void 0, function* () {
             const projectsEndpoint = '/projects';
             const projectsQueryParameters = {
@@ -209,6 +219,10 @@ class OpenlayerClient {
 }
 exports.OpenlayerClient = OpenlayerClient;
 class OpenAIMonitor {
+    /**
+     * Constructs an OpenAIMonitor instance.
+     * @param {OpenAIMonitorConstructorProps} props - The configuration properties for the OpenAI and Openlayer clients.
+     */
     constructor({ openAiApiKey, openlayerApiKey, openlayerProjectName, openlayerInferencePipelineName, openlayerServerUrl, }) {
         this.openlayerInferencePipelineName = 'production';
         this.monitoringOn = false;
@@ -218,12 +232,11 @@ class OpenAIMonitor {
             .join('\n')
             .trim();
         /**
-         * Creates a new ChatCompletion instance. If monitoring is not active, an error is thrown.
-         * This function also measures latency and uploads data to Openlayer.
-         * @param body The parameters for creating a chat completion.
-         * @param options Optional request options.
-         * @throws Throws an error if monitoring is not active or if there is no output received from OpenAI.
-         * @returns A promise that resolves to a ChatCompletion or a Stream of ChatCompletionChunks.
+         * Creates a chat completion using the OpenAI client and streams the result to Openlayer.
+         * @param {ChatCompletionCreateParams} body - The parameters for creating a chat completion.
+         * @param {RequestOptions} [options] - Optional request options.
+         * @returns {Promise<ChatCompletion | Stream<ChatCompletionChunk>>} Promise of a ChatCompletion or a Stream
+         * @throws {Error} Throws an error if monitoring is not active or if no output is received from OpenAI.
          */
         this.createChatCompletion = (body, options) => __awaiter(this, void 0, void 0, function* () {
             var _a, e_1, _b, _c;
@@ -285,12 +298,11 @@ class OpenAIMonitor {
             return response;
         });
         /**
-         * Creates a new Completion instance. If monitoring is not active, an error is thrown.
-         * This function also measures latency and uploads data to Openlayer.
-         * @param body The parameters for creating a completion.
-         * @param options Optional request options.
-         * @throws Throws an error if monitoring is not active or if no prompt is provided.
-         * @returns A promise that resolves to a Completion or a Stream of Completions.
+         * Creates a completion using the OpenAI client and streams the result to Openlayer.
+         * @param {CompletionCreateParams} body - The parameters for creating a completion.
+         * @param {RequestOptions} [options] - Optional request options.
+         * @returns {Promise<Completion | Stream<Completion>>} Promise that resolves to a Completion or a Stream.
+         * @throws {Error} Throws an error if monitoring is not active or if no prompt is provided.
          */
         this.createCompletion = (body, options) => __awaiter(this, void 0, void 0, function* () {
             var _g, e_2, _h, _j;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openlayer",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "The Openlayer TypeScript client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",