Skip to main content

InferenceCreateAsyncInvokeBodyInput

Struct InferenceCreateAsyncInvokeBodyInput 

Source
pub struct InferenceCreateAsyncInvokeBodyInput {
    pub enable_safety_checker: Option<bool>,
    pub guidance_scale: Option<f64>,
    pub num_images: Option<NonZeroU64>,
    pub num_inference_steps: Option<NonZeroU64>,
    pub output_format: Option<String>,
    pub prompt: Option<String>,
    pub seconds_total: Option<NonZeroU64>,
    pub text: Option<String>,
}
Expand description

The input parameters for the model invocation. Fields vary by model type.

For image generation models (e.g., fal-ai/flux/schnell, fal-ai/fast-sdxl), use prompt along with optional image parameters like output_format, num_inference_steps, guidance_scale, num_images, and enable_safety_checker.

For audio generation models (e.g., fal-ai/stable-audio-25/text-to-audio), use prompt along with seconds_total to control the duration.

For text-to-speech models (e.g., fal-ai/elevenlabs/tts/multilingual-v2), use text with the content you want converted to speech.

JSON schema
{
 "description": "The input parameters for the model invocation. Fields vary by model type.\n\nFor **image generation** models (e.g., `fal-ai/flux/schnell`, `fal-ai/fast-sdxl`), use `prompt` along with optional image parameters like `output_format`, `num_inference_steps`, `guidance_scale`, `num_images`, and `enable_safety_checker`.\n\nFor **audio generation** models (e.g., `fal-ai/stable-audio-25/text-to-audio`), use `prompt` along with `seconds_total` to control the duration.\n\nFor **text-to-speech** models (e.g., `fal-ai/elevenlabs/tts/multilingual-v2`), use `text` with the content you want converted to speech.\n",
 "type": "object",
 "properties": {
   "enable_safety_checker": {
     "description": "Whether to enable the safety checker for generated content.",
     "examples": [
       true
     ],
     "type": [
       "boolean",
       "null"
     ]
   },
   "guidance_scale": {
     "description": "Controls how closely the image generation model follows the prompt. Higher values produce output more closely matching the prompt.\n",
     "examples": [
       3.5
     ],
     "type": [
       "number",
       "null"
     ]
   },
   "num_images": {
     "description": "The number of images to generate.",
     "examples": [
       1
     ],
     "type": [
       "integer",
       "null"
     ],
     "minimum": 1.0
   },
   "num_inference_steps": {
     "description": "The number of inference steps to use during image generation. More steps generally produce higher quality output but take longer.\n",
     "examples": [
       4
     ],
     "type": [
       "integer",
       "null"
     ],
     "minimum": 1.0
   },
   "output_format": {
     "description": "The desired output format or aspect ratio for image generation.\n",
     "examples": [
       "landscape_4_3"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "prompt": {
     "description": "The text prompt describing the desired output. Used for image generation and audio generation models.\n",
     "examples": [
       "A futuristic city at sunset"
     ],
     "type": "string"
   },
   "seconds_total": {
     "description": "The total duration in seconds for generated audio. Used for audio generation models.\n",
     "examples": [
       60
     ],
     "type": [
       "integer",
       "null"
     ],
     "minimum": 1.0
   },
   "text": {
     "description": "The text content to convert to speech. Used for text-to-speech models.\n",
     "examples": [
       "This text-to-speech example uses DigitalOcean multilingual voice."
     ],
     "type": "string"
   }
 },
 "additionalProperties": true
}

Fields§

§enable_safety_checker: Option<bool>

Whether to enable the safety checker for generated content.

§guidance_scale: Option<f64>

Controls how closely the image generation model follows the prompt. Higher values produce output more closely matching the prompt.

§num_images: Option<NonZeroU64>

The number of images to generate.

§num_inference_steps: Option<NonZeroU64>

The number of inference steps to use during image generation. More steps generally produce higher quality output but take longer.

§output_format: Option<String>

The desired output format or aspect ratio for image generation.

§prompt: Option<String>

The text prompt describing the desired output. Used for image generation and audio generation models.

§seconds_total: Option<NonZeroU64>

The total duration in seconds for generated audio. Used for audio generation models.

§text: Option<String>

The text content to convert to speech. Used for text-to-speech models.

Trait Implementations§

Source§

impl Clone for InferenceCreateAsyncInvokeBodyInput

Source§

fn clone(&self) -> InferenceCreateAsyncInvokeBodyInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for InferenceCreateAsyncInvokeBodyInput

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for InferenceCreateAsyncInvokeBodyInput

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for InferenceCreateAsyncInvokeBodyInput

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&InferenceCreateAsyncInvokeBodyInput> for InferenceCreateAsyncInvokeBodyInput

Source§

fn from(value: &InferenceCreateAsyncInvokeBodyInput) -> Self

Converts to this type from the input type.
Source§

impl Serialize for InferenceCreateAsyncInvokeBodyInput

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more