Interface ChatGPTPluginRetrieverParams

Interface for the parameters required to initialize a RemoteRetriever instance.

Hierarchy

Implemented by

Properties

auth url callbacks? filter? maxConcurrency? maxRetries? metadata? onFailedAttempt? tags? topK? 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 filter

filter?: ChatGPTPluginRetrieverFilter

The filter to use when querying the ChatGPTRetrievalPlugin server

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 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 tags

tags?: string[]

Optional topK

topK?: number

The number of results to request from the ChatGPTRetrievalPlugin server

Optional verbose

verbose?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc