@docsearch/react 4.6.3 → 4.7.0

package/dist/esm/index.d.ts

@@ -183,7 +183,7 @@ type ExchangeWithOptionalAssistant = {
  */
 declare function filterExchangesForThreadDepthError<T extends ExchangeWithOptionalAssistant>(exchanges: T[], _hasThreadDepthError: boolean): T[];
 /**
- * Whether the error is thread depth exceeded (AI-217), including JSON-shaped Agent Studio payloads.
+ * Whether the error is conversation depth exceeded (AI-217), including JSON-shaped Agent Studio payloads.
  */
 declare function isThreadDepthError(error?: Error): boolean;
 /**
@@ -259,7 +259,7 @@ declare function resolveAgentStudioPromptBlocking(error: Error): {
 };
 /**
  * Plain-text matchers over `Error.message.toLowerCase()` (callers pass `error.message.toLowerCase()`).
- * Thread depth: first entry mirrors common plain cases; JSON-shaped payloads still need `isThreadDepthError` in `ai.ts`.
+ * Conversation depth / AI-217: first entry mirrors common plain cases; JSON-shaped payloads still need `isThreadDepthError` in `ai.ts`.
  *
  * Blocking UX and “Start new conversation” visibility are driven by `agentStudioPromptBlockingMatchers`.
  */
@@ -370,6 +370,8 @@ interface DocSearchProps {
     indices?: Array<DocSearchIndex | string>;
     /**
      * Configuration or assistant id to enable ask ai mode. Pass a string assistant id or a full config object.
+     *
+     * @deprecated Ask AI is being migrated from a standalone DocSearch feature into Algolia's Agent Studio. The `askAi` prop will be removed in DocSearch v5.
      */
     askAi?: DocSearchAskAi | string;
     /**
@@ -649,7 +651,7 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, isAskAiActive, onAskAiToggle, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.6.3";
+declare const version = "4.7.0";
 
 export { AGENT_STUDIO_PROMPT_BLOCKING_CODES, DocSearch, DocSearchButton, DocSearchInner, DocSearchModal, agentStudioPromptBlockingMatchers, extractAgentStudioErrorFieldMessage, extractAiErrorCodeFromMessage, filterExchangesForThreadDepthError, getAskAiBlockingBannerMessage, getAskAiPromptBlockingUserFacingMessage, getThreadDepthErrorUserFacingMessage, isAgentStudioTokenOutputLimitError, isAskAiPromptBlockingError, isThreadDepthError, matchesAgentStudioContextOrTokenLimitsPlainMessage, matchesAgentStudioMaxStepsMessage, matchesAgentStudioRateLimitMessage, matchesAgentStudioTokenOutputLimitPlainMessage, matchesAgentStudioWhitelistOrNotAllowedDomainPlainMessage, matchesRequestBlockedForThisDomainMessage, matchesThreadDepthLimitError, newConversationErrorMatchers, readAgentStudioJsonStringField, resolveAgentStudioPromptBlocking, showAskAiBlockingBannerNewConversationLink, useDocSearchKeyboardEvents, version };
 export type { AgentStudioBlockingMatchContext, AgentStudioPromptBlockingMatcher, AgentStudioSearchParameters, AskAiSearchParameters, ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchIndex, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, KeyboardShortcuts, ModalTranslations, NewConversationErrorMatcher, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, SuggestedQuestion, SuggestedQuestionHit, UseDocSearchKeyboardEventsProps };