Class: RemoteLangChainRetriever
retrievers.RemoteLangChainRetriever
Base Index class. All indexes should extend this class.
Hierarchy
↳
RemoteLangChainRetriever
Implements
Constructors
constructor
• new RemoteLangChainRetriever(«destructured»)
Parameters
| Name | Type |
|---|---|
«destructured» | RemoteLangChainRetrieverParams |
Overrides
Defined in
langchain/src/retrievers/remote/remote-retriever.ts:39
Properties
asyncCaller
• asyncCaller: AsyncCaller
Inherited from
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
RemoteLangChainRetrieverParams.auth
Inherited from
Defined in
langchain/src/retrievers/remote/base.ts:29
headers
• headers: Record<string, string>
Inherited from
Defined in
langchain/src/retrievers/remote/base.ts:31
inputKey
• inputKey: string
The key in the JSON body to put the query in
Implementation of
RemoteLangChainRetrieverParams.inputKey
Defined in
langchain/src/retrievers/remote/remote-retriever.ts:31
metadataKey
• metadataKey: string
The key in the JSON response to get the metadata from
Implementation of
RemoteLangChainRetrieverParams.metadataKey
Defined in
langchain/src/retrievers/remote/remote-retriever.ts:37
pageContentKey
• pageContentKey: string
The key in the JSON response to get the page content from
Implementation of
RemoteLangChainRetrieverParams.pageContentKey
Defined in
langchain/src/retrievers/remote/remote-retriever.ts:35
responseKey
• responseKey: string
The key in the JSON response to get the response from
Implementation of
RemoteLangChainRetrieverParams.responseKey
Defined in
langchain/src/retrievers/remote/remote-retriever.ts:33
url
• url: string
The URL of the remote retriever server
Implementation of
RemoteLangChainRetrieverParams.url
Inherited from
Defined in
langchain/src/retrievers/remote/base.ts:27
Methods
createJsonBody
▸ createJsonBody(query): RemoteRetrieverValues
Parameters
| Name | Type |
|---|---|
query | string |
Returns
Overrides
RemoteRetriever.createJsonBody
Defined in
langchain/src/retrievers/remote/remote-retriever.ts:53
getRelevantDocuments
▸ getRelevantDocuments(query): Promise<Document[]>
Parameters
| Name | Type |
|---|---|
query | string |
Returns
Promise<Document[]>
Inherited from
RemoteRetriever.getRelevantDocuments
Defined in
langchain/src/retrievers/remote/base.ts:53
processJsonResponse
▸ processJsonResponse(json): Document[]
Parameters
| Name | Type |
|---|---|
json | RemoteRetrieverValues |
Returns
Document[]
Overrides
RemoteRetriever.processJsonResponse
Defined in
langchain/src/retrievers/remote/remote-retriever.ts:59