import * as z from "zod/v3"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; export type RetrieveParams = { /** * The query to search with when retrieving document chunks. */ query: string; /** * The maximum number of chunks to return. Defaults to 8. */ topK?: number | undefined; filter?: { [k: string]: any; } | undefined; /** * Reranks the chunks for semantic relevancy post cosine similarity. Will be slower but returns a subset of highly relevant chunks. Best for reducing hallucinations and improving accuracy for LLM generation. */ rerank?: boolean | undefined; /** * Maximum number of chunks to retrieve per document. Use this to increase the number of documents the final chunks are retrieved from. This feature is in beta and may change in the future. */ maxChunksPerDocument?: number | undefined; /** * The partition to scope a retrieval to. If omitted, the retrieval will be scoped to the default partition, which includes any documents that have not been created in a partition. */ partition?: string | undefined; /** * Enables recency bias which will favor more recent documents vs older documents. https://docs.ragie.ai/docs/retrievals-recency-bias */ recencyBias?: boolean | undefined; }; /** @internal */ export declare const RetrieveParams$inboundSchema: z.ZodType; /** @internal */ export type RetrieveParams$Outbound = { query: string; top_k: number; filter?: { [k: string]: any; } | undefined; rerank: boolean; max_chunks_per_document?: number | undefined; partition?: string | undefined; recency_bias: boolean; }; /** @internal */ export declare const RetrieveParams$outboundSchema: z.ZodType; export declare function retrieveParamsToJSON(retrieveParams: RetrieveParams): string; export declare function retrieveParamsFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=retrieveparams.d.ts.map