@docsearch/react 4.5.0-beta.2 → 4.5.0

package/dist/esm/index.d.ts

@@ -177,8 +177,9 @@ type AskAiSearchParameters = {
     filters?: string;
     attributesToRetrieve?: string[];
     restrictSearchableAttributes?: string[];
-    distinct?: boolean;
+    distinct?: boolean | number | string;
 };
+type AgentStudioSearchParameters = Record<string, Omit<AskAiSearchParameters, 'facetFilters'>>;
 type DocSearchAskAi = {
     /**
      * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
@@ -199,10 +200,6 @@ type DocSearchAskAi = {
      * The assistant ID to use for the ask AI feature.
      */
     assistantId: string;
-    /**
-     * The search parameters to use for the ask AI feature.
-     */
-    searchParameters?: AskAiSearchParameters;
     /**
      * Enables displaying suggested questions on Ask AI's new conversation screen.
      *
@@ -210,7 +207,39 @@ type DocSearchAskAi = {
      */
     suggestedQuestions?: boolean;
     useStagingEnv?: boolean;
-};
+} & ({
+    /**
+     * **Experimental:** Whether to use Agent Studio as the chat backend.
+     *
+     * This is an experimental feature and its API may change without notice in future releases.
+     * Use with caution in production environments.
+     *
+     * @default false
+     */
+    agentStudio?: never;
+    /**
+     * The search parameters to use for the ask AI feature.
+     *
+     * **NOTE**: If using `agentStudio = true`, the `searchParameters` object is
+     * keyed by the index name.
+     */
+    searchParameters?: AskAiSearchParameters;
+} | {
+    agentStudio: false;
+    searchParameters?: AskAiSearchParameters;
+} | {
+    agentStudio: true;
+    /**
+     * The search parameters to use for the ask AI feature.
+     * Keyed by the index name.
+     *
+     * @example
+     * {
+     *   "INDEX_NAME": { distinct: false }
+     * }
+     */
+    searchParameters?: AgentStudioSearchParameters;
+});
 interface DocSearchIndex {
     name: string;
     searchParameters?: SearchParamsObject;
@@ -247,15 +276,6 @@ interface DocSearchProps {
      * Useful to route Ask AI into a different UI (e.g. `@docsearch/sidepanel-js`) without flicker.
      */
     interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
-    /**
-     * **Experimental:** Whether to use Agent Studio as the chat backend.
-     *
-     * This is an experimental feature and its API may change without notice in future releases.
-     * Use with caution in production environments.
-     *
-     * @default false
-     */
-    agentStudio?: boolean;
     /**
      * Theme overrides applied to the modal and related components.
      */
@@ -506,7 +526,7 @@ type DocSearchModalProps = DocSearchProps & {
     translations?: ModalTranslations;
     isHybridModeSupported?: boolean;
 };
-declare function DocSearchModal({ appId, apiKey, askAi, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, interceptAskAiEvent, isAskAiActive, recentSearchesLimit, recentSearchesWithFavoritesLimit, indices, indexName, searchParameters, isHybridModeSupported, agentStudio, ...props }: DocSearchModalProps): JSX.Element;
+declare function DocSearchModal({ appId, apiKey, askAi, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, interceptAskAiEvent, isAskAiActive, recentSearchesLimit, recentSearchesWithFavoritesLimit, indices, indexName, searchParameters, isHybridModeSupported, ...props }: DocSearchModalProps): JSX.Element;
 
 interface UseDocSearchKeyboardEventsProps {
     isOpen: boolean;
@@ -530,7 +550,7 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, isAskAiActive, onAskAiToggle, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.5.0-beta.2";
+declare const version = "4.5.0";
 
 export { DocSearch, DocSearchButton, DocSearchInner, DocSearchModal, useDocSearchKeyboardEvents, version };
-export type { AskAiSearchParameters, ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchIndex, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, KeyboardShortcuts, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, SuggestedQuestion, SuggestedQuestionHit, UseDocSearchKeyboardEventsProps };
+export type { AgentStudioSearchParameters, AskAiSearchParameters, ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchIndex, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, KeyboardShortcuts, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, SuggestedQuestion, SuggestedQuestionHit, UseDocSearchKeyboardEventsProps };