Base Retriever class. All indexes should extend this class.

Hierarchy

Properties

datastoreId: string
apiKey?: string
callbacks?: Callbacks
filter?: Record<string, unknown>
maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

metadata?: Record<string, unknown>
onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

tags?: string[]
topK?: number
verbose?: boolean

Generated using TypeDoc