@bitbitpress/client 0.1.5 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -444,10 +444,17 @@ console.log('Daily summary:', dailySummaryData);
|
|
|
444
444
|
|
|
445
445
|
const customData = await client.user.synthesizeItem({
|
|
446
446
|
type: 'CUSTOM',
|
|
447
|
-
schema: [
|
|
447
|
+
schema: [
|
|
448
|
+
{
|
|
449
|
+
fieldName: 'title',
|
|
450
|
+
fieldDescription: 'The article title',
|
|
451
|
+
fieldCharacterLimitHint: 100,
|
|
452
|
+
},
|
|
453
|
+
],
|
|
448
454
|
contentContext: {
|
|
449
455
|
contentId: 'article-123',
|
|
450
456
|
contentType: 'article',
|
|
457
|
+
expandOnContext: true,
|
|
451
458
|
},
|
|
452
459
|
});
|
|
453
460
|
// customData will be an object with keys matching your schema fieldNames
|
|
@@ -477,12 +484,13 @@ client.user.synthesize(items: SynthesizeRequest['items']): Promise<AsyncIterable
|
|
|
477
484
|
|
|
478
485
|
- `fieldName` (required): Name of the field
|
|
479
486
|
- `fieldDescription` (required): A prompt describing the value of the field
|
|
480
|
-
- `
|
|
487
|
+
- `fieldCharacterLimitHint` (optional): Optional hint for max number of characters that should be returned for this field. Not a guarantee.
|
|
481
488
|
|
|
482
489
|
##### ContentContext (required for CUSTOM items)
|
|
483
490
|
|
|
484
491
|
- `contentId` (optional): Your content ID
|
|
485
492
|
- `contentType` (optional): The type of content to synthesize (currently only `"article"`)
|
|
493
|
+
- `expandOnContext` (optional): If `true`, expands on the current context to provide more data to the synthesis. Determines if the synthesis should focus on the content provided, or if it should expand on it.
|
|
486
494
|
|
|
487
495
|
##### Returns
|
|
488
496
|
|
|
@@ -504,17 +512,26 @@ const stream = await client.user.synthesize([
|
|
|
504
512
|
{
|
|
505
513
|
type: 'DAILY_SUMMARY',
|
|
506
514
|
},
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
515
|
+
{
|
|
516
|
+
type: 'CUSTOM',
|
|
517
|
+
schema: [
|
|
518
|
+
{
|
|
519
|
+
fieldName: 'title',
|
|
520
|
+
fieldDescription: 'The article title',
|
|
521
|
+
fieldCharacterLimitHint: 100,
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
fieldName: 'summary',
|
|
525
|
+
fieldDescription: 'A brief summary',
|
|
526
|
+
fieldCharacterLimitHint: 200,
|
|
527
|
+
},
|
|
528
|
+
],
|
|
529
|
+
contentContext: {
|
|
530
|
+
contentId: 'article-123',
|
|
531
|
+
contentType: 'article',
|
|
532
|
+
expandOnContext: true,
|
|
533
|
+
},
|
|
516
534
|
},
|
|
517
|
-
},
|
|
518
535
|
]);
|
|
519
536
|
|
|
520
537
|
for await (const event of stream) {
|
|
@@ -666,10 +683,12 @@ type SynthesizeRequest = {
|
|
|
666
683
|
schema: Array<{
|
|
667
684
|
fieldName: string;
|
|
668
685
|
fieldDescription: string;
|
|
686
|
+
fieldCharacterLimitHint?: number;
|
|
669
687
|
}>;
|
|
670
688
|
contentContext: {
|
|
671
689
|
contentId?: string;
|
|
672
690
|
contentType?: 'article';
|
|
691
|
+
expandOnContext?: boolean;
|
|
673
692
|
};
|
|
674
693
|
}
|
|
675
694
|
>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"basic-usage.d.ts","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,iBAAe,YAAY,kBA4B1B;AAGD,iBAAe,gBAAgB,
|
|
1
|
+
{"version":3,"file":"basic-usage.d.ts","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,iBAAe,YAAY,kBA4B1B;AAGD,iBAAe,gBAAgB,kBAkD9B;AAGD,iBAAe,uBAAuB,kBAmCrC;AAGD,iBAAe,aAAa,kBAqC3B;AAGD,iBAAe,oBAAoB,kBAiClC;AAED,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC"}
|
|
@@ -45,12 +45,21 @@ async function streamingExample() {
|
|
|
45
45
|
{
|
|
46
46
|
type: 'CUSTOM',
|
|
47
47
|
schema: [
|
|
48
|
-
{
|
|
49
|
-
|
|
48
|
+
{
|
|
49
|
+
fieldName: 'title',
|
|
50
|
+
fieldDescription: 'The article title',
|
|
51
|
+
fieldCharacterLimitHint: 100,
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
fieldName: 'summary',
|
|
55
|
+
fieldDescription: 'A brief summary',
|
|
56
|
+
fieldCharacterLimitHint: 200,
|
|
57
|
+
},
|
|
50
58
|
],
|
|
51
59
|
contentContext: {
|
|
52
60
|
contentId: 'article-123',
|
|
53
61
|
contentType: 'article',
|
|
62
|
+
expandOnContext: true,
|
|
54
63
|
},
|
|
55
64
|
},
|
|
56
65
|
]);
|
|
@@ -87,10 +96,17 @@ async function batchedSynthesisExample() {
|
|
|
87
96
|
console.log('Daily summary:', dailySummaryData);
|
|
88
97
|
const customData = await client.user.synthesizeItem({
|
|
89
98
|
type: 'CUSTOM',
|
|
90
|
-
schema: [
|
|
99
|
+
schema: [
|
|
100
|
+
{
|
|
101
|
+
fieldName: 'title',
|
|
102
|
+
fieldDescription: 'The article title',
|
|
103
|
+
fieldCharacterLimitHint: 100,
|
|
104
|
+
},
|
|
105
|
+
],
|
|
91
106
|
contentContext: {
|
|
92
107
|
contentId: 'article-123',
|
|
93
108
|
contentType: 'article',
|
|
109
|
+
expandOnContext: true,
|
|
94
110
|
},
|
|
95
111
|
});
|
|
96
112
|
console.log('Custom data:', customData);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"basic-usage.js","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,6CAA6C;AAC7C,KAAK,UAAU,YAAY;IACzB,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,gFAAgF;IAChF,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,sBAAsB;IACtB,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;QACxD,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IAEvD,yDAAyD;IACzD,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAC5C,OAAO,EAAE;YACP;gBACE,MAAM,EAAE,6BAA6B;gBACrC,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE;oBACd,SAAS,EAAE,aAAa;oBACxB,WAAW,EAAE,SAAS;iBACvB;aACF;SACF;KACF,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;AACzD,CAAC;AAED,iCAAiC;AACjC,KAAK,UAAU,gBAAgB;IAC7B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC1C;YACE,IAAI,EAAE,eAAe;SACtB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE;gBACN,
|
|
1
|
+
{"version":3,"file":"basic-usage.js","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,6CAA6C;AAC7C,KAAK,UAAU,YAAY;IACzB,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,gFAAgF;IAChF,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,sBAAsB;IACtB,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;QACxD,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IAEvD,yDAAyD;IACzD,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAC5C,OAAO,EAAE;YACP;gBACE,MAAM,EAAE,6BAA6B;gBACrC,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE;oBACd,SAAS,EAAE,aAAa;oBACxB,WAAW,EAAE,SAAS;iBACvB;aACF;SACF;KACF,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;AACzD,CAAC;AAED,iCAAiC;AACjC,KAAK,UAAU,gBAAgB;IAC7B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC1C;YACE,IAAI,EAAE,eAAe;SACtB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE;gBACN;oBACE,SAAS,EAAE,OAAO;oBAClB,gBAAgB,EAAE,mBAAmB;oBACrC,uBAAuB,EAAE,GAAG;iBAC7B;gBACD;oBACE,SAAS,EAAE,SAAS;oBACpB,gBAAgB,EAAE,iBAAiB;oBACnC,uBAAuB,EAAE,GAAG;iBAC7B;aACF;YACD,cAAc,EAAE;gBACd,SAAS,EAAE,aAAa;gBACxB,WAAW,EAAE,SAAS;gBACtB,eAAe,EAAE,IAAI;aACtB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACjC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,WAAW;gBACd,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAChC,MAAM;YACR,KAAK,eAAe;gBAClB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC1C,MAAM;YACR,KAAK,QAAQ;gBACX,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,UAAU;gBACb,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM;QACV,CAAC;IACH,CAAC;AACH,CAAC;AAED,mDAAmD;AACnD,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;QAC5D,sBAAsB,EAAE,GAAG,EAAE,oCAAoC;KAClE,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,sEAAsE;IACtE,2DAA2D;IAC3D,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;QACxD,IAAI,EAAE,eAAe;KACtB,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;IAEhD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;QAClD,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE;YACN;gBACE,SAAS,EAAE,OAAO;gBAClB,gBAAgB,EAAE,mBAAmB;gBACrC,uBAAuB,EAAE,GAAG;aAC7B;SACF;QACD,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;YACtB,eAAe,EAAE,IAAI;SACtB;KACF,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;IAExC,yDAAyD;IACzD,gEAAgE;AAClE,CAAC;AAED,oCAAoC;AACpC,KAAK,UAAU,aAAa;IAC1B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,kCAAkC;IAClC,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACvB,OAAO,EAAE;YACP,gEAAgE;YAChE;gBACE,MAAM,EAAE,6EAA6E;gBACrF,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE;oBACd,SAAS,EAAE,aAAa;oBACxB,WAAW,EAAE,SAAS;iBACvB;aACF;YACD,qDAAqD;YACrD;gBACE,MAAM,EAAE,uBAAuB;gBAC/B,IAAI,EAAE,SAAS;gBACf,cAAc,EAAE;oBACd,SAAS,EAAE,aAAa;oBACxB,WAAW,EAAE,SAAS;iBACvB;aACF;YACD,4DAA4D;YAC5D;gBACE,MAAM,EAAE,6BAA6B;gBACrC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED,6CAA6C;AAC7C,KAAK,UAAU,oBAAoB;IACjC,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;QAC5D,kBAAkB,EAAE,GAAG,EAAE,oCAAoC;KAC9D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,wEAAwE;IACxE,gDAAgD;IAChD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC7C,MAAM,EAAE,6EAA6E;QACrF,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC7C,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,SAAS;QACf,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IAEH,2DAA2D;IAC3D,yDAAyD;IACzD,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IACtD,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;AACxD,CAAC;AAED,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC"}
|
|
@@ -605,8 +605,8 @@ export interface paths {
|
|
|
605
605
|
fieldName: string;
|
|
606
606
|
/** @description A prompt describing the value of the field */
|
|
607
607
|
fieldDescription: string;
|
|
608
|
-
/** @description Optional max number of characters that
|
|
609
|
-
|
|
608
|
+
/** @description Optional hint for max number of characters that should be returned for this field. Not a guarantee. */
|
|
609
|
+
fieldCharacterLimitHint?: number;
|
|
610
610
|
}[];
|
|
611
611
|
/** @description Context data to provide to the prompt. */
|
|
612
612
|
contentContext: {
|
|
@@ -617,6 +617,8 @@ export interface paths {
|
|
|
617
617
|
* @enum {string}
|
|
618
618
|
*/
|
|
619
619
|
contentType?: "article";
|
|
620
|
+
/** @description If true, expands on the current context to provide more data to the synthesis. Determines if the synthesis should focus on the content provided, or if it should expand on it. */
|
|
621
|
+
expandOnContext?: boolean;
|
|
620
622
|
};
|
|
621
623
|
})[];
|
|
622
624
|
};
|