|
| 1 | +import { BaseRetriever } from '@langchain/core/retrievers' |
| 2 | +import { ContextualCompressionRetriever } from 'langchain/retrievers/contextual_compression' |
| 3 | +import { getCredentialData, getCredentialParam, handleEscapeCharacters } from '../../../src' |
| 4 | +import { ICommonObject, INode, INodeData, INodeOutputsValue, INodeParams } from '../../../src/Interface' |
| 5 | +import { JinaRerank } from './JinaRerank' |
| 6 | + |
| 7 | +class JinaRerankRetriever_Retrievers implements INode { |
| 8 | + label: string |
| 9 | + name: string |
| 10 | + version: number |
| 11 | + description: string |
| 12 | + type: string |
| 13 | + icon: string |
| 14 | + category: string |
| 15 | + baseClasses: string[] |
| 16 | + inputs: INodeParams[] |
| 17 | + credential: INodeParams |
| 18 | + badge: string |
| 19 | + outputs: INodeOutputsValue[] |
| 20 | + |
| 21 | + constructor() { |
| 22 | + this.label = 'Jina AI Rerank Retriever' |
| 23 | + this.name = 'JinaRerankRetriever' |
| 24 | + this.version = 1.0 |
| 25 | + this.type = 'JinaRerankRetriever' |
| 26 | + this.icon = 'JinaAI.svg' |
| 27 | + this.category = 'Retrievers' |
| 28 | + this.description = 'Jina AI Rerank indexes the documents from most to least semantically relevant to the query.' |
| 29 | + this.baseClasses = [this.type, 'BaseRetriever'] |
| 30 | + this.credential = { |
| 31 | + label: 'Connect Credential', |
| 32 | + name: 'credential', |
| 33 | + type: 'credential', |
| 34 | + credentialNames: ['jinaAIApi'] |
| 35 | + } |
| 36 | + this.inputs = [ |
| 37 | + { |
| 38 | + label: 'Vector Store Retriever', |
| 39 | + name: 'baseRetriever', |
| 40 | + type: 'VectorStoreRetriever' |
| 41 | + }, |
| 42 | + { |
| 43 | + label: 'Model Name', |
| 44 | + name: 'model', |
| 45 | + type: 'options', |
| 46 | + options: [ |
| 47 | + { |
| 48 | + label: 'jina-reranker-v2-base-multilingual', |
| 49 | + name: 'jina-reranker-v2-base-multilingual' |
| 50 | + }, |
| 51 | + { |
| 52 | + label: 'jina-colbert-v2', |
| 53 | + name: 'jina-colbert-v2' |
| 54 | + } |
| 55 | + ], |
| 56 | + default: 'jina-reranker-v2-base-multilingual', |
| 57 | + optional: true |
| 58 | + }, |
| 59 | + { |
| 60 | + label: 'Query', |
| 61 | + name: 'query', |
| 62 | + type: 'string', |
| 63 | + description: 'Query to retrieve documents from retriever. If not specified, user question will be used', |
| 64 | + optional: true, |
| 65 | + acceptVariable: true |
| 66 | + }, |
| 67 | + { |
| 68 | + label: 'Top N', |
| 69 | + name: 'topN', |
| 70 | + description: 'Number of top results to fetch. Default to 4', |
| 71 | + placeholder: '4', |
| 72 | + default: 4, |
| 73 | + type: 'number', |
| 74 | + additionalParams: true, |
| 75 | + optional: true |
| 76 | + } |
| 77 | + ] |
| 78 | + this.outputs = [ |
| 79 | + { |
| 80 | + label: 'Jina AI Rerank Retriever', |
| 81 | + name: 'retriever', |
| 82 | + baseClasses: this.baseClasses |
| 83 | + }, |
| 84 | + { |
| 85 | + label: 'Document', |
| 86 | + name: 'document', |
| 87 | + description: 'Array of document objects containing metadata and pageContent', |
| 88 | + baseClasses: ['Document', 'json'] |
| 89 | + }, |
| 90 | + { |
| 91 | + label: 'Text', |
| 92 | + name: 'text', |
| 93 | + description: 'Concatenated string from pageContent of documents', |
| 94 | + baseClasses: ['string', 'json'] |
| 95 | + } |
| 96 | + ] |
| 97 | + } |
| 98 | + |
| 99 | + async init(nodeData: INodeData, input: string, options: ICommonObject): Promise<any> { |
| 100 | + const baseRetriever = nodeData.inputs?.baseRetriever as BaseRetriever |
| 101 | + const model = nodeData.inputs?.model as string |
| 102 | + const query = nodeData.inputs?.query as string |
| 103 | + const credentialData = await getCredentialData(nodeData.credential ?? '', options) |
| 104 | + const jinaApiKey = getCredentialParam('jinaAIAPIKey', credentialData, nodeData) |
| 105 | + const topN = nodeData.inputs?.topN ? parseFloat(nodeData.inputs?.topN as string) : 4 |
| 106 | + const output = nodeData.outputs?.output as string |
| 107 | + |
| 108 | + const jinaCompressor = new JinaRerank(jinaApiKey, model, topN) |
| 109 | + |
| 110 | + const retriever = new ContextualCompressionRetriever({ |
| 111 | + baseCompressor: jinaCompressor, |
| 112 | + baseRetriever: baseRetriever |
| 113 | + }) |
| 114 | + |
| 115 | + if (output === 'retriever') return retriever |
| 116 | + else if (output === 'document') return await retriever.invoke(query ? query : input) |
| 117 | + else if (output === 'text') { |
| 118 | + const docs = await retriever.invoke(query ? query : input) |
| 119 | + let finaltext = '' |
| 120 | + for (const doc of docs) finaltext += `${doc.pageContent}\n` |
| 121 | + |
| 122 | + return handleEscapeCharacters(finaltext, false) |
| 123 | + } |
| 124 | + |
| 125 | + return retriever |
| 126 | + } |
| 127 | +} |
| 128 | + |
| 129 | +module.exports = { nodeClass: JinaRerankRetriever_Retrievers } |
0 commit comments