@promptbook/openai - npm Package Compare versions

Comparing version 0.12.0 to 0.13.0

esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Error.d.ts

@@ -0,3 +1,11 @@
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when error occurs and stops the process
+ */
 export interface Ptps_Error {
+    /**
+     * The error message which caused the error
+     */
     readonly errorMessage: string;
 }

esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Progress.d.ts

 import { TaskProgress } from '../../../../../types/TaskProgress';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is sent from server to client arbitrarily and may be sent multiple times
+ */
 export interface Ptps_Progress {
+    /**
+     * The progress of text generation
+     */
     readonly taskProgress: TaskProgress;
 }

esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Request.d.ts

 import { uuid } from '../../../../.././types/typeAliases';
 import { Prompt } from '../../../../../types/Prompt';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
 export interface Ptps_Request {
+    /**
+     * Client responsible for the requests
+     */
     readonly clientId: uuid;
+    /**
+     * The Prompt to execute
+     */
     readonly prompt: Prompt;
 }

esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Response.d.ts

 import { PromptResult } from '../../../../../execution/PromptResult';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when the generated text is completed
+ */
 export interface Ptps_Response {
+    /**
+     * The result of the prompt
+     */
     promptResult: PromptResult;
 }

esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts

 import { PromptTemplatePipelineLibrary } from '../../../../../classes/PromptTemplatePipelineLibrary';
-import { uuid } from '../../../../../types/typeAliases';
+import { string_uri, uuid } from '../../../../../types/typeAliases';
 import { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
@@ -11,2 +11,9 @@ import { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
     /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
      * Prompt template pipeline library to use
@@ -13,0 +20,0 @@ *

package.json

 {
     "name": "@promptbook/openai",
-    "version": "0.12.0",
+    "version": "0.13.0",
     "description": "Library to supercharge your use of large language models",
@@ -40,3 +40,3 @@ "private": false,
     "peerDependencies": {
-        "@promptbook/core": "0.12.0"
+        "@promptbook/core": "0.13.0"
     },
@@ -43,0 +43,0 @@ "main": "./umd/index.umd.js",

umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Error.d.ts

@@ -0,3 +1,11 @@
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when error occurs and stops the process
+ */
 export interface Ptps_Error {
+    /**
+     * The error message which caused the error
+     */
     readonly errorMessage: string;
 }

umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Progress.d.ts

 import { TaskProgress } from '../../../../../types/TaskProgress';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is sent from server to client arbitrarily and may be sent multiple times
+ */
 export interface Ptps_Progress {
+    /**
+     * The progress of text generation
+     */
     readonly taskProgress: TaskProgress;
 }

umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Request.d.ts

 import { uuid } from '../../../../.././types/typeAliases';
 import { Prompt } from '../../../../../types/Prompt';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
 export interface Ptps_Request {
+    /**
+     * Client responsible for the requests
+     */
     readonly clientId: uuid;
+    /**
+     * The Prompt to execute
+     */
     readonly prompt: Prompt;
 }

umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Response.d.ts

 import { PromptResult } from '../../../../../execution/PromptResult';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when the generated text is completed
+ */
 export interface Ptps_Response {
+    /**
+     * The result of the prompt
+     */
     promptResult: PromptResult;
 }

umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts

 import { PromptTemplatePipelineLibrary } from '../../../../../classes/PromptTemplatePipelineLibrary';
-import { uuid } from '../../../../../types/typeAliases';
+import { string_uri, uuid } from '../../../../../types/typeAliases';
 import { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
@@ -11,2 +11,9 @@ import { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
     /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
      * Prompt template pipeline library to use
@@ -13,0 +20,0 @@ *

No alert changes

Improved metrics

Total package byte prevSize

306553

increased by0.63%

Lines of code

4410

increased by1.94%

No dependency changes