Interface RemoteLangChainRetrieverParams

⚠️ Deprecated ⚠️

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

It is not recommended for use.

Hierarchy

Implemented by

Properties

auth url callbacks? inputKey? maxConcurrency? maxRetries? metadata? metadataKey? onFailedAttempt? pageContentKey? responseKey? tags? verbose?

Properties

auth

auth: RemoteRetrieverAuth

The authentication method to use, currently implemented is

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

url

url: string

The URL of the remote retriever server

Optional callbacks

callbacks?: Callbacks

Optional inputKey

inputKey?: string

The key in the JSON body to put the query in

Optional maxConcurrency

maxConcurrency?: number

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

Optional maxRetries

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.

Optional metadata

metadata?: Record<string, unknown>

Optional metadataKey

metadataKey?: string

The key in the JSON response to get the metadata from

Optional onFailedAttempt

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.

Optional pageContentKey

pageContentKey?: string

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

Optional responseKey

responseKey?: string

The key in the JSON response to get the response from

Optional tags

tags?: string[]

Optional verbose

verbose?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc