import { DocumentInformation, FacetStateRequest } from '../events'; import { InsightEvents } from '../insight/insightEvents'; export declare enum SearchPageEvents { interfaceLoad = "interfaceLoad", interfaceChange = "interfaceChange", didyoumeanAutomatic = "didyoumeanAutomatic", didyoumeanClick = "didyoumeanClick", resultsSort = "resultsSort", searchboxSubmit = "searchboxSubmit", searchboxClear = "searchboxClear", searchboxAsYouType = "searchboxAsYouType", breadcrumbFacet = "breadcrumbFacet", breadcrumbResetAll = "breadcrumbResetAll", documentQuickview = "documentQuickview", documentOpen = "documentOpen", omniboxAnalytics = "omniboxAnalytics", omniboxFromLink = "omniboxFromLink", searchFromLink = "searchFromLink", triggerNotify = "notify", triggerExecute = "execute", triggerQuery = "query", undoTriggerQuery = "undoQuery", triggerRedirect = "redirect", pagerResize = "pagerResize", pagerNumber = "pagerNumber", pagerNext = "pagerNext", pagerPrevious = "pagerPrevious", pagerScrolling = "pagerScrolling", staticFilterClearAll = "staticFilterClearAll", staticFilterSelect = "staticFilterSelect", staticFilterDeselect = "staticFilterDeselect", facetClearAll = "facetClearAll", facetSearch = "facetSearch", facetSelect = "facetSelect", facetSelectAll = "facetSelectAll", facetDeselect = "facetDeselect", facetExclude = "facetExclude", facetUnexclude = "facetUnexclude", facetUpdateSort = "facetUpdateSort", facetShowMore = "showMoreFacetResults", facetShowLess = "showLessFacetResults", queryError = "query", queryErrorBack = "errorBack", queryErrorClear = "errorClearQuery", queryErrorRetry = "errorRetry", recommendation = "recommendation", recommendationInterfaceLoad = "recommendationInterfaceLoad", recommendationOpen = "recommendationOpen", likeSmartSnippet = "likeSmartSnippet", dislikeSmartSnippet = "dislikeSmartSnippet", expandSmartSnippet = "expandSmartSnippet", collapseSmartSnippet = "collapseSmartSnippet", openSmartSnippetFeedbackModal = "openSmartSnippetFeedbackModal", closeSmartSnippetFeedbackModal = "closeSmartSnippetFeedbackModal", sendSmartSnippetReason = "sendSmartSnippetReason", expandSmartSnippetSuggestion = "expandSmartSnippetSuggestion", collapseSmartSnippetSuggestion = "collapseSmartSnippetSuggestion", showMoreSmartSnippetSuggestion = "showMoreSmartSnippetSuggestion", showLessSmartSnippetSuggestion = "showLessSmartSnippetSuggestion", openSmartSnippetSource = "openSmartSnippetSource", openSmartSnippetSuggestionSource = "openSmartSnippetSuggestionSource", openSmartSnippetInlineLink = "openSmartSnippetInlineLink", openSmartSnippetSuggestionInlineLink = "openSmartSnippetSuggestionInlineLink", recentQueryClick = "recentQueriesClick", clearRecentQueries = "clearRecentQueries", recentResultClick = "recentResultClick", clearRecentResults = "clearRecentResults", noResultsBack = "noResultsBack", showMoreFoldedResults = "showMoreFoldedResults", showLessFoldedResults = "showLessFoldedResults", copyToClipboard = "copyToClipboard", caseSendEmail = "Case.SendEmail", feedItemTextPost = "FeedItem.TextPost", caseAttach = "caseAttach", caseDetach = "caseDetach", retryGeneratedAnswer = "retryGeneratedAnswer", likeGeneratedAnswer = "likeGeneratedAnswer", dislikeGeneratedAnswer = "dislikeGeneratedAnswer", openGeneratedAnswerSource = "openGeneratedAnswerSource", generatedAnswerOpenInlineLink = "generatedAnswerOpenInlineLink", generatedAnswerStreamEnd = "generatedAnswerStreamEnd", generatedAnswerSourceHover = "generatedAnswerSourceHover", generatedAnswerCopyToClipboard = "generatedAnswerCopyToClipboard", generatedAnswerHideAnswers = "generatedAnswerHideAnswers", generatedAnswerShowAnswers = "generatedAnswerShowAnswers", generatedAnswerExpand = "generatedAnswerExpand", generatedAnswerCollapse = "generatedAnswerCollapse", generatedAnswerFeedbackSubmit = "generatedAnswerFeedbackSubmit", rephraseGeneratedAnswer = "rephraseGeneratedAnswer", generatedAnswerFeedbackSubmitV2 = "generatedAnswerFeedbackSubmitV2", generatedAnswerCitationClick = "generatedAnswerCitationClick", generatedAnswerFollowupOpenSource = "generatedAnswerFollowupOpenSource", generatedAnswerCitationDocumentAttach = "generatedAnswerCitationDocumentAttach" } export declare const CustomEventsTypes: Partial>; export interface StaticFilterMetadata { staticFilterId: string; } export interface StaticFilterToggleValueMetadata extends StaticFilterMetadata { staticFilterValue: StaticFilterValueMetadata; } interface StaticFilterValueMetadata { caption: string; expression: string; } export interface FacetMetadata { facetId: string; facetField: string; facetValue: string; facetTitle: string; } export type FacetStateMetadata = FacetStateRequest; export interface FacetRangeMetadata extends Omit { facetRangeStart: string; facetRangeEnd: string; facetRangeEndInclusive: boolean; } export interface CategoryFacetMetadata { categoryFacetId: string; categoryFacetField: string; categoryFacetPath: string[]; categoryFacetTitle: string; } export interface OmniboxSuggestionsMetadata { suggestionRanking: number; partialQueries: string | string[]; suggestions: string | string[]; partialQuery: string; querySuggestResponseId: string; } export interface DocumentIdentifier { contentIDKey: string; contentIDValue: string; } export interface InterfaceChangeMetadata { interfaceChangeTo: string; } export interface ResultsSortMetadata { resultsSortBy: string; } export interface TriggerNotifyMetadata { notifications: string[]; } export interface TriggerExecution { functionName: string; params: (string | number | boolean)[]; } export interface TriggerExecuteMetadata { executions: TriggerExecution[]; } export interface UndoTriggerRedirectMetadata { undoneQuery: string; } export interface TriggerRedirectMetadata { redirectedTo: string; } export interface PagerResizeMetadata { currentResultsPerPage: number; } export interface PagerMetadata { pagerNumber: number; } export interface FacetBaseMeta { facetId: string; facetField: string; facetTitle: string; } export interface FacetMetadata extends FacetBaseMeta { facetValue: string; } export interface FacetRangeMetadata extends FacetBaseMeta { facetRangeStart: string; facetRangeEnd: string; } export interface FacetSortMeta extends FacetBaseMeta { criteria: string; } export interface QueryErrorMeta { query: string; aq: string; cq: string; dq: string; errorType: string; errorMessage: string; } export type SmartSnippetFeedbackReason = 'does_not_answer' | 'partially_answers' | 'was_not_a_question' | 'other'; export interface SmartSnippetSuggestionMeta { question: string; answerSnippet: string; documentId: SmartSnippetDocumentIdentifier; } export interface LinkMeta { linkText: string; linkURL: string; } export interface SmartSnippetLinkMeta extends LinkMeta { } export interface SmartSnippetDocumentIdentifier { contentIdKey: string; contentIdValue: string; } export type PartialDocumentInformation = Omit; export type PartialCitationInformation = Omit; interface AnswerGeneratedWithAnswerAPI { answerAPIStreamId: string; generativeQuestionAnsweringId?: never; conversationId?: never; } interface AnswerGeneratedWithSearchAPI { answerAPIStreamId?: never; generativeQuestionAnsweringId: string; conversationId?: never; } interface AnswerGeneratedWithAgent { answerAPIStreamId?: never; generativeQuestionAnsweringId: string; conversationId: string; } export type GeneratedAnswerBaseMeta = AnswerGeneratedWithAnswerAPI | AnswerGeneratedWithSearchAPI | AnswerGeneratedWithAgent; export type GeneratedAnswerStreamEndMeta = GeneratedAnswerBaseMeta & { answerGenerated: boolean; answerTextIsEmpty?: boolean; }; export type GeneratedAnswerCitationMeta = GeneratedAnswerBaseMeta & { permanentId: string; citationId: string; }; export type GeneratedAnswerInlineLinkMeta = GeneratedAnswerBaseMeta & LinkMeta; export type GeneratedAnswerCitationClickMeta = GeneratedAnswerBaseMeta & { citationId: string; documentId: GeneratedAnswerDocumentIdentifier; }; type GeneratedAnswerDocumentIdentifier = { contentIdKey: string; contentIdValue: string; }; export type GeneratedAnswerFeedbackReason = 'irrelevant' | 'notAccurate' | 'outOfDate' | 'harmful' | 'other'; export type GeneratedAnswerRephraseFormat = 'step' | 'bullet' | 'concise' | 'default'; export type GeneratedAnswerSourceHoverMeta = GeneratedAnswerCitationMeta & { citationHoverTimeMs: number; }; export type GeneratedAnswerFollowupOpenSourceMeta = PartialCitationInformation & AnswerGeneratedWithAgent & { citationId: string; permanentId: string; }; export type GeneratedAnswerRephraseMeta = GeneratedAnswerBaseMeta & { rephraseFormat: GeneratedAnswerRephraseFormat; }; export type GeneratedAnswerFeedbackMeta = GeneratedAnswerBaseMeta & { reason: GeneratedAnswerFeedbackReason; details?: string; }; export type GeneratedAnswerFeedbackReasonOption = 'yes' | 'unknown' | 'no'; export type GeneratedAnswerFeedbackMetaV2 = GeneratedAnswerBaseMeta & { helpful: boolean; readable: GeneratedAnswerFeedbackReasonOption; documented: GeneratedAnswerFeedbackReasonOption; correctTopic: GeneratedAnswerFeedbackReasonOption; hallucinationFree: GeneratedAnswerFeedbackReasonOption; details?: string; documentUrl?: string; }; export {};