@runware/sdk-js 1.2.0 → 1.2.1-beta.2

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@runware/sdk-js",
3
- "version": "1.2.0",
3
+ "version": "1.2.1-beta.2",
4
4
  "description": "The SDK is used to run image inference with the Runware API, powered by the RunWare inference platform. It can be used to generate imaged with text-to-image and image-to-image. It also allows the use of an existing gallery of models or selecting any model or LoRA from the CivitAI gallery. The API also supports upscaling, background removal, inpainting and outpainting, and a series of other ControlNet models.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",
package/readme.md CHANGED
@@ -431,6 +431,32 @@ return interface IControlNetImage {
431
431
 
432
432
   
433
433
 
434
+ ### Request Caption
435
+
436
+ [Read Documentation](https://docs.runware.ai/en/utilities/caption)
437
+
438
+ ```js
439
+
440
+ const runware = new Runware({ apiKey: "API_KEY" });
441
+ const caption = await runware.caption({
442
+ "model": "memories:1@1",
443
+ inputs: {
444
+ video: "https://example.com/video.mp4"
445
+ }
446
+ });
447
+
448
+ console.log(caption)
449
+
450
+ return interface IImageToText {
451
+ taskType: ETaskType;
452
+ taskUUID: string;
453
+ text: string;
454
+ cost?: number;
455
+ }
456
+ ```
457
+
458
+  
459
+
434
460
  ### Model Upload
435
461
 
436
462
  [Read Documentation](https://docs.runware.ai/en/image-inference/model-upload)
@@ -679,6 +705,10 @@ export type TImageMaskingResponse = {
679
705
 
680
706
  ## Changelog
681
707
 
708
+ ### - v1.2.1
709
+
710
+ - Added caption task type
711
+
682
712
  ### - v1.2.0
683
713
 
684
714
  - Change removeImageBackground taskType from `removeImageBackground` to `removeBackground` -- removeBackground is compatible with removeImageBackground but it also supports other media inputs such as removing backgrounds from videos