@liip/liipgpt 3.8.6 → 3.8.8

package/index.d.ts

@@ -4006,6 +4006,10 @@ declare const chatErrorsSchema: z.ZodUnion<readonly [
 	z.ZodLiteral<"client-error">,
 	z.ZodLiteral<"unexpected-call">
 ]>;
+declare const preAnswerNoticeSchema: z.ZodObject<{
+	text: z.ZodString;
+	lang: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
 export declare const chatMessageBotStreamingSchema: z.ZodObject<{
 	type: z.ZodLiteral<"bot">;
 	time: z.ZodString;
@@ -4140,6 +4144,10 @@ export declare const chatMessageBotStreamingSchema: z.ZodObject<{
 	]>>;
 	retrievalQuestion: z.ZodOptional<z.ZodString>;
 	noFeedback: z.ZodOptional<z.ZodBoolean>;
+	preAnswerNotice: z.ZodOptional<z.ZodObject<{
+		text: z.ZodString;
+		lang: z.ZodOptional<z.ZodString>;
+	}, z.core.$strip>>;
 	state: z.ZodEnum<{
 		streaming: "streaming";
 		done: "done";
@@ -4279,6 +4287,10 @@ export declare const chatMessageBotLoadingSchema: z.ZodObject<{
 	]>>;
 	retrievalQuestion: z.ZodOptional<z.ZodString>;
 	noFeedback: z.ZodOptional<z.ZodBoolean>;
+	preAnswerNotice: z.ZodOptional<z.ZodObject<{
+		text: z.ZodString;
+		lang: z.ZodOptional<z.ZodString>;
+	}, z.core.$strip>>;
 	state: z.ZodLiteral<"loading">;
 }, z.core.$strip>;
 export declare const chatContentSchema: z.ZodUnion<readonly [
@@ -4416,6 +4428,10 @@ export declare const chatContentSchema: z.ZodUnion<readonly [
 		]>>;
 		retrievalQuestion: z.ZodOptional<z.ZodString>;
 		noFeedback: z.ZodOptional<z.ZodBoolean>;
+		preAnswerNotice: z.ZodOptional<z.ZodObject<{
+			text: z.ZodString;
+			lang: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
 		state: z.ZodLiteral<"loading">;
 	}, z.core.$strip>,
 	z.ZodObject<{
@@ -4552,6 +4568,10 @@ export declare const chatContentSchema: z.ZodUnion<readonly [
 		]>>;
 		retrievalQuestion: z.ZodOptional<z.ZodString>;
 		noFeedback: z.ZodOptional<z.ZodBoolean>;
+		preAnswerNotice: z.ZodOptional<z.ZodObject<{
+			text: z.ZodString;
+			lang: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
 		state: z.ZodEnum<{
 			streaming: "streaming";
 			done: "done";
@@ -4694,6 +4714,10 @@ export declare const chatMessageSchema: z.ZodUnion<readonly [
 			]>>;
 			retrievalQuestion: z.ZodOptional<z.ZodString>;
 			noFeedback: z.ZodOptional<z.ZodBoolean>;
+			preAnswerNotice: z.ZodOptional<z.ZodObject<{
+				text: z.ZodString;
+				lang: z.ZodOptional<z.ZodString>;
+			}, z.core.$strip>>;
 			state: z.ZodLiteral<"loading">;
 		}, z.core.$strip>,
 		z.ZodObject<{
@@ -4830,6 +4854,10 @@ export declare const chatMessageSchema: z.ZodUnion<readonly [
 			]>>;
 			retrievalQuestion: z.ZodOptional<z.ZodString>;
 			noFeedback: z.ZodOptional<z.ZodBoolean>;
+			preAnswerNotice: z.ZodOptional<z.ZodObject<{
+				text: z.ZodString;
+				lang: z.ZodOptional<z.ZodString>;
+			}, z.core.$strip>>;
 			state: z.ZodEnum<{
 				streaming: "streaming";
 				done: "done";
@@ -4918,6 +4946,7 @@ export type ChatMessageComponent = z.infer<typeof chatMessageEmbedSchema>;
 export type ConversationState = z.infer<typeof conversationStateSchema>;
 export type ChatContent = z.infer<typeof chatContentSchema>;
 export type ChatMessage = z.infer<typeof chatMessageSchema>;
+export type PreAnswerNotice = z.infer<typeof preAnswerNoticeSchema>;
 export type ChatReference = z.infer<typeof chatReferenceSchema>;
 export type ChatReferenceWithIndexes = z.infer<typeof chatReferenceWithIndexesSchema>;
 export type ChatReferences = z.infer<typeof chatReferencesSchema>;
@@ -5017,6 +5046,11 @@ export type SseMessageV2 = {
 } | {
 	type: "chat-footer-text";
 	text: string;
+} | {
+	/** Shown as its own bubble above the answer, e.g. "the answers are translated from French". */
+	type: "pre-answer-notice";
+	text: string;
+	lang?: string;
 };
 /** Callback to inform of a value updates. */
 export type Subscriber<T> = (value: T) => void;
@@ -5052,6 +5086,7 @@ export declare class ChatResultBuilder {
 	addMappedReference(reference: ChatReference): void;
 	addOldReference(oldReference: SseReference): void;
 	updateRetrievalQuestion(question: string): void;
+	setPreAnswerNotice(preAnswerNotice: PreAnswerNotice): void;
 	setNoFeedback(): void;
 	getReadableStore(): Readable<ChatContent>;
 	getPromise(): Promise<ChatContent>;
@@ -6438,6 +6473,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 					]>>;
 					retrievalQuestion: z.ZodOptional<z.ZodString>;
 					noFeedback: z.ZodOptional<z.ZodBoolean>;
+					preAnswerNotice: z.ZodOptional<z.ZodObject<{
+						text: z.ZodString;
+						lang: z.ZodOptional<z.ZodString>;
+					}, z.core.$strip>>;
 					state: z.ZodLiteral<"loading">;
 				}, z.core.$strip>,
 				z.ZodObject<{
@@ -6574,6 +6613,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 					]>>;
 					retrievalQuestion: z.ZodOptional<z.ZodString>;
 					noFeedback: z.ZodOptional<z.ZodBoolean>;
+					preAnswerNotice: z.ZodOptional<z.ZodObject<{
+						text: z.ZodString;
+						lang: z.ZodOptional<z.ZodString>;
+					}, z.core.$strip>>;
 					state: z.ZodEnum<{
 						streaming: "streaming";
 						done: "done";
@@ -6788,6 +6831,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -6924,6 +6971,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -7137,6 +7188,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -7273,6 +7328,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -7488,6 +7547,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -7624,6 +7687,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -7837,6 +7904,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -7973,6 +8044,10 @@ export declare const completeChatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -9105,6 +9180,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 					]>>;
 					retrievalQuestion: z.ZodOptional<z.ZodString>;
 					noFeedback: z.ZodOptional<z.ZodBoolean>;
+					preAnswerNotice: z.ZodOptional<z.ZodObject<{
+						text: z.ZodString;
+						lang: z.ZodOptional<z.ZodString>;
+					}, z.core.$strip>>;
 					state: z.ZodLiteral<"loading">;
 				}, z.core.$strip>,
 				z.ZodObject<{
@@ -9241,6 +9320,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 					]>>;
 					retrievalQuestion: z.ZodOptional<z.ZodString>;
 					noFeedback: z.ZodOptional<z.ZodBoolean>;
+					preAnswerNotice: z.ZodOptional<z.ZodObject<{
+						text: z.ZodString;
+						lang: z.ZodOptional<z.ZodString>;
+					}, z.core.$strip>>;
 					state: z.ZodEnum<{
 						streaming: "streaming";
 						done: "done";
@@ -9455,6 +9538,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -9591,6 +9678,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -9804,6 +9895,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -9940,6 +10035,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -10155,6 +10254,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -10291,6 +10394,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -10504,6 +10611,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -10640,6 +10751,10 @@ export declare const chatConfigSchema: z.ZodObject<{
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -11772,6 +11887,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 					]>>;
 					retrievalQuestion: z.ZodOptional<z.ZodString>;
 					noFeedback: z.ZodOptional<z.ZodBoolean>;
+					preAnswerNotice: z.ZodOptional<z.ZodObject<{
+						text: z.ZodString;
+						lang: z.ZodOptional<z.ZodString>;
+					}, z.core.$strip>>;
 					state: z.ZodLiteral<"loading">;
 				}, z.core.$strip>,
 				z.ZodObject<{
@@ -11908,6 +12027,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 					]>>;
 					retrievalQuestion: z.ZodOptional<z.ZodString>;
 					noFeedback: z.ZodOptional<z.ZodBoolean>;
+					preAnswerNotice: z.ZodOptional<z.ZodObject<{
+						text: z.ZodString;
+						lang: z.ZodOptional<z.ZodString>;
+					}, z.core.$strip>>;
 					state: z.ZodEnum<{
 						streaming: "streaming";
 						done: "done";
@@ -12122,6 +12245,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -12258,6 +12385,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -12471,6 +12602,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -12607,6 +12742,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -12822,6 +12961,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -12958,6 +13101,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";
@@ -13171,6 +13318,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodLiteral<"loading">;
 					}, z.core.$strip>,
 					z.ZodObject<{
@@ -13307,6 +13458,10 @@ export declare const chatConfigSchemaWithLegacyThemeName: z.ZodIntersection<z.Zo
 						]>>;
 						retrievalQuestion: z.ZodOptional<z.ZodString>;
 						noFeedback: z.ZodOptional<z.ZodBoolean>;
+						preAnswerNotice: z.ZodOptional<z.ZodObject<{
+							text: z.ZodString;
+							lang: z.ZodOptional<z.ZodString>;
+						}, z.core.$strip>>;
 						state: z.ZodEnum<{
 							streaming: "streaming";
 							done: "done";

package/index.js

@@ -3589,6 +3589,9 @@ class ChatResultBuilder {
       retrievalQuestion: question
     }));
   }
+  setPreAnswerNotice(preAnswerNotice) {
+    this.store.update((current) => ({ ...current, preAnswerNotice }));
+  }
   setNoFeedback() {
     this.store.update((current) => ({
       ...current,
@@ -8306,6 +8309,10 @@ var serverErrorSchema = _enum([
   "aborted"
 ]);
 var chatErrorsSchema = union([serverErrorSchema, literal("sse-error"), literal("client-error"), literal("unexpected-call")]);
+var preAnswerNoticeSchema = object({
+  text: string2(),
+  lang: string2().optional()
+});
 var botMessageBaseSchema = object({
   type: literal("bot"),
   time: string2(),
@@ -8318,7 +8325,8 @@ var botMessageBaseSchema = object({
   references: chatReferencesSchema,
   errors: array(chatErrorsSchema),
   retrievalQuestion: string2().optional(),
-  noFeedback: boolean2().optional()
+  noFeedback: boolean2().optional(),
+  preAnswerNotice: preAnswerNoticeSchema.optional()
 });
 var chatMessageBotStreamingSchema = botMessageBaseSchema.extend({
   state: _enum(["streaming", "done"])
@@ -9579,6 +9587,11 @@ class LiipGPTClientPrimitive {
             case "no-feedback":
               typingQueue.runAfterTyping(() => chatResultBuilder.setNoFeedback());
               break;
+            case "pre-answer-notice":
+              if (!data.text?.trim())
+                break;
+              chatResultBuilder.setPreAnswerNotice({ text: data.text, lang: data.lang || undefined });
+              break;
             case "component":
               typingQueue.runWithWarmup(() => options.onEmbed?.(data));
               break;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@liip/liipgpt",
-    "version": "3.8.6",
+    "version": "3.8.8",
     "description": "LiipGPT Chat and Library",
     "type": "module",
     "exports": {