Add SearchApi documentloader, tool & podcast QA example

2026-06-28 13:00:56 +03:00 · 2023-10-31 16:27:37 +02:00
parent 06552416bb
commit 7bc41939e4
6 changed files with 879 additions and 0 deletions
@@ -0,0 +1,109 @@
+import { ICommonObject, INode, INodeData, INodeParams } from '../../../src/Interface'
+import { TextSplitter } from 'langchain/text_splitter'
+import { SearchApiLoader } from 'langchain/document_loaders/web/searchapi'
+import { getCredentialData, getCredentialParam } from '../../../src'
+
+// Provides access to multiple search engines using the SearchApi.
+// For available parameters & engines, refer to: https://www.searchapi.io/docs/google
+class SearchAPI_DocumentLoaders implements INode {
+    label: string
+    name: string
+    version: number
+    description: string
+    type: string
+    icon: string
+    category: string
+    baseClasses: string[]
+    credential: INodeParams
+    inputs: INodeParams[]
+
+    constructor() {
+        this.label = 'SearchApi For Web Search'
+        this.name = 'searchApi'
+        this.version = 1.0
+        this.type = 'Document'
+        this.icon = 'searchapi.svg'
+        this.category = 'Document Loaders'
+        this.description = 'Load data from real-time search results'
+        this.baseClasses = [this.type]
+        this.credential = {
+            label: 'Connect Credential',
+            name: 'credential',
+            type: 'credential',
+            optional: false,
+            credentialNames: ['searchApi']
+        }
+        this.inputs = [
+            {
+                label: 'Query',
+                name: 'query',
+                type: 'string',
+                optional: true
+            },
+            {
+                label: 'Custom Parameters',
+                name: 'customParameters',
+                type: 'json',
+                optional: true,
+                additionalParams: true
+            },
+            {
+                label: 'Text Splitter',
+                name: 'textSplitter',
+                type: 'TextSplitter',
+                optional: true
+            },
+            {
+                label: 'Metadata',
+                name: 'metadata',
+                type: 'json',
+                optional: true,
+                additionalParams: true
+            }
+        ]
+    }
+
+    async init(nodeData: INodeData, _: string, options: ICommonObject): Promise<any> {
+        const textSplitter = nodeData.inputs?.textSplitter as TextSplitter
+        const query = nodeData.inputs?.query as string
+        const customParameters = nodeData.inputs?.customParameters
+        const metadata = nodeData.inputs?.metadata
+
+        // Fetch the API credentials for this node
+        const credentialData = await getCredentialData(nodeData.credential ?? '', options)
+        const searchApiKey = getCredentialParam('searchApiKey', credentialData, nodeData)
+
+        // Check and parse custom parameters (should be JSON or object)
+        const parsedParameters = typeof customParameters === 'object' ? customParameters : JSON.parse(customParameters || '{}');
+
+        // Prepare the configuration for the SearchApiLoader
+        const loaderConfig = {
+            q: query,
+            apiKey: searchApiKey,
+            ...parsedParameters
+        };
+
+        // Initialize the loader with the given configuration
+        const loader = new SearchApiLoader(loaderConfig);
+
+        // Fetch documents, split if a text splitter is provided
+        const docs = textSplitter ? await loader.loadAndSplit() : await loader.load()
+
+        if (metadata) {
+            const parsedMetadata = typeof metadata === 'object' ? metadata : JSON.parse(metadata)
+            return docs.map((doc) => {
+                return {
+                    ...doc,
+                    metadata: {
+                        ...doc.metadata,
+                        ...parsedMetadata
+                    }
+                }
+            })
+        }
+
+        return docs
+    }
+}
+
+module.exports = { nodeClass: SearchAPI_DocumentLoaders }