@chat-ads/chatads-sdk 0.1.16 → 0.2.1

package/README.md

@@ -41,15 +41,7 @@ if (response.data?.offers?.length) {
 ```ts
 const result = await client.analyzeMessage("Need scheduling ideas", {
   country: "US",
-});
-```
-
-### Image search
-
-```ts
-const result = await client.analyze({
-  message: "https://example.com/product-image.jpg",
-  input_type: "image_url",
+  max_offers: 2,
 });
 ```
 
@@ -101,7 +93,8 @@ try {
     "offers": [
       {
         "link_text": "CRM tools",
-        "url": "https://amazon.com/dp/example?tag=chatads-20"
+        "url": "https://www.amazon.com/dp/example?tag=chatads-20",
+        "is_branded": true
       }
     ],
     "requested": 1,

package/dist/client.js

@@ -180,7 +180,6 @@ async function parseResponse(response) {
                 extraction_source: data.extraction_source,
                 extraction_debug: data.extraction_debug,
                 resolution_debug: data.resolution_debug,
-                input_type: data.input_type,
             },
             error: raw.error,
             meta: raw.meta ?? { request_id: "unknown" },

package/dist/models.d.ts

@@ -1,4 +1,4 @@
-export type ExtractionMode = "none" | "fast" | "standard";
+export type ExtractionMode = "none" | "standard";
 export type ResolutionMode = "none" | "standard";
 /** Top-level response status indicating the outcome of the request */
 export type ResponseStatus = "filled" | "partial_fill" | "no_offer" | "no_brand_found" | "message_too_short" | "message_too_long" | "country_not_allowed" | "blocked_keyword" | "language_not_allowed" | "ip_country_not_allowed";
@@ -10,14 +10,14 @@ export type FunctionItemOptionalFields = {
     ip?: string;
     /** ISO 3166-1 alpha-2 country code for geo-targeting */
     country?: string;
-    /** Content type of the input message. Default: "text" */
-    input_type?: "text" | "image_url" | "image_file";
-    /** Extraction control: "none" (bring your own product), "fast" (NLP only), "standard" (default). Default: "standard" */
+    /** Extraction control: "none" (bring your own product), "standard" (default). Default: "standard" */
     extraction_mode?: ExtractionMode;
     /** Resolution control: "none" (extraction only), "standard" (default). Default: "standard" */
     resolution_mode?: ResolutionMode;
-    /** Filter image search results by title keyword (image input_type only) */
-    image_title_filter?: string;
+    /** Max distinct keyterms with offers extracted (1-3). Default: 1. */
+    max_offers?: number;
+    /** Max resolved products per offer carousel (1-3). Default: 1. */
+    max_products_per_offer?: number;
     /** Arbitrary JSON metadata passed through to the response (max 10KB, must be a JSON object) */
     metadata?: Record<string, unknown>;
 };
@@ -31,18 +31,22 @@ export type FunctionItemPayload = {
 export interface Product {
     /** Product title from search result */
     title?: string;
-    /** Product rating (e.g., 4.5 out of 5) */
+    /** Raw product rating on the catalog's scale (e.g., 4.5 on a 5-star catalog) */
     stars?: number;
     /** Number of product reviews */
     reviews?: number;
     /** Product image URL */
     image?: string;
-    /** Product price in USD, when available */
+    /** Product price in USD (canonical). Only present when available from search results. */
     price?: number;
+    /** ISO 4217 currency code for `price`. Always "USD" today. */
+    currency?: string;
+    /** Raw catalog price in the source catalog's currency. Only populated for non-USD catalogs. */
+    price_local?: number;
+    /** ISO 4217 currency code for `price_local`. Only populated for non-USD catalogs. */
+    currency_local?: string;
     /** Brand name (not always available) */
     brand_name?: string;
-    /** Whether the product is Amazon Prime eligible */
-    is_prime?: boolean;
 }
 /**
  * Single affiliate offer returned by the API.
@@ -53,18 +57,14 @@ export interface Offer {
     link_text: string;
     /** Product search term used (verbose mode only) */
     search_term?: string;
-    /** Unified intent score (verbose mode only) */
-    confidence_score?: number | null;
-    /** Confidence level classification (verbose mode only) */
-    confidence_level?: string;
     /** Affiliate URL — empty when resolution_mode=none */
     url?: string;
-    /** Source of the URL resolution (e.g., vector, serper_lens) (verbose mode only) */
+    /** Source of the URL resolution (e.g., vector) (verbose mode only) */
     resolution_source?: string;
-    /** Product metadata from resolution */
-    product?: Product;
-    /** Source retailer name (image input_type only) */
-    offer_source?: string;
+    /** Whether the winning extracted term was classified as brand-derived (true) or generic (false). Omitted when no classification is available (e.g. extraction_mode=none). */
+    is_branded?: boolean;
+    /** Resolved products carousel. products[0] is the ranking-best pick; additional entries are runner-ups deduped across offers. Up to max_products_per_offer entries (default 1). */
+    products?: Product[];
 }
 /**
  * Response data containing affiliate offers.
@@ -80,14 +80,12 @@ export interface AnalyzeData {
     returned: number;
     /** Whether this request was billed */
     billed: boolean;
-    /** Extraction source ("nlp", "groq_vector", "groq_resolved") (verbose mode only) */
+    /** Extraction source ("nlp") (verbose mode only) */
     extraction_source?: string;
     /** Extraction debug information (verbose mode only) */
     extraction_debug?: unknown[];
     /** Resolution debug information (verbose mode only) */
     resolution_debug?: unknown[];
-    /** Request input type (verbose mode only) */
-    input_type?: string;
 }
 export interface ChatAdsError {
     code: string;

package/dist/models.js

@@ -6,9 +6,9 @@ export const RESERVED_PAYLOAD_KEYS = new Set([
     "message",
     "ip",
     "country",
-    "input_type",
     "extraction_mode",
     "resolution_mode",
-    "image_title_filter",
+    "max_offers",
+    "max_products_per_offer",
     "metadata",
 ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chat-ads/chatads-sdk",
-  "version": "0.1.16",
+  "version": "0.2.1",
   "description": "TypeScript/JavaScript client for the ChatAds prospect scoring API",
   "license": "MIT",
   "type": "module",