@docsearch/react 4.5.0-beta.0 → 4.5.0-beta.1

package/dist/esm/DocSearchModal.d.ts

@@ -127,7 +127,7 @@ type DocSearchAskAi = {
     /**
      * The assistant ID to use for the ask AI feature.
      */
-    assistantId: string | null;
+    assistantId: string;
     /**
      * The search parameters to use for the ask AI feature.
      */
@@ -175,13 +175,16 @@ interface DocSearchProps {
      * Return `true` to prevent the default modal Ask AI flow (no toggle, no sendMessage).
      * Useful to route Ask AI into a different UI (e.g. `@docsearch/sidepanel-js`) without flicker.
      */
+    interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
     /**
-     * Intercept Ask AI events (prompt submit, suggested question selection, etc).
+     * **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.
      *
-     * Return `true` to prevent *all* default Ask AI behavior that would normally follow
-     * (no toggle, no sendMessage, no internal Ask AI state updates).
+     * @default false
      */
-    interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
+    agentStudio?: boolean;
     /**
      * Theme overrides applied to the modal and related components.
      */
@@ -419,7 +422,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, ...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, agentStudio, ...props }: DocSearchModalProps): JSX.Element;
 
 export { DocSearchModal };
 export type { DocSearchModalProps, ModalTranslations };