Class: RemoteLangChainRetriever

retrievers/remote.RemoteLangChainRetriever

Base Index class. All indexes should extend this class.

Hierarchy

• RemoteRetriever

  ↳ RemoteLangChainRetriever

Implements

• RemoteLangChainRetrieverParams

Constructors

constructor

• new RemoteLangChainRetriever(«destructured»)

Parameters

Name	Type
«destructured»	RemoteLangChainRetrieverParams

Overrides

RemoteRetriever.constructor

Defined in

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

Properties

asyncCaller

• asyncCaller: AsyncCaller

Inherited from

RemoteRetriever.asyncCaller

Defined in

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

---

auth

• auth: RemoteRetrieverAuth

Implementation of

RemoteLangChainRetrieverParams.auth

Inherited from

RemoteRetriever.auth

Defined in

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

---

headers

• headers: Record<string, string>

Inherited from

RemoteRetriever.headers

Defined in

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

---

inputKey

• inputKey: string

Implementation of

RemoteLangChainRetrieverParams.inputKey

Defined in

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

---

metadataKey

• metadataKey: string

Implementation of

RemoteLangChainRetrieverParams.metadataKey

Defined in

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

---

pageContentKey

• pageContentKey: string

Implementation of

RemoteLangChainRetrieverParams.pageContentKey

Defined in

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

---

responseKey

• responseKey: string

Implementation of

RemoteLangChainRetrieverParams.responseKey

Defined in

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

---

url

• url: string

Implementation of

RemoteLangChainRetrieverParams.url

Inherited from

RemoteRetriever.url

Defined in

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

Methods

createJsonBody

▸ createJsonBody(query): RemoteRetrieverValues

Parameters

Name	Type
query	string

Returns

RemoteRetrieverValues

Overrides

RemoteRetriever.createJsonBody

Defined in

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

---

getRelevantDocuments

▸ getRelevantDocuments(query): Promise<Document<Record<string, any>>[]>

Parameters

Name	Type
query	string

Returns

Promise<Document<Record<string, any>>[]>

Inherited from

RemoteRetriever.getRelevantDocuments

Defined in

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

---

processJsonResponse

▸ processJsonResponse(json): Document<Record<string, any>>[]

Parameters

Name	Type
json	RemoteRetrieverValues

Returns

Document<Record<string, any>>[]

Overrides

RemoteRetriever.processJsonResponse

Defined in

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