@docsearch/react 4.7.0 → 5.0.0-beta.1

package/dist/esm/askaiModal.js

@@ -0,0 +1,3 @@
+import { t as DocSearchAskAiModal } from "./DocSearchAskAiModal-KaA6fBV4.js";
+
+export { DocSearchAskAiModal };

package/dist/esm/button.d.ts

@@ -0,0 +1,2 @@
+import { n as DocSearchButton, r as DocSearchButtonProps, t as ButtonTranslations } from "./DocSearchButton-CZM_jACU.js";
+export { ButtonTranslations, DocSearchButton, DocSearchButtonProps };

package/dist/esm/button.js

@@ -0,0 +1,3 @@
+import { t as DocSearchButton } from "./DocSearchButton-CaxxOzQU.js";
+
+export { DocSearchButton };

package/dist/esm/docsearchAi.d.ts

@@ -0,0 +1,220 @@
+import { o as ToolCalls } from "./index-Bqqv4HmN.js";
+import { a as DocSearchProps } from "./DocSearch-HJsNvtZr.js";
+import { DocSearchRef, InitialAskAiMessage } from "@docsearch/core";
+import React, { JSX } from "react";
+import { SearchParamsObject } from "algoliasearch/lite";
+//#region src/DocSearchAI.d.ts
+interface AskAiSearchParameters {
+  facetFilters?: string[];
+  filters?: string;
+  attributesToRetrieve?: string[];
+  restrictSearchableAttributes?: string[];
+  distinct?: boolean | number | string;
+}
+type AgentStudioSearchParameters = Record<string, Omit<AskAiSearchParameters, 'facetFilters'>>;
+interface IndexTextParam {
+  exposed: boolean;
+  default?: string;
+}
+interface NumberConstraint {
+  min?: number;
+  max?: number;
+}
+interface IndexNumberParam {
+  exposed: boolean;
+  default?: number;
+  constraint?: NumberConstraint;
+}
+interface StringArrayConstraints {
+  values?: string[];
+}
+interface IndexStringArrayParam {
+  exposed: boolean;
+  default?: string[];
+  constraint?: StringArrayConstraints;
+  merge?: boolean;
+}
+interface IndexFacetParam {
+  exposed: false;
+  default?: string[];
+}
+interface AgentStudioSearchControls {
+  /**
+   * Augmented query for the MCP search tool to use.
+   *
+   * @default undefined
+   */
+  query?: IndexTextParam;
+  /**
+   * Number of hits for the MCP to return per page.
+   *
+   * @default { exposed: false, default: 7 }
+   */
+  hits_per_page?: IndexNumberParam;
+  /**
+   * The page number the MCP should pull results from.
+   *
+   * @default { exposed: false, default: 0 }
+   */
+  page?: IndexNumberParam;
+  /**
+   * List of attributes that the MCP can retrieve from the index.
+   *
+   * @default { exposed: false, default: ['*'] }
+   */
+  attributesToRetrieve?: IndexStringArrayParam;
+  /**
+   * List of fields that the MCP will return to the Agent.
+   *
+   * @default { exposed: false, default: ["hits", "nbHits", "page", "nbPages", "hitsPerPage", "facets"] }
+   */
+  responseFields?: IndexStringArrayParam;
+  /**
+   * Defined facets the MCP will use when querying the index.
+   *
+   * @default undefined
+   */
+  facets?: IndexFacetParam;
+  /**
+   * Any other custom properties the MCP should send when querying the index.
+   *
+   * @default undefined
+   */
+  custom?: Record<string, unknown>;
+}
+interface AgentStudioIndices {
+  /** The name of the index used by the search tool. */
+  index: string;
+  /** A brief description for the search tool. */
+  description: string;
+  /**
+   * A description used to steer the agent on how/when to use the search tool.
+   *
+   * @default ''
+   */
+  enhancedDescription?: string;
+  /**
+   * Default search parameters for the internal (non-MCP) search tool path.
+   *
+   * @default undefined
+   */
+  searchParameters?: SearchParamsObject;
+  /**
+   * Structured search parameters for the MCP-based search tool path.
+   *
+   * Each parameter controls whether it is exposed to the LLM and it's default
+   * value.
+   *
+   * @default undefined
+   */
+  searchControls?: AgentStudioSearchControls;
+}
+interface Memory {
+  /**
+   * Determines whether or not to display the memory based tool calls.
+   *
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * The JWT used by the agent to know which user's memory to read.
+   *
+   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/user-authentication
+   */
+  userToken?: string;
+}
+interface PromptSuggestions {
+  /** The name of the index where the prompt suggestions are stored. */
+  indexName: string;
+  /**
+   * The number of prompt suggestions that are retrieved and displayed.
+   *
+   * @default 3
+   */
+  hitsPerPage?: number;
+}
+interface DocSearchAskAi {
+  /**
+   * The index name to use for the Ask AI feature. Your assistant will search
+   * for relevant documents. If not provided, the root index name will be used.
+   */
+  indexName?: string;
+  /**
+   * The API key to use for the ask AI feature. Your assistant will use this API
+   * key to search the index. If not provided, the API key will be used.
+   */
+  apiKey?: string;
+  /**
+   * The app ID to use for the ask AI feature. Your assistant will use this app
+   * ID to search the index. If not provided, the app ID will be used.
+   */
+  appId?: string;
+  /** The assistant ID to use for the ask AI feature. */
+  assistantId: string;
+  /**
+   * Enables displaying suggested questions on Ask AI's new conversation screen.
+   *
+   * @default false
+   */
+  suggestedQuestions?: boolean;
+  /**
+   * The search parameters to use for the ask AI feature. Keyed by the index
+   * name.
+   *
+   * @example
+   *   {
+   *   "INDEX_NAME": { distinct: false }
+   *   }
+   */
+  searchParameters?: AgentStudioSearchParameters;
+  /** List of dynamic indices for the Agent Studio search tool to use. */
+  indices?: AgentStudioIndices[];
+  /**
+   * Use custom tools driven by Agent Studio.
+   *
+   * For best performance, memoize this object with `useMemo` or define it
+   * outside the component. Inline object literals will be recreated every
+   * render but will not affect correctness.
+   */
+  tools?: ToolCalls;
+  /**
+   * Configuration for the Agent Studio memory feature.
+   *
+   * @example
+   *   { enabled: true, userToken: '{{SERVER_GENERATED_JWT_TOKEN}}' }
+   *
+   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/memory/overview
+   */
+  memory?: Memory;
+  /**
+   * Enables and configures prompt suggestions that are displayed during keyword
+   * search.
+   *
+   * @example
+   *   { indexName: 'docsearch-markdown_prompt_suggestions', hitsPerPage: 1 }
+   *
+   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/integration#prompt-suggestions
+   */
+  promptSuggestions?: PromptSuggestions;
+}
+interface DocSearchAIProps extends DocSearchProps {
+  /**
+   * Configuration or assistant id to enable ask ai mode. Pass a string
+   * assistant id or a full config object.
+   */
+  askAi: DocSearchAskAi | string;
+  /**
+   * Intercept Ask AI requests (e.g. Submitting a prompt or selecting a
+   * suggested question).
+   *
+   * 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;
+}
+declare const DocSearchAI: React.ForwardRefExoticComponent<DocSearchAIProps & React.RefAttributes<DocSearchRef>>;
+declare function DocSearchAIInner(props: DocSearchAIProps): JSX.Element;
+//#endregion
+export { AgentStudioIndices, AgentStudioSearchControls, AgentStudioSearchParameters, AskAiSearchParameters, DocSearchAI, DocSearchAIInner, DocSearchAIProps, DocSearchAskAi, Memory, PromptSuggestions, type ToolCalls };
+//# sourceMappingURL=docsearchAi.d.ts.map

package/dist/esm/docsearchAi.js

@@ -0,0 +1,34 @@
+import { t as _objectSpread2 } from "./objectSpread2-BNmiQYyW.js";
+import { t as DocSearchButton } from "./DocSearchButton-CaxxOzQU.js";
+import { t as DocSearchAskAiModal } from "./DocSearchAskAiModal-KaA6fBV4.js";
+import { DocSearch, useDocSearch } from "@docsearch/core";
+import React from "react";
+import { createPortal } from "react-dom";
+
+//#region src/DocSearchAI.tsx
+function DocSearchAIComponent(props, ref) {
+	return /* @__PURE__ */ React.createElement(DocSearch, _objectSpread2(_objectSpread2({}, props), {}, { ref }), /* @__PURE__ */ React.createElement(DocSearchAIInner, props));
+}
+const DocSearchAI = React.forwardRef(DocSearchAIComponent);
+function DocSearchAIInner(props) {
+	var _props$translations, _props$translations2, _props$portalContaine;
+	const { searchButtonRef, keyboardShortcuts, isModalActive, isAskAiActive, initialQuery, onAskAiToggle, openModal, closeModal, isHybridModeSupported } = useDocSearch();
+	return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(DocSearchButton, {
+		keyboardShortcuts,
+		ref: searchButtonRef,
+		translations: (_props$translations = props.translations) === null || _props$translations === void 0 ? void 0 : _props$translations.button,
+		onClick: openModal
+	}), isModalActive && createPortal(/* @__PURE__ */ React.createElement(DocSearchAskAiModal, _objectSpread2(_objectSpread2({}, props), {}, {
+		initialScrollY: window.scrollY,
+		initialQuery,
+		translations: props === null || props === void 0 || (_props$translations2 = props.translations) === null || _props$translations2 === void 0 ? void 0 : _props$translations2.modal,
+		isAskAiActive,
+		isHybridModeSupported,
+		onAskAiToggle,
+		onClose: closeModal
+	})), (_props$portalContaine = props.portalContainer) !== null && _props$portalContaine !== void 0 ? _props$portalContaine : document.body));
+}
+
+//#endregion
+export { DocSearchAI, DocSearchAIInner };
+//# sourceMappingURL=docsearchAi.js.map

package/dist/esm/docsearchAi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsearchAi.js","names":["DocSearchProvider"],"sources":["../../src/DocSearchAI.tsx"],"sourcesContent":["import { DocSearch as DocSearchProvider, useDocSearch } from '@docsearch/core';\nimport type { DocSearchRef, InitialAskAiMessage } from '@docsearch/core';\nimport type { SearchParamsObject } from 'algoliasearch/lite';\nimport React, { type JSX } from 'react';\nimport { createPortal } from 'react-dom';\n\nimport type { DocSearchProps } from './DocSearch';\nimport { DocSearchAskAiModal } from './DocSearchAskAiModal';\nimport { DocSearchButton } from './DocSearchButton';\nimport type { ToolCalls } from './types/AskiAi';\n\nexport interface AskAiSearchParameters {\n  facetFilters?: string[];\n  filters?: string;\n  attributesToRetrieve?: string[];\n  restrictSearchableAttributes?: string[];\n  distinct?: boolean | number | string;\n}\n\nexport type AgentStudioSearchParameters = Record<\n  string,\n  Omit<AskAiSearchParameters, 'facetFilters'>\n>;\n\ninterface IndexTextParam {\n  exposed: boolean;\n  default?: string;\n}\n\ninterface NumberConstraint {\n  min?: number;\n  max?: number;\n}\n\ninterface IndexNumberParam {\n  exposed: boolean;\n  default?: number;\n  constraint?: NumberConstraint;\n}\n\ninterface StringArrayConstraints {\n  values?: string[];\n}\n\ninterface IndexStringArrayParam {\n  exposed: boolean;\n  default?: string[];\n  constraint?: StringArrayConstraints;\n  merge?: boolean;\n}\n\ninterface IndexFacetParam {\n  exposed: false;\n  default?: string[];\n}\n\nexport interface AgentStudioSearchControls {\n  /**\n   * Augmented query for the MCP search tool to use.\n   *\n   * @default undefined\n   */\n  query?: IndexTextParam;\n  /**\n   * Number of hits for the MCP to return per page.\n   *\n   * @default { exposed: false, default: 7 }\n   */\n  hits_per_page?: IndexNumberParam;\n  /**\n   * The page number the MCP should pull results from.\n   *\n   * @default { exposed: false, default: 0 }\n   */\n  page?: IndexNumberParam;\n  /**\n   * List of attributes that the MCP can retrieve from the index.\n   *\n   * @default { exposed: false, default: ['*'] }\n   */\n  attributesToRetrieve?: IndexStringArrayParam;\n  /**\n   * List of fields that the MCP will return to the Agent.\n   *\n   * @default { exposed: false, default: [\"hits\", \"nbHits\", \"page\", \"nbPages\", \"hitsPerPage\", \"facets\"] }\n   */\n  responseFields?: IndexStringArrayParam;\n  /**\n   * Defined facets the MCP will use when querying the index.\n   *\n   * @default undefined\n   */\n  facets?: IndexFacetParam;\n  /**\n   * Any other custom properties the MCP should send when querying the index.\n   *\n   * @default undefined\n   */\n  custom?: Record<string, unknown>;\n}\n\nexport interface AgentStudioIndices {\n  /** The name of the index used by the search tool. */\n  index: string;\n  /** A brief description for the search tool. */\n  description: string;\n  /**\n   * A description used to steer the agent on how/when to use the search tool.\n   *\n   * @default ''\n   */\n  enhancedDescription?: string;\n  /**\n   * Default search parameters for the internal (non-MCP) search tool path.\n   *\n   * @default undefined\n   */\n  searchParameters?: SearchParamsObject;\n  /**\n   * Structured search parameters for the MCP-based search tool path.\n   *\n   * Each parameter controls whether it is exposed to the LLM and it's default\n   * value.\n   *\n   * @default undefined\n   */\n  searchControls?: AgentStudioSearchControls;\n}\n\nexport interface Memory {\n  /**\n   * Determines whether or not to display the memory based tool calls.\n   *\n   * @default false\n   */\n  enabled?: boolean;\n  /**\n   * The JWT used by the agent to know which user's memory to read.\n   *\n   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/user-authentication\n   */\n  userToken?: string;\n}\n\nexport interface PromptSuggestions {\n  /** The name of the index where the prompt suggestions are stored. */\n  indexName: string;\n  /**\n   * The number of prompt suggestions that are retrieved and displayed.\n   *\n   * @default 3\n   */\n  hitsPerPage?: number;\n}\n\nexport interface DocSearchAskAi {\n  /**\n   * The index name to use for the Ask AI feature. Your assistant will search\n   * for relevant documents. If not provided, the root index name will be used.\n   */\n  indexName?: string;\n  /**\n   * The API key to use for the ask AI feature. Your assistant will use this API\n   * key to search the index. If not provided, the API key will be used.\n   */\n  apiKey?: string;\n  /**\n   * The app ID to use for the ask AI feature. Your assistant will use this app\n   * ID to search the index. If not provided, the app ID will be used.\n   */\n  appId?: string;\n  /** The assistant ID to use for the ask AI feature. */\n  assistantId: string;\n  /**\n   * Enables displaying suggested questions on Ask AI's new conversation screen.\n   *\n   * @default false\n   */\n  suggestedQuestions?: boolean;\n  /**\n   * The search parameters to use for the ask AI feature. Keyed by the index\n   * name.\n   *\n   * @example\n   *   {\n   *   \"INDEX_NAME\": { distinct: false }\n   *   }\n   */\n  searchParameters?: AgentStudioSearchParameters;\n  /** List of dynamic indices for the Agent Studio search tool to use. */\n  indices?: AgentStudioIndices[];\n  /**\n   * Use custom tools driven by Agent Studio.\n   *\n   * For best performance, memoize this object with `useMemo` or define it\n   * outside the component. Inline object literals will be recreated every\n   * render but will not affect correctness.\n   */\n  tools?: ToolCalls;\n  /**\n   * Configuration for the Agent Studio memory feature.\n   *\n   * @example\n   *   { enabled: true, userToken: '{{SERVER_GENERATED_JWT_TOKEN}}' }\n   *\n   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/memory/overview\n   */\n  memory?: Memory;\n  /**\n   * Enables and configures prompt suggestions that are displayed during keyword\n   * search.\n   *\n   * @example\n   *   { indexName: 'docsearch-markdown_prompt_suggestions', hitsPerPage: 1 }\n   *\n   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/integration#prompt-suggestions\n   */\n  promptSuggestions?: PromptSuggestions;\n}\n\nexport interface DocSearchAIProps extends DocSearchProps {\n  /**\n   * Configuration or assistant id to enable ask ai mode. Pass a string\n   * assistant id or a full config object.\n   */\n  askAi: DocSearchAskAi | string;\n  /**\n   * Intercept Ask AI requests (e.g. Submitting a prompt or selecting a\n   * suggested question).\n   *\n   * Return `true` to prevent the default modal Ask AI flow (no toggle, no\n   * sendMessage). Useful to route Ask AI into a different UI (e.g.\n   * `@docsearch/sidepanel-js`) without flicker.\n   */\n  interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;\n}\n\nfunction DocSearchAIComponent(\n  props: DocSearchAIProps,\n  ref: React.ForwardedRef<DocSearchRef>\n): JSX.Element {\n  return (\n    <DocSearchProvider {...props} ref={ref}>\n      <DocSearchAIInner {...props} />\n    </DocSearchProvider>\n  );\n}\n\nexport const DocSearchAI = React.forwardRef(DocSearchAIComponent);\n\nexport function DocSearchAIInner(props: DocSearchAIProps): JSX.Element {\n  const {\n    searchButtonRef,\n    keyboardShortcuts,\n    isModalActive,\n    isAskAiActive,\n    initialQuery,\n    onAskAiToggle,\n    openModal,\n    closeModal,\n    isHybridModeSupported,\n  } = useDocSearch();\n\n  return (\n    <>\n      <DocSearchButton\n        keyboardShortcuts={keyboardShortcuts}\n        ref={searchButtonRef}\n        translations={props.translations?.button}\n        onClick={openModal}\n      />\n      {isModalActive &&\n        createPortal(\n          <DocSearchAskAiModal\n            {...props}\n            initialScrollY={window.scrollY}\n            initialQuery={initialQuery}\n            translations={props?.translations?.modal}\n            isAskAiActive={isAskAiActive}\n            isHybridModeSupported={isHybridModeSupported}\n            onAskAiToggle={onAskAiToggle}\n            onClose={closeModal}\n          />,\n          props.portalContainer ?? document.body\n        )}\n    </>\n  );\n}\n\nexport type { ToolCalls } from './types/AskiAi';\n"],"mappings":";;;;;;;;AA6OA,SAAS,qBACP,OACA,KACa;CACb,OACE,oCAACA,6CAAsB,cAAY,KAEhB,GADjB,oCAAC,kBAAqB,KAAQ,CACb;AAEvB;AAEA,MAAa,cAAc,MAAM,WAAW,oBAAoB;AAEhE,SAAgB,iBAAiB,OAAsC;;CACrE,MAAM,EACJ,iBACA,mBACA,eACA,eACA,cACA,eACA,WACA,YACA,0BACE,aAAa;CAEjB,OACE,0DACE,oCAAC,iBAAD;EACqB;EACnB,KAAK;EACL,qCAAc,MAAM,wFAAc;EAClC,SAAS;CACV,IACA,iBACC,aACE,oCAAC,uDACK;EACJ,gBAAgB,OAAO;EACT;EACd,4EAAc,MAAO,0FAAc;EACpB;EACQ;EACR;EACf,SAAS;EACV,6BACD,MAAM,wFAAmB,SAAS,IACpC,CACF;AAEN"}

package/dist/esm/index-Bqqv4HmN.d.ts

@@ -0,0 +1,233 @@
+import { AutocompleteContext, AutocompleteInsightsApi, AutocompleteState, BaseItem } from "@algolia/autocomplete-core";
+import { Hit } from "algoliasearch/lite";
+import { UIMessage } from "@ai-sdk/react";
+import "ai";
+//#region src/types/DocSearchHit.d.ts
+type ContentType = 'askAI' | 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
+interface DocSearchHitAttributeHighlightResult {
+  value: string;
+  matchLevel: 'full' | 'none' | 'partial';
+  matchedWords: string[];
+  fullyHighlighted?: boolean;
+}
+interface DocSearchHitHighlightResultHierarchy {
+  lvl0: DocSearchHitAttributeHighlightResult;
+  lvl1: DocSearchHitAttributeHighlightResult;
+  lvl2: DocSearchHitAttributeHighlightResult;
+  lvl3: DocSearchHitAttributeHighlightResult;
+  lvl4: DocSearchHitAttributeHighlightResult;
+  lvl5: DocSearchHitAttributeHighlightResult;
+  lvl6: DocSearchHitAttributeHighlightResult;
+}
+interface DocSearchHitHighlightResult {
+  content: DocSearchHitAttributeHighlightResult;
+  hierarchy: DocSearchHitHighlightResultHierarchy;
+  hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
+}
+interface DocSearchHitAttributeSnippetResult {
+  value: string;
+  matchLevel: 'full' | 'none' | 'partial';
+}
+interface DocSearchHitSnippetResult {
+  content: DocSearchHitAttributeSnippetResult;
+  hierarchy: DocSearchHitHighlightResultHierarchy;
+  hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
+}
+declare type DocSearchHit = {
+  objectID: string;
+  content: string | null;
+  query?: string;
+  url: string;
+  url_without_anchor: string;
+  type: ContentType;
+  anchor: string | null;
+  hierarchy: {
+    lvl0: string;
+    lvl1: string;
+    lvl2: string | null;
+    lvl3: string | null;
+    lvl4: string | null;
+    lvl5: string | null;
+    lvl6: string | null;
+  };
+  _highlightResult: DocSearchHitHighlightResult;
+  _snippetResult: DocSearchHitSnippetResult;
+  _rankingInfo?: {
+    promoted: boolean;
+    nbTypos: number;
+    firstMatchedWord: number;
+    proximityDistance?: number;
+    geoDistance: number;
+    geoPrecision?: number;
+    nbExactWords: number;
+    words: number;
+    filters: number;
+    userScore: number;
+    matchedGeoLocation?: {
+      lat: number;
+      lng: number;
+      distance: number;
+    };
+  };
+  _distinctSeqID?: number;
+  __autocomplete_indexName?: string;
+  __autocomplete_queryID?: string;
+  __autocomplete_algoliaCredentials?: {
+    appId: string;
+    apiKey: string;
+  };
+  __autocomplete_id?: number;
+};
+//#endregion
+//#region src/types/DocSearchState.d.ts
+interface DocSearchContext extends AutocompleteContext {
+  algoliaInsightsPlugin?: {
+    insights: AutocompleteInsightsApi;
+  };
+}
+interface DocSearchState<TItem extends BaseItem> extends AutocompleteState<TItem> {
+  context: DocSearchContext;
+}
+//#endregion
+//#region src/types/Feedback.d.ts
+/**
+ * Categories a user can select when submitting negative (thumbs down) feedback
+ * on an AI chat message.
+ */
+type AskAiFeedbackReason = 'incorrect' | 'not_what_i_asked' | 'other' | 'safety_or_legal' | 'slow_or_buggy' | 'style_or_tone';
+/**
+ * Payload sent when a user submits feedback on an AI chat message. `tags` and
+ * `notes` are only present for negative feedback.
+ */
+type AskAiFeedbackPayload = {
+  /** 1 for a thumbs up, 0 for a thumbs down. */
+  thumbs: 0 | 1;
+  /** Optional reason categories, only collected for negative feedback. */
+  tags?: AskAiFeedbackReason[];
+  /** Optional free-text note, only collected for negative feedback. */
+  notes?: string;
+};
+/** Callback invoked when a user submits feedback on an AI chat message. */
+type OnAskAiFeedback = (messageId: string, feedback: AskAiFeedbackPayload) => Promise<void>;
+//#endregion
+//#region src/types/AskiAi.d.ts
+interface CustomTool {
+  input: unknown;
+  output: unknown;
+}
+interface SearchIndexTool {
+  input: {
+    query: string;
+  };
+  output: {
+    query?: string;
+    hits?: any[];
+  };
+}
+interface MCPSearchToolQuery {
+  query: string;
+  [key: string]: unknown;
+}
+interface MCPSearchToolInputV1 {
+  query: string;
+  index: string;
+  number_of_results?: number;
+  facet_filters?: string[];
+}
+interface MCPSearchToolInputV2 {
+  queries: MCPSearchToolQuery[];
+  clickAnalytics: boolean;
+  originalQuery: string;
+}
+interface AlgoliaMCPSearchTool {
+  input: MCPSearchToolInputV1 | MCPSearchToolInputV2;
+  output: {
+    hits?: unknown[];
+    nbHits?: number;
+    queryId?: string;
+  } | undefined;
+}
+interface MemoryTool {
+  input: unknown;
+  output: unknown;
+}
+type ToolDefinition = {
+  /**
+   * Use the tool's input and output to build a string output for the tool
+   * result.
+   */
+  render: (params: {
+    message: {
+      input: unknown;
+      output: unknown;
+    };
+  }) => string;
+  /**
+   * Optional callback function that is invoked when a tool call is received.
+   * You must call addToolOutput to provide the tool result.
+   */
+  onToolCall?: (params: {
+    input: unknown;
+    addToolOutput: (props: {
+      output: unknown;
+    }) => Promise<void>;
+    toolCallId: string;
+    toolName: string;
+    dynamic?: boolean;
+  }) => Promise<void> | void;
+  translations?: Partial<{
+    /** The text displayed before tool call output is available. */
+    callingToolText: string;
+  }>;
+};
+type ToolCalls = Record<string, ToolDefinition>;
+type AgentStudioMemoryTools = {
+  algolia_ponder: MemoryTool;
+  algolia_memorize: MemoryTool;
+  algolia_memory_search: MemoryTool;
+};
+type SearchTools = { [K in `algolia_search_index_${string}`]: AlgoliaMCPSearchTool; } & {
+  algolia_search_index: AlgoliaMCPSearchTool;
+  searchIndex: SearchIndexTool;
+};
+type CustomTools = { [K in string as K extends keyof SearchTools | `algolia_search_index_${string}` ? never : K]: CustomTool; };
+type Tools = AgentStudioMemoryTools & CustomTools & SearchTools;
+type DataParts = {
+  suggestions: {
+    suggestions: string[];
+  };
+};
+type AIMessage = UIMessage<{
+  stopped?: boolean;
+}, DataParts, Tools>;
+//#endregion
+//#region src/types/StoredDocSearchHit.d.ts
+type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;
+type StoredAskAiMessage = AIMessage & {
+  /** Optional user feedback on this assistant message. */
+  feedback?: 'dislike' | 'like';
+  /** Optional reason categories submitted with negative feedback. */
+  feedbackTags?: AskAiFeedbackReason[];
+  /** Optional free-text note submitted with negative feedback. */
+  feedbackNotes?: string;
+};
+type StoredAskAiState = StoredDocSearchHit & {
+  chatId?: string;
+  stopped?: boolean;
+  messages?: StoredAskAiMessage[];
+};
+//#endregion
+//#region src/types/SuggestedQuestions.d.ts
+type SuggestedQuestion = {
+  appId: string;
+  assistantId: string;
+  question: string;
+  locale?: string;
+  state: 'published';
+  source: string;
+  order: number;
+};
+type SuggestedQuestionHit = Hit<SuggestedQuestion>;
+//#endregion
+export { StoredDocSearchHit as a, AskAiFeedbackReason as c, DocSearchHit as d, StoredAskAiState as i, OnAskAiFeedback as l, SuggestedQuestionHit as n, ToolCalls as o, StoredAskAiMessage as r, AskAiFeedbackPayload as s, SuggestedQuestion as t, DocSearchState as u };
+//# sourceMappingURL=index-Bqqv4HmN.d.ts.map