Class: RemoteRetriever
retrievers/remote.RemoteRetriever
Base Index class. All indexes should extend this class.
Hierarchyβ
β³
RemoteRetriever
β³β³
ChatGPTPluginRetriever
β³β³
RemoteLangChainRetriever
Implementsβ
RemoteRetrieverParams
Constructorsβ
constructorβ
β’ Protected
new RemoteRetriever(Β«destructuredΒ»
)
Parametersβ
Name | Type |
---|---|
Β«destructuredΒ» | RemoteRetrieverParams |
Overridesβ
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
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
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
<Record
<string
, any
>>[]>
Parametersβ
Name | Type |
---|---|
query | string |
Returnsβ
Promise
<Document
<Record
<string
, any
>>[]>
Overridesβ
BaseRetriever.getRelevantDocuments
Defined inβ
langchain/src/retrievers/remote/base.ts:53
processJsonResponseβ
βΈ Abstract
processJsonResponse(json
): Document
<Record
<string
, any
>>[]
Parametersβ
Name | Type |
---|---|
json | RemoteRetrieverValues |
Returnsβ
Document
<Record
<string
, any
>>[]
Defined inβ
langchain/src/retrievers/remote/base.ts:51