Interface VespaRetrieverParams

Interface for the parameters required to initialize a RemoteRetriever instance.

interface VespaRetrieverParams {
    auth: RemoteRetrieverAuth;
    callbacks?: Callbacks;
    content_field: string;
    maxConcurrency?: number;
    maxRetries?: number;
    metadata?: Record<string, unknown>;
    onFailedAttempt?: FailedAttemptHandler;
    query_body: object;
    tags?: string[];
    url: string;
    verbose?: boolean;
}

Hierarchy (view full)

Properties

auth callbacks? content_field maxConcurrency? maxRetries? metadata? onFailedAttempt? query_body tags? url verbose?

Properties

auth

auth: RemoteRetrieverAuth

The authentication method to use, currently implemented is

  • false: no authentication
  • { bearer: string }: Bearer token authentication

Optionalcallbacks

callbacks?: Callbacks

content_field

content_field: string

The name of the field the content resides in

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.

query_body

query_body: object

The body of the query to send to Vespa

Optionaltags

tags?: string[]

url

url: string

The URL of the remote retriever server

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties