context.dev 0.2.0 → 0.3.0

package/resources/ai.d.mts

@@ -0,0 +1,331 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class AI extends APIResource {
+    /**
+     * Use AI to extract specific data points from a brand's website. The AI will crawl
+     * the website and extract the requested information based on the provided data
+     * points.
+     */
+    aiQuery(body: AIAIQueryParams, options?: RequestOptions): APIPromise<AIAIQueryResponse>;
+    /**
+     * Beta feature: Given a single URL, determines if it is a product detail page,
+     * classifies the platform/product type, and extracts the product information.
+     * Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites.
+     */
+    extractProduct(body: AIExtractProductParams, options?: RequestOptions): APIPromise<AIExtractProductResponse>;
+    /**
+     * Beta feature: Extract product information from a brand's website. Brand.dev will
+     * analyze the website and return a list of products with details such as name,
+     * description, image, pricing, features, and more.
+     */
+    extractProducts(body: AIExtractProductsParams, options?: RequestOptions): APIPromise<AIExtractProductsResponse>;
+}
+export interface AIAIQueryResponse {
+    /**
+     * Array of extracted data points
+     */
+    data_extracted?: Array<AIAIQueryResponse.DataExtracted>;
+    /**
+     * The domain that was analyzed
+     */
+    domain?: string;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+    /**
+     * List of URLs that were analyzed
+     */
+    urls_analyzed?: Array<string>;
+}
+export declare namespace AIAIQueryResponse {
+    interface DataExtracted {
+        /**
+         * Name of the extracted data point
+         */
+        datapoint_name?: string;
+        /**
+         * Value of the extracted data point. Can be a primitive type, an array of
+         * primitives, or an array of objects when datapoint_list_type is 'object'.
+         */
+        datapoint_value?: string | number | boolean | Array<string> | Array<number> | Array<unknown>;
+    }
+}
+export interface AIExtractProductResponse {
+    /**
+     * Whether the given URL is a product detail page
+     */
+    is_product_page?: boolean;
+    /**
+     * The detected ecommerce platform, or null if not a product page
+     */
+    platform?: 'amazon' | 'tiktok_shop' | 'etsy' | 'generic' | null;
+    /**
+     * The extracted product data, or null if not a product page
+     */
+    product?: AIExtractProductResponse.Product | null;
+}
+export declare namespace AIExtractProductResponse {
+    /**
+     * The extracted product data, or null if not a product page
+     */
+    interface Product {
+        /**
+         * Description of the product
+         */
+        description: string;
+        /**
+         * List of product features
+         */
+        features: Array<string>;
+        /**
+         * URLs to product images on the page (up to 7)
+         */
+        images: Array<string>;
+        /**
+         * Name of the product
+         */
+        name: string;
+        /**
+         * Tags associated with the product
+         */
+        tags: Array<string>;
+        /**
+         * Target audience for the product (array of strings)
+         */
+        target_audience: Array<string>;
+        /**
+         * Billing frequency for the product
+         */
+        billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
+        /**
+         * Category of the product
+         */
+        category?: string | null;
+        /**
+         * Currency code for the price (e.g., USD, EUR)
+         */
+        currency?: string | null;
+        /**
+         * URL to the product image
+         */
+        image_url?: string | null;
+        /**
+         * Price of the product
+         */
+        price?: number | null;
+        /**
+         * Pricing model for the product
+         */
+        pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
+        /**
+         * URL to the product page
+         */
+        url?: string | null;
+    }
+}
+export interface AIExtractProductsResponse {
+    /**
+     * Array of products extracted from the website
+     */
+    products?: Array<AIExtractProductsResponse.Product>;
+}
+export declare namespace AIExtractProductsResponse {
+    interface Product {
+        /**
+         * Description of the product
+         */
+        description: string;
+        /**
+         * List of product features
+         */
+        features: Array<string>;
+        /**
+         * URLs to product images on the page (up to 7)
+         */
+        images: Array<string>;
+        /**
+         * Name of the product
+         */
+        name: string;
+        /**
+         * Tags associated with the product
+         */
+        tags: Array<string>;
+        /**
+         * Target audience for the product (array of strings)
+         */
+        target_audience: Array<string>;
+        /**
+         * Billing frequency for the product
+         */
+        billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
+        /**
+         * Category of the product
+         */
+        category?: string | null;
+        /**
+         * Currency code for the price (e.g., USD, EUR)
+         */
+        currency?: string | null;
+        /**
+         * URL to the product image
+         */
+        image_url?: string | null;
+        /**
+         * Price of the product
+         */
+        price?: number | null;
+        /**
+         * Pricing model for the product
+         */
+        pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
+        /**
+         * URL to the product page
+         */
+        url?: string | null;
+    }
+}
+export interface AIAIQueryParams {
+    /**
+     * Array of data points to extract from the website
+     */
+    data_to_extract: Array<AIAIQueryParams.DataToExtract>;
+    /**
+     * The domain name to analyze
+     */
+    domain: string;
+    /**
+     * Optional object specifying which pages to analyze
+     */
+    specific_pages?: AIAIQueryParams.SpecificPages;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export declare namespace AIAIQueryParams {
+    interface DataToExtract {
+        /**
+         * Description of what to extract
+         */
+        datapoint_description: string;
+        /**
+         * Example of the expected value
+         */
+        datapoint_example: string;
+        /**
+         * Name of the data point to extract
+         */
+        datapoint_name: string;
+        /**
+         * Type of the data point
+         */
+        datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
+        /**
+         * Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
+         * Use 'object' to extract an array of objects matching a schema.
+         */
+        datapoint_list_type?: 'string' | 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url' | 'object';
+        /**
+         * Schema definition for objects when datapoint_list_type is 'object'. Provide a
+         * map of field names to their scalar types.
+         */
+        datapoint_object_schema?: {
+            [key: string]: 'string' | 'number' | 'date' | 'boolean';
+        };
+    }
+    /**
+     * Optional object specifying which pages to analyze
+     */
+    interface SpecificPages {
+        /**
+         * Whether to analyze the about us page
+         */
+        about_us?: boolean;
+        /**
+         * Whether to analyze the blog
+         */
+        blog?: boolean;
+        /**
+         * Whether to analyze the careers page
+         */
+        careers?: boolean;
+        /**
+         * Whether to analyze the contact us page
+         */
+        contact_us?: boolean;
+        /**
+         * Whether to analyze the FAQ page
+         */
+        faq?: boolean;
+        /**
+         * Whether to analyze the home page
+         */
+        home_page?: boolean;
+        /**
+         * Whether to analyze the pricing page
+         */
+        pricing?: boolean;
+        /**
+         * Whether to analyze the privacy policy page
+         */
+        privacy_policy?: boolean;
+        /**
+         * Whether to analyze the terms and conditions page
+         */
+        terms_and_conditions?: boolean;
+    }
+}
+export interface AIExtractProductParams {
+    /**
+     * The product page URL to extract product data from.
+     */
+    url: string;
+    /**
+     * Optional timeout in milliseconds for the request. Maximum allowed value is
+     * 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export type AIExtractProductsParams = AIExtractProductsParams.ByDomain | AIExtractProductsParams.ByDirectURL;
+export declare namespace AIExtractProductsParams {
+    interface ByDomain {
+        /**
+         * The domain name to analyze.
+         */
+        domain: string;
+        /**
+         * Maximum number of products to extract.
+         */
+        maxProducts?: number;
+        /**
+         * Optional timeout in milliseconds for the request. Maximum allowed value is
+         * 300000ms (5 minutes).
+         */
+        timeoutMS?: number;
+    }
+    interface ByDirectURL {
+        /**
+         * A specific URL to use directly as the starting point for extraction without
+         * domain resolution.
+         */
+        directUrl: string;
+        /**
+         * Maximum number of products to extract.
+         */
+        maxProducts?: number;
+        /**
+         * Optional timeout in milliseconds for the request. Maximum allowed value is
+         * 300000ms (5 minutes).
+         */
+        timeoutMS?: number;
+    }
+}
+export declare namespace AI {
+    export { type AIAIQueryResponse as AIAIQueryResponse, type AIExtractProductResponse as AIExtractProductResponse, type AIExtractProductsResponse as AIExtractProductsResponse, type AIAIQueryParams as AIAIQueryParams, type AIExtractProductParams as AIExtractProductParams, type AIExtractProductsParams as AIExtractProductsParams, };
+}
+//# sourceMappingURL=ai.d.mts.map

package/resources/ai.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.d.mts","sourceRoot":"","sources":["../src/resources/ai.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIvF;;;;OAIG;IACH,cAAc,CACZ,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;OAIG;IACH,eAAe,CACb,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAExD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,aAAa;QAC5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;KAC9F;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;CACnD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,IAAI,CAAC;QAE7E;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE9E;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,IAAI,CAAC;QAE7E;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE9E;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAEtD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC,aAAa,CAAC;IAE/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,aAAa;QAC5B;;WAEG;QACH,qBAAqB,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC;QAExE;;;WAGG;QACH,mBAAmB,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;QAEpG;;;WAGG;QACH,uBAAuB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;SAAE,CAAC;KACvF;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,GAAG,CAAC,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;KAChC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,CAAC,QAAQ,GAAG,uBAAuB,CAAC,WAAW,CAAC;AAE7G,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,WAAW;QAC1B;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/ai.d.ts

@@ -0,0 +1,331 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class AI extends APIResource {
+    /**
+     * Use AI to extract specific data points from a brand's website. The AI will crawl
+     * the website and extract the requested information based on the provided data
+     * points.
+     */
+    aiQuery(body: AIAIQueryParams, options?: RequestOptions): APIPromise<AIAIQueryResponse>;
+    /**
+     * Beta feature: Given a single URL, determines if it is a product detail page,
+     * classifies the platform/product type, and extracts the product information.
+     * Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites.
+     */
+    extractProduct(body: AIExtractProductParams, options?: RequestOptions): APIPromise<AIExtractProductResponse>;
+    /**
+     * Beta feature: Extract product information from a brand's website. Brand.dev will
+     * analyze the website and return a list of products with details such as name,
+     * description, image, pricing, features, and more.
+     */
+    extractProducts(body: AIExtractProductsParams, options?: RequestOptions): APIPromise<AIExtractProductsResponse>;
+}
+export interface AIAIQueryResponse {
+    /**
+     * Array of extracted data points
+     */
+    data_extracted?: Array<AIAIQueryResponse.DataExtracted>;
+    /**
+     * The domain that was analyzed
+     */
+    domain?: string;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+    /**
+     * List of URLs that were analyzed
+     */
+    urls_analyzed?: Array<string>;
+}
+export declare namespace AIAIQueryResponse {
+    interface DataExtracted {
+        /**
+         * Name of the extracted data point
+         */
+        datapoint_name?: string;
+        /**
+         * Value of the extracted data point. Can be a primitive type, an array of
+         * primitives, or an array of objects when datapoint_list_type is 'object'.
+         */
+        datapoint_value?: string | number | boolean | Array<string> | Array<number> | Array<unknown>;
+    }
+}
+export interface AIExtractProductResponse {
+    /**
+     * Whether the given URL is a product detail page
+     */
+    is_product_page?: boolean;
+    /**
+     * The detected ecommerce platform, or null if not a product page
+     */
+    platform?: 'amazon' | 'tiktok_shop' | 'etsy' | 'generic' | null;
+    /**
+     * The extracted product data, or null if not a product page
+     */
+    product?: AIExtractProductResponse.Product | null;
+}
+export declare namespace AIExtractProductResponse {
+    /**
+     * The extracted product data, or null if not a product page
+     */
+    interface Product {
+        /**
+         * Description of the product
+         */
+        description: string;
+        /**
+         * List of product features
+         */
+        features: Array<string>;
+        /**
+         * URLs to product images on the page (up to 7)
+         */
+        images: Array<string>;
+        /**
+         * Name of the product
+         */
+        name: string;
+        /**
+         * Tags associated with the product
+         */
+        tags: Array<string>;
+        /**
+         * Target audience for the product (array of strings)
+         */
+        target_audience: Array<string>;
+        /**
+         * Billing frequency for the product
+         */
+        billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
+        /**
+         * Category of the product
+         */
+        category?: string | null;
+        /**
+         * Currency code for the price (e.g., USD, EUR)
+         */
+        currency?: string | null;
+        /**
+         * URL to the product image
+         */
+        image_url?: string | null;
+        /**
+         * Price of the product
+         */
+        price?: number | null;
+        /**
+         * Pricing model for the product
+         */
+        pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
+        /**
+         * URL to the product page
+         */
+        url?: string | null;
+    }
+}
+export interface AIExtractProductsResponse {
+    /**
+     * Array of products extracted from the website
+     */
+    products?: Array<AIExtractProductsResponse.Product>;
+}
+export declare namespace AIExtractProductsResponse {
+    interface Product {
+        /**
+         * Description of the product
+         */
+        description: string;
+        /**
+         * List of product features
+         */
+        features: Array<string>;
+        /**
+         * URLs to product images on the page (up to 7)
+         */
+        images: Array<string>;
+        /**
+         * Name of the product
+         */
+        name: string;
+        /**
+         * Tags associated with the product
+         */
+        tags: Array<string>;
+        /**
+         * Target audience for the product (array of strings)
+         */
+        target_audience: Array<string>;
+        /**
+         * Billing frequency for the product
+         */
+        billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
+        /**
+         * Category of the product
+         */
+        category?: string | null;
+        /**
+         * Currency code for the price (e.g., USD, EUR)
+         */
+        currency?: string | null;
+        /**
+         * URL to the product image
+         */
+        image_url?: string | null;
+        /**
+         * Price of the product
+         */
+        price?: number | null;
+        /**
+         * Pricing model for the product
+         */
+        pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
+        /**
+         * URL to the product page
+         */
+        url?: string | null;
+    }
+}
+export interface AIAIQueryParams {
+    /**
+     * Array of data points to extract from the website
+     */
+    data_to_extract: Array<AIAIQueryParams.DataToExtract>;
+    /**
+     * The domain name to analyze
+     */
+    domain: string;
+    /**
+     * Optional object specifying which pages to analyze
+     */
+    specific_pages?: AIAIQueryParams.SpecificPages;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export declare namespace AIAIQueryParams {
+    interface DataToExtract {
+        /**
+         * Description of what to extract
+         */
+        datapoint_description: string;
+        /**
+         * Example of the expected value
+         */
+        datapoint_example: string;
+        /**
+         * Name of the data point to extract
+         */
+        datapoint_name: string;
+        /**
+         * Type of the data point
+         */
+        datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
+        /**
+         * Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
+         * Use 'object' to extract an array of objects matching a schema.
+         */
+        datapoint_list_type?: 'string' | 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url' | 'object';
+        /**
+         * Schema definition for objects when datapoint_list_type is 'object'. Provide a
+         * map of field names to their scalar types.
+         */
+        datapoint_object_schema?: {
+            [key: string]: 'string' | 'number' | 'date' | 'boolean';
+        };
+    }
+    /**
+     * Optional object specifying which pages to analyze
+     */
+    interface SpecificPages {
+        /**
+         * Whether to analyze the about us page
+         */
+        about_us?: boolean;
+        /**
+         * Whether to analyze the blog
+         */
+        blog?: boolean;
+        /**
+         * Whether to analyze the careers page
+         */
+        careers?: boolean;
+        /**
+         * Whether to analyze the contact us page
+         */
+        contact_us?: boolean;
+        /**
+         * Whether to analyze the FAQ page
+         */
+        faq?: boolean;
+        /**
+         * Whether to analyze the home page
+         */
+        home_page?: boolean;
+        /**
+         * Whether to analyze the pricing page
+         */
+        pricing?: boolean;
+        /**
+         * Whether to analyze the privacy policy page
+         */
+        privacy_policy?: boolean;
+        /**
+         * Whether to analyze the terms and conditions page
+         */
+        terms_and_conditions?: boolean;
+    }
+}
+export interface AIExtractProductParams {
+    /**
+     * The product page URL to extract product data from.
+     */
+    url: string;
+    /**
+     * Optional timeout in milliseconds for the request. Maximum allowed value is
+     * 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export type AIExtractProductsParams = AIExtractProductsParams.ByDomain | AIExtractProductsParams.ByDirectURL;
+export declare namespace AIExtractProductsParams {
+    interface ByDomain {
+        /**
+         * The domain name to analyze.
+         */
+        domain: string;
+        /**
+         * Maximum number of products to extract.
+         */
+        maxProducts?: number;
+        /**
+         * Optional timeout in milliseconds for the request. Maximum allowed value is
+         * 300000ms (5 minutes).
+         */
+        timeoutMS?: number;
+    }
+    interface ByDirectURL {
+        /**
+         * A specific URL to use directly as the starting point for extraction without
+         * domain resolution.
+         */
+        directUrl: string;
+        /**
+         * Maximum number of products to extract.
+         */
+        maxProducts?: number;
+        /**
+         * Optional timeout in milliseconds for the request. Maximum allowed value is
+         * 300000ms (5 minutes).
+         */
+        timeoutMS?: number;
+    }
+}
+export declare namespace AI {
+    export { type AIAIQueryResponse as AIAIQueryResponse, type AIExtractProductResponse as AIExtractProductResponse, type AIExtractProductsResponse as AIExtractProductsResponse, type AIAIQueryParams as AIAIQueryParams, type AIExtractProductParams as AIExtractProductParams, type AIExtractProductsParams as AIExtractProductsParams, };
+}
+//# sourceMappingURL=ai.d.ts.map

package/resources/ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../src/resources/ai.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIvF;;;;OAIG;IACH,cAAc,CACZ,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;OAIG;IACH,eAAe,CACb,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAExD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,aAAa;QAC5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;KAC9F;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;CACnD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,IAAI,CAAC;QAE7E;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE9E;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,IAAI,CAAC;QAE7E;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE9E;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAEtD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC,aAAa,CAAC;IAE/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,aAAa;QAC5B;;WAEG;QACH,qBAAqB,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC;QAExE;;;WAGG;QACH,mBAAmB,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;QAEpG;;;WAGG;QACH,uBAAuB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;SAAE,CAAC;KACvF;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,GAAG,CAAC,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;KAChC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,CAAC,QAAQ,GAAG,uBAAuB,CAAC,WAAW,CAAC;AAE7G,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,WAAW;QAC1B;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}