@squiz/dxp-ai-client - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

CHANGELOG.md

 # @squiz/dxp-ai-client
 
+## 1.1.0
+
+### Minor Changes
+
+- e2aefa4: Add reference links to chatbot responses.
+
 ## 1.0.0
@@ -4,0 +10,0 @@

dist/generated/DxpAiService.d.ts

@@ -56,3 +56,3 @@ export type AiAuthType = 'none' | 'dxp';
     finishedAt: string | null;
-    outputs: RecordString40ActionFlowsGetExecutionOutputsActionEnumDatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum1ExperienceIdStringTypeFlowsGetExecutionOutputsTypeEnumValueStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnum1OrFlowsGetExecutionOutputsValueEnum2OrActionFlowsGetExecutionOutputsActionEnum1DatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum3EntityIdStringOrNullExperienceIdStringSchemaIdStringTypeFlowsGetExecutionOutputsTypeEnum2OrActionFlowsGetExecutionOutputsActionEnum2To58TypeFlowsGetExecutionOutputsTypeEnum5UrlStringOrPathStringTypeFlowsGetExecutionOutputsTypeEnum6OrDatumInputs63RecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnum1OrFlowsGetExecutionOutputsDatumInputsEnum2ExperienceIdStringExperiencePathStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum7OrEntityId63StringOrNullSchemaIdStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum8TypeFlowsGetExecutionOutputsTypeEnum441Or40FlowsGetExecutionOutputsOutputsEnumOrAnyOrStringOrNumberOrBooleanOrAllowedBlocks63FlowsGetExecutionOutputsAllowedBlocksEnumArrayAllowedMarks63FlowsGetExecutionOutputsAllowedMarksEnumArrayDescription63StringOrNullHoveringToolbar63BooleanNameStringOrderNumberRequired63BooleanOrNullShowInTable63BooleanOrNullTypeFlowsGetExecutionOutputsTypeEnum9OrAnyArrayOrRecordStringAny41;
+    outputs: RecordString40ActionFlowsGetExecutionOutputsActionEnumDatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum1ExperienceIdStringTypeFlowsGetExecutionOutputsTypeEnumValueStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnum1Or40StringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnum241ArrayOrFlowsGetExecutionOutputsValueEnum3OrActionFlowsGetExecutionOutputsActionEnum1DatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum3EntityIdStringOrNullExperienceIdStringSchemaIdStringTypeFlowsGetExecutionOutputsTypeEnum2OrActionFlowsGetExecutionOutputsActionEnum2To58TypeFlowsGetExecutionOutputsTypeEnum5UrlStringOrPathStringTypeFlowsGetExecutionOutputsTypeEnum6OrDatumInputs63RecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnum1Or40StringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnum241ArrayOrFlowsGetExecutionOutputsDatumInputsEnum3ExperienceIdStringExperiencePathStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum7OrEntityId63StringOrNullSchemaIdStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum8TypeFlowsGetExecutionOutputsTypeEnum441Or40FlowsGetExecutionOutputsOutputsEnumOrAnyOrStringOrNumberOrBooleanOrAllowedBlocks63FlowsGetExecutionOutputsAllowedBlocksEnumArrayAllowedMarks63FlowsGetExecutionOutputsAllowedMarksEnumArrayDescription63StringOrNullHoveringToolbar63BooleanNameStringOrder63NumberPlaceholder63StringRequired63BooleanOrNullShowInTable63BooleanOrNullTypeFlowsGetExecutionOutputsTypeEnum9OrAnyArrayOrRecordStringAnyOrRecordStringAny41;
     startedAt: string | null;
@@ -223,5 +223,10 @@ status: FlowsGetExecutionOutputsStatusEnum;
     query: string;
+    references: MessageReference[];
     response: string | null;
     updatedAt?: string | null;
 }
+export interface MessageReference {
+    title: string;
+    url: string;
+}
 export type OmitAiTenantOrMetadata = PickAiExcludeKeysTenantOrMetadata;
@@ -407,3 +412,3 @@ export type OmitCrawlerLastCrawledAtOrScheduleArn = PickCrawlerExcludeKeysLastCrawledAtOrScheduleArn;
 }
-export type RecordString40ActionFlowsGetExecutionOutputsActionEnumDatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum1ExperienceIdStringTypeFlowsGetExecutionOutputsTypeEnumValueStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnum1OrFlowsGetExecutionOutputsValueEnum2OrActionFlowsGetExecutionOutputsActionEnum1DatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum3EntityIdStringOrNullExperienceIdStringSchemaIdStringTypeFlowsGetExecutionOutputsTypeEnum2OrActionFlowsGetExecutionOutputsActionEnum2To58TypeFlowsGetExecutionOutputsTypeEnum5UrlStringOrPathStringTypeFlowsGetExecutionOutputsTypeEnum6OrDatumInputs63RecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnum1OrFlowsGetExecutionOutputsDatumInputsEnum2ExperienceIdStringExperiencePathStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum7OrEntityId63StringOrNullSchemaIdStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum8TypeFlowsGetExecutionOutputsTypeEnum441Or40FlowsGetExecutionOutputsOutputsEnumOrAnyOrStringOrNumberOrBooleanOrAllowedBlocks63FlowsGetExecutionOutputsAllowedBlocksEnumArrayAllowedMarks63FlowsGetExecutionOutputsAllowedMarksEnumArrayDescription63StringOrNullHoveringToolbar63BooleanNameStringOrderNumberRequired63BooleanOrNullShowInTable63BooleanOrNullTypeFlowsGetExecutionOutputsTypeEnum9OrAnyArrayOrRecordStringAny41 = {
+export type RecordString40ActionFlowsGetExecutionOutputsActionEnumDatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum1ExperienceIdStringTypeFlowsGetExecutionOutputsTypeEnumValueStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnum1Or40StringOrNumberOrBooleanOrFlowsGetExecutionOutputsValueEnum241ArrayOrFlowsGetExecutionOutputsValueEnum3OrActionFlowsGetExecutionOutputsActionEnum1DatumReference58Path63StringOrStringArrayReferenceIdStringTypeFlowsGetExecutionOutputsTypeEnum3EntityIdStringOrNullExperienceIdStringSchemaIdStringTypeFlowsGetExecutionOutputsTypeEnum2OrActionFlowsGetExecutionOutputsActionEnum2To58TypeFlowsGetExecutionOutputsTypeEnum5UrlStringOrPathStringTypeFlowsGetExecutionOutputsTypeEnum6OrDatumInputs63RecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnumOrRecordStringStringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnum1Or40StringOrNumberOrBooleanOrFlowsGetExecutionOutputsDatumInputsEnum241ArrayOrFlowsGetExecutionOutputsDatumInputsEnum3ExperienceIdStringExperiencePathStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum7OrEntityId63StringOrNullSchemaIdStringSpaceIdStringTypeFlowsGetExecutionOutputsTypeEnum8TypeFlowsGetExecutionOutputsTypeEnum441Or40FlowsGetExecutionOutputsOutputsEnumOrAnyOrStringOrNumberOrBooleanOrAllowedBlocks63FlowsGetExecutionOutputsAllowedBlocksEnumArrayAllowedMarks63FlowsGetExecutionOutputsAllowedMarksEnumArrayDescription63StringOrNullHoveringToolbar63BooleanNameStringOrder63NumberPlaceholder63StringRequired63BooleanOrNullShowInTable63BooleanOrNullTypeFlowsGetExecutionOutputsTypeEnum9OrAnyArrayOrRecordStringAnyOrRecordStringAny41 = {
     [key: string]: any;
@@ -410,0 +415,0 @@ };

dist/utils/CommandExecutor/ChatBotCommandExecutor.types.d.ts

@@ -1,2 +0,2 @@
-import { ChatbotCommand } from '../../generated/DxpAiService';
+import { ChatbotCommand, Thread, Message } from '../../generated/DxpAiService';
 type ProcessChatMessageCommandInput = {
@@ -8,9 +8,4 @@ query: string;
 type ProcessChatMessageCommandOutput = {
-    thread: {
-        id: string;
-    };
-    message: {
-        query: string;
-        response: string;
-    };
+    thread: Pick<Thread, 'id'>;
+    message: Pick<Message, 'query' | 'response' | 'references'>;
 };
@@ -17,0 +12,0 @@ export type ChatBotCommandInputs<T extends ChatbotCommand> = T extends 'processChatMessage' ? ProcessChatMessageCommandInput : never;

dist/utils/CommandExecutor/ChatBotCommandExecutor.types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ2hhdEJvdENvbW1hbmRFeGVjdXRvci50eXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy91dGlscy9Db21tYW5kRXhlY3V0b3IvQ2hhdEJvdENvbW1hbmRFeGVjdXRvci50eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ2hhdGJvdENvbW1hbmQgfSBmcm9tICcuLi8uLi9nZW5lcmF0ZWQvRHhwQWlTZXJ2aWNlJztcblxudHlwZSBQcm9jZXNzQ2hhdE1lc3NhZ2VDb21tYW5kSW5wdXQgPSB7XG4gIHF1ZXJ5OiBzdHJpbmc7XG4gIGlzUHJldmlldz86IGJvb2xlYW47XG4gIHRocmVhZElkPzogc3RyaW5nO1xufTtcblxudHlwZSBQcm9jZXNzQ2hhdE1lc3NhZ2VDb21tYW5kT3V0cHV0ID0ge1xuICB0aHJlYWQ6IHtcbiAgICBpZDogc3RyaW5nO1xuICB9O1xuICBtZXNzYWdlOiB7XG4gICAgcXVlcnk6IHN0cmluZztcbiAgICByZXNwb25zZTogc3RyaW5nO1xuICB9O1xufTtcblxuZXhwb3J0IHR5cGUgQ2hhdEJvdENvbW1hbmRJbnB1dHM8VCBleHRlbmRzIENoYXRib3RDb21tYW5kPiA9IFQgZXh0ZW5kcyAncHJvY2Vzc0NoYXRNZXNzYWdlJ1xuICA/IFByb2Nlc3NDaGF0TWVzc2FnZUNvbW1hbmRJbnB1dFxuICA6IG5ldmVyO1xuXG5leHBvcnQgdHlwZSBDaGF0Qm90Q29tbWFuZE91dHB1dHM8VCBleHRlbmRzIENoYXRib3RDb21tYW5kPiA9IFQgZXh0ZW5kcyAncHJvY2Vzc0NoYXRNZXNzYWdlJ1xuICA/IFByb2Nlc3NDaGF0TWVzc2FnZUNvbW1hbmRPdXRwdXRcbiAgOiBuZXZlcjtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ2hhdEJvdENvbW1hbmRFeGVjdXRvci50eXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy91dGlscy9Db21tYW5kRXhlY3V0b3IvQ2hhdEJvdENvbW1hbmRFeGVjdXRvci50eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ2hhdGJvdENvbW1hbmQsIFRocmVhZCwgTWVzc2FnZSB9IGZyb20gJy4uLy4uL2dlbmVyYXRlZC9EeHBBaVNlcnZpY2UnO1xuXG50eXBlIFByb2Nlc3NDaGF0TWVzc2FnZUNvbW1hbmRJbnB1dCA9IHtcbiAgcXVlcnk6IHN0cmluZztcbiAgaXNQcmV2aWV3PzogYm9vbGVhbjtcbiAgdGhyZWFkSWQ/OiBzdHJpbmc7XG59O1xuXG50eXBlIFByb2Nlc3NDaGF0TWVzc2FnZUNvbW1hbmRPdXRwdXQgPSB7XG4gIHRocmVhZDogUGljazxUaHJlYWQsICdpZCc+O1xuICBtZXNzYWdlOiBQaWNrPE1lc3NhZ2UsICdxdWVyeScgfCAncmVzcG9uc2UnIHwgJ3JlZmVyZW5jZXMnPjtcbn07XG5cbmV4cG9ydCB0eXBlIENoYXRCb3RDb21tYW5kSW5wdXRzPFQgZXh0ZW5kcyBDaGF0Ym90Q29tbWFuZD4gPSBUIGV4dGVuZHMgJ3Byb2Nlc3NDaGF0TWVzc2FnZSdcbiAgPyBQcm9jZXNzQ2hhdE1lc3NhZ2VDb21tYW5kSW5wdXRcbiAgOiBuZXZlcjtcblxuZXhwb3J0IHR5cGUgQ2hhdEJvdENvbW1hbmRPdXRwdXRzPFQgZXh0ZW5kcyBDaGF0Ym90Q29tbWFuZD4gPSBUIGV4dGVuZHMgJ3Byb2Nlc3NDaGF0TWVzc2FnZSdcbiAgPyBQcm9jZXNzQ2hhdE1lc3NhZ2VDb21tYW5kT3V0cHV0XG4gIDogbmV2ZXI7XG4iXX0=

package.json

@@ -8,3 +8,3 @@ {
   },
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Exposes the DXP AI service as a package for consumers",
@@ -21,3 +21,3 @@ "main": "dist/index.js",
   "devDependencies": {
-    "@squiz/ai-service": "1.34.1",
+    "@squiz/ai-service": "1.35.0",
     "jest": "^29.7.0",
@@ -24,0 +24,0 @@ "swagger-typescript-api": "^13.0.22",

src/utils/CommandExecutor/ChatBotCommandExecutor.types.ts

@@ -1,2 +0,2 @@
-import { ChatbotCommand } from '../../generated/DxpAiService';
+import { ChatbotCommand, Thread, Message } from '../../generated/DxpAiService';
 
@@ -10,9 +10,4 @@ type ProcessChatMessageCommandInput = {
 type ProcessChatMessageCommandOutput = {
-  thread: {
-    id: string;
-  };
-  message: {
-    query: string;
-    response: string;
-  };
+  thread: Pick<Thread, 'id'>;
+  message: Pick<Message, 'query' | 'response' | 'references'>;
 };
@@ -19,0 +14,0 @@

No alert changes

Improved metrics

Total package byte prevSize

294460

0.42%

Worsened metrics

Lines of code

2508

-0.2%

No dependency changes