Interface TurbopufferParams

interface TurbopufferParams {
    apiKey?: string;
    apiUrl?: string;
    batchSize?: number;
    distanceMetric?: TurbopufferDistanceMetric;
    maxConcurrency?: number;
    maxRetries?: number;
    namespace?: string;
    onFailedAttempt?: FailedAttemptHandler;
}

Hierarchy

  • AsyncCallerParams
    • TurbopufferParams

Properties

apiKey? apiUrl? batchSize? distanceMetric? maxConcurrency? maxRetries? namespace? onFailedAttempt?

Properties

OptionalapiKey

apiKey?: string

OptionalapiUrl

apiUrl?: string

OptionalbatchSize

batchSize?: number

OptionaldistanceMetric

distanceMetric?: TurbopufferDistanceMetric

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.

Optionalnamespace

namespace?: string

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.

Settings

Member Visibility

On This Page

Properties