Class: ChatGPTPluginRetriever
retrievers/remote.ChatGPTPluginRetriever
Base Index class. All indexes should extend this class.
Hierarchyβ
β³
ChatGPTPluginRetriever
Implementsβ
ChatGPTPluginRetrieverParams
Constructorsβ
constructorβ
β’ new ChatGPTPluginRetriever(Β«destructuredΒ»
)
Parametersβ
Name | Type |
---|---|
Β«destructuredΒ» | ChatGPTPluginRetrieverParams |
Overridesβ
Defined inβ
langchain/src/retrievers/remote/chatgpt-plugin.ts:37
Propertiesβ
asyncCallerβ
β’ asyncCaller: AsyncCaller
Inherited fromβ
Defined inβ
langchain/src/retrievers/remote/base.ts:33
authβ
β’ auth: RemoteRetrieverAuth
Implementation ofβ
ChatGPTPluginRetrieverParams.auth
Inherited fromβ
Defined inβ
langchain/src/retrievers/remote/base.ts:29
filterβ
β’ Optional
filter: ChatGPTPluginRetrieverFilter
Implementation ofβ
ChatGPTPluginRetrieverParams.filter
Defined inβ
langchain/src/retrievers/remote/chatgpt-plugin.ts:35
headersβ
β’ headers: Record
<string
, string
>
Inherited fromβ
Defined inβ
langchain/src/retrievers/remote/base.ts:31
topKβ
β’ topK: number
Implementation ofβ
ChatGPTPluginRetrieverParams.topK
Defined inβ
langchain/src/retrievers/remote/chatgpt-plugin.ts:33
urlβ
β’ url: string
Implementation ofβ
ChatGPTPluginRetrieverParams.url
Inherited fromβ
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/chatgpt-plugin.ts:43
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/chatgpt-plugin.ts:55