import { Schema } from '@coveo/bueno'; import { type EngineConfiguration } from '../engine-configuration.js'; /** * The insight engine configuration. */ export interface InsightEngineConfiguration extends EngineConfiguration { /** * Specifies the unique identifier of the target insight configuration. */ insightId: string; /** * Specifies the configuration for the insight search. */ search?: InsightEngineSearchConfigurationOptions; } /** * The insight engine search configuration options. */ export interface InsightEngineSearchConfigurationOptions { /** * The locale of the current user. Must comply with IETF’s BCP 47 definition: https://www.rfc-editor.org/rfc/bcp/bcp47.txt. * * Notes: * Coveo Machine Learning models use this information to provide contextually relevant output. * Moreover, this information can be referred to in query expressions and QPL statements by using the $locale object. */ locale?: string; /** * The base URL to use to proxy Coveo insight requests (for example, `https://example.com/insight`). * * This is an advanced option that you only set if you proxy Coveo insight requests through your own * server. In most cases, you should not set this option. * * See [Headless proxy: Insight engine](https://docs.coveo.com/en/headless/latest/usage/proxy#insight-engine). */ proxyBaseUrl?: string; } export declare const insightEngineConfigurationSchema: Schema; /** * Creates a sample search engine configuration. * * @returns The sample search engine configuration. */ export declare function getSampleInsightEngineConfiguration(): InsightEngineConfiguration;