Class: RemoteRetriever

retrievers.RemoteRetriever

Base Index class. All indexes should extend this class.

Hierarchy

• BaseRetriever

  ↳ RemoteRetriever

  ↳↳ ChatGPTPluginRetriever

  ↳↳ RemoteLangChainRetriever

Implements

• RemoteRetrieverParams

Constructors

constructor

• Protected new RemoteRetriever(«destructured»)

Parameters

Name	Type
«destructured»	RemoteRetrieverParams

Overrides

BaseRetriever.constructor

Defined in

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

Properties

asyncCaller

• asyncCaller: AsyncCaller

Defined in

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

---

auth

• auth: RemoteRetrieverAuth

The authentication method to use, currently implemented is

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

Implementation of

RemoteRetrieverParams.auth

Defined in

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

---

headers

• headers: Record<string, string>

Defined in

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

---

url

• url: string

The URL of the remote retriever server

Implementation of

RemoteRetrieverParams.url

Defined in

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

Methods

createJsonBody

▸ Abstract createJsonBody(query): RemoteRetrieverValues

Parameters

Name	Type
query	string

Returns

RemoteRetrieverValues

Defined in

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

---

getRelevantDocuments

▸ getRelevantDocuments(query): Promise<Document[]>

Parameters

Name	Type
query	string

Returns

Promise<Document[]>

Overrides

BaseRetriever.getRelevantDocuments

Defined in

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

---

processJsonResponse

▸ Abstract processJsonResponse(json): Document[]

Parameters

Name	Type
json	RemoteRetrieverValues

Returns

Document[]

Defined in

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