@microsoft/webiq 0.1.0 → 0.1.1

package/README.md

@@ -62,6 +62,10 @@ await client.close();
 
 ## Authentication
 
+### API Key
+
+Get an API key at [webiq.microsoft.ai](https://webiq.microsoft.ai).
+
 ```typescript
 import { WebIQClient } from '@microsoft/webiq';
 
@@ -110,7 +114,7 @@ const results = await client.news.search(query, {
   contentFormat: ContentFormat.TEXT,
   maxLength: 10000,
 });
-// results.newsResults → [{title, url, content, snippet, source, lastUpdatedAt, thumbnail, isAdult}]
+// results.newsResults → [{title, url, content, source, lastUpdatedAt, thumbnail, isAdult}]
 ```
 
 ### Video Search

package/dist/index.d.mts

@@ -113,6 +113,14 @@ type WebResult = {
      * Indicates whether the result includes adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type WebResponse = {
@@ -120,6 +128,14 @@ type WebResponse = {
      * List of web page results.
      */
     webResults?: Array<WebResult> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -205,10 +221,6 @@ type NewsItem = {
      * The detailed content of the news.
      */
     content?: string | null;
-    /**
-     * A snippet from the news content.
-     */
-    snippet?: string | null;
     thumbnail?: NewsThumbnail;
     /**
      * The last updated date of the news, in UTC ISO8601 format.
@@ -222,6 +234,14 @@ type NewsItem = {
      * Indicates if the content is adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type NewsResponse = {
@@ -229,6 +249,14 @@ type NewsResponse = {
      * List of news article results.
      */
     newsResults?: Array<NewsItem> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -420,6 +448,14 @@ type VideoItem = {
      * Indicates whether the result includes adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type VideosResponse = {
@@ -431,6 +467,14 @@ type VideosResponse = {
      * List of playlist results.
      */
     playlists?: Array<PlaylistItem> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -543,6 +587,14 @@ type ImageItem = {
      * Indicates whether the content is adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type ImagesResponse = {
@@ -550,6 +602,14 @@ type ImagesResponse = {
      * List of image results.
      */
     imageResults?: Array<ImageItem> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -736,16 +796,20 @@ type QuerySignals = {
     isFresh?: boolean | null;
 };
 
-/**
- * Response for the classic search endpoint. The spec defines this as an
- * open object (additionalProperties: {}) — keep the typed fields the spec
- * lists but allow arbitrary extra keys (webResults, imageResults, etc.)
- * so callers can read what the server actually returns.
- */
 type SearchClassicResponse = {
     querySignals?: QuerySignals;
-    /** Trace ID for debugging and tracking. */
-    traceId?: string;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
+    /**
+     * Trace ID for debugging and tracking.
+     */
+    traceId?: string | null;
     [key: string]: any;
 };
 

package/dist/index.d.ts

@@ -113,6 +113,14 @@ type WebResult = {
      * Indicates whether the result includes adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type WebResponse = {
@@ -120,6 +128,14 @@ type WebResponse = {
      * List of web page results.
      */
     webResults?: Array<WebResult> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -205,10 +221,6 @@ type NewsItem = {
      * The detailed content of the news.
      */
     content?: string | null;
-    /**
-     * A snippet from the news content.
-     */
-    snippet?: string | null;
     thumbnail?: NewsThumbnail;
     /**
      * The last updated date of the news, in UTC ISO8601 format.
@@ -222,6 +234,14 @@ type NewsItem = {
      * Indicates if the content is adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type NewsResponse = {
@@ -229,6 +249,14 @@ type NewsResponse = {
      * List of news article results.
      */
     newsResults?: Array<NewsItem> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -420,6 +448,14 @@ type VideoItem = {
      * Indicates whether the result includes adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type VideosResponse = {
@@ -431,6 +467,14 @@ type VideosResponse = {
      * List of playlist results.
      */
     playlists?: Array<PlaylistItem> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -543,6 +587,14 @@ type ImageItem = {
      * Indicates whether the content is adult content.
      */
     isAdult?: boolean;
+    /**
+     * Redirect URL that proxies through Bing. Only present when redirect is enabled.
+     */
+    clickUrl?: string | null;
+    /**
+     * Suffix to append to the instrumentation ping URL base for this result item.
+     */
+    instrumentationSuffix?: string | null;
 };
 
 type ImagesResponse = {
@@ -550,6 +602,14 @@ type ImagesResponse = {
      * List of image results.
      */
     imageResults?: Array<ImageItem> | null;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
     /**
      * Trace ID for debugging and tracking.
      */
@@ -736,16 +796,20 @@ type QuerySignals = {
     isFresh?: boolean | null;
 };
 
-/**
- * Response for the classic search endpoint. The spec defines this as an
- * open object (additionalProperties: {}) — keep the typed fields the spec
- * lists but allow arbitrary extra keys (webResults, imageResults, etc.)
- * so callers can read what the server actually returns.
- */
 type SearchClassicResponse = {
     querySignals?: QuerySignals;
-    /** Trace ID for debugging and tracking. */
-    traceId?: string;
+    /**
+     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
+     */
+    instrumentationClickBase?: string | null;
+    /**
+     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
+     */
+    instrumentationCitationBase?: string | null;
+    /**
+     * Trace ID for debugging and tracking.
+     */
+    traceId?: string | null;
     [key: string]: any;
 };
 

package/package.json

@@ -1,65 +1,67 @@
 {
-    "name": "@microsoft/webiq",
-    "version": "0.1.0",
-    "description": "Web IQ API TypeScript SDK",
-    "main": "dist/index.js",
-    "module": "dist/index.mjs",
-    "types": "dist/index.d.ts",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.mjs",
-            "require": "./dist/index.js"
-        }
-    },
-    "files": [
-        "dist",
-        "README.md"
-    ],
-    "scripts": {
-        "build": "tsup",
-        "dev": "tsup --watch",
-        "lint": "eslint src --ext .ts",
-        "lint:fix": "eslint src --ext .ts --fix",
-        "format": "prettier --write \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
-        "format:check": "prettier --check \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
-        "typecheck": "tsc --noEmit",
-        "test": "vitest run",
-        "test:watch": "vitest",
-        "clean": "rimraf dist"
-    },
-    "keywords": [
-        "webiq",
-        "webiq sdk"
-    ],
-    "author": "Microsoft <webiqsdk@microsoft.com>",
-    "license": "MIT",
-    "engines": {
-        "node": ">=22",
-        "npm": ">=10"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "sideEffects": false,
-    "devDependencies": {
-        "@azure/identity": ">=4.13.1",
-        "@types/node": "^20.10.0",
-        "eslint": "^8.56.0",
-        "openapi-typescript-codegen": "^0.30.0",
-        "prettier": "^3.5.3",
-        "rimraf": "^6.0.0",
-        "tsup": "^8.0.0",
-        "tsx": "^4.21.0",
-        "typescript": "^5.3.0",
-        "vitest": "^4.0.18"
-    },
-    "peerDependencies": {
-        "@azure/identity": ">=4.13.1"
-    },
-    "peerDependenciesMeta": {
-        "@azure/identity": {
-            "optional": true
-        }
+  "name": "@microsoft/webiq",
+  "version": "0.1.1",
+  "description": "Web IQ API TypeScript SDK",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
     }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
+    "format:check": "prettier --check \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rimraf dist"
+  },
+  "keywords": [
+    "webiq",
+    "webiq sdk"
+  ],
+  "author": "Microsoft <webiqsdk@microsoft.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=22",
+    "npm": ">=10"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "@azure/identity": ">=4.13.1",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.10.0",
+    "eslint": "^8.56.0",
+    "js-yaml": "^5.2.0",
+    "openapi-typescript-codegen": "^0.30.0",
+    "prettier": "^3.5.3",
+    "rimraf": "^6.0.0",
+    "tsup": "^8.0.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.3.0",
+    "vitest": "^4.0.18"
+  },
+  "peerDependencies": {
+    "@azure/identity": ">=4.13.1"
+  },
+  "peerDependenciesMeta": {
+    "@azure/identity": {
+      "optional": true
+    }
+  }
 }