@coveo/headless
    Preparing search index...

    Interface GeneratedAnswer

    The GeneratedAnswer controller uses Coveo Machine Learning (Coveo ML) models to automatically generate an answer to a query executed by the user.

    interface GeneratedAnswer {
        state: GeneratedAnswerState;
        closeFeedbackModal(): void;
        collapse(): void;
        disable(): void;
        dislike(): void;
        dislike(answerId: string): void;
        enable(): void;
        expand(): void;
        hide(): void;
        like(): void;
        like(answerId: string): void;
        logCitationClick(citationId: string): void;
        logCitationClick(citationId: string, answerId: string): void;
        logCitationHover(citationId: string, citationHoverTimeMs: number): void;
        logCitationHover(
            citationId: string,
            citationHoverTimeMs: number,
            answerId: string,
        ): void;
        logCopyToClipboard(): void;
        logCopyToClipboard(answerId: string): void;
        openFeedbackModal(): void;
        retry(): void;
        sendFeedback(feedback: GeneratedAnswerFeedback): void;
        show(): void;
        subscribe(listener: () => void): Unsubscribe;
    }

    Hierarchy (View Summary)

    Index

    Methods

    closeFeedbackModal collapse disable dislike enable expand hide like logCitationClick logCitationHover logCopyToClipboard openFeedbackModal retry sendFeedback show subscribe

    Properties

    state

    Methods

    • Logs a custom event indicating a cited source link was hovered.

      Parameters

      • citationId: string

        The ID of the hovered citation.

      • citationHoverTimeMs: number

        The number of milliseconds spent hovering over the citation.

      Returns void

      The logCitationHover method is deprecated and will be removed in a future major version. The method will now take a required answerId parameter to specify which answer is being hovered, and will log the hover action with the provided answerId for analytics.

    • Logs a custom event indicating a cited source link was hovered.

      Parameters

      • citationId: string

        The ID of the hovered citation.

      • citationHoverTimeMs: number

        The number of milliseconds spent hovering over the citation.

      • answerId: string

        Answer Id of the hovered citation's answer.

      Returns void

    Properties

    state: GeneratedAnswerState

    The state of the GeneratedAnswer controller.

    Settings

    Member Visibility
    In this article
    Methods
    Properties