@boldvideo/bold-js 1.6.0 → 1.6.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @boldvideo/bold-js
 
+## 1.6.1
+
+### Patch Changes
+
+- 7aff057: Align SDK with API specification
+
+  - Renamed `synthesize` to `includeGuidance` in `RecommendOptions` to match API
+  - Renamed `why` to `reason` in `RecommendationVideo` type to match API response
+  - Added `tags` filter to `AskOptions` and `SearchOptions`
+  - Added `currentTime` to `ChatOptions` for playback context
+
 ## 1.6.0
 
 ### Minor Changes

package/README.md

@@ -133,7 +133,7 @@ console.log(response.recommendations);
 | `limit` | `number` | Max videos per topic (default: 5, max: 20) |
 | `collectionId` | `string` | Filter to a specific collection |
 | `tags` | `string[]` | Filter by tags |
-| `synthesize` | `boolean` | Include AI guidance (default: true) |
+| `includeGuidance` | `boolean` | Include AI learning path narrative (default: true) |
 | `context` | `string` | User context for personalized guidance |
 
 ### Coach / Ask
@@ -186,6 +186,12 @@ const stream = await bold.ai.chat('video-id', {
 for await (const event of stream) {
   if (event.type === 'text_delta') process.stdout.write(event.delta);
 }
+
+// With playback context - helps AI understand what viewer just watched
+const stream = await bold.ai.chat('video-id', { 
+  prompt: 'What does she mean by that?',
+  currentTime: 847  // seconds
+});
 ```
 
 ### Multi-turn Conversations

package/dist/index.cjs

@@ -306,6 +306,8 @@ function createAI(config) {
     const body = { prompt: options.prompt };
     if (options.collectionId)
       body.collection_id = options.collectionId;
+    if (options.tags)
+      body.tags = options.tags;
     if (options.stream === false) {
       body.stream = false;
       return jsonRequest(path, body, config);
@@ -324,6 +326,8 @@ function createAI(config) {
       body.collection_id = options.collectionId;
     if (options.videoId)
       body.video_id = options.videoId;
+    if (options.tags)
+      body.tags = options.tags;
     if (options.context)
       body.context = options.context;
     if (options.stream === false) {
@@ -335,6 +339,8 @@ function createAI(config) {
   async function chat(videoId, options) {
     const path = options.conversationId ? `ai/videos/${videoId}/chat/${options.conversationId}` : `ai/videos/${videoId}/chat`;
     const body = { prompt: options.prompt };
+    if (options.currentTime !== void 0)
+      body.current_time = options.currentTime;
     if (options.stream === false) {
       body.stream = false;
       return jsonRequest(path, body, config);
@@ -350,8 +356,8 @@ function createAI(config) {
       body.collection_id = options.collectionId;
     if (options.tags)
       body.tags = options.tags;
-    if (options.synthesize !== void 0)
-      body.synthesize = options.synthesize;
+    if (options.includeGuidance !== void 0)
+      body.include_guidance = options.includeGuidance;
     if (options.context)
       body.context = options.context;
     if (options.stream === false) {

package/dist/index.d.ts

@@ -260,6 +260,7 @@ interface AskOptions {
     stream?: boolean;
     conversationId?: string;
     collectionId?: string;
+    tags?: string[];
 }
 /**
  * Conversation message for AI context
@@ -277,6 +278,7 @@ interface SearchOptions {
     limit?: number;
     collectionId?: string;
     videoId?: string;
+    tags?: string[];
     context?: AIContextMessage[];
 }
 /**
@@ -290,6 +292,7 @@ interface ChatOptions {
     prompt: string;
     stream?: boolean;
     conversationId?: string;
+    currentTime?: number;
 }
 /**
  * A recommended video with relevance score
@@ -299,7 +302,7 @@ interface RecommendationVideo {
     title: string;
     playback_id: string;
     relevance: number;
-    why: string;
+    reason: string;
 }
 /**
  * A topic recommendation with its videos
@@ -325,7 +328,7 @@ interface RecommendOptions {
     limit?: number;
     collectionId?: string;
     tags?: string[];
-    synthesize?: boolean;
+    includeGuidance?: boolean;
     context?: string;
 }
 /**

package/dist/index.js

@@ -268,6 +268,8 @@ function createAI(config) {
     const body = { prompt: options.prompt };
     if (options.collectionId)
       body.collection_id = options.collectionId;
+    if (options.tags)
+      body.tags = options.tags;
     if (options.stream === false) {
       body.stream = false;
       return jsonRequest(path, body, config);
@@ -286,6 +288,8 @@ function createAI(config) {
       body.collection_id = options.collectionId;
     if (options.videoId)
       body.video_id = options.videoId;
+    if (options.tags)
+      body.tags = options.tags;
     if (options.context)
       body.context = options.context;
     if (options.stream === false) {
@@ -297,6 +301,8 @@ function createAI(config) {
   async function chat(videoId, options) {
     const path = options.conversationId ? `ai/videos/${videoId}/chat/${options.conversationId}` : `ai/videos/${videoId}/chat`;
     const body = { prompt: options.prompt };
+    if (options.currentTime !== void 0)
+      body.current_time = options.currentTime;
     if (options.stream === false) {
       body.stream = false;
       return jsonRequest(path, body, config);
@@ -312,8 +318,8 @@ function createAI(config) {
       body.collection_id = options.collectionId;
     if (options.tags)
       body.tags = options.tags;
-    if (options.synthesize !== void 0)
-      body.synthesize = options.synthesize;
+    if (options.includeGuidance !== void 0)
+      body.include_guidance = options.includeGuidance;
     if (options.context)
       body.context = options.context;
     if (options.stream === false) {

package/llms.txt

@@ -65,7 +65,7 @@ All AI methods return `AsyncIterable<AIEvent>` (streaming) or `Promise<AIRespons
   limit?: number;             // Max videos per topic (default: 5, max: 20)
   collectionId?: string;      // Filter to collection
   tags?: string[];            // Filter by tags
-  synthesize?: boolean;       // Include AI guidance (default: true)
+  includeGuidance?: boolean;  // Include AI learning path narrative (default: true)
   context?: string;           // User context for personalization
 }
 ```
@@ -78,6 +78,7 @@ All AI methods return `AsyncIterable<AIEvent>` (streaming) or `Promise<AIRespons
   stream?: boolean;           // Default: true
   conversationId?: string;    // Continue existing conversation
   collectionId?: string;      // Filter to collection
+  tags?: string[];            // Filter by tags
 }
 ```
 
@@ -90,6 +91,7 @@ All AI methods return `AsyncIterable<AIEvent>` (streaming) or `Promise<AIRespons
   limit?: number;             // Max results
   collectionId?: string;      // Filter to collection
   videoId?: string;           // Search within specific video
+  tags?: string[];            // Filter by tags
   context?: AIContextMessage[]; // Conversation context
 }
 ```
@@ -101,6 +103,7 @@ All AI methods return `AsyncIterable<AIEvent>` (streaming) or `Promise<AIRespons
   prompt: string;             // Question about the video (required)
   stream?: boolean;           // Default: true
   conversationId?: string;    // Continue existing conversation
+  currentTime?: number;       // Current playback position in seconds
 }
 ```
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@boldvideo/bold-js",
   "license": "MIT",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",