import type { DateAttributeGranularity } from "../base/dateGranularities.js";
import type { IAttribute } from "../execution/attribute/index.js";
import type { IFilter } from "../execution/filter/index.js";
import type { IMeasure } from "../execution/measure/index.js";
import type { ObjRef } from "../objRef/index.js";
import type { GenAIObjectType } from "./common.js";
import type { ISemanticSearchResult, ISemanticSearchResultItem } from "./semanticSearch.js";
/**
 * Role of the chat interaction.
 * @internal
 */
export type GenAIChatRole = "USER" | "AI";
/**
 * User feedback for the chat interaction.
 * @public
 */
export type GenAIChatInteractionUserFeedback = "POSITIVE" | "NEGATIVE" | "NONE";
/**
 * User visualization for the chat interaction.
 * @internal
 */
export type GenAIChatInteractionUserVisualisation = {
    /**
     * ID of the visualization that server created.
     */
    createdId: string;
    /**
     * ID of the visualization that was saved by the user.
     */
    savedId: string;
};
/**
 * A route that was detected by the assistant based on the user question.
 * @internal
 */
export type GenAIChatRoutingUseCase = "ALERT" | "SEARCH" | "HOWTO" | "CHANGE_ANALYSIS" | "SEARCH_ALL" | "SEARCH_VISUALIZATIONS" | "SEARCH_DASHBOARDS" | "CREATE_VISUALIZATION" | "EXTEND_VISUALIZATION" | "GENERAL" | "WHAT_IF" | "INVALID";
/**
 * Routing for the chat interaction.
 * @internal
 */
export interface IGenAIChatRouting {
    /**
     * Detected use case for the routing.
     */
    useCase: GenAIChatRoutingUseCase;
    /**
     * Assistant reasoning on why the use case was detected.
     */
    reasoning: string;
}
/**
 * Reasoning steps for the chat interaction.
 * @internal
 */
export interface IGenAIChatReasoning {
    /**
     * Localized answer summarizing the assistant's reasoning.
     */
    answer?: string;
    /**
     * Array of reasoning steps describing the thought process.
     */
    steps: IGenAIChatReasoningStep[];
}
/**
 * A single reasoning step.
 * @internal
 */
export interface IGenAIChatReasoningStep {
    /**
     * Title or description of the reasoning step.
     */
    title: string;
    /**
     * Additional localized thoughts that belong to the step.
     */
    thoughts?: IGenAIChatReasoningThought[];
}
/**
 * A single reasoning thought item.
 * @internal
 */
export interface IGenAIChatReasoningThought {
    /**
     * Localized text that explains an individual thought.
     */
    text: string;
}
/**
 * User context for GenAI.
 * @internal
 */
export interface IGenAIUserContext {
    /**
     * Ambient UI state: what the user is currently looking at.
     */
    view?: IGenAIUIContext;
    /**
     * Active object the user is interacting with.
     */
    activeObject?: IGenAIActiveObject;
    /**
     * Groups of explicitly referenced objects, each optionally scoped by a context.
     */
    referencedObjects?: IGenAIObjectReferenceGroup[];
}
/**
 * Ambient UI state for GenAI.
 * @internal
 */
export interface IGenAIUIContext {
    /**
     * Dashboard the user is currently viewing.
     */
    dashboard?: IGenAIDashboardContext;
}
/**
 * Dashboard context for GenAI.
 * @internal
 */
export interface IGenAIDashboardContext {
    /**
     * Dashboard object reference.
     */
    ref: ObjRef;
    /**
     * Widgets currently visible on the dashboard.
     */
    widgets: IGenAIWidgetDescriptor[];
}
/**
 * Descriptor for a widget on the dashboard.
 * @internal
 */
export interface IGenAIWidgetDescriptor {
    /**
     * Widget title.
     */
    title: string;
    /**
     * Widget reference.
     */
    widgetRef: ObjRef;
    /**
     * Widget type.
     */
    widgetType: string;
    /**
     * Insight reference (required for insight widgets).
     */
    insightRef?: ObjRef;
    /**
     * Signed result ID for this widget's cached execution result.
     */
    resultId?: string;
}
/**
 * Active object the user is interacting with.
 * @internal
 */
export interface IGenAIActiveObject {
    /**
     * Object reference.
     */
    ref: ObjRef;
    /**
     * ID of the workspace the object belongs to.
     */
    workspaceId: string;
    /**
     * Type of the object.
     */
    type: GenAIObjectType;
}
/**
 * Type of a referenced object.
 * @internal
 */
export type GenAIObjectReferenceType = "WIDGET" | "METRIC" | "ATTRIBUTE" | "DASHBOARD";
/**
 * A reference to an object in the user context.
 * @internal
 */
export interface IGenAIObjectReference {
    /**
     * Type of the referenced object.
     */
    type: GenAIObjectReferenceType;
    /**
     * Object reference.
     */
    ref: ObjRef;
}
/**
 * A group of referenced objects, optionally scoped by a context.
 * @internal
 */
export interface IGenAIObjectReferenceGroup {
    /**
     * Context for this group of references (e.g. a dashboard).
     */
    context?: IGenAIObjectReference;
    /**
     * Objects the user explicitly referenced within this context.
     */
    objects: IGenAIObjectReference[];
}
/**
 * Visualization definition created by the assistant.
 * @internal
 */
export interface IGenAIVisualization {
    /**
     * ID of the visualization.
     */
    id: string;
    /**
     * Title of the visualization.
     */
    title: string;
    /**
     * Type of the visualization.
     */
    visualizationType: GenAIVisualizationType;
    /**
     * Metrics used in the visualization.
     */
    metrics: IGenAIVisualizationMetric[];
    /**
     * Dimensions used in the visualization.
     */
    dimensionality: IGenAIVisualizationDimension[];
    /**
     * Filters used in the visualization.
     */
    filters?: GenAIFilter[];
    /**
     * Visualization-level configuration.
     */
    config?: IGenAIVisualizationConfig;
    /**
     * Suggestions for the visualization.
     */
    suggestions?: IGenAISuggestion[];
    /**
     * A visualization ID in case it was saved.
     */
    savedVisualizationId?: string;
    /**
     * A flag indicating if visualization is being saved right now
     */
    saving?: boolean;
    /**
     * A flag indicating if visualization status waiting for report
     */
    statusReportPending?: boolean;
}
/**
 * Visualization configuration for GenAI-created visualization.
 * @internal
 */
export interface IGenAIVisualizationConfig {
    /**
     * Forecast configuration.
     */
    forecast?: IGenAIForecastConfig;
    /**
     * Anomaly detection configuration.
     */
    anomalyDetection?: IGenAIAnomalyDetectionConfig;
    /**
     * Clustering configuration.
     */
    clustering?: IGenAIClusteringConfig;
    /**
     * What-if scenario configuration.
     */
    whatIf?: IGenAIWhatIfConfig;
}
/**
 * Clustering configuration for GenAI-created visualization.
 * @internal
 */
export interface IGenAIClusteringConfig {
    /**
     * Number of clusters.
     */
    numberOfClusters: number;
    /**
     * Clustering algorithm threshold.
     */
    threshold?: number;
}
/**
 * Anomaly detection configuration for GenAI-created visualization.
 * @internal
 */
export interface IGenAIAnomalyDetectionConfig {
    /**
     * Anomaly detection sensitivity level.
     */
    sensitivity: "LOW" | "MEDIUM" | "HIGH";
}
/**
 * Forecast configuration for GenAI-created visualization.
 * @internal
 */
export interface IGenAIForecastConfig {
    /**
     * Number of future periods that should be forecasted.
     */
    forecastPeriod: number;
    /**
     * Confidence interval boundary value.
     */
    confidenceLevel: number;
    /**
     * Whether the input data is seasonal.
     */
    seasonal: boolean;
}
/**
 * What-if scenario configuration for GenAI-created visualization.
 * @internal
 */
export interface IGenAIWhatIfConfig {
    /**
     * List of what-if scenarios.
     */
    scenarios: IGenAIWhatIfScenario[];
    /**
     * Whether to include the baseline (unmodified) visualization.
     */
    includeBaseline?: boolean;
}
/**
 * A single what-if scenario.
 * @internal
 */
export interface IGenAIWhatIfScenario {
    /**
     * Display label for the scenario.
     */
    label: string;
    /**
     * Metric adjustments for this scenario.
     */
    adjustments: IGenAIWhatIfAdjustment[];
}
/**
 * A metric adjustment within a what-if scenario.
 * @internal
 */
export interface IGenAIWhatIfAdjustment {
    /**
     * ID of the metric to override.
     */
    metricId: string;
    /**
     * Type of the metric object.
     */
    metricType: GenAIMetricType;
    /**
     * MAQL expression to use as the scenario override.
     */
    scenarioMaql: string;
}
/**
 * Positive attribute filter definition for the visualization.
 * @internal
 */
export type GenAIPositiveAttributeFilter = {
    using: string;
    include: Array<string | null>;
};
/**
 * Negative attribute filter definition for the visualization.
 * @internal
 */
export type GenAINegativeAttributeFilter = {
    using: string;
    exclude: Array<string | null>;
};
/**
 * Absolute date filter definition for the visualization.
 * @internal
 */
export type GenAIAbsoluteDateFilter = {
    using: string;
    from: string;
    to: string;
};
/**
 * Relative date filter definition for the visualization.
 * @internal
 */
export type GenAIRelativeDateFilter = {
    using: string;
    granularity: GenAIDateGranularity;
    from: number;
    to: number;
};
/**
 * Ranking filter definition for the visualization.
 * @internal
 */
export type GenAIRankingFilter = {
    measures: string[];
    dimensionality?: string[] | null;
    operator: "TOP" | "BOTTOM";
    value: number;
};
/**
 * Date granularity for the relative date filter.
 * @internal
 */
export type GenAIDateGranularity = "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR";
/**
 * Filter definition for the visualization.
 * @internal
 */
export type GenAIFilter = GenAIPositiveAttributeFilter | GenAINegativeAttributeFilter | GenAIAbsoluteDateFilter | GenAIRelativeDateFilter | GenAIRankingFilter;
/**
 * Suggestion for the visualization.
 * @internal
 */
export type IGenAISuggestion = {
    /**
     * The actual suggestion.
     */
    query: string;
    /**
     * The label of the suggestion.
     */
    label: string;
};
/**
 * Type of the visualization.
 * @internal
 */
export type GenAIVisualizationType = "TABLE" | "HEADLINE" | "BAR" | "LINE" | "PIE" | "COLUMN" | "SCATTER";
/**
 * Metric definition for the visualization.
 * @internal
 */
export interface IGenAIVisualizationMetric {
    /**
     * ID of the object used in metric.
     */
    id: string;
    /**
     * Type of the object used in the metric.
     */
    type: GenAIMetricType;
    /**
     * Title of the metric.
     */
    title?: string;
    /**
     * Aggregation function for the metric.
     */
    aggFunction?: GenAIMetricAggregation;
}
/**
 * Type of the metric.
 * @internal
 */
export type GenAIMetricType = "metric" | "fact" | "attribute";
/**
 * Aggregation function for the metric.
 * @internal
 */
export type GenAIMetricAggregation = "COUNT" | "SUM" | "MIN" | "MAX" | "AVG" | "MEDIAN";
/**
 * Dimension definition for the visualization.
 * @internal
 */
export interface IGenAIVisualizationDimension {
    /**
     * ID of the object used in dimension.
     */
    id: string;
    /**
     * Type of the object used in the dimension.
     */
    type: "attribute";
}
/**
 * A singe user - assistant chat interaction.
 * @internal
 */
export interface IGenAIChatInteraction {
    /**
     * User question.
     */
    question: string;
    /**
     * ID of the interaction within the thread.
     */
    chatHistoryInteractionId: string;
    /**
     * Flag indicating whether the interaction is finished.
     */
    interactionFinished: boolean;
    /**
     * Routing for the interaction.
     */
    routing: IGenAIChatRouting;
    /**
     * Reasoning steps accumulated during the interaction.
     */
    reasoning?: IGenAIChatReasoning;
    /**
     * A generic text response from the assistant.
     */
    textResponse?: string;
    /**
     * A list of found objects for the interaction.
     * @deprecated Use `semanticSearch` property instead.
     */
    foundObjects?: IGenAIFoundObjects;
    /**
     * Semantic search results for the interaction.
     */
    semanticSearch?: ISemanticSearchResult;
    /**
     * A list of created visualizations for the interaction.
     */
    createdVisualizations?: IGenAICreatedVisualizations;
    /**
     * Change analysis parameters for the interaction.
     */
    changeAnalysisParams?: IGenAIChangeAnalysisParams;
    /**
     * User feedback for the assistant reply.
     */
    userFeedback?: GenAIChatInteractionUserFeedback;
    /**
     * An error message in case the interaction failed.
     */
    errorResponse?: string;
}
/**
 * A list of found objects for a given interaction
 * @internal
 */
export interface IGenAIFoundObjects {
    /**
     * List of found objects.
     */
    objects: ISemanticSearchResultItem[];
    /**
     * Assistant reasoning on how the objects were matched.
     */
    reasoning: string;
}
/**
 * A list of created visualizations for a given interaction
 * @internal
 */
export interface IGenAICreatedVisualizations {
    /**
     * List of created visualizations.
     */
    objects?: IGenAIVisualization[];
    /**
     * Assistant reasoning on how the visualizations were created.
     */
    reasoning: string;
    /**
     * Assistant suggestions for the visualizations.
     */
    suggestions?: IGenAISuggestion[];
}
/**
 * Change analysis parameters for a given interaction
 * @internal
 */
export interface IGenAIChangeAnalysisParams {
    /**
     * Measure definition to analyze
     */
    measure: IMeasure;
    /**
     * Date attribute definition
     */
    dateAttribute: IAttribute;
    /**
     * Date attribute granularity
     */
    dateGranularity: DateAttributeGranularity;
    /**
     * Attributes to apply
     */
    attributes: IAttribute[];
    /**
     * Reference period
     */
    referencePeriod: string;
    /**
     * Reference period normalized to ISO string
     */
    normalizedReferencePeriod: string;
    /**
     * Analyzed period
     */
    analyzedPeriod: string;
    /**
     * Analyzed period normalized to ISO string
     */
    normalizedAnalyzedPeriod: string;
    /**
     * Filters to apply
     */
    filters: IFilter[];
}
//# sourceMappingURL=chat.d.ts.map