@onkernel/sdk 0.109.0 → 0.111.0

package/resources/search/providers.d.ts

@@ -0,0 +1,141 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Search the web and retrieve content for selected results.
+ */
+export declare class Providers extends APIResource {
+    /**
+     * Lists providers, capabilities, and machine-readable native-option schemas. Auto
+     * and fallback are strategies, not provider entries. The list is not paginated and
+     * contains no latency benchmarks. X-Request-Id identifies the request.
+     *
+     * @example
+     * ```ts
+     * const providers = await client.search.providers.list();
+     * ```
+     */
+    list(query?: ProviderListParams | null | undefined, options?: RequestOptions): APIPromise<ProviderListResponse>;
+}
+export interface Provider {
+    content: Provider.Content;
+    max_results_cap: number;
+    params: Provider.Params;
+    provider_options: Provider.ProviderOptions;
+    slug: string;
+    /**
+     * Provider-specific limitations, conditional filter support, and warnings about
+     * search modes.
+     */
+    notes?: Array<string>;
+}
+export declare namespace Provider {
+    interface Content {
+        /**
+         * Can enforce the requested maximum content age.
+         */
+        freshness_control: boolean;
+        /**
+         * Supports content retrieval with the search request.
+         */
+        inline: boolean;
+        /**
+         * Supports content retrieval after the search completes.
+         */
+        post_hoc: boolean;
+    }
+    interface Params {
+        country: Params.Country;
+        end_date: Params.EndDate;
+        exclude_domains: Params.ExcludeDomains;
+        include_domains: Params.IncludeDomains;
+        language: Params.Language;
+        recency: Params.Recency;
+        safe_search: Params.SafeSearch;
+        start_date: Params.StartDate;
+    }
+    namespace Params {
+        interface Country {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+        interface EndDate {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+        interface ExcludeDomains {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+        interface IncludeDomains {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+        interface Language {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+        interface Recency {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+        interface SafeSearch {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+        interface StartDate {
+            support: 'native' | 'emulated' | 'unsupported';
+            /**
+             * Translation behavior, limitations, and precision.
+             */
+            notes?: string;
+        }
+    }
+    interface ProviderOptions {
+        /**
+         * JSON Schema for the provider-native options accepted by POST /search.
+         */
+        schema: {
+            [key: string]: unknown;
+        };
+        /**
+         * OpenAPI component name for the matching typed provider-options schema.
+         */
+        schema_ref: string;
+        examples?: Array<{
+            [key: string]: unknown;
+        }>;
+    }
+}
+export type ProviderListResponse = Array<Provider>;
+export interface ProviderListParams {
+    /**
+     * Optional concrete provider slug filter. Omit to list every provider.
+     */
+    slug?: 'brave' | 'exa' | 'perplexity' | 'context' | 'parallel' | 'valyu' | 'octen' | 'you' | 'tavily' | 'serpapi';
+}
+export declare namespace Providers {
+    export { type Provider as Provider, type ProviderListResponse as ProviderListResponse, type ProviderListParams as ProviderListParams, };
+}
+//# sourceMappingURL=providers.d.ts.map

package/resources/search/providers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/resources/search/providers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAGpC;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAE1B,eAAe,EAAE,MAAM,CAAC;IAExB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC;IAExB,gBAAgB,EAAE,QAAQ,CAAC,eAAe,CAAC;IAE3C,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,OAAO;QACtB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;KACnB;IAED,UAAiB,MAAM;QACrB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;QAExB,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC;QAEzB,eAAe,EAAE,MAAM,CAAC,cAAc,CAAC;QAEvC,eAAe,EAAE,MAAM,CAAC,cAAc,CAAC;QAEvC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;QAE1B,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;QAExB,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC;QAE/B,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;KAC9B;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,OAAO;YACtB,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,OAAO;YACtB,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,cAAc;YAC7B,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,cAAc;YAC7B,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,QAAQ;YACvB,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,OAAO;YACtB,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,UAAU;YACzB,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,SAAS;YACxB,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;YAE/C;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,MAAM,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEnC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,QAAQ,CAAC,EAAE,KAAK,CAAC;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC,CAAC;KAC9C;CACF;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAEnD,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EACD,OAAO,GACP,KAAK,GACL,YAAY,GACZ,SAAS,GACT,UAAU,GACV,OAAO,GACP,OAAO,GACP,KAAK,GACL,QAAQ,GACR,SAAS,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/search/providers.js

@@ -0,0 +1,25 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Providers = void 0;
+const resource_1 = require("../../core/resource.js");
+/**
+ * Search the web and retrieve content for selected results.
+ */
+class Providers extends resource_1.APIResource {
+    /**
+     * Lists providers, capabilities, and machine-readable native-option schemas. Auto
+     * and fallback are strategies, not provider entries. The list is not paginated and
+     * contains no latency benchmarks. X-Request-Id identifies the request.
+     *
+     * @example
+     * ```ts
+     * const providers = await client.search.providers.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/search/providers', { query, ...options });
+    }
+}
+exports.Providers = Providers;
+//# sourceMappingURL=providers.js.map

package/resources/search/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/resources/search/providers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;OASG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAjBD,8BAiBC"}

package/resources/search/providers.mjs

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+/**
+ * Search the web and retrieve content for selected results.
+ */
+export class Providers extends APIResource {
+    /**
+     * Lists providers, capabilities, and machine-readable native-option schemas. Auto
+     * and fallback are strategies, not provider entries. The list is not paginated and
+     * contains no latency benchmarks. X-Request-Id identifies the request.
+     *
+     * @example
+     * ```ts
+     * const providers = await client.search.providers.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/search/providers', { query, ...options });
+    }
+}
+//# sourceMappingURL=providers.mjs.map

package/resources/search/providers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.mjs","sourceRoot":"","sources":["../../src/resources/search/providers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;OASG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}