@hevmind/ask 0.1.0

package/src/types.ts

@@ -0,0 +1,99 @@
+export interface HevAskOptions {
+  /**
+   * Content collection name(s) to index and search over.
+   * @example ['docs']
+   */
+  collections?: string[];
+
+  /**
+   * Claude model used by the bounded search loop.
+   * @default 'claude-haiku-4-5'
+   */
+  model?: string;
+
+  /**
+   * The route the search endpoint is injected at.
+   * @default '/api/ask'
+   */
+  endpoint?: string;
+
+  /**
+   * Prefix used to turn a document slug into its page URL: `basePath + slug`.
+   * @default '/docs/'
+   */
+  basePath?: string;
+
+  /**
+   * Maximum number of source sections the AI answer may ground in and cite
+   * (also the size of the Sources footer). Keyword mode uses it as the result
+   * row cap.
+   * @default 6
+   */
+  maxResults?: number;
+
+  /**
+   * Token budget for the streamed AI answer.
+   * @default 1024
+   */
+  answerMaxTokens?: number;
+
+  /**
+   * Model used by the offline digest builder.
+   * @default 'claude-opus-4-8'
+   */
+  digestModel?: string;
+
+  /**
+   * Maximum search tool rounds the model can run before it must present results.
+   * @default 4
+   */
+  maxIterations?: number;
+
+  /**
+   * Highest Markdown heading level used as a chunk boundary.
+   * `2` chunks at `##`; `3` chunks at `##` and `###`.
+   * @default 3
+   */
+  chunkHeadingDepth?: number;
+
+  /**
+   * Chunks returned by each search tool call.
+   * @default 8
+   */
+  candidatePerSearch?: number;
+
+  /**
+   * Maximum chunks from the same document returned by one prefilter call.
+   * @default 2
+   */
+  perDocCap?: number;
+
+  /**
+   * Path to the committed ask digest artifact, relative to the site root.
+   * @default '.hev-ask/digest.json'
+   */
+  digestPath?: string;
+
+  /**
+   * Content globs used by the offline digest builder.
+   * Defaults to Markdown/MDX files under each configured collection directory.
+   */
+  digestContentGlobs?: string[];
+}
+
+/** The shape the integration serializes into `virtual:hev-ask/config`. */
+export interface ResolvedConfig {
+  collections: string[] | null;
+  model: string;
+  digestModel: string;
+  endpoint: string;
+  basePath: string;
+  maxResults: number;
+  answerMaxTokens: number;
+  maxIterations: number;
+  chunkHeadingDepth: number;
+  candidatePerSearch: number;
+  perDocCap: number;
+  digestPath: string;
+  digestContentGlobs?: string[];
+}