⚠️ Deprecated ⚠️

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Hierarchy

Implemented by

Properties

The authentication method to use, currently implemented is

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

The URL of the remote retriever server

callbacks?: Callbacks
inputKey?: string

The key in the JSON body to put the query in

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>
metadataKey?: string

The key in the JSON response to get the metadata from

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.

pageContentKey?: string

The key in the JSON response to get the page content from

responseKey?: string

The key in the JSON response to get the response from

tags?: string[]
verbose?: boolean

Generated using TypeDoc