fal 0.3.6

A Rust crate for the fal.ai API, including generated, typed functions for all public models
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

#[allow(unused_imports)]
use crate::prelude::*;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
#[allow(unused_imports)]
use std::collections::HashMap;

#[cfg(any(
    feature = "endpoints",
    feature = "endpoints_fal-ai",
    feature = "endpoints_fal-ai_hunyuan3d"
))]
#[cfg_attr(
    docsrs,
    doc(cfg(any(
        feature = "endpoints",
        feature = "endpoints_fal-ai",
        feature = "endpoints_fal-ai_hunyuan3d"
    )))
)]
pub mod turbo;

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct File {
    /// The mime type of the file.
    /// "image/png"
    #[serde(skip_serializing_if = "Option::is_none")]
    pub content_type: Option<String>,
    /// File data
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_data: Option<String>,
    /// The name of the file. It will be auto-generated if not provided.
    /// "z9RV14K95DvU.png"
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_name: Option<String>,
    /// The size of the file in bytes.
    /// 4404019
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_size: Option<i64>,
    /// The URL where the file can be downloaded from.
    pub url: String,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct HTTPValidationError {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub detail: Option<Vec<Option<ValidationError>>>,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct Hunyuan3DInput {
    /// Guidance scale for the model.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub guidance_scale: Option<f64>,
    /// URL of image to use while generating the 3D model.
    /// "https://storage.googleapis.com/falserverless/model_tests/video_models/robot.png"
    pub input_image_url: String,
    /// Number of inference steps to perform.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub num_inference_steps: Option<i64>,
    /// Octree resolution for the model.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub octree_resolution: Option<i64>,
    /// The same seed and the same prompt given to the same version of the model
    /// will output the same image every time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seed: Option<i64>,
    /// If set true, textured mesh will be generated and the price charged would be 3 times that of white mesh.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub textured_mesh: Option<bool>,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct Hunyuan3DInputMultiView {
    /// URL of image to use while generating the 3D model.
    /// "https://storage.googleapis.com/falserverless/model_tests/video_models/back.png"
    pub back_image_url: String,
    /// URL of image to use while generating the 3D model.
    /// "https://storage.googleapis.com/falserverless/model_tests/video_models/front.png"
    pub front_image_url: String,
    /// Guidance scale for the model.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub guidance_scale: Option<f64>,
    /// URL of image to use while generating the 3D model.
    /// "https://storage.googleapis.com/falserverless/model_tests/video_models/left.png"
    pub left_image_url: String,
    /// Number of inference steps to perform.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub num_inference_steps: Option<i64>,
    /// Octree resolution for the model.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub octree_resolution: Option<i64>,
    /// The same seed and the same prompt given to the same version of the model
    /// will output the same image every time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seed: Option<i64>,
    /// If set true, textured mesh will be generated and the price charged would be 3 times that of white mesh.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub textured_mesh: Option<bool>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct MultiViewObjectOutput {
    /// Generated 3D object file.
    /// {"content_type":"application/octet-stream","file_name":"white_mesh.glb","file_size":720696,"url":"https://storage.googleapis.com/falserverless/model_tests/video_models/mesh.glb"}
    pub model_mesh: File,
    /// Seed value used for generation.
    pub seed: i64,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct ObjectOutput {
    /// Generated 3D object file.
    /// {"content_type":"application/octet-stream","file_name":"white_mesh.glb","file_size":720696,"url":"https://v3.fal.media/files/lion/WqIhtKPaSoeBtC30qzIGG_white_mesh.glb"}
    pub model_mesh: File,
    /// Seed value used for generation.
    pub seed: i64,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct ValidationError {
    pub loc: Vec<serde_json::Value>,
    pub msg: String,
    #[serde(rename = "type")]
    pub ty: String,
}

/// Hunyuan3D
///
/// Category: image-to-3d
/// Machine Type: H100
/// License Type: commercial
pub fn multi_view(
    params: Hunyuan3DInputMultiView,
) -> FalRequest<Hunyuan3DInputMultiView, MultiViewObjectOutput> {
    FalRequest::new("fal-ai/hunyuan3d/v2/multi-view", params)
}