import type { CoreEngine } from '../../../app/engine.js';
import type { CustomAction, LegacySearchAction } from '../../../features/analytics/analytics-utils.js';
import type { GeneratedAnswerFeedback } from '../../../features/generated-answer/generated-answer-analytics-actions.js';
import type { GeneratedAnswerState } from '../../../features/generated-answer/generated-answer-state.js';
import type { GeneratedResponseFormat } from '../../../features/generated-answer/generated-response-format.js';
import { type Controller } from '../../controller/headless-controller.js';
/**
 * The `GeneratedAnswer` controller uses Coveo Machine Learning (Coveo ML) models to automatically generate an answer to a query executed by the user.
 *
 * @group Controllers
 * @category GeneratedAnswer
 */
export interface GeneratedAnswer extends Controller {
    /**
     * The state of the GeneratedAnswer controller.
     */
    state: GeneratedAnswerState;
    /**
     * Re-executes the last query to generate an answer.
     */
    retry(): void;
    /**
     * Indicates that the generated answer met the user expectations.
     */
    like(): void;
    /**
     * Marks the generated answer as not relevant to the end user.
     */
    dislike(): void;
    /**
     * Opens the modal to provide feedback about why the generated answer was not relevant.
     */
    openFeedbackModal(): void;
    /**
     * Closes the modal to provide feedback about why the generated answer was not relevant.
     */
    closeFeedbackModal(): void;
    /**
     * Sends feedback about why the generated answer was not relevant.
     * @param feedback - The feedback that the end user wishes to send.
     */
    sendFeedback(feedback: GeneratedAnswerFeedback): void;
    /**
     * Displays the generated answer.
     */
    show(): void;
    /**
     * Hides the generated answer.
     */
    hide(): void;
    /**
     * Expands the generated answer.
     */
    expand(): void;
    /**
     * Collapses the generated answer.
     */
    collapse(): void;
    /**
     * Enables the generated answer.
     */
    enable(): void;
    /**
     * Disables the generated answer.
     */
    disable(): void;
    /**
     * Logs a custom event indicating the generated answer was copied to the clipboard.
     * @deprecated The `logCopyToClipboard` 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 copied, and will log the copy action with the provided `answerId` for analytics.
     */
    logCopyToClipboard(): void;
    /**
     * Logs a custom event indicating the generated answer was copied to the clipboard.
     * @param answerId - Answer Id of the copied answer.
     */
    logCopyToClipboard(answerId: string): void;
    /**
     * Logs a custom event indicating a cited source link was clicked.
     * @param citationId - The ID of the clicked citation.
     * @deprecated The `logCitationClick` 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 clicked, and will log the click action with the provided `answerId` for analytics.
     */
    logCitationClick(citationId: string): void;
    /**
     * Logs a custom event indicating a cited source link was clicked.
     * @param citationId - The ID of the clicked citation.
     * @param answerId - Answer Id of the clicked citation's answer.
     */
    logCitationClick(citationId: string, answerId: string): void;
    /**
     * Logs a custom event indicating a cited source link was hovered.
     * @param citationId - The ID of the hovered citation.
     * @param citationHoverTimeMs - The number of milliseconds spent hovering over the citation.
     * @deprecated 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.
     */
    logCitationHover(citationId: string, citationHoverTimeMs: number): void;
    /**
     * Logs a custom event indicating a cited source link was hovered.
     * @param citationId - The ID of the hovered citation.
     * @param citationHoverTimeMs - The number of milliseconds spent hovering over the citation.
     * @param answerId - Answer Id of the hovered citation's answer.
     */
    logCitationHover(citationId: string, citationHoverTimeMs: number, answerId: string): void;
}
export interface GeneratedAnswerAnalyticsClient {
    /** @deprecated */
    logLikeGeneratedAnswer(): CustomAction;
    logLikeGeneratedAnswer(answerId?: string): CustomAction;
    /** @deprecated */
    logDislikeGeneratedAnswer(): CustomAction;
    logDislikeGeneratedAnswer(answerId?: string): CustomAction;
    logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
    /** @deprecated */
    logOpenGeneratedAnswerSource(citationId: string): CustomAction;
    logOpenGeneratedAnswerSource(citationId: string, answerId?: string): CustomAction;
    /** @deprecated */
    logHoverCitation(citationId: string, citationHoverTimeMs: number): CustomAction;
    logHoverCitation(citationId: string, citationHoverTimeMs: number, answerId?: string): CustomAction;
    logGeneratedAnswerShowAnswers: () => CustomAction;
    logGeneratedAnswerHideAnswers: () => CustomAction;
    /** @deprecated */
    logCopyGeneratedAnswer(): CustomAction;
    logCopyGeneratedAnswer(answerId?: string): CustomAction;
    logRetryGeneratedAnswer: () => LegacySearchAction;
    logGeneratedAnswerExpand: () => CustomAction;
    logGeneratedAnswerCollapse: () => CustomAction;
}
export interface GeneratedAnswerPropsInitialState {
    initialState?: {
        /**
         * Sets the component visibility state on load.
         */
        isVisible?: boolean;
        /**
         * Sets the component enabled state on load.
         */
        isEnabled?: boolean;
        /**
         * The initial formatting options applied to generated answers when the controller first loads.
         */
        responseFormat?: GeneratedResponseFormat;
        /**
         * The initial expanded state of the generated answer.
         */
        expanded?: boolean;
    };
}
export interface GeneratedAnswerProps extends GeneratedAnswerPropsInitialState {
    /**
     * The answer configuration ID used to leverage coveo answer management capabilities.
     */
    answerConfigurationId?: string;
    /**
     * The agent ID that identifies the agent used for generating the answer.
     */
    agentId?: string;
    /**
     * A list of indexed fields to include in the citations returned with the generated answer.
     */
    fieldsToIncludeInCitations?: string[];
}
/**
 * Can be used as a basis for controllers aiming to return a `GeneratedAnswer` controller instance.
 *
 * @param engine - The headless engine.
 * @param props - The configurable `GeneratedAnswer` properties.
 * @returns A `GeneratedAnswer` controller instance.
 *
 * @group Controllers
 * @category GeneratedAnswer
 */
export declare function buildCoreGeneratedAnswer(engine: CoreEngine, analyticsClient: GeneratedAnswerAnalyticsClient, props?: GeneratedAnswerProps): GeneratedAnswer;