Skip to main content

Interface: RemoteLangChainRetrieverParams

retrievers.internal.RemoteLangChainRetrieverParams

Hierarchy​

Implemented by​

Properties​

auth​

• auth: RemoteRetrieverAuth

The authentication method to use, currently implemented is

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

Inherited from​

RemoteRetrieverParams.auth

Defined in​

langchain/src/retrievers/remote/base.ts:20

inputKey​

• Optional inputKey: string

The key in the JSON body to put the query in

Defined in​

langchain/src/retrievers/remote/remote-retriever.ts:12

maxConcurrency​

• Optional maxConcurrency: number

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

Inherited from​

RemoteRetrieverParams.maxConcurrency

Defined in​

langchain/src/util/async_caller.ts:9

maxRetries​

• Optional 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.

Inherited from​

RemoteRetrieverParams.maxRetries

Defined in​

langchain/src/util/async_caller.ts:14

metadataKey​

• Optional metadataKey: string

The key in the JSON response to get the metadata from

Defined in​

langchain/src/retrievers/remote/remote-retriever.ts:24

pageContentKey​

• Optional pageContentKey: string

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

Defined in​

langchain/src/retrievers/remote/remote-retriever.ts:20

responseKey​

• Optional responseKey: string

The key in the JSON response to get the response from

Defined in​

langchain/src/retrievers/remote/remote-retriever.ts:16

url​

• url: string

The URL of the remote retriever server

Inherited from​

RemoteRetrieverParams.url

Defined in​

langchain/src/retrievers/remote/base.ts:13