Class RemoteRetriever`Abstract`

Abstract class for interacting with a remote server to retrieve relevant documents based on a given query.

Hierarchy

BaseRetriever
- RemoteRetriever

Implements

RemoteRetrieverParams

Index

Constructors

Properties

asyncCaller auth headers url

Methods

createJsonBody processJsonResponse

Constructors

constructor

new RemoteRetriever(fields): RemoteRetriever
Parameters
- fields: RemoteRetrieverParams
Returns RemoteRetriever
Overrides BaseRetriever.constructor
- Defined in docs/api_refs/langchain/src/retrievers/remote/base.ts:60

Properties

asyncCaller

asyncCaller: AsyncCaller

auth

auth: RemoteRetrieverAuth

The authentication method to use, currently implemented is

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

headers

headers: Record<string, string>

url

url: string

The URL of the remote retriever server

Methods

`Abstract` createJsonBody

createJsonBody(query): RemoteRetrieverValues
Abstract method that should be implemented by subclasses to create the JSON body of the request based on the given query.
Parameters
- query: string
  
  The query based on which the JSON body of the request is created.
Returns RemoteRetrieverValues
The JSON body of the request.
- Defined in docs/api_refs/langchain/src/retrievers/remote/base.ts:81

`Abstract` processJsonResponse

processJsonResponse(json): Document<Record<string, any>>[]
Abstract method that should be implemented by subclasses to process the JSON response from the server and convert it into an array of Document instances.
Parameters
- json: RemoteRetrieverValues
  
  The JSON response from the server.
Returns Document<Record<string, any>>[]
An array of Document instances.
- Defined in docs/api_refs/langchain/src/retrievers/remote/base.ts:90

Generated using TypeDoc