@coveo/quantic 3.42.1 → 3.43.0

package/force-app/main/default/labels/CustomLabels.labels-meta.xml

@@ -1652,6 +1652,13 @@
     <protected>false</protected>
     <shortDescription>Submit follow-up</shortDescription>
   </labels>
+  <labels>
+    <fullName>quantic_FollowUpInputTooLong</fullName>
+    <value>Your question is too long. Please use {{0}} characters or fewer.</value>
+    <language>en_US</language>
+    <protected>false</protected>
+    <shortDescription>Follow-up question character limit exceeded</shortDescription>
+  </labels>
   <labels>
     <fullName>quantic_ShowPreviousQuestions_plural</fullName>
     <value>Show {{0}} previous questions</value>
@@ -1687,6 +1694,20 @@
     <protected>false</protected>
     <shortDescription>Knowledge base searched</shortDescription>
   </labels>
+  <labels>
+    <fullName>quantic_AgentGenerationStepSearchQuery</fullName>
+    <value>Searching for {{0}}…</value>
+    <language>en_US</language>
+    <protected>false</protected>
+    <shortDescription>Searching for query</shortDescription>
+  </labels>
+  <labels>
+    <fullName>quantic_AgentGenerationStepSearchQueryCompleted</fullName>
+    <value>Searched for {{0}}</value>
+    <language>en_US</language>
+    <protected>false</protected>
+    <shortDescription>Searched for query</shortDescription>
+  </labels>
   <labels>
     <fullName>quantic_AgentGenerationStepAnalyzingResults</fullName>
     <value>Analyzing results…</value>

package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/agentData.ts

@@ -0,0 +1,248 @@
+type AgentRunType = {
+  type: 'RUN_STARTED' | 'RUN_FINISHED';
+  timestamp: number;
+  threadId: string;
+  runId: string;
+  result?: {
+    completionReason: string;
+  };
+};
+
+type AgentCustomType = {
+  type: 'CUSTOM';
+  timestamp: number;
+  name: string;
+  value: any;
+};
+
+type AgentStepType = {
+  type: 'STEP_STARTED' | 'STEP_FINISHED';
+  timestamp: number;
+  stepName: string;
+};
+
+type AgentToolCallType = {
+  type: 'TOOL_CALL_START' | 'TOOL_CALL_END';
+  timestamp: number;
+  toolCallId: string;
+  toolCallName: string;
+  parentMessageId: string;
+};
+
+type AgentToolCallArgsType = {
+  type: 'TOOL_CALL_ARGS';
+  timestamp: number;
+  toolCallId: string;
+  delta: any;
+};
+
+type AgentTextMessageType = {
+  type: 'TEXT_MESSAGE_CHUNK';
+  timestamp: number;
+  messageId: string;
+  parentMessageId: string;
+  delta: string;
+};
+
+export type AgentCitation = {
+  id: string;
+  title: string;
+  uri: string;
+  permanentid: string;
+  primaryId: string;
+  clickUri: string;
+  text: string;
+  source: string;
+  filetype: string;
+  fields: Record<string, any>;
+};
+
+type AgentCitationType = {
+  type: 'CUSTOM';
+  timestamp: number;
+  name: 'citations';
+  value: {
+    citations: Array<AgentCitation>;
+  };
+};
+
+const STREAM_ID = 'conv_1';
+const ANSWER_ID_1 = 'conv_1_0001';
+const ANSWER_ID_2 = 'conv_1_0002';
+const ANSWER_ID_3 = 'conv_1_0003';
+const CONVERSATION_TOKEN = 'conv_1_token';
+
+const runStartStream = (answerId: string): AgentRunType => ({
+  type: 'RUN_STARTED',
+  timestamp: new Date().valueOf(),
+  threadId: STREAM_ID,
+  runId: answerId,
+});
+
+const customInitialHeadersStream = (followUpEnabled: boolean): AgentCustomType => ({
+  type: 'CUSTOM',
+  timestamp: new Date().valueOf(),
+  name: 'header',
+  value: {
+    contentFormat: 'text/markdown',
+    conversationId: STREAM_ID,
+    followUpEnabled,
+    conversationToken: CONVERSATION_TOKEN,
+  },
+});
+
+const stepStartedStream = (stepName: string): AgentStepType => ({
+  type: 'STEP_STARTED',
+  timestamp: new Date().valueOf(),
+  stepName,
+});
+
+const stepFinishedStream = (stepName: string): AgentStepType => ({
+  type: 'STEP_FINISHED',
+  timestamp: new Date().valueOf(),
+  stepName,
+});
+
+const toolCallStartStream = (toolCallName: string): AgentToolCallType => ({
+  type: 'TOOL_CALL_START',
+  timestamp: new Date().valueOf(),
+  toolCallId: 'tool_call_1',
+  toolCallName,
+  parentMessageId: 'message_1',
+});
+
+const searchQueryToolCallArgsStream = (q: string): AgentToolCallArgsType => ({
+  type: 'TOOL_CALL_ARGS',
+  timestamp: new Date().valueOf(),
+  toolCallId: 'tool_call_1',
+  delta: JSON.stringify({
+    q,
+  }),
+});
+
+const toolCallEndStream = (toolCallName: string): AgentToolCallType => ({
+  type: 'TOOL_CALL_END',
+  timestamp: new Date().valueOf(),
+  toolCallId: 'tool_call_1',
+  toolCallName,
+  parentMessageId: 'message_1',
+});
+
+const textMessageStream = (delta: string): AgentTextMessageType => ({
+  type: 'TEXT_MESSAGE_CHUNK',
+  timestamp: new Date().valueOf(),
+  messageId: 'message_2',
+  parentMessageId: 'message_1',
+  delta,
+});
+
+const exampleCitation: AgentCitation = {
+  id: 'some-id-1',
+  title: 'Some Title 1',
+  uri: 'https://www.coveo.com',
+  permanentid: 'some-permanent-id-1',
+  clickUri: 'https://www.coveo.com',
+  text: 'example text 1',
+  source: 'Some source 1',
+  filetype: 'pdf',
+  fields: {},
+  primaryId: 'primary-id-1',
+};
+
+const citationStream: AgentCitationType = {
+  type: 'CUSTOM',
+  timestamp: new Date().valueOf(),
+  name: 'citations',
+  value: {
+    citations: [exampleCitation],
+  },
+};
+
+const runFinishedStream = (answerId: string): AgentRunType => ({
+  type: 'RUN_FINISHED',
+  timestamp: new Date().valueOf(),
+  threadId: STREAM_ID,
+  runId: answerId,
+  result: {
+    completionReason: 'ANSWERED',
+  },
+});
+
+export type AgentMessage =
+  | AgentRunType
+  | AgentCustomType
+  | AgentStepType
+  | AgentToolCallType
+  | AgentToolCallArgsType
+  | AgentTextMessageType
+  | AgentCitationType;
+
+export type AgentData = {
+  answerStreams: Array<AgentMessage>;
+  followUpStreams: Array<Array<AgentMessage>>;
+  conversationId: string;
+  answerId1: string;
+  answerId2: string;
+  answerId3: string;
+  conversationToken: string;
+  citations: Array<AgentCitation>;
+};
+
+const agentData: AgentData = {
+  answerStreams: [
+    runStartStream(ANSWER_ID_1),
+    customInitialHeadersStream(true),
+    stepStartedStream('Searching'),
+    toolCallStartStream('search'),
+    searchQueryToolCallArgsStream('test'),
+    toolCallEndStream('search'),
+    stepFinishedStream('Searching'),
+    stepStartedStream('Answering'),
+    textMessageStream('### Testing in Coveo\n\nclick **Edit components**.\n   - On the **A/B test** tab, click **Configure A/B test**.\n   - Set the traffic ratio and configure the **Test scenario**.\n   - Click **Start** to activate the A/B test.\n\n2. **Edit an A/B Test**\n   - Follow the same steps as creating an A/B test.\n   - Click **Edit A/B test** and adjust the traffic ratio.'),
+    citationStream,
+    stepFinishedStream('Answering'),
+    runFinishedStream(ANSWER_ID_1),
+  ],
+  followUpStreams: [
+    [
+      runStartStream(ANSWER_ID_2),
+      customInitialHeadersStream(true),
+      stepStartedStream('Thinking'),
+      stepFinishedStream('Thinking'),
+      stepStartedStream('Searching'),
+      toolCallStartStream('search'),
+      searchQueryToolCallArgsStream('follow-up question'),
+      toolCallEndStream('search'),
+      stepFinishedStream('Searching'),
+      stepStartedStream('Answering'),
+      textMessageStream('This is a follow-up answer.'),
+      citationStream,
+      stepFinishedStream('Answering'),
+      runFinishedStream(ANSWER_ID_2),
+    ],
+    [
+      runStartStream(ANSWER_ID_3),
+      customInitialHeadersStream(true),
+      stepStartedStream('Thinking'),
+      stepFinishedStream('Thinking'),
+      stepStartedStream('Searching'),
+      toolCallStartStream('search'),
+      searchQueryToolCallArgsStream('third question'),
+      toolCallEndStream('search'),
+      stepFinishedStream('Searching'),
+      stepStartedStream('Answering'),
+      textMessageStream('This is the third answer.'),
+      citationStream,
+      stepFinishedStream('Answering'),
+      runFinishedStream(ANSWER_ID_3),
+    ],
+  ],
+  conversationId: STREAM_ID,
+  answerId1: ANSWER_ID_1,
+  answerId2: ANSWER_ID_2,
+  answerId3: ANSWER_ID_3,
+  conversationToken: CONVERSATION_TOKEN,
+  citations: [exampleCitation],
+};
+
+export default agentData;

package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/fixture-agent.ts

@@ -0,0 +1,77 @@
+import {quanticBase} from '../../../../../../playwright/fixtures/baseFixture';
+import {SearchObject} from '../../../../../../playwright/page-object/searchObject';
+import {
+  searchRequestRegex,
+  agentAnswerRequestRegex,
+  agentFollowUpRequestRegex,
+} from '../../../../../../playwright/utils/requests';
+import {GeneratedAnswerObject} from './pageObject';
+import agentData from './agentData';
+import type {AgentData} from './agentData';
+import {AnalyticsModeEnum} from '../../../../../../playwright/utils/analyticsMode';
+
+const pageUrl = 's/quantic-generated-answer';
+
+interface AgentOptions {
+  agentId: string;
+  withToggle: boolean;
+}
+
+type QuanticGeneratedAnswerAgentE2EFixtures = {
+  agentData: AgentData;
+  generatedAnswer: GeneratedAnswerObject;
+  search: SearchObject;
+  options: Partial<AgentOptions>;
+};
+
+export const exampleQuery = 'test';
+
+export const testAgent =
+  quanticBase.extend<QuanticGeneratedAnswerAgentE2EFixtures>({
+    pageUrl,
+    agentData,
+    options: {},
+    analyticsMode: AnalyticsModeEnum.legacy,
+    search: async ({page}, use) => {
+      await use(new SearchObject(page, searchRequestRegex));
+    },
+    generatedAnswer: async (
+      {page, options, configuration, search, agentData: data, analytics},
+      use
+    ) => {
+      const generatedAnswerObject = new GeneratedAnswerObject(
+        page,
+        data.answerId1,
+        analytics,
+        {
+          headAnswerRequestRegex: agentAnswerRequestRegex,
+          agentFollowUpRequestRegex,
+          isAgent: true,
+        }
+      );
+
+      await generatedAnswerObject.mockAgentAnswerResponse(
+        data.answerStreams
+      );
+      await generatedAnswerObject.mockAgentFollowUpResponse(
+        data.followUpStreams
+      );
+
+      await page.goto(pageUrl);
+      await configuration.configure(options);
+      await search.waitForSearchResponse();
+
+      generatedAnswerObject.streamEndAnalyticRequestPromise =
+        generatedAnswerObject.waitForStreamEndAnalytics();
+      generatedAnswerObject.generateRequestPromise =
+        generatedAnswerObject.waitForHeadAnswerRequest();
+
+      await search.fillSearchInput(exampleQuery);
+      await search.performSearch();
+      await search.waitForSearchResponse();
+
+      await use(generatedAnswerObject);
+    },
+  });
+
+export {expect} from '@playwright/test';

package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/fixture.ts

@@ -44,70 +44,74 @@ type QuanticGeneratedAnswerE2EInsightFixtures =
 
 export const exampleQuery = 'test';
 
-export const testSearch = quanticBase.extend<QuanticGeneratedAnswerE2ESearchFixtures>({
-  pageUrl,
-  genQaData,
-  options: {},
-  analyticsMode: AnalyticsModeEnum.legacy,
-  withFacets: false,
-  search: async ({page}, use) => {
-    await use(new SearchObject(page, searchRequestRegex));
-  },
-  baseFacet: async ({page}, use) => {
-    await use(new BaseFacetObject(page, searchRequestRegex));
-  },
-  generatedAnswer: async (
-    {
-      page,
-      options,
-      configuration,
-      search,
-      genQaData: data,
-      analytics,
-      withFacets,
+export const testSearch =
+  quanticBase.extend<QuanticGeneratedAnswerE2ESearchFixtures>({
+    pageUrl,
+    genQaData,
+    options: {},
+    analyticsMode: AnalyticsModeEnum.legacy,
+    withFacets: false,
+    search: async ({page}, use) => {
+      await use(new SearchObject(page, searchRequestRegex));
     },
-    use
-  ) => {
-    const generatedAnswerObject = new GeneratedAnswerObject(
-      page,
-      data.streamId,
-      analytics,
-      !!options.answerConfigurationId,
-      rgaGenerateRequestRegex,
-      withFacets,
-    );
-
-    const streamingUrl = options.answerConfigurationId
-      ? ANSWER_API_URL
-      : `${MACHINE_LEARNING_API_URL}/${data.streamId}`;
-    await generatedAnswerObject.mockStreamResponse(
-      streamingUrl,
-      data.streams,
-      data.streamId
-    );
-
-    await page.goto(pageUrl);
-    if (withFacets) {
-      await generatedAnswerObject.clickAddFacetsButton();
-    }
-    await configuration.configure(options);
-    await search.waitForSearchResponse();
+    baseFacet: async ({page}, use) => {
+      await use(new BaseFacetObject(page, searchRequestRegex));
+    },
+    generatedAnswer: async (
+      {
+        page,
+        options,
+        configuration,
+        search,
+        genQaData: data,
+        analytics,
+        withFacets,
+      },
+      use
+    ) => {
+      const generatedAnswerObject = new GeneratedAnswerObject(
+        page,
+        data.streamId,
+        analytics,
+        {
+          answerApiEnabled: !!options.answerConfigurationId,
+          headAnswerRequestRegex: rgaGenerateRequestRegex,
+          withFacets,
+        }
+      );
+
+      const streamingUrl = options.answerConfigurationId
+        ? ANSWER_API_URL
+        : `${MACHINE_LEARNING_API_URL}/${data.streamId}`;
+      await generatedAnswerObject.mockStreamResponse(
+        streamingUrl,
+        data.streams,
+        data.streamId
+      );
+
+      await page.goto(pageUrl);
+      if (withFacets) {
+        await generatedAnswerObject.clickAddFacetsButton();
+      }
+      await configuration.configure(options);
+      await search.waitForSearchResponse();
 
       generatedAnswerObject.streamEndAnalyticRequestPromise =
         generatedAnswerObject.waitForStreamEndAnalytics();
+
       if (options.answerConfigurationId) {
         generatedAnswerObject.generateRequestPromise =
-          generatedAnswerObject.waitForGenerateRequest();
+          generatedAnswerObject.waitForHeadAnswerRequest();
       }
 
-    await search.fillSearchInput(exampleQuery);
-    await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
-    await search.performSearch();
-    await search.waitForSearchResponse();
+      await search.fillSearchInput(exampleQuery);
+      await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
+      await search.performSearch();
+      await search.waitForSearchResponse();
 
-    await use(generatedAnswerObject);
-  },
-});
+      await use(generatedAnswerObject);
+    },
+  });
 
 export const testInsight =
   quanticBase.extend<QuanticGeneratedAnswerE2EInsightFixtures>({
@@ -142,9 +146,11 @@ export const testInsight =
         page,
         data.streamId,
         analytics,
-        !!options.answerConfigurationId,
-        insightRgaGenerateRequestRegex,
-        withFacets
+        {
+          answerApiEnabled: !!options.answerConfigurationId,
+          headAnswerRequestRegex: insightRgaGenerateRequestRegex,
+          withFacets,
+        }
       );
 
       const streamingUrl = options.answerConfigurationId
@@ -171,7 +177,7 @@ export const testInsight =
         generatedAnswerObject.waitForStreamEndAnalytics();
       if (options.answerConfigurationId) {
         generatedAnswerObject.generateRequestPromise =
-          generatedAnswerObject.waitForGenerateRequest();
+          generatedAnswerObject.waitForHeadAnswerRequest();
       }
 
       await search.fillSearchInput(exampleQuery);