@adobe/firefly-apis
Version:
Adobe Firefly Services library for consuming Firefly Service APIs.
72 lines (70 loc) • 3.29 kB
TypeScript
/*************************************************************************
* ADOBE CONFIDENTIAL
* ___________________
*
* Copyright 2025 Adobe
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains
* the property of Adobe and its suppliers, if any. The intellectual
* and technical concepts contained herein are proprietary to Adobe
* and its suppliers and are protected by all applicable intellectual
* property laws, including trade secret and copyright laws.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe.
**************************************************************************/
import type { ContentClass } from "./ContentClass";
import type { ObjectCompositeInputImage } from "./ObjectCompositeInputImage";
import type { Placement } from "./Placement";
import type { Size } from "./Size";
import type { Styles } from "./Styles";
/**
* Generating object composite from prompt
*/
export type GenerateObjectCompositeRequest = {
/**
* The number of variations to generate. numVariations will default to the number of seeds, or to 1 if seeds is not specified.
*/
numVariations?: number;
/**
* Array of seed(s) that ensure consistent image generation across multiple API calls. For example, you can use the same seed to generate a similar image with different styles. If specified alongside with numVariations, the number of seeds must be the equal to numVariations
*/
seeds?: number[];
/**
* The size of the requested generations. The supported dimensions for image generations are:
* | Dimensions | Description |
* | -----------| ----- |
* | { "width": 2048, "height": 2048} | Square (1:1) |
* | { "width": 2304, "height": 1792 } | Landscape (4:3) |
* | { "width": 1792, "height": 2304 } | Portrait (3:4) |
* | { "width": 2688, "height": 1536 } | Widescreen (16:9) |
* | { "width": 1344, "height": 768 } |(7:4) |
* |{ "width": 1152, "height": 896 } |(9:7) |
* |{ "width": 896, "height": 1152 } |(7:9) |
* | { "width": 1024, "height": 1024} | Square (1:1) |
*/
size?: Size;
/**
* An image of an object that needs to be rendered on a scene. You can either use a <code>url</code> or an <code>uploadId</code> as the source for the uploaded image.
* <strong>Note</strong>: Only allow listed domains are allowed to be accepted as input URL in the request. The allow-listed domains are as follows:
* <ul><li><code>amazonaws.com</code></li><li><code>windows.net</code></li><li><code>dropboxusercontent.com</code></li></ul>
*/
image: ObjectCompositeInputImage;
/**
* The prompt used to generate the image. The longer the prompt - the better
*/
prompt: string;
/**
* Specifies how the image will be positioned and sized in the final generation. You can specify both inset and alignment, only inset, only alignment or none of them.
*/
placement?: Placement;
/**
* You can specify a preset, a reference image or both
*/
style?: Styles;
/**
* Will guide the generation to being more photographic or more like art
*/
contentClass?: ContentClass;
};