Interface DocumentSearchRequest

interface DocumentSearchRequest {
    documentIds?: string[];
    limit: number;
    query: string;
}

Properties

documentIds?: string[]

Restricts the search to these documents. Absent means every document in scope.

limit: number

How many passages to return. Briyah clamps it; hosts need not.

query: string

What to look for, in the agent's words. Never empty.