Interface ChaindeskRetrieverArgs

interface ChaindeskRetrieverArgs {
    apiKey?: string;
    callbacks?: Callbacks;
    datastoreId: string;
    filter?: Record<string, unknown>;
    maxConcurrency?: number;
    maxRetries?: number;
    metadata?: Record<string, unknown>;
    onFailedAttempt?: FailedAttemptHandler;
    tags?: string[];
    topK?: number;
    verbose?: boolean;
}

Hierarchy

  • AsyncCallerParams
  • BaseRetrieverInput
    • ChaindeskRetrieverArgs

Properties

apiKey? callbacks? datastoreId filter? maxConcurrency? maxRetries? metadata? onFailedAttempt? tags? topK? verbose?

Properties

OptionalapiKey

apiKey?: string

Optionalcallbacks

callbacks?: Callbacks

datastoreId

datastoreId: string

Optionalfilter

filter?: Record<string, unknown>

OptionalmaxConcurrency

maxConcurrency?: number

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

OptionalmaxRetries

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.

Optionalmetadata

metadata?: Record<string, unknown>

OptionalonFailedAttempt

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.

Optionaltags

tags?: string[]

OptionaltopK

topK?: number

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties