Interface RemoteLangChainRetrieverParams

Interface for the parameters required to initialize a RemoteRetriever instance.

Hierarchy

Implemented by

Properties

auth url inputKey? metadataKey? pageContentKey? responseKey?

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 inputKey

inputKey?: string

The key in the JSON body to put the query in

Optional metadataKey

metadataKey?: string

The key in the JSON response to get the metadata from

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc