@activepieces/piece-ai 0.1.21 → 0.3.0

package/src/lib/common/web-search.js

@@ -0,0 +1,188 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildWebSearchOptionsProperty = buildWebSearchOptionsProperty;
+exports.buildWebSearchConfig = buildWebSearchConfig;
+const tslib_1 = require("tslib");
+const pieces_framework_1 = require("@activepieces/pieces-framework");
+const shared_1 = require("@activepieces/shared");
+const ai_sdk_1 = require("./ai-sdk");
+function buildWebSearchOptionsProps(provider, params) {
+    var _a;
+    const showIncludeSources = (_a = params === null || params === void 0 ? void 0 : params.showIncludeSources) !== null && _a !== void 0 ? _a : true;
+    const isOpenRouterProvider = provider === shared_1.AIProviderName.OPENROUTER ||
+        provider === shared_1.AIProviderName.ACTIVEPIECES;
+    const supportsToolBasedWebSearch = provider === shared_1.AIProviderName.OPENAI ||
+        provider === shared_1.AIProviderName.ANTHROPIC ||
+        provider === shared_1.AIProviderName.GOOGLE;
+    let options = {
+        maxUses: pieces_framework_1.Property.Number({
+            displayName: 'Max Web Search Uses',
+            required: false,
+            defaultValue: 5,
+            description: isOpenRouterProvider
+                ? 'For OpenRouter/Activepieces, this maps to OpenRouter web plugin max_results (1-10). Default is 5.'
+                : 'Maximum number of searches to use. Default is 5.',
+        }),
+    };
+    if (supportsToolBasedWebSearch && showIncludeSources) {
+        options = Object.assign(Object.assign({}, options), { includeSources: pieces_framework_1.Property.Checkbox({
+                displayName: 'Include Sources',
+                description: 'Whether to include the sources in the response. Useful for getting web search details (e.g. search queries, searched URLs, etc).',
+                required: false,
+                defaultValue: false,
+            }) });
+    }
+    const userLocationOptions = {
+        userLocationCity: pieces_framework_1.Property.ShortText({
+            displayName: 'User Location - City',
+            required: false,
+            description: 'The city name for localizing search results (e.g., San Francisco).',
+        }),
+        userLocationRegion: pieces_framework_1.Property.ShortText({
+            displayName: 'User Location - Region',
+            required: false,
+            description: 'The region or state for localizing search results (e.g., California).',
+        }),
+        userLocationCountry: pieces_framework_1.Property.ShortText({
+            displayName: 'User Location - Country',
+            required: false,
+            description: 'The country code for localizing search results (e.g., US).',
+        }),
+        userLocationTimezone: pieces_framework_1.Property.ShortText({
+            displayName: 'User Location - Timezone',
+            required: false,
+            description: 'The IANA timezone ID for localizing search results (e.g., America/Los_Angeles).',
+        }),
+    };
+    if (provider === shared_1.AIProviderName.ANTHROPIC) {
+        options = Object.assign(Object.assign(Object.assign({}, options), { allowedDomains: pieces_framework_1.Property.Array({
+                displayName: 'Allowed Domains',
+                required: false,
+                description: 'List of domains to search (e.g., example.com, docs.example.com/blog). Domains should not include HTTP/HTTPS scheme. Subdomains are automatically included unless more specific subpaths are provided. Overrides Blocked Domains if both are provided.',
+                properties: {
+                    domain: pieces_framework_1.Property.ShortText({
+                        displayName: 'Domain',
+                        required: true,
+                    }),
+                },
+            }), blockedDomains: pieces_framework_1.Property.Array({
+                displayName: 'Blocked Domains',
+                required: false,
+                description: 'List of domains to exclude from search (e.g., example.com, docs.example.com/blog). Domains should not include HTTP/HTTPS scheme. Subdomains are automatically included unless more specific subpaths are provided. Overrided by Allowed Domains if both are provided.',
+                properties: {
+                    domain: pieces_framework_1.Property.ShortText({
+                        displayName: 'Domain',
+                        required: true,
+                    }),
+                },
+            }) }), userLocationOptions);
+    }
+    if (provider === shared_1.AIProviderName.OPENAI) {
+        options = Object.assign(Object.assign(Object.assign({}, options), { searchContextSize: pieces_framework_1.Property.StaticDropdown({
+                displayName: 'Search Context Size',
+                required: false,
+                defaultValue: 'medium',
+                options: {
+                    options: [
+                        { label: 'Low', value: 'low' },
+                        { label: 'Medium', value: 'medium' },
+                        { label: 'High', value: 'high' },
+                    ],
+                },
+                description: 'High level guidance for the amount of context window space to use for the search.',
+            }) }), userLocationOptions);
+    }
+    return options;
+}
+function buildUserLocation(options) {
+    if (!options.userLocationCity &&
+        !options.userLocationRegion &&
+        !options.userLocationCountry &&
+        !options.userLocationTimezone) {
+        return undefined;
+    }
+    return Object.assign(Object.assign(Object.assign(Object.assign({ type: 'approximate' }, (0, shared_1.spreadIfDefined)('city', options.userLocationCity)), (0, shared_1.spreadIfDefined)('region', options.userLocationRegion)), (0, shared_1.spreadIfDefined)('country', options.userLocationCountry)), (0, shared_1.spreadIfDefined)('timezone', options.userLocationTimezone));
+}
+function createWebSearchTool(provider, options = {}) {
+    var _a;
+    const defaultMaxUses = 5;
+    switch (provider) {
+        case shared_1.AIProviderName.ANTHROPIC: {
+            const anthropicOptions = options;
+            let allowedDomains;
+            let blockedDomains;
+            if (anthropicOptions.allowedDomains &&
+                anthropicOptions.allowedDomains.length > 0) {
+                allowedDomains = anthropicOptions.allowedDomains.map(({ domain }) => domain);
+            }
+            if (anthropicOptions.blockedDomains &&
+                anthropicOptions.blockedDomains.length > 0 &&
+                (!anthropicOptions.allowedDomains ||
+                    anthropicOptions.allowedDomains.length === 0)) {
+                blockedDomains = anthropicOptions.blockedDomains.map(({ domain }) => domain);
+            }
+            return {
+                web_search: (0, ai_sdk_1.anthropicSearchTool)(Object.assign(Object.assign(Object.assign({ maxUses: (_a = anthropicOptions.maxUses) !== null && _a !== void 0 ? _a : defaultMaxUses }, (0, shared_1.spreadIfDefined)('userLocation', buildUserLocation(anthropicOptions))), (0, shared_1.spreadIfDefined)('allowedDomains', allowedDomains)), (0, shared_1.spreadIfDefined)('blockedDomains', blockedDomains))),
+            };
+        }
+        case shared_1.AIProviderName.OPENAI: {
+            const openaiOptions = options;
+            return {
+                web_search_preview: (0, ai_sdk_1.openaiSearchTool)(Object.assign(Object.assign({}, (0, shared_1.spreadIfDefined)('searchContextSize', openaiOptions.searchContextSize)), (0, shared_1.spreadIfDefined)('userLocation', buildUserLocation(openaiOptions)))),
+            };
+        }
+        case shared_1.AIProviderName.GOOGLE: {
+            return {
+                google_search: (0, ai_sdk_1.googleSearchTool)({}),
+            };
+        }
+        default:
+            throw new Error(`Provider ${provider} is not supported for web search`);
+    }
+}
+function buildWebSearchOptionsProperty(getProvider, refreshers, params) {
+    return pieces_framework_1.Property.DynamicProperties({
+        displayName: 'Web Search Options',
+        required: false,
+        auth: pieces_framework_1.PieceAuth.None(),
+        refreshers,
+        props: (propsValue) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const webSearchEnabled = propsValue['webSearch'];
+            if (!webSearchEnabled) {
+                return {};
+            }
+            const provider = getProvider(propsValue);
+            if (!provider) {
+                return {};
+            }
+            return buildWebSearchOptionsProps(provider, params);
+        }),
+    });
+}
+function buildWebSearchConfig(params) {
+    var _a;
+    const { provider, webSearchEnabled, webSearchOptions } = params;
+    if (!webSearchEnabled) {
+        return { tools: undefined, providerOptions: undefined };
+    }
+    const isOpenRouter = provider === shared_1.AIProviderName.OPENROUTER ||
+        provider === shared_1.AIProviderName.ACTIVEPIECES;
+    if (isOpenRouter) {
+        return {
+            tools: undefined,
+            providerOptions: {
+                openrouter: {
+                    plugins: [{
+                            id: 'web',
+                            max_results: Math.min(Math.max((_a = webSearchOptions === null || webSearchOptions === void 0 ? void 0 : webSearchOptions.maxUses) !== null && _a !== void 0 ? _a : 5, 1), 10),
+                        }],
+                },
+            },
+        };
+    }
+    return {
+        tools: createWebSearchTool(provider, webSearchOptions),
+        providerOptions: undefined,
+    };
+}
+//# sourceMappingURL=web-search.js.map

package/src/lib/common/web-search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-search.js","sourceRoot":"","sources":["../../../../src/lib/common/web-search.ts"],"names":[],"mappings":";;AA0NA,sEAsBC;AAED,oDAoCC;;AAtRD,qEAIwC;AAGxC,iDAAuE;AACvE,qCAAmF;AAEnF,SAAS,0BAA0B,CAAC,QAAgB,EAAE,MAAyC;;IAC7F,MAAM,kBAAkB,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,kBAAkB,mCAAI,IAAI,CAAC;IAC9D,MAAM,oBAAoB,GACxB,QAAQ,KAAK,uBAAc,CAAC,UAAU;QACtC,QAAQ,KAAK,uBAAc,CAAC,YAAY,CAAC;IAC3C,MAAM,0BAA0B,GAC9B,QAAQ,KAAK,uBAAc,CAAC,MAAM;QAClC,QAAQ,KAAK,uBAAc,CAAC,SAAS;QACrC,QAAQ,KAAK,uBAAc,CAAC,MAAM,CAAC;IAErC,IAAI,OAAO,GAAqB;QAC9B,OAAO,EAAE,2BAAQ,CAAC,MAAM,CAAC;YACvB,WAAW,EAAE,qBAAqB;YAClC,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,WAAW,EAAE,oBAAoB;gBAC/B,CAAC,CAAC,mGAAmG;gBACrG,CAAC,CAAC,kDAAkD;SACvD,CAAC;KACH,CAAC;IAEF,IAAI,0BAA0B,IAAI,kBAAkB,EAAE,CAAC;QACrD,OAAO,mCACF,OAAO,KACV,cAAc,EAAE,2BAAQ,CAAC,QAAQ,CAAC;gBAChC,WAAW,EAAE,iBAAiB;gBAC9B,WAAW,EACT,kIAAkI;gBACpI,QAAQ,EAAE,KAAK;gBACf,YAAY,EAAE,KAAK;aACpB,CAAC,GACH,CAAC;IACJ,CAAC;IAED,MAAM,mBAAmB,GAAG;QAC1B,gBAAgB,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACnC,WAAW,EAAE,sBAAsB;YACnC,QAAQ,EAAE,KAAK;YACf,WAAW,EACT,oEAAoE;SACvE,CAAC;QACF,kBAAkB,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACrC,WAAW,EAAE,wBAAwB;YACrC,QAAQ,EAAE,KAAK;YACf,WAAW,EACT,uEAAuE;SAC1E,CAAC;QACF,mBAAmB,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACtC,WAAW,EAAE,yBAAyB;YACtC,QAAQ,EAAE,KAAK;YACf,WAAW,EACT,4DAA4D;SAC/D,CAAC;QACF,oBAAoB,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACvC,WAAW,EAAE,0BAA0B;YACvC,QAAQ,EAAE,KAAK;YACf,WAAW,EACT,iFAAiF;SACpF,CAAC;KACH,CAAC;IAEF,IAAI,QAAQ,KAAK,uBAAc,CAAC,SAAS,EAAE,CAAC;QAC1C,OAAO,iDACF,OAAO,KACV,cAAc,EAAE,2BAAQ,CAAC,KAAK,CAAC;gBAC7B,WAAW,EAAE,iBAAiB;gBAC9B,QAAQ,EAAE,KAAK;gBACf,WAAW,EACT,uPAAuP;gBACzP,UAAU,EAAE;oBACV,MAAM,EAAE,2BAAQ,CAAC,SAAS,CAAC;wBACzB,WAAW,EAAE,QAAQ;wBACrB,QAAQ,EAAE,IAAI;qBACf,CAAC;iBACH;aACF,CAAC,EACF,cAAc,EAAE,2BAAQ,CAAC,KAAK,CAAC;gBAC7B,WAAW,EAAE,iBAAiB;gBAC9B,QAAQ,EAAE,KAAK;gBACf,WAAW,EACT,uQAAuQ;gBACzQ,UAAU,EAAE;oBACV,MAAM,EAAE,2BAAQ,CAAC,SAAS,CAAC;wBACzB,WAAW,EAAE,QAAQ;wBACrB,QAAQ,EAAE,IAAI;qBACf,CAAC;iBACH;aACF,CAAC,KACC,mBAAmB,CACvB,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,KAAK,uBAAc,CAAC,MAAM,EAAE,CAAC;QACvC,OAAO,iDACF,OAAO,KACV,iBAAiB,EAAE,2BAAQ,CAAC,cAAc,CAAC;gBACzC,WAAW,EAAE,qBAAqB;gBAClC,QAAQ,EAAE,KAAK;gBACf,YAAY,EAAE,QAAQ;gBACtB,OAAO,EAAE;oBACP,OAAO,EAAE;wBACP,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;wBAC9B,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;wBACpC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;qBACjC;iBACF;gBACD,WAAW,EACT,mFAAmF;aACtF,CAAC,KACC,mBAAmB,CACvB,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,iBAAiB,CACxB,OAA4B;IAE5B,IACE,CAAC,OAAO,CAAC,gBAAgB;QACzB,CAAC,OAAO,CAAC,kBAAkB;QAC3B,CAAC,OAAO,CAAC,mBAAmB;QAC5B,CAAC,OAAO,CAAC,oBAAoB,EAC7B,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,iEACE,IAAI,EAAE,aAAsB,IACzB,IAAA,wBAAe,EAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACjD,IAAA,wBAAe,EAAC,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACrD,IAAA,wBAAe,EAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GACvD,IAAA,wBAAe,EAAC,UAAU,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAC5D;AACJ,CAAC;AAED,SAAS,mBAAmB,CAC1B,QAAgB,EAChB,UAA4B,EAAE;;IAE9B,MAAM,cAAc,GAAG,CAAC,CAAC;IAEzB,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,uBAAc,CAAC,SAAS,CAAC,CAAC,CAAC;YAC9B,MAAM,gBAAgB,GAAG,OAAoC,CAAC;YAE9D,IAAI,cAAoC,CAAC;YACzC,IAAI,cAAoC,CAAC;YAEzC,IACE,gBAAgB,CAAC,cAAc;gBAC/B,gBAAgB,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAC1C,CAAC;gBACD,cAAc,GAAG,gBAAgB,CAAC,cAAc,CAAC,GAAG,CAClD,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CACvB,CAAC;YACJ,CAAC;YAED,IACE,gBAAgB,CAAC,cAAc;gBAC/B,gBAAgB,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC1C,CAAC,CAAC,gBAAgB,CAAC,cAAc;oBAC/B,gBAAgB,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,EAC/C,CAAC;gBACD,cAAc,GAAG,gBAAgB,CAAC,cAAc,CAAC,GAAG,CAClD,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CACvB,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,UAAU,EAAE,IAAA,4BAAmB,8CAC7B,OAAO,EAAE,MAAA,gBAAgB,CAAC,OAAO,mCAAI,cAAc,IAChD,IAAA,wBAAe,EAChB,cAAc,EACd,iBAAiB,CAAC,gBAAgB,CAAC,CACpC,GACE,IAAA,wBAAe,EAAC,gBAAgB,EAAE,cAAc,CAAC,GACjD,IAAA,wBAAe,EAAC,gBAAgB,EAAE,cAAc,CAAC,EACpD;aACI,CAAC;QACX,CAAC;QAED,KAAK,uBAAc,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3B,MAAM,aAAa,GAAG,OAAiC,CAAC;YAExD,OAAO;gBACL,kBAAkB,EAAE,IAAA,yBAAgB,kCAC/B,IAAA,wBAAe,EAChB,mBAAmB,EACnB,aAAa,CAAC,iBAAiB,CAChC,GACE,IAAA,wBAAe,EAAC,cAAc,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAC,EACpE;aACI,CAAC;QACX,CAAC;QAED,KAAK,uBAAc,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3B,OAAO;gBACL,aAAa,EAAE,IAAA,yBAAgB,EAAC,EAAE,CAAC;aAC7B,CAAC;QACX,CAAC;QAED;YACE,MAAM,IAAI,KAAK,CAAC,YAAY,QAAQ,kCAAkC,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC;AAED,SAAgB,6BAA6B,CAC3C,WAAwE,EACxE,UAAoB,EACpB,MAAyC;IAEzC,OAAO,2BAAQ,CAAC,iBAAiB,CAAC;QAChC,WAAW,EAAE,oBAAoB;QACjC,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,4BAAS,CAAC,IAAI,EAAE;QACtB,UAAU;QACV,KAAK,EAAE,CAAO,UAAU,EAAE,EAAE;YAC1B,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAuB,CAAC;YACvE,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,MAAM,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,0BAA0B,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC,CAAA;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,oBAAoB,CAAC,MAIpC;;IACC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;IAEhE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;IAC1D,CAAC;IAED,MAAM,YAAY,GAChB,QAAQ,KAAK,uBAAc,CAAC,UAAU;QACtC,QAAQ,KAAK,uBAAc,CAAC,YAAY,CAAC;IAE3C,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO;YACL,KAAK,EAAE,SAAS;YAChB,eAAe,EAAE;gBACf,UAAU,EAAE;oBACV,OAAO,EAAE,CAAC;4BACR,EAAE,EAAE,KAAc;4BAClB,WAAW,EAAE,IAAI,CAAC,GAAG,CACnB,IAAI,CAAC,GAAG,CAAC,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,mCAAI,CAAC,EAAE,CAAC,CAAC,EAC3C,EAAE,CACH;yBACF,CAAC;iBACH;aACF;SACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,KAAK,EAAE,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,CAAC;QACtD,eAAe,EAAE,SAAS;KAC3B,CAAC;AACJ,CAAC"}