@coveo/quantic 3.44.0 → 3.44.2

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

@@ -1,279 +0,0 @@
-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>;
-  };
-};
-
-type AgentRunErrorType = {
-  type: 'RUN_ERROR';
-  timestamp: number;
-  message: string;
-  code: string;
-};
-
-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',
-  },
-});
-
-const runErrorStream = (
-  message: string,
-  code: string
-): AgentRunErrorType => ({
-  type: 'RUN_ERROR',
-  timestamp: new Date().valueOf(),
-  message,
-  code,
-});
-
-export type AgentMessage =
-  | AgentRunType
-  | AgentCustomType
-  | AgentStepType
-  | AgentToolCallType
-  | AgentToolCallArgsType
-  | AgentTextMessageType
-  | AgentCitationType
-  | AgentRunErrorType;
-
-export const turnLimitErrorStream: Array<AgentMessage> = [
-  runStartStream(ANSWER_ID_2),
-  runErrorStream(
-    'The conversation turn limit has been reached.',
-    'KNOWLEDGE:SSE_TURN_LIMIT_REACHED'
-  ),
-];
-
-export const genericErrorStream: Array<AgentMessage> = [
-  runStartStream(ANSWER_ID_2),
-  runErrorStream('An unexpected error occurred.', 'KNOWLEDGE:SSE_INTERNAL_ERROR'),
-];
-
-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/data.ts

@@ -1,56 +0,0 @@
-const exampleStreamId = crypto.randomUUID();
-const genQaMarkdownTextPayload = {
-  payloadType: 'genqa.messageType',
-  payload: JSON.stringify({
-    textDelta:
-      'THIS IS SOME LOREM IPSUM: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin accumsan felis vel nulla venenatis, vel volutpat mauris suscipit. Praesent aliquam, ex et dapibus fermentum, ligula metus condimentum nunc, non vehicula magna magna a nulla. Integer efficitur nunc eget semper facilisis. Quisque nec tortor at nunc blandit dictum sit amet vel mauris. Duis at tellus sit amet mi pharetra tincidunt. Nullam id risus eget risus accumsan molestie ac quis velit. Vivamus consectetur nisi vel enim finibus, nec laoreet risus facilisis. Integer a lacinia ligula. Etiam cursus urna nisi, ut tincidunt elit consectetur quis. Pellentesque nec sem vel neque malesuada euismod vitae nec augue. Suspendisse non ligula eu purus posuere dictum quis et magna. Curabitur dignissim, magna non feugiat consectetur, lorem orci fringilla sapien, sit amet vehicula eros nulla eget enim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin accumsan felis vel nulla venenatis, vel volutpat mauris suscipit. Praesent aliquam, ex et dapibus fermentum, ligula metus condimentum nunc, non vehicula magna magna a nulla. Integer efficitur nunc eget semper facilisis. Quisque nec tortor at nunc blandit dictum sit amet vel mauris. Duis at tellus sit amet mi pharetra tincidunt. Nullam id risus eget risus accumsan molestie ac quis velit. Vivamus consectetur nisi vel enim finibus, nec laoreet risus facilisis. Integer a lacinia ligula. Etiam cursus urna nisi, ut tincidunt elit consectetur quis. Pellentesque nec sem vel neque malesuada euismod vitae nec augue. Suspendisse non ligula eu purus posuere dictum quis et magna. Curabitur dignissim, magna non feugiat consectetur, lorem orci fringilla sapien, sit amet vehicula eros nulla eget enim.',
-  }),
-  finishReason: 'COMPLETED',
-};
-const genQaMarkdownTypePayload = {
-  payloadType: 'genqa.headerMessageType',
-  payload: JSON.stringify({
-    contentFormat: 'text/markdown',
-  }),
-};
-const genQaStreamEndPayload = {
-  payloadType: 'genqa.endOfStreamType',
-  payload: JSON.stringify({
-    answerGenerated: true,
-  }),
-};
-const exampleCitation = {
-  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',
-};
-const exampleCitations = [exampleCitation];
-const genQaCitationPayload = {
-  payloadType: 'genqa.citationsType',
-  payload: JSON.stringify({
-    citations: exampleCitations,
-  }),
-};
-
-export type GenQaData = {
-  streamId: string;
-  streams: Array<{payloadType: string; payload: string; finishReason?: string}>;
-  citations: Array<Record<string, any>>;
-};
-
-const genQaData: GenQaData = {
-  streamId: exampleStreamId,
-  streams: [
-    genQaMarkdownTypePayload,
-    genQaMarkdownTextPayload,
-    genQaCitationPayload,
-    genQaStreamEndPayload,
-  ],
-  citations: exampleCitations,
-};
-
-export default genQaData;

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

@@ -1,77 +0,0 @@
-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,
-        }
-      );
-
-      await generatedAnswerObject.mockAgentAnswerResponse(
-        data.answerStreams
-      );
-      await generatedAnswerObject.mockAgentFollowUpResponse(
-        data.followUpStreams
-      );
-      
-      await search.mockSearchWithBaseResponse();
-      await page.goto(pageUrl);
-      await configuration.configure(options);
-      await search.waitForSearchResponse();
-
-      generatedAnswerObject.streamEndAnalyticRequestPromise =
-        generatedAnswerObject.waitForStreamEndAnalytics();
-      generatedAnswerObject.generateRequestPromise =
-        generatedAnswerObject.waitForHeadAnswerRequest();
-
-      await search.fillSearchInput(exampleQuery);
-      search.performSearch();
-      await search.waitForSearchResponse();
-
-      await use(generatedAnswerObject);
-    },
-  });
-
-export {expect} from '@playwright/test';

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

@@ -1,194 +0,0 @@
-import {quanticBase} from '../../../../../../playwright/fixtures/baseFixture';
-import {SearchObject} from '../../../../../../playwright/page-object/searchObject';
-import {
-  searchRequestRegex,
-  insightSearchRequestRegex,
-  rgaGenerateRequestRegex,
-  insightRgaGenerateRequestRegex,
-} from '../../../../../../playwright/utils/requests';
-import {InsightSetupObject} from '../../../../../../playwright/page-object/insightSetupObject';
-import {useCaseEnum} from '../../../../../../playwright/utils/useCase';
-import {GeneratedAnswerObject} from './pageObject';
-import genQaData from './data';
-import type {GenQaData} from './data';
-import {AnalyticsModeEnum} from '../../../../../../playwright/utils/analyticsMode';
-import {BaseFacetObject} from '../../../../../../playwright/page-object/baseFacetObject';
-
-const MACHINE_LEARNING_API_URL = '**/machinelearning/streaming';
-const ANSWER_API_URL = '**/answer/v1/configs/**/generate';
-const ANSWER_API_INSIGHT_URL = '**/insight/v1/configs/**/answer/**/generate';
-
-const pageUrl = 's/quantic-generated-answer';
-
-interface GeneratedAnswerOptions {
-  fieldsToIncludeInCitations: string;
-  collapsible: boolean;
-  withToggle: boolean;
-  useCase: string;
-  answerConfigurationId: string;
-}
-
-type QuanticGeneratedAnswerE2ESearchFixtures = {
-  genQaData: GenQaData;
-  generatedAnswer: GeneratedAnswerObject;
-  search: SearchObject;
-  options: Partial<GeneratedAnswerOptions>;
-  withFacets: boolean;
-  baseFacet: BaseFacetObject;
-};
-
-type QuanticGeneratedAnswerE2EInsightFixtures =
-  QuanticGeneratedAnswerE2ESearchFixtures & {
-    insightSetup: InsightSetupObject;
-  };
-
-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,
-      },
-      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 search.mockSearchWithBaseResponse();
-      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.waitForHeadAnswerRequest();
-      }
-
-      await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
-      await search.fillSearchInput(exampleQuery);
-      await Promise.all([
-        search.waitForSearchResponse(),
-        search.performSearch(),
-      ]);
-
-      await use(generatedAnswerObject);
-    },
-  });
-
-export const testInsight =
-  quanticBase.extend<QuanticGeneratedAnswerE2EInsightFixtures>({
-    pageUrl,
-    genQaData,
-    options: {},
-    analyticsMode: AnalyticsModeEnum.legacy,
-    withFacets: false,
-    search: async ({page}, use) => {
-      await use(new SearchObject(page, insightSearchRequestRegex));
-    },
-    baseFacet: async ({page}, use) => {
-      await use(new BaseFacetObject(page, insightSearchRequestRegex));
-    },
-    insightSetup: async ({page}, use) => {
-      await use(new InsightSetupObject(page));
-    },
-    generatedAnswer: async (
-      {
-        page,
-        options,
-        search,
-        configuration,
-        insightSetup,
-        genQaData: data,
-        analytics,
-        withFacets,
-      },
-      use
-    ) => {
-      const generatedAnswerObject = new GeneratedAnswerObject(
-        page,
-        data.streamId,
-        analytics,
-        {
-          answerApiEnabled: !!options.answerConfigurationId,
-          headAnswerRequestRegex: insightRgaGenerateRequestRegex,
-          withFacets,
-        }
-      );
-
-      const streamingUrl = options.answerConfigurationId
-        ? ANSWER_API_INSIGHT_URL
-        : `${MACHINE_LEARNING_API_URL}/${data.streamId}`;
-      await generatedAnswerObject.mockStreamResponse(
-        streamingUrl,
-        data.streams,
-        data.streamId
-      );
-
-      await search.mockSearchWithBaseResponse();
-      await page.goto(pageUrl);
-      if (withFacets) {
-        await generatedAnswerObject.clickAddFacetsButton();
-      }
-      configuration.configure({...options, useCase: useCaseEnum.insight});
-      await insightSetup.waitForInsightInterfaceInitialization();
-
-      generatedAnswerObject.streamEndAnalyticRequestPromise =
-        generatedAnswerObject.waitForStreamEndAnalytics();
-      if (options.answerConfigurationId) {
-        generatedAnswerObject.generateRequestPromise =
-          generatedAnswerObject.waitForHeadAnswerRequest();
-      }
-
-      await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
-      await search.fillSearchInput(exampleQuery);
-      await Promise.all([
-        search.waitForSearchResponse(),
-        search.performSearch(),
-      ]);
-
-      await use(generatedAnswerObject);
-    },
-  });
-
-export {expect} from '@playwright/test';