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

Comparing version 1.3.0 to 1.4.0

CHANGELOG.md

 # @squiz/dxp-ai-client
 
+## 1.4.0
+
+### Minor Changes
+
+- 83749ab: Updated return types in Chatbot controller from Ai to Chatbot type.
+
 ## 1.3.0
@@ -4,0 +10,0 @@

dist/generated/DxpAiService.d.ts

@@ -11,8 +11,18 @@ export type AiAuthType = 'none' | 'dxp';
 export type AiTypeGenerative = 'generative';
-export type AiWrite = PickAiAuthTypeOrInstructionOrResponseTemplateOrNameOrTypeOrEnabled & {
+export type AiWrite = {
+    authType: AiAuthType;
+    enabled: boolean;
+    instruction: string;
+    name: string;
+    responseTemplate: string;
+    type: AiType;
+} & object & {
     tags?: string[];
 };
 export type ChatBotPatch = PartialChatBotWrite;
-export type ChatBotWrite = AiWrite & {
-    type: AiTypeChatbot;
+export type ChatBotWrite = AiWrite & PickChatbotSearch;
+export type ChatbotAiResponse = OmitChatbotTenantOrMetadata & {
+    negativeCount: number;
+    overallCount: number;
+    positiveCount: number;
 };
@@ -232,2 +242,3 @@ export type ChatbotCommand = 'closeThread' | 'populateThreadTags' | 'populateThreadTitle' | 'processChatMessage' | 'processArticleAddUpdate' | 'processArticleDelete';
 export type OmitAiTenantOrMetadata = PickAiExcludeKeysTenantOrMetadata;
+export type OmitChatbotTenantOrMetadata = PickChatbotExcludeKeysTenantOrMetadata;
 export type OmitCrawlerLastCrawledAtOrScheduleArn = PickCrawlerExcludeKeysLastCrawledAtOrScheduleArn;
@@ -243,2 +254,9 @@ export type OmitCrawlerReadIdOrCrawlState = PickCrawlerReadExcludeKeysIdOrCrawlState;
 }
+export interface PageResultChatbotAiResponse {
+    items: ChatbotAiResponse[];
+    links?: {
+        nextPage?: string;
+        prevPage?: string;
+    };
+}
 export interface PageResultContext {
@@ -286,4 +304,9 @@ items: Context[];
     responseTemplate?: string;
+    search?: {
+        resultsPageId: string;
+        searchPackageId: string;
+        url: string;
+    };
     tags?: string[];
-    type?: AiTypeChatbot;
+    type?: AiType;
 }
@@ -309,11 +332,13 @@ export interface PartialGenerativeWrite {
 };
-export interface PickAiAuthTypeOrInstructionOrResponseTemplateOrNameOrTypeOrEnabled {
+export interface PickAiExcludeKeysTenantOrMetadata {
     authType: AiAuthType;
     enabled: boolean;
+    id: string;
     instruction: string;
     name: string;
     responseTemplate: string;
+    tags: string[];
     type: AiType;
 }
-export interface PickAiExcludeKeysTenantOrMetadata {
+export interface PickChatbotExcludeKeysTenantOrMetadata {
     authType: AiAuthType;
@@ -325,5 +350,17 @@ enabled: boolean;
     responseTemplate: string;
+    search?: {
+        resultsPageId: string;
+        searchPackageId: string;
+        url: string;
+    };
     tags: string[];
-    type: AiType;
+    type: AiTypeChatbot;
 }
+export interface PickChatbotSearch {
+    search?: {
+        resultsPageId: string;
+        searchPackageId: string;
+        url: string;
+    };
+}
 export interface PickCrawlerExcludeKeysLastCrawledAtOrScheduleArn {
@@ -575,3 +612,3 @@ aiId: string;
         type RequestHeaders = {};
-        type ResponseBody = AiResponse;
+        type ResponseBody = ChatbotAiResponse;
     }
@@ -597,3 +634,3 @@ namespace Delete {
         type RequestHeaders = {};
-        type ResponseBody = AiResponse;
+        type ResponseBody = ChatbotAiResponse;
     }
@@ -642,3 +679,3 @@ namespace GetAllChatBotThreads {
         type RequestHeaders = {};
-        type ResponseBody = PageResultAiResponse;
+        type ResponseBody = PageResultChatbotAiResponse;
     }
@@ -671,3 +708,3 @@ namespace Rate {
         type RequestHeaders = {};
-        type ResponseBody = AiResponse;
+        type ResponseBody = ChatbotAiResponse;
     }
@@ -681,3 +718,3 @@ namespace Update {
         type RequestHeaders = {};
-        type ResponseBody = AiResponse;
+        type ResponseBody = ChatbotAiResponse;
     }
@@ -919,12 +956,12 @@ }
     chatbot: {
-        create: (data: ChatBotWrite, params?: RequestParams) => Promise<AiResponse>;
+        create: (data: ChatBotWrite, params?: RequestParams) => Promise<ChatbotAiResponse>;
         delete: ({ id, ...query }: DeleteParams3, params?: RequestParams) => Promise<void>;
-        get: (id: string, params?: RequestParams) => Promise<AiResponse>;
+        get: (id: string, params?: RequestParams) => Promise<ChatbotAiResponse>;
         getAllChatBotThreads: ({ aiId, ...query }: GetAllChatBotThreadsParams, params?: RequestParams) => Promise<PageResultThread>;
         getChatBotThreadMessages: ({ aiId, threadId, ...query }: GetChatBotThreadMessagesParams, params?: RequestParams) => Promise<PageResultMessage>;
-        list: (query: ListParams6, params?: RequestParams) => Promise<PageResultAiResponse>;
+        list: (query: ListParams6, params?: RequestParams) => Promise<PageResultChatbotAiResponse>;
         rate: (aiId: string, threadId: string, data: RateBody, params?: RequestParams) => Promise<Thread>;
         restore: (id: string, params?: RequestParams) => Promise<void>;
-        set: (id: string, data: ChatBotWrite, params?: RequestParams) => Promise<AiResponse>;
-        update: (id: string, data: ChatBotPatch, params?: RequestParams) => Promise<AiResponse>;
+        set: (id: string, data: ChatBotWrite, params?: RequestParams) => Promise<ChatbotAiResponse>;
+        update: (id: string, data: ChatBotPatch, params?: RequestParams) => Promise<ChatbotAiResponse>;
     };
@@ -931,0 +968,0 @@ chatbotExecution: {

package.json

@@ -8,3 +8,3 @@ {
   },
-  "version": "1.3.0",
+  "version": "1.4.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.37.0",
+    "@squiz/ai-service": "1.38.0",
     "jest": "^29.7.0",
@@ -24,0 +24,0 @@ "swagger-typescript-api": "^13.0.22",

No alert changes

Improved metrics

Total package byte prevSize

297200

0.87%

Lines of code

2545

1.48%

No dependency changes