openlayer 0.1.13 → 0.1.15

package/README.md

@@ -26,6 +26,10 @@ Install with npm
 npm i openlayer
 ```
 
+## Usage
+
+[Example usage available in our docs](https://docs.openlayer.com/quickstarts/llm-quickstart)
+
 ## Documentation
 
 The official documentation for this library can be found [here](https://docs.openlayer.com).

package/dist/index.d.ts

@@ -15,6 +15,10 @@ export interface StreamingData {
      * The output string generated by the chat completion.
      */
     output: string;
+    /**
+     * The full prompt history for the chat completion.
+     */
+    prompt?: ChatCompletionMessageParam[];
     /**
      * A timestamp representing when the chat completion occurred. Optional.
      */
@@ -53,9 +57,9 @@ interface StreamingDataConfig {
      */
     outputColumnName: string | null;
     /**
-     * The full prompt history for the chat completion.
+     * The name of the column that stores the prompt template. Can be null.
      */
-    prompt?: ChatCompletionMessageParam[];
+    promptColumnName: string | null;
     /**
      * The name of the column that stores timestamp data. Can be null.
      */

package/dist/index.js

@@ -33,6 +33,7 @@ class OpenlayerClient {
             latencyColumnName: 'latency',
             numOfTokenColumnName: 'tokens',
             outputColumnName: 'output',
+            promptColumnName: 'prompt',
             timestampColumnName: 'timestamp',
         };
         this.openlayerServerUrl = 'https://api.openlayer.com/v1';
@@ -124,7 +125,7 @@ class OpenlayerClient {
             catch (_c) {
                 const projectsEndpoint = '/projects';
                 const projectsQuery = this.resolvedQuery(projectsEndpoint);
-                const projectsResponse = yield fetch(projectsQuery, {
+                const response = yield fetch(projectsQuery, {
                     body: JSON.stringify({
                         description,
                         name,
@@ -136,9 +137,10 @@ class OpenlayerClient {
                     },
                     method: 'POST',
                 });
-                const { items: projects } = yield projectsResponse.json();
+                const data = yield response.json();
+                const { items: projects, error } = data;
                 if (!Array.isArray(projects)) {
-                    throw new Error('Invalid response from Openlayer');
+                    throw new Error(typeof error === 'string' ? error : 'Invalid response from Openlayer');
                 }
                 const project = projects.find((p) => p.name === name);
                 if (!(project === null || project === void 0 ? void 0 : project.id)) {
@@ -190,16 +192,17 @@ class OpenlayerClient {
                 version: this.version,
             };
             const projectsQuery = this.resolvedQuery(projectsEndpoint, projectsQueryParameters);
-            const projectsResponse = yield fetch(projectsQuery, {
+            const response = yield fetch(projectsQuery, {
                 headers: {
                     Authorization: `Bearer ${this.openlayerApiKey}`,
                     'Content-Type': 'application/json',
                 },
                 method: 'GET',
             });
-            const { items: projects } = yield projectsResponse.json();
+            const data = yield response.json();
+            const { items: projects, error } = data;
             if (!Array.isArray(projects)) {
-                throw new Error('Invalid response from Openlayer');
+                throw new Error(typeof error === 'string' ? error : 'Invalid response from Openlayer');
             }
             const project = projects.find((p) => p.name === name);
             if (!(project === null || project === void 0 ? void 0 : project.id)) {

package/package.json

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