@leonardo-ai/sdk 4.20.0 → 4.21.2

package/src/sdk/models/operations/createelement.ts

@@ -2,14 +2,15 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../../lib/primitives.js";
 import { safeParse } from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as shared from "../shared/index.js";
 
 /**
- * The base version of stable diffusion to use if not using a custom model.
+ * The base version to use if not using a custom model.
  */
 export enum SdVersions {
   Sdxl09 = "SDXL_0_9",
@@ -19,6 +20,7 @@ export enum SdVersions {
   VisionXl = "VISION_XL",
   KinoXl = "KINO_XL",
   AlbedoXl = "ALBEDO_XL",
+  FluxDev = "FLUX_DEV",
 }
 
 /**
@@ -34,31 +36,31 @@ export type CreateElementRequestBody = {
    */
   description?: string | null | undefined;
   /**
-   * The instance prompt to use during training.Try “a” by a noun. E.g. a castle
+   * Use a word that is closely related to what you're training that isn't too common. For example, instead of 'dog,' try something unique like 'jackthedog' or 'magicdonut'. Required for all non-FLUX_DEV models and FLUX_DEV Character model training.
    */
-  instancePrompt?: string | undefined;
+  instancePrompt?: string | null | undefined;
   /**
-   * The speed of element learns.
+   * The speed at which the model learns during training.<br><br><table><tr><th>Model Type</th><th>Lora Focus</th><th>Min</th><th>Max</th><th>Default</th></tr><tr><td>Default</td><td>General | Style | Character | Object</td><td>0.00000001</td><td>0.00001</td><td>0.000001</td></tr><tr><td rowspan='3'>FLUX_DEV</td><td>Style</td><td>0.000001</td><td>0.00003</td><td>0.00001</td></tr><tr><td>Object</td><td>0.00001</td><td>0.001</td><td>0.0004</td></tr><tr><td>Character</td><td>0.00001</td><td>0.001</td><td>0.0005</td></tr><tr><td>General</td><td colspan='3'>NA</td></tr></table>
    */
-  learningRate?: number | undefined;
+  learningRate: number;
   /**
-   * The category determines how the element will be trained. Options are 'General' | 'Character' | 'Style' | 'Object'.
+   * The category determines how the element will be trained. Options are 'General' | 'Character' | 'Style' | 'Object'. FLUX_DEV doesn't support General category.
    */
-  loraFocus?: string | undefined;
+  loraFocus: string;
   /**
    * The name of the element.
    */
   name?: string | undefined;
   /**
-   * The number of times the entire training dataset is passed through the element.
+   * The number of times the entire training dataset is passed through the element.<br><br><table><tr><th>Model Type</th><th>Lora Focus</th><th>Min</th><th>Max</th><th>Default</th></tr><tr><td>Default</td><td>General | Style | Character | Object</td><td>1</td><td>250</td><td>100</td></tr><tr><td rowspan='3'>FLUX_DEV</td><td>Style</td><td>30</td><td>120</td><td>60</td></tr><tr><td>Object</td><td>120</td><td>220</td><td>140</td></tr><tr><td>Character</td><td>100</td><td>200</td><td>135</td></tr><tr><td>General</td><td colspan='3'>NA</td></tr></table>
    */
-  numTrainEpochs?: number | undefined;
+  numTrainEpochs: number;
   /**
    * The resolution for training. Must be 1024.
    */
   resolution?: number | null | undefined;
   /**
-   * The base version of stable diffusion to use if not using a custom model.
+   * The base version to use if not using a custom model.
    */
   sdVersion?: SdVersions | undefined;
   /**
@@ -69,9 +71,15 @@ export type CreateElementRequestBody = {
 
 export type SDTrainingOutput = {
   /**
-   * API Credits Cost for Model Training. Available for Production API Users.
+   * API Credits Cost for Model Training. Available for Production API Users. Note: it will be deprecated. Please use the cost instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   apiCreditCost?: number | null | undefined;
+  /**
+   * The cost of the operation.
+   */
+  cost?: shared.Cost | null | undefined;
   userLoraId?: number | undefined;
 };
 
@@ -102,56 +110,14 @@ export type CreateElementResponse = {
 };
 
 /** @internal */
-export const SdVersions$inboundSchema: z.ZodNativeEnum<typeof SdVersions> = z
+export const SdVersions$outboundSchema: z.ZodNativeEnum<typeof SdVersions> = z
   .nativeEnum(SdVersions);
 
-/** @internal */
-export const SdVersions$outboundSchema: z.ZodNativeEnum<typeof SdVersions> =
-  SdVersions$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace SdVersions$ {
-  /** @deprecated use `SdVersions$inboundSchema` instead. */
-  export const inboundSchema = SdVersions$inboundSchema;
-  /** @deprecated use `SdVersions$outboundSchema` instead. */
-  export const outboundSchema = SdVersions$outboundSchema;
-}
-
-/** @internal */
-export const CreateElementRequestBody$inboundSchema: z.ZodType<
-  CreateElementRequestBody,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  datasetId: z.string().default(""),
-  description: z.nullable(z.string().default("")),
-  instance_prompt: z.string().default("a character"),
-  learning_rate: z.number().default(0.000001),
-  lora_focus: z.string().default("General"),
-  name: z.string().default("placeholder"),
-  num_train_epochs: z.number().int().default(100),
-  resolution: z.nullable(z.number().int().default(1024)),
-  sd_version: SdVersions$inboundSchema.default(SdVersions.Sdxl09),
-  train_text_encoder: z.boolean().default(true),
-}).transform((v) => {
-  return remap$(v, {
-    "instance_prompt": "instancePrompt",
-    "learning_rate": "learningRate",
-    "lora_focus": "loraFocus",
-    "num_train_epochs": "numTrainEpochs",
-    "sd_version": "sdVersion",
-    "train_text_encoder": "trainTextEncoder",
-  });
-});
-
 /** @internal */
 export type CreateElementRequestBody$Outbound = {
   datasetId: string;
   description: string | null;
-  instance_prompt: string;
+  instance_prompt: string | null;
   learning_rate: number;
   lora_focus: string;
   name: string;
@@ -169,13 +135,13 @@ export const CreateElementRequestBody$outboundSchema: z.ZodType<
 > = z.object({
   datasetId: z.string().default(""),
   description: z.nullable(z.string().default("")),
-  instancePrompt: z.string().default("a character"),
-  learningRate: z.number().default(0.000001),
-  loraFocus: z.string().default("General"),
+  instancePrompt: z.nullable(z.string().default("")),
+  learningRate: z.number(),
+  loraFocus: z.string(),
   name: z.string().default("placeholder"),
-  numTrainEpochs: z.number().int().default(100),
+  numTrainEpochs: z.number().int(),
   resolution: z.nullable(z.number().int().default(1024)),
-  sdVersion: SdVersions$outboundSchema.default(SdVersions.Sdxl09),
+  sdVersion: SdVersions$outboundSchema.default(SdVersions.FluxDev),
   trainTextEncoder: z.boolean().default(true),
 }).transform((v) => {
   return remap$(v, {
@@ -188,19 +154,6 @@ export const CreateElementRequestBody$outboundSchema: z.ZodType<
   });
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateElementRequestBody$ {
-  /** @deprecated use `CreateElementRequestBody$inboundSchema` instead. */
-  export const inboundSchema = CreateElementRequestBody$inboundSchema;
-  /** @deprecated use `CreateElementRequestBody$outboundSchema` instead. */
-  export const outboundSchema = CreateElementRequestBody$outboundSchema;
-  /** @deprecated use `CreateElementRequestBody$Outbound` instead. */
-  export type Outbound = CreateElementRequestBody$Outbound;
-}
-
 export function createElementRequestBodyToJSON(
   createElementRequestBody: CreateElementRequestBody,
 ): string {
@@ -209,16 +162,6 @@ export function createElementRequestBodyToJSON(
   );
 }
 
-export function createElementRequestBodyFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateElementRequestBody, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateElementRequestBody$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateElementRequestBody' from JSON`,
-  );
-}
-
 /** @internal */
 export const SDTrainingOutput$inboundSchema: z.ZodType<
   SDTrainingOutput,
@@ -226,46 +169,10 @@ export const SDTrainingOutput$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   apiCreditCost: z.nullable(z.number().int()).optional(),
+  cost: z.nullable(shared.Cost$inboundSchema).optional(),
   userLoraId: z.number().int().optional(),
 });
 
-/** @internal */
-export type SDTrainingOutput$Outbound = {
-  apiCreditCost?: number | null | undefined;
-  userLoraId?: number | undefined;
-};
-
-/** @internal */
-export const SDTrainingOutput$outboundSchema: z.ZodType<
-  SDTrainingOutput$Outbound,
-  z.ZodTypeDef,
-  SDTrainingOutput
-> = z.object({
-  apiCreditCost: z.nullable(z.number().int()).optional(),
-  userLoraId: z.number().int().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace SDTrainingOutput$ {
-  /** @deprecated use `SDTrainingOutput$inboundSchema` instead. */
-  export const inboundSchema = SDTrainingOutput$inboundSchema;
-  /** @deprecated use `SDTrainingOutput$outboundSchema` instead. */
-  export const outboundSchema = SDTrainingOutput$outboundSchema;
-  /** @deprecated use `SDTrainingOutput$Outbound` instead. */
-  export type Outbound = SDTrainingOutput$Outbound;
-}
-
-export function sdTrainingOutputToJSON(
-  sdTrainingOutput: SDTrainingOutput,
-): string {
-  return JSON.stringify(
-    SDTrainingOutput$outboundSchema.parse(sdTrainingOutput),
-  );
-}
-
 export function sdTrainingOutputFromJSON(
   jsonString: string,
 ): SafeParseResult<SDTrainingOutput, SDKValidationError> {
@@ -286,42 +193,6 @@ export const CreateElementResponseBody$inboundSchema: z.ZodType<
     .optional(),
 });
 
-/** @internal */
-export type CreateElementResponseBody$Outbound = {
-  sdTrainingJob?: SDTrainingOutput$Outbound | null | undefined;
-};
-
-/** @internal */
-export const CreateElementResponseBody$outboundSchema: z.ZodType<
-  CreateElementResponseBody$Outbound,
-  z.ZodTypeDef,
-  CreateElementResponseBody
-> = z.object({
-  sdTrainingJob: z.nullable(z.lazy(() => SDTrainingOutput$outboundSchema))
-    .optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateElementResponseBody$ {
-  /** @deprecated use `CreateElementResponseBody$inboundSchema` instead. */
-  export const inboundSchema = CreateElementResponseBody$inboundSchema;
-  /** @deprecated use `CreateElementResponseBody$outboundSchema` instead. */
-  export const outboundSchema = CreateElementResponseBody$outboundSchema;
-  /** @deprecated use `CreateElementResponseBody$Outbound` instead. */
-  export type Outbound = CreateElementResponseBody$Outbound;
-}
-
-export function createElementResponseBodyToJSON(
-  createElementResponseBody: CreateElementResponseBody,
-): string {
-  return JSON.stringify(
-    CreateElementResponseBody$outboundSchema.parse(createElementResponseBody),
-  );
-}
-
 export function createElementResponseBodyFromJSON(
   jsonString: string,
 ): SafeParseResult<CreateElementResponseBody, SDKValidationError> {
@@ -350,55 +221,6 @@ export const CreateElementResponse$inboundSchema: z.ZodType<
   });
 });
 
-/** @internal */
-export type CreateElementResponse$Outbound = {
-  ContentType: string;
-  StatusCode: number;
-  RawResponse: never;
-  object?: CreateElementResponseBody$Outbound | undefined;
-};
-
-/** @internal */
-export const CreateElementResponse$outboundSchema: z.ZodType<
-  CreateElementResponse$Outbound,
-  z.ZodTypeDef,
-  CreateElementResponse
-> = z.object({
-  contentType: z.string(),
-  statusCode: z.number().int(),
-  rawResponse: z.instanceof(Response).transform(() => {
-    throw new Error("Response cannot be serialized");
-  }),
-  object: z.lazy(() => CreateElementResponseBody$outboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    contentType: "ContentType",
-    statusCode: "StatusCode",
-    rawResponse: "RawResponse",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateElementResponse$ {
-  /** @deprecated use `CreateElementResponse$inboundSchema` instead. */
-  export const inboundSchema = CreateElementResponse$inboundSchema;
-  /** @deprecated use `CreateElementResponse$outboundSchema` instead. */
-  export const outboundSchema = CreateElementResponse$outboundSchema;
-  /** @deprecated use `CreateElementResponse$Outbound` instead. */
-  export type Outbound = CreateElementResponse$Outbound;
-}
-
-export function createElementResponseToJSON(
-  createElementResponse: CreateElementResponse,
-): string {
-  return JSON.stringify(
-    CreateElementResponse$outboundSchema.parse(createElementResponse),
-  );
-}
-
 export function createElementResponseFromJSON(
   jsonString: string,
 ): SafeParseResult<CreateElementResponse, SDKValidationError> {