added error support for streaming

predictionguard · Sep 27, 2024 · 2e59f7a · 2e59f7a
1 parent dd137a0
commit 2e59f7a
Show file tree

Hide file tree

Showing 26 changed files with 154 additions and 128 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/Client.html b/docs/classes/Client.html
diff --git a/docs/interfaces/ChatSSE.html b/docs/interfaces/ChatSSE.html
diff --git a/docs/interfaces/ChatVision.html b/docs/interfaces/ChatVision.html
diff --git a/docs/interfaces/ChatVisionChoice.html b/docs/interfaces/ChatVisionChoice.html
diff --git a/docs/interfaces/ChatVisionInput.html b/docs/interfaces/ChatVisionInput.html
diff --git a/docs/interfaces/ChatVisionMessage.html b/docs/interfaces/ChatVisionMessage.html
diff --git a/docs/interfaces/Completion.html b/docs/interfaces/Completion.html
diff --git a/docs/interfaces/CompletionChoice.html b/docs/interfaces/CompletionChoice.html
diff --git a/docs/interfaces/CompletionInput.html b/docs/interfaces/CompletionInput.html
diff --git a/docs/interfaces/Embedding.html b/docs/interfaces/Embedding.html
diff --git a/docs/interfaces/EmbeddingData.html b/docs/interfaces/EmbeddingData.html
diff --git a/docs/interfaces/EmbeddingInput.html b/docs/interfaces/EmbeddingInput.html
diff --git a/docs/interfaces/Factuality.html b/docs/interfaces/Factuality.html
diff --git a/docs/interfaces/FactualityCheck.html b/docs/interfaces/FactualityCheck.html
diff --git a/docs/interfaces/Injection.html b/docs/interfaces/Injection.html
diff --git a/docs/interfaces/InjectionCheck.html b/docs/interfaces/InjectionCheck.html
diff --git a/docs/interfaces/ReplacePII.html b/docs/interfaces/ReplacePII.html
diff --git a/docs/interfaces/ReplacePIICheck.html b/docs/interfaces/ReplacePIICheck.html
diff --git a/docs/interfaces/Toxicity.html b/docs/interfaces/Toxicity.html
diff --git a/docs/interfaces/ToxicityCheck.html b/docs/interfaces/ToxicityCheck.html
diff --git a/docs/interfaces/Translate.html b/docs/interfaces/Translate.html
diff --git a/docs/interfaces/Translation.html b/docs/interfaces/Translation.html
diff --git a/examples/chat_sse.js b/examples/chat_sse.js
@@ -24,7 +24,14 @@ async function ChatSSE() {
                 if (err.error == 'EOF') {
                     return;
                 }
-                console.log(err);
+
+                console.log('ERROR 1:' + err.error);
+                return;
+            }
+
+            if (event.error != '') {
+                console.log('ERROR 2:' + event.error);
+                return;
             }
 
             for (const choice of event.choices) {

diff --git a/src/api_client.ts b/src/api_client.ts
@@ -239,7 +239,14 @@ export class Client {
      *                 if (err.error == 'EOF') {
      *                     return;
      *                 }
-     *                 console.log(err);
+     *
+     *                 console.log('ERROR 1:' + err.error);
+     *                 return;
+     *             }
+     *
+     *             if (event.error != '') {
+     *                 console.log('ERROR 2:' + err.error);
+     *                 return;
      *             }
      *
      *             for (const choice of event.choices) {
@@ -340,6 +347,13 @@ export class Client {
                     return new Date(this.created * 1000);
                 };
 
+                // Bill: Earler versions of the API didn't set this field so it
+                // could be undefined. When V2 is 100% running, we can remove
+                // this code.
+                if (typeof chatSSE.error == 'undefined') {
+                    chatSSE.error = '';
+                }
+
                 input.onMessage(chatSSE, err);
             };
 

diff --git a/src/api_model.ts b/src/api_model.ts
@@ -318,6 +318,9 @@ export interface ChatSSE {
     /** choices represents the collection of choices to choose from. */
     choices: ChatSSEChoice[];
 
+    /** error provides error information from the stream. */
+    error: string;
+
     /** createdDate converts the created unix timestamp into a JS Date. */
     createdDate(): Date;
 }