/** Public and internal retrieval data types. @module dsh-tool-retriever/retrieval/types */

/** Stable field names used by BM25F and score explanations. */
export type ToolDocumentField = 'name' | 'description' | 'parameterName' | 'parameterDescription'

/** Deterministic searchable projection of one DSH Tool Schema. */
export interface ToolDocument {
  name: string
  normalizedName: string
  description: string
  fields: Record<ToolDocumentField, string[]>
}

/** One ranked candidate returned by the retrieval core and `tool_search`. */
export interface ToolSearchHit {
  name: string
  description: string
  rank: number
  score: number
  exact: boolean
  bm25: number
  matchedFields: ToolDocumentField[]
}

/** Canonical value returned by the `tool_search` DSH tool. */
export interface ToolSearchOutput {
  query: string
  catalogSize: number
  results: ToolSearchHit[]
}