transloadit 4.14.0 → 5.0.0

package/src/alphalib/types/robots/supabase-store.ts

@@ -1,45 +1,32 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
-import { interpolateRobot, robotBase, robotUse, supabaseBase } from './_instructions-primitives.ts'
+import {
+  createStorageStoreExample,
+  defineRobot,
+  robotBase,
+  robotStoreMeta,
+  robotUse,
+  storeFilePath,
+  supabaseBase,
+} from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 6,
-  discount_factor: 0.15000150001500018,
-  discount_pct: 84.99984999849998,
-  example_code: {
-    steps: {
-      exported: {
-        robot: '/supabase/store',
-        use: ':original',
-        credentials: 'YOUR_SUPABASE_CREDENTIALS',
-        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
-      },
-    },
-  },
-  example_code_description: 'Export uploaded files to `my_target_folder` on supabase R2:',
+  ...robotStoreMeta,
+  example_code: createStorageStoreExample('/supabase/store', 'YOUR_SUPABASE_CREDENTIALS'),
+  example_code_description:
+    'Export uploaded files to `my_target_folder` in a Supabase Storage bucket:',
   has_small_icon: true,
-  minimum_charge: 0,
-  output_factor: 1,
-  override_lvl1: 'File Exporting',
-  purpose_sentence: 'exports encoding results to supabase buckets',
-  purpose_verb: 'export',
-  purpose_word: 'Supabase',
-  purpose_words: 'Export files to Supabase',
-  service_slug: 'file-exporting',
-  slot_count: 10,
-  title: 'Export files to Supabase',
-  typical_file_size_mb: 1.2,
-  typical_file_type: 'file',
+  purpose_sentence: 'exports encoding results to Supabase Storage buckets',
+  purpose_word: 'Supabase Storage',
+  purpose_words: 'Export files to Supabase Storage',
+  title: 'Export files to Supabase Storage',
   name: 'SupabaseStoreRobot',
-  priceFactor: 6.6666,
-  queueSlotCount: 10,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
-  isInternal: false,
 }
 
 export const robotSupabaseStoreInstructionsSchema = robotBase
@@ -47,59 +34,35 @@ export const robotSupabaseStoreInstructionsSchema = robotBase
   .merge(supabaseBase)
   .extend({
     robot: z.literal('/supabase/store'),
-    path: z
-      .string()
-      .default('${unique_prefix}/${file.url_name}')
-      .describe(`
-The path at which the file is to be stored. This may include any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables). The path must not be a directory.
-`),
+    path: storeFilePath,
     headers: z
       .record(z.string())
       .default({ 'Content-Type': '${file.mime}' })
       .describe(`
-An object containing a list of headers to be set for this file on supabase Spaces, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).
+An object containing a list of headers to be set for this file in your Supabase Storage bucket, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).
 
 Object Metadata can be specified using \`x-amz-meta-*\` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).
-`),
-    sign_urls_for: z
-      .number()
-      .int()
-      .min(0)
-      .optional()
-      .describe(`
-This parameter provides signed URLs in the result JSON (in the \`signed_ssl_url\` property). The number that you set this parameter to is the URL expiry time in seconds. If this parameter is not used, no URL signing is done.
 `),
   })
   .strict()
 
-export const robotSupabaseStoreInstructionsWithHiddenFieldsSchema =
-  robotSupabaseStoreInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotSupabaseStoreInstructionsSchema.shape.result])
-      .optional(),
-  })
-
-export type RobotSupabaseStoreInstructions = z.infer<typeof robotSupabaseStoreInstructionsSchema>
-export type RobotSupabaseStoreInstructionsWithHiddenFields = z.infer<
-  typeof robotSupabaseStoreInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotSupabaseStoreInstructionsSchema.shape> =
+  defineRobot(meta, robotSupabaseStoreInstructionsSchema)
 
-export const interpolatableRobotSupabaseStoreInstructionsSchema = interpolateRobot(
-  robotSupabaseStoreInstructionsSchema,
-)
-export type InterpolatableRobotSupabaseStoreInstructions =
-  InterpolatableRobotSupabaseStoreInstructionsInput
+export const {
+  withHiddenFields: robotSupabaseStoreInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotSupabaseStoreInstructionsSchema,
+  interpolatableWithHiddenFields:
+    interpolatableRobotSupabaseStoreInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotSupabaseStoreInstructionsInput = z.input<
-  typeof interpolatableRobotSupabaseStoreInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotSupabaseStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotSupabaseStoreInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotSupabaseStoreInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotSupabaseStoreInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotSupabaseStoreInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotSupabaseStoreInstructionsWithHiddenFieldsSchema
->
+export type RobotSupabaseStoreInstructions = Instructions['output']
+export type RobotSupabaseStoreInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotSupabaseStoreInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotSupabaseStoreInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotSupabaseStoreInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotSupabaseStoreInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

package/src/alphalib/types/robots/swift-import.ts

@@ -1,57 +1,37 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
 import {
-  files_per_page,
-  interpolateRobot,
-  page_number,
+  createStorageImportExample,
+  defineRobot,
   path,
-  recursive,
+  recursiveImport,
+  recursiveImportPageNumber,
+  recursiveImportPageSize,
   return_file_stubs,
   robotBase,
   robotImport,
+  robotImportMeta,
   swiftBase,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 10,
-  discount_factor: 0.1,
-  discount_pct: 90,
-  example_code: {
-    steps: {
-      imported: {
-        robot: '/swift/import',
-        credentials: 'YOUR_SWIFT_CREDENTIALS',
-        path: 'path/to/files/',
-        recursive: true,
-      },
-    },
-  },
+  ...robotImportMeta,
+  example_code: createStorageImportExample('/swift/import', 'YOUR_SWIFT_CREDENTIALS'),
   example_code_description:
     'Import files from the `path/to/files` directory and its subdirectories:',
   has_small_icon: true,
-  minimum_charge: 0,
-  output_factor: 1,
-  override_lvl1: 'File Importing',
-  purpose_sentence: 'imports whole directories of files from your Openstack/Swift bucket',
-  purpose_verb: 'import',
-  purpose_word: 'Openstack/Swift',
-  purpose_words: 'Import files from Openstack/Swift',
+  purpose_sentence: 'imports whole directories of files from your OpenStack Swift container',
+  purpose_word: 'OpenStack Swift',
+  purpose_words: 'Import files from OpenStack Swift',
   requires_credentials: true,
-  service_slug: 'file-importing',
-  slot_count: 20,
-  title: 'Import files from Openstack/Swift',
-  typical_file_size_mb: 1.2,
-  typical_file_type: 'file',
+  title: 'Import files from OpenStack Swift',
   name: 'SwiftImportRobot',
-  priceFactor: 6.6666,
-  queueSlotCount: 20,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: false,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
-  stage: 'ga',
 }
 
 export const robotSwiftImportInstructionsSchema = robotBase
@@ -60,61 +40,39 @@ export const robotSwiftImportInstructionsSchema = robotBase
   .extend({
     robot: z.literal('/swift/import'),
     path: path.describe(`
-The path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example: \`images/avatar.jpg\`.
+The path in your container to the specific file or directory. If the path points to a file, only this file will be imported. For example: \`images/avatar.jpg\`.
 
 If it points to a directory, indicated by a trailing slash (\`/\`), then all files that are direct descendants of this directory will be imported. For example: \`images/\`.
 
 Directories are **not** imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the \`recursive\` parameter.
 
-If you want to import all files from the root directory, please use \`/\` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with \`/\`, you'll receive an error: \`A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.\`
+If you want to import all files from the root directory, please use \`/\` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your container that aren't prefixed with \`/\`, you'll receive an error: \`A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.\`
 
 You can also use an array of path strings here to import multiple paths in the same <dfn>Robot</dfn>'s <dfn>Step</dfn>.
 `),
-    recursive: recursive.describe(`
-Setting this to \`true\` will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.
-
-Please use the pagination parameters \`page_number\` and \`files_per_page\` wisely here.
-`),
-    page_number: page_number.describe(`
-The pagination page number. For now, in order to not break backwards compatibility in non-recursive imports, this only works when recursive is set to \`true\`.
-
-When doing big imports, make sure no files are added or removed from other scripts within your path, otherwise you might get weird results with the pagination.
-`),
-    files_per_page: files_per_page.describe(`
-The pagination page size. This only works when recursive is \`true\` for now, in order to not break backwards compatibility in non-recursive imports.
-`),
+    recursive: recursiveImport,
+    page_number: recursiveImportPageNumber,
+    files_per_page: recursiveImportPageSize,
     return_file_stubs,
   })
   .strict()
 
-export const robotSwiftImportInstructionsWithHiddenFieldsSchema =
-  robotSwiftImportInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotSwiftImportInstructionsSchema.shape.result])
-      .optional(),
-  })
-
-export type RobotSwiftImportInstructions = z.infer<typeof robotSwiftImportInstructionsSchema>
-export type RobotSwiftImportInstructionsWithHiddenFields = z.infer<
-  typeof robotSwiftImportInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotSwiftImportInstructionsSchema.shape> =
+  defineRobot(meta, robotSwiftImportInstructionsSchema)
 
-export const interpolatableRobotSwiftImportInstructionsSchema = interpolateRobot(
-  robotSwiftImportInstructionsSchema,
-)
-export type InterpolatableRobotSwiftImportInstructions =
-  InterpolatableRobotSwiftImportInstructionsInput
+export const {
+  withHiddenFields: robotSwiftImportInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotSwiftImportInstructionsSchema,
+  interpolatableWithHiddenFields: interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotSwiftImportInstructionsInput = z.input<
-  typeof interpolatableRobotSwiftImportInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotSwiftImportInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotSwiftImportInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotSwiftImportInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema
->
+export type RobotSwiftImportInstructions = Instructions['output']
+export type RobotSwiftImportInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotSwiftImportInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotSwiftImportInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotSwiftImportInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotSwiftImportInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

package/src/alphalib/types/robots/swift-store.ts

@@ -1,45 +1,34 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
-import { interpolateRobot, robotBase, robotUse, swiftBase } from './_instructions-primitives.ts'
+import {
+  createStorageStoreExample,
+  defineRobot,
+  robotBase,
+  robotStoreMeta,
+  robotUse,
+  signedSslUrlLifetime,
+  storageAcl,
+  storeFilePath,
+  swiftBase,
+} from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 6,
-  discount_factor: 0.15000150001500018,
-  discount_pct: 84.99984999849998,
-  example_code: {
-    steps: {
-      exported: {
-        robot: '/swift/store',
-        use: ':original',
-        credentials: 'YOUR_SWIFT_CREDENTIALS',
-        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
-      },
-    },
-  },
-  example_code_description: 'Export uploaded files to `my_target_folder` on Swift:',
+  ...robotStoreMeta,
+  example_code: createStorageStoreExample('/swift/store', 'YOUR_SWIFT_CREDENTIALS'),
+  example_code_description:
+    'Export uploaded files to `my_target_folder` in an OpenStack Swift container:',
   has_small_icon: true,
-  minimum_charge: 0,
-  output_factor: 1,
-  override_lvl1: 'File Exporting',
-  purpose_sentence: 'exports encoding results to OpenStack Swift buckets',
-  purpose_verb: 'export',
+  purpose_sentence: 'exports encoding results to OpenStack Swift containers',
   purpose_word: 'OpenStack Swift',
-  purpose_words: 'Export files to OpenStack/Swift',
-  service_slug: 'file-exporting',
-  slot_count: 10,
-  title: 'Export files to OpenStack Swift Spaces',
-  typical_file_size_mb: 1.2,
-  typical_file_type: 'file',
+  purpose_words: 'Export files to OpenStack Swift',
+  title: 'Export files to OpenStack Swift',
   name: 'SwiftStoreRobot',
-  priceFactor: 6.6666,
-  queueSlotCount: 10,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: false,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
 }
 
 export const robotSwiftStoreInstructionsSchema = robotBase
@@ -47,66 +36,37 @@ export const robotSwiftStoreInstructionsSchema = robotBase
   .merge(swiftBase)
   .extend({
     robot: z.literal('/swift/store').describe(`
-The URL to the result file in your OpenStack bucket will be returned in the <dfn>Assembly Status JSON</dfn>.`),
-    path: z
-      .string()
-      .default('${unique_prefix}/${file.url_name}')
-      .describe(`
-The path at which the file is to be stored. This may include any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables). The path must not be a directory.
-`),
-    acl: z
-      .enum(['private', 'public-read'])
-      .default('public-read')
-      .describe(`
-The permissions used for this file.
-`),
+The URL to the result file in your OpenStack Swift container will be returned in the <dfn>Assembly Status JSON</dfn>.`),
+    path: storeFilePath,
+    acl: storageAcl,
     headers: z
       .record(z.string())
       .default({ 'Content-Type': '${file.mime}' })
       .describe(`
-An object containing a list of headers to be set for this file on swift Spaces, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).
+An object containing a list of headers to be set for this file in your OpenStack Swift container, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).
 
 Object Metadata can be specified using \`x-amz-meta-*\` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).
 `),
-    sign_urls_for: z
-      .number()
-      .int()
-      .min(0)
-      .optional()
-      .describe(`
-This parameter provides signed URLs in the result JSON (in the \`signed_ssl_url\` property). The number that you set this parameter to is the URL expiry time in seconds. If this parameter is not used, no URL signing is done.
-`),
+    sign_urls_for: signedSslUrlLifetime,
   })
   .strict()
 
-export const robotSwiftStoreInstructionsWithHiddenFieldsSchema =
-  robotSwiftStoreInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotSwiftStoreInstructionsSchema.shape.result])
-      .optional(),
-  })
-
-export type RobotSwiftStoreInstructions = z.infer<typeof robotSwiftStoreInstructionsSchema>
-export type RobotSwiftStoreInstructionsWithHiddenFields = z.infer<
-  typeof robotSwiftStoreInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotSwiftStoreInstructionsSchema.shape> =
+  defineRobot(meta, robotSwiftStoreInstructionsSchema)
 
-export const interpolatableRobotSwiftStoreInstructionsSchema = interpolateRobot(
-  robotSwiftStoreInstructionsSchema,
-)
-export type InterpolatableRobotSwiftStoreInstructions =
-  InterpolatableRobotSwiftStoreInstructionsInput
+export const {
+  withHiddenFields: robotSwiftStoreInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotSwiftStoreInstructionsSchema,
+  interpolatableWithHiddenFields: interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotSwiftStoreInstructionsInput = z.input<
-  typeof interpolatableRobotSwiftStoreInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotSwiftStoreInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema
->
+export type RobotSwiftStoreInstructions = Instructions['output']
+export type RobotSwiftStoreInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotSwiftStoreInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotSwiftStoreInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

package/src/alphalib/types/robots/text-speak.ts

@@ -1,30 +1,28 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
 import {
-  autoProviderDescription,
   awsGcpAiProviderSchema,
-  interpolateRobot,
+  createProcessingExample,
+  defineRobot,
+  robotArtificialIntelligenceMeta,
   robotBase,
+  robotParameterDocs,
   robotUse,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 1,
-  discount_factor: 1,
-  discount_pct: 0,
-  example_code: {
-    steps: {
-      synthesized: {
-        robot: '/text/speak',
-        use: ':original',
-        provider: 'aws',
-        voice: 'female-1',
-        target_language: 'en-US',
-      },
-    },
-  },
+  ...robotArtificialIntelligenceMeta,
+  example_code: createProcessingExample('synthesized', '/text/speak', {
+    provider: 'aws',
+    voice: 'female-1',
+    target_language: 'en-US',
+  }),
   example_code_description:
     'Synthesize speech from uploaded text documents, using a female voice in American English:',
   extended_description: `
@@ -55,27 +53,16 @@ export const meta: RobotMetaInput = {
 </table>
 {% endfor %}
 `,
-  minimum_charge: 1048576,
-  output_factor: 1,
   override_lvl1: 'Artificial Intelligence',
   purpose_sentence: 'synthesizes speech in documents',
   purpose_verb: 'speak',
   purpose_word: 'synthesize speech',
   purpose_words: 'Synthesize speech in documents',
-  service_slug: 'artificial-intelligence',
-  slot_count: 10,
   title: 'Speak text',
   typical_file_size_mb: 1,
   typical_file_type: 'document',
   name: 'TextSpeakRobot',
-  priceFactor: 1,
-  queueSlotCount: 10,
   minimumChargeUsd: 0.05,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: true,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
 }
 
 export const robotTextSpeakInstructionsSchema = robotBase
@@ -92,11 +79,7 @@ Another common use case is making your product accessible to people with a readi
       .describe(`
 Which text to speak. You can also set this to \`null\` and supply an input text file.
 `),
-    provider: awsGcpAiProviderSchema.describe(`
-${autoProviderDescription}
-
-Set this to \`"aws"\` or \`"gcp"\` to force a specific provider.
-`),
+    provider: awsGcpAiProviderSchema.describe(robotParameterDocs.ai_provider.description),
     // TODO determine the list of languages
     target_language: z
       .string()
@@ -111,7 +94,7 @@ The language should be specified in the [BCP-47](https://www.rfc-editor.org/rfc/
       .default('female-1')
       .describe(`
 The gender to be used for voice synthesis. Please consult the list of supported languages and voices.
-      `),
+`),
     ssml: z
       .boolean()
       .default(false)
@@ -123,31 +106,22 @@ Please see the supported syntaxes for [AWS](https://docs.aws.amazon.com/polly/la
   })
   .strict()
 
-export const robotTextSpeakInstructionsWithHiddenFieldsSchema =
-  robotTextSpeakInstructionsSchema.extend({
-    result: z.union([z.literal('debug'), robotTextSpeakInstructionsSchema.shape.result]).optional(),
-  })
-
-export type RobotTextSpeakInstructions = z.infer<typeof robotTextSpeakInstructionsSchema>
-export type RobotTextSpeakInstructionsWithHiddenFields = z.infer<
-  typeof robotTextSpeakInstructionsWithHiddenFieldsSchema
->
-
-export const interpolatableRobotTextSpeakInstructionsSchema = interpolateRobot(
-  robotTextSpeakInstructionsSchema,
-)
-export type InterpolatableRobotTextSpeakInstructions = InterpolatableRobotTextSpeakInstructionsInput
-
-export type InterpolatableRobotTextSpeakInstructionsInput = z.input<
-  typeof interpolatableRobotTextSpeakInstructionsSchema
->
-
-export const interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotTextSpeakInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotTextSpeakInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotTextSpeakInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotTextSpeakInstructionsSchema.shape> =
+  defineRobot(meta, robotTextSpeakInstructionsSchema)
+
+export const {
+  withHiddenFields: robotTextSpeakInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotTextSpeakInstructionsSchema,
+  interpolatableWithHiddenFields: interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
+
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
+
+export type RobotTextSpeakInstructions = Instructions['output']
+export type RobotTextSpeakInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotTextSpeakInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotTextSpeakInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotTextSpeakInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotTextSpeakInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']