llmasaservice-client 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # llmasaservice-client
 
+## 0.5.0
+
+### Minor Changes
+
+- Adding the ability to pass data to the chat service
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/index.js

@@ -91,7 +91,7 @@ var useLLM = (options) => {
     setIdle(true);
   };
   function send(_0) {
-    return __async(this, arguments, function* (prompt, messages = [], stream = true, allowCaching = true, service = null, abortController = new AbortController(), onComplete, onError) {
+    return __async(this, arguments, function* (prompt, messages = [], data = [], stream = true, allowCaching = true, service = null, abortController = new AbortController(), onComplete, onError) {
       var _a, _b, _c, _d, _e;
       setResponse("");
       setIdle(false);
@@ -101,6 +101,7 @@ var useLLM = (options) => {
         serviceId: service,
         prompt,
         messages,
+        data,
         customer: (_b = context == null ? void 0 : context.customer) != null ? _b : {},
         // if no customer, use the projectId as the customer_id
         allowCaching

package/dist/index.mjs

@@ -54,7 +54,7 @@ var useLLM = (options) => {
     setIdle(true);
   };
   function send(_0) {
-    return __async(this, arguments, function* (prompt, messages = [], stream = true, allowCaching = true, service = null, abortController = new AbortController(), onComplete, onError) {
+    return __async(this, arguments, function* (prompt, messages = [], data = [], stream = true, allowCaching = true, service = null, abortController = new AbortController(), onComplete, onError) {
       var _a, _b, _c, _d, _e;
       setResponse("");
       setIdle(false);
@@ -64,6 +64,7 @@ var useLLM = (options) => {
         serviceId: service,
         prompt,
         messages,
+        data,
         customer: (_b = context == null ? void 0 : context.customer) != null ? _b : {},
         // if no customer, use the projectId as the customer_id
         allowCaching

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "llmasaservice-client",
   "license": "MIT",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",

package/readme.md

@@ -215,4 +215,59 @@ export default function Home() {
   );
 }
 ```
-![Next / React Example](images/nextexample.png)
+![Next / React Example](images/nextexample.png)
+
+# send method reference
+The send method is the main entry point to call LLMs both streaming and synchronous. "prompt" is the only required field. 
+
+The full call signature is -
+
+```typescript
+   /**
+   * Calls the LLM as a service with the given prompt and messages. The response is returned in the response property of the hook.
+   *
+   * @param prompt The prompt to send the the LLM service.
+   * @param messages The history and context messages to send to the LLM service. as an array of {role: string, content: string} objects. for example, [{ role: "system", content: "You are a useful assistant." }]
+   * @param stream  Determines whether to stream results back in the response property as they return from the service or batch them up and return them all at once in the response property as a string.
+   * @param allowCaching Determines whether the service can use cached results or not.
+   * @param service The service to use for the request. If null, load balancing will be applied. This is typically only used for testing.
+   * @param abortController The AbortController used to abort this request once its started. This allows you to add a stop button to your UI.
+   * @param onComplete The callback function to be called once the stream completes, with the final result string.
+   * @param onError The callback function to be called if an error occurs, with the error string.
+   * @returns a StreamReader object if stream is true, otherwise a string of the response. Typically this isn't used when streaming, the stream is exposed in the response property.
+   */
+  async function send(
+    prompt: string,
+    messages = [],
+    stream: boolean = true,
+    allowCaching: boolean = true,
+    service: string | null = null, // null means use the default service and apply services load balancing
+    abortController: AbortController = new AbortController(),
+    onComplete?: (result: string) => void,
+    onError?: (error: string) => void
+  ): Promise<ReadableStreamDefaultReader<any> | string | undefined> { ...
+```
+
+Example:
+
+Sends a streaming request that is progressively resuned in the response property. On full completion, the response is saved to the ValueText state.
+
+```typescript
+await send(
+  "What is 1+1=",
+  [{
+    role: "system",
+    content: "Answer all responses like a pirate"
+  }],
+  true,  // stream (if this is false, the return type of send is a string)
+  false, // don't cache this call
+  null,  // this uses the default services, not any specific group id or service id
+  new AbortController(), // this allows abort functionality in UI's
+  (response: string) => { // this function is called when a streaming response completes fully
+      setValueText(response);
+  },
+  (errorMessage: string) => { // this function is called if there are any errors during the streaming
+      console.errro(errorMessage);
+  }
+);
+```

package/src/useLLM.ts

@@ -38,22 +38,24 @@ export const useLLM = (options?: LLMServiceType): UseLLMReturnType => {
     setIdle(true);
   };
 
-  /**
-   * Calls the LLM as a service with the given prompt and messages. The response is returned in the response property of the hook.
-   *
-   * @param prompt The prompt to send the the LLM service.
-   * @param messages The history and context messages to send to the LLM service. as an array of {role: string, content: string} objects. for example, [{ role: "system", content: "You are a useful assistant." }]
-   * @param stream  Determines whether to stream results back in the response property as they return from the service or batch them up and return them all at once in the response property as a string.
-   * @param allowCaching Determines whether the service can use cached results or not.
-   * @param service The service to use for the request. If null, load balancing will be applied. This is typically only used for testing.
-   * @param abortController The AbortController used to abort this request once its started. This allows you to add a stop button to your UI.
-   * @param onComplete The callback function to be called once the stream completes, with the final result string.
-   * @param onError The callback function to be called if an error occurs, with the error string.
-   * @returns a StreamReader object if stream is true, otherwise a string of the response. Typically this isn't used when streaming, the stream is exposed in the response property.
-   */
+/**
+ * Calls the LLM as a service with the given prompt and messages. The response is returned in the response property of the hook.
+ *
+ * @param {string} prompt - The prompt to send to the LLM service.
+ * @param {Array<{role: string, content: string}>} messages - The history and context messages to send to the LLM service, as an array of {role: string, content: string} objects. For example, [{ role: "system", content: "You are a useful assistant." }]
+ * @param {Array<{key: string, data: string}>} data - The data to send to the LLM service, as an array of {key: string, data: string} objects. For example, [{ key: "name", value: "John" }]
+ * @param {boolean} stream - Determines whether to stream results back in the response property as they return from the service or batch them up and return them all at once in the response property as a string.
+ * @param {boolean} allowCaching - Determines whether the service can use cached results or not.
+ * @param {string | null} service - The service to use for the request. If null, load balancing will be applied. This is typically only used for testing.
+ * @param {AbortController} abortController - The AbortController used to abort this request once it's started. This allows you to add a stop button to your UI.
+ * @param {(result: string) => void} onComplete - The callback function to be called once the stream completes, with the final result string.
+ * @param {(error: string) => void} onError - The callback function to be called if an error occurs, with the error string.
+ * @returns {Promise<ReadableStreamDefaultReader<any> | string | undefined>} - A StreamReader object if stream is true, otherwise a string of the response. Typically this isn't used when streaming, the stream is exposed in the response property.
+ */
   async function send(
     prompt: string,
     messages = [],
+    data = [],
     stream: boolean = true,
     allowCaching: boolean = true,
     service: string | null = null, // null means use the default service and apply services load balancing
@@ -71,6 +73,7 @@ export const useLLM = (options?: LLMServiceType): UseLLMReturnType => {
       serviceId: service,
       prompt: prompt,
       messages: messages,
+      data: data,
       customer: context?.customer ?? {}, // if no customer, use the projectId as the customer_id
       allowCaching: allowCaching,
     });