transloadit 5.2.0 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/alphalib/aiMessages.d.ts +1 -1
- package/dist/alphalib/aiMessages.d.ts.map +1 -1
- package/dist/alphalib/aiMessages.js +1 -1
- package/dist/alphalib/aiMessages.js.map +1 -1
- package/dist/alphalib/types/assemblyStatus.d.ts +682 -682
- package/dist/alphalib/types/assemblyStatus.d.ts.map +1 -1
- package/dist/alphalib/types/assemblyStatus.js +23 -14
- package/dist/alphalib/types/assemblyStatus.js.map +1 -1
- package/dist/alphalib/types/robots/_ai-models.d.ts.map +1 -1
- package/dist/alphalib/types/robots/_ai-models.js +2 -0
- package/dist/alphalib/types/robots/_ai-models.js.map +1 -1
- package/dist/alphalib/types/robots/_google-image-seed.d.ts +8 -0
- package/dist/alphalib/types/robots/_google-image-seed.d.ts.map +1 -0
- package/dist/alphalib/types/robots/_google-image-seed.js +12 -0
- package/dist/alphalib/types/robots/_google-image-seed.js.map +1 -0
- package/dist/alphalib/types/robots/_instructions-primitives.d.ts +2 -0
- package/dist/alphalib/types/robots/_instructions-primitives.d.ts.map +1 -1
- package/dist/alphalib/types/robots/_instructions-primitives.js +11 -14
- package/dist/alphalib/types/robots/_instructions-primitives.js.map +1 -1
- package/dist/alphalib/types/robots/ai-chat.d.ts +1 -1
- package/dist/alphalib/types/robots/ai-chat.d.ts.map +1 -1
- package/dist/alphalib/types/robots/ai-chat.js.map +1 -1
- package/dist/alphalib/types/robots/google-import.d.ts +4 -6
- package/dist/alphalib/types/robots/google-import.d.ts.map +1 -1
- package/dist/alphalib/types/robots/google-import.js +5 -2
- package/dist/alphalib/types/robots/google-import.js.map +1 -1
- package/dist/alphalib/types/robots/google-store.d.ts.map +1 -1
- package/dist/alphalib/types/robots/google-store.js +5 -13
- package/dist/alphalib/types/robots/google-store.js.map +1 -1
- package/dist/alphalib/types/robots/http-import.d.ts.map +1 -1
- package/dist/alphalib/types/robots/http-import.js +4 -0
- package/dist/alphalib/types/robots/http-import.js.map +1 -1
- package/dist/alphalib/types/robots/image-generate.d.ts.map +1 -1
- package/dist/alphalib/types/robots/image-generate.js +6 -1
- package/dist/alphalib/types/robots/image-generate.js.map +1 -1
- package/dist/alphalib/types/robots/image-resize.d.ts +4 -0
- package/dist/alphalib/types/robots/image-resize.d.ts.map +1 -1
- package/dist/alphalib/types/robots/image-resize.js +34 -6
- package/dist/alphalib/types/robots/image-resize.js.map +1 -1
- package/dist/alphalib/types/robots/s3-store.d.ts.map +1 -1
- package/dist/alphalib/types/robots/s3-store.js +21 -17
- package/dist/alphalib/types/robots/s3-store.js.map +1 -1
- package/dist/alphalib/types/robots/video-thumbs.d.ts +6 -0
- package/dist/alphalib/types/robots/video-thumbs.d.ts.map +1 -1
- package/dist/alphalib/types/robots/video-thumbs.js +15 -5
- package/dist/alphalib/types/robots/video-thumbs.js.map +1 -1
- package/dist/alphalib/zodParseWithContext.d.ts +1 -1
- package/dist/alphalib/zodParseWithContext.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/alphalib/aiMessages.ts +1 -1
- package/src/alphalib/types/assemblyStatus.ts +24 -14
- package/src/alphalib/types/robots/_ai-models.ts +2 -0
- package/src/alphalib/types/robots/_google-image-seed.ts +14 -0
- package/src/alphalib/types/robots/_instructions-primitives.ts +13 -15
- package/src/alphalib/types/robots/ai-chat.ts +6 -7
- package/src/alphalib/types/robots/google-import.ts +7 -1
- package/src/alphalib/types/robots/google-store.ts +6 -11
- package/src/alphalib/types/robots/http-import.ts +4 -0
- package/src/alphalib/types/robots/image-generate.ts +8 -1
- package/src/alphalib/types/robots/image-resize.ts +36 -6
- package/src/alphalib/types/robots/s3-store.ts +21 -17
- package/src/alphalib/types/robots/video-thumbs.ts +19 -5
- package/src/alphalib/zodParseWithContext.ts +1 -1
package/package.json
CHANGED
|
@@ -130,6 +130,7 @@ export const assemblyStatusErrCodeSchema = z.enum([
|
|
|
130
130
|
'CLOUDFLARE_STORE_VALIDATION',
|
|
131
131
|
'CLOUDFLARE_STORE_WRONG_REGION',
|
|
132
132
|
'CLOUD_AI_IMAGE_VALIDATION',
|
|
133
|
+
'DAM_STORAGE_UNAVAILABLE',
|
|
133
134
|
'DIGITALOCEAN_IMPORT_ACCESS_DENIED',
|
|
134
135
|
'DIGITALOCEAN_IMPORT_FAILURE',
|
|
135
136
|
'DIGITALOCEAN_IMPORT_NOT_FOUND',
|
|
@@ -190,6 +191,7 @@ export const assemblyStatusErrCodeSchema = z.enum([
|
|
|
190
191
|
'GOOGLE_IMPORT_FAILURE',
|
|
191
192
|
'GOOGLE_IMPORT_NOT_FOUND',
|
|
192
193
|
'GOOGLE_IMPORT_VALIDATION',
|
|
194
|
+
'GOOGLE_STORE_ACCESS_DENIED',
|
|
193
195
|
'GOOGLE_STORE_INVALID_INPUT',
|
|
194
196
|
'GOOGLE_STORE_VALIDATION',
|
|
195
197
|
'HTML_CONVERT_VALIDATION',
|
|
@@ -399,6 +401,9 @@ export const assemblyStatusErrCodeSchema = z.enum([
|
|
|
399
401
|
export type AssemblyStatusErrCode = z.infer<typeof assemblyStatusErrCodeSchema>
|
|
400
402
|
|
|
401
403
|
const metadataTextSchema = z.union([z.string(), z.number().finite()])
|
|
404
|
+
const metadataDateSchema = z.union([metadataTextSchema, z.array(metadataTextSchema)])
|
|
405
|
+
// Readers must survive new server errors; the exported known-code enum remains closed.
|
|
406
|
+
const publicAssemblyErrorCodeSchema = z.string().min(1)
|
|
402
407
|
|
|
403
408
|
const assemblyStatusMetaSchema = z
|
|
404
409
|
.object({
|
|
@@ -406,7 +411,7 @@ const assemblyStatusMetaSchema = z
|
|
|
406
411
|
has_alpha: storedAssetSchema.shape.has_alpha,
|
|
407
412
|
width: z.union([z.number(), z.null()]).optional(),
|
|
408
413
|
height: z.union([z.number(), z.null()]).optional(),
|
|
409
|
-
date_file_modified:
|
|
414
|
+
date_file_modified: metadataDateSchema.nullable().optional(),
|
|
410
415
|
aspect_ratio: z.union([z.number(), z.string(), z.null()]).optional(),
|
|
411
416
|
has_clipping_path: z.boolean().optional(),
|
|
412
417
|
frame_count: z.union([z.number(), z.null()]).optional(),
|
|
@@ -415,14 +420,14 @@ const assemblyStatusMetaSchema = z
|
|
|
415
420
|
average_color: z.string().nullable().optional(),
|
|
416
421
|
svgViewBoxWidth: z.union([z.number(), z.null()]).optional(),
|
|
417
422
|
svgViewBoxHeight: z.union([z.number(), z.null()]).optional(),
|
|
418
|
-
date_recorded:
|
|
419
|
-
date_file_created:
|
|
423
|
+
date_recorded: metadataDateSchema.nullable().optional(),
|
|
424
|
+
date_file_created: metadataDateSchema.nullable().optional(),
|
|
420
425
|
title: z.union([z.string(), z.number()]).nullable().optional(),
|
|
421
426
|
description: metadataTextSchema.nullable().optional(),
|
|
422
427
|
duration: z.union([z.number(), z.null()]).optional(),
|
|
423
428
|
location: z.string().nullable().optional(),
|
|
424
429
|
city: z.string().nullable().optional(),
|
|
425
|
-
state:
|
|
430
|
+
state: metadataTextSchema.nullable().optional(),
|
|
426
431
|
rights: z.union([z.string(), z.number()]).nullable().optional(),
|
|
427
432
|
country: z.string().nullable().optional(),
|
|
428
433
|
country_code: z.string().nullable().optional(),
|
|
@@ -469,7 +474,7 @@ const assemblyStatusMetaSchema = z
|
|
|
469
474
|
xp_title: metadataTextSchema.nullable().optional(),
|
|
470
475
|
xp_comment: z.string().nullable().optional(),
|
|
471
476
|
xp_keywords: metadataTextSchema.nullable().optional(),
|
|
472
|
-
xp_subject:
|
|
477
|
+
xp_subject: metadataTextSchema.nullable().optional(),
|
|
473
478
|
recognized_text: z
|
|
474
479
|
.union([
|
|
475
480
|
z.array(z.string()),
|
|
@@ -560,8 +565,8 @@ const assemblyStatusMetaSchema = z
|
|
|
560
565
|
page_count: z.union([z.number(), z.null()]).optional(),
|
|
561
566
|
page_size: z.string().nullable().optional(),
|
|
562
567
|
producer: z.string().nullable().optional(),
|
|
563
|
-
create_date:
|
|
564
|
-
modify_date:
|
|
568
|
+
create_date: metadataDateSchema.nullable().optional(),
|
|
569
|
+
modify_date: metadataDateSchema.nullable().optional(),
|
|
565
570
|
colortransfer: z.string().nullable().optional(),
|
|
566
571
|
colorprimaries: z.string().nullable().optional(),
|
|
567
572
|
archive_directory: z.string().nullable().optional(),
|
|
@@ -655,7 +660,7 @@ export const assemblyStatusUploadSchema = z
|
|
|
655
660
|
has_alpha: storedAssetSchema.shape.has_alpha,
|
|
656
661
|
name: z.string().nullable(),
|
|
657
662
|
basename: z.string().nullable(),
|
|
658
|
-
ext: z.string(),
|
|
663
|
+
ext: z.string().nullable(),
|
|
659
664
|
size: z.number(),
|
|
660
665
|
mime: z.string().nullable(),
|
|
661
666
|
type: z.string().nullable(),
|
|
@@ -918,7 +923,7 @@ export const assemblyStatusOkSchema: AssemblyStatusVariant<{
|
|
|
918
923
|
.passthrough()
|
|
919
924
|
|
|
920
925
|
const assemblyStatusErrorFields = z.object({
|
|
921
|
-
error:
|
|
926
|
+
error: publicAssemblyErrorCodeSchema,
|
|
922
927
|
ok: z.null().optional(),
|
|
923
928
|
retries: z.number().optional(),
|
|
924
929
|
numRetries: z.number().optional(),
|
|
@@ -996,12 +1001,13 @@ export type AssemblyStatus = z.infer<typeof assemblyStatusSchema>
|
|
|
996
1001
|
*/
|
|
997
1002
|
export function hasError(
|
|
998
1003
|
assembly: AssemblyStatus | undefined | null,
|
|
999
|
-
|
|
1004
|
+
// Keep known-code suggestions while matching future public response codes too.
|
|
1005
|
+
particularErrorCode?: AssemblyStatusErrCode | (string & {}),
|
|
1000
1006
|
): assembly is AssemblyStatusError {
|
|
1001
1007
|
const errorExists =
|
|
1002
1008
|
Boolean(assembly) && assembly != null && typeof assembly === 'object' && 'error' in assembly
|
|
1003
1009
|
|
|
1004
|
-
if (particularErrorCode) {
|
|
1010
|
+
if (particularErrorCode !== undefined) {
|
|
1005
1011
|
return errorExists && assembly.error === particularErrorCode
|
|
1006
1012
|
}
|
|
1007
1013
|
|
|
@@ -1079,7 +1085,7 @@ export function isAssemblyOkStatus(
|
|
|
1079
1085
|
}
|
|
1080
1086
|
|
|
1081
1087
|
/**
|
|
1082
|
-
* Type guard to check if a status string is
|
|
1088
|
+
* Type guard to check if a status string is a known error code.
|
|
1083
1089
|
*/
|
|
1084
1090
|
export function isAssemblyErrorStatus(
|
|
1085
1091
|
status: string | undefined | null,
|
|
@@ -1123,7 +1129,11 @@ export function isAssemblyTerminalOk(assembly: AssemblyStatus | undefined | null
|
|
|
1123
1129
|
* Returns true if the assembly has a terminal error state.
|
|
1124
1130
|
*/
|
|
1125
1131
|
export function isAssemblyTerminalError(assembly: AssemblyStatus | undefined | null): boolean {
|
|
1126
|
-
|
|
1132
|
+
// getError() historically stringifies explicit undefined; classification needs the raw value.
|
|
1133
|
+
return (
|
|
1134
|
+
(hasError(assembly) && publicAssemblyErrorCodeSchema.safeParse(assembly.error).success) ||
|
|
1135
|
+
isAssemblySysError(assembly)
|
|
1136
|
+
)
|
|
1127
1137
|
}
|
|
1128
1138
|
|
|
1129
1139
|
/**
|
|
@@ -1185,7 +1195,7 @@ export const assemblyIndexItemSchema = z
|
|
|
1185
1195
|
bytes_received: assemblyStatusBaseSchema.shape.bytes_received.optional(),
|
|
1186
1196
|
upload_duration: assemblyStatusBaseSchema.shape.upload_duration.optional(),
|
|
1187
1197
|
ok: assemblyStatusOkCodeSchema.nullable().optional(),
|
|
1188
|
-
error:
|
|
1198
|
+
error: publicAssemblyErrorCodeSchema.nullable().optional(),
|
|
1189
1199
|
created: z.string(),
|
|
1190
1200
|
created_ts: z.number().optional(),
|
|
1191
1201
|
template_name: z.string().nullable().optional(),
|
|
@@ -20,6 +20,7 @@ export const MODEL_CAPABILITIES: Readonly<Record<string, { pdf: boolean; image:
|
|
|
20
20
|
'anthropic/claude-fable-5': { pdf: true, image: true },
|
|
21
21
|
'anthropic/claude-fable-5-1': { pdf: true, image: true },
|
|
22
22
|
'anthropic/claude-sonnet-5': { pdf: true, image: true },
|
|
23
|
+
'anthropic/claude-sonnet-5-5': { pdf: true, image: true },
|
|
23
24
|
'openai/gpt-4.1-2025-04-14': { pdf: false, image: true },
|
|
24
25
|
'openai/chatgpt-4o-latest': { pdf: false, image: true },
|
|
25
26
|
'openai/o3-2025-04-16': { pdf: false, image: true },
|
|
@@ -33,6 +34,7 @@ export const MODEL_CAPABILITIES: Readonly<Record<string, { pdf: boolean; image:
|
|
|
33
34
|
'openai/gpt-5.5': { pdf: false, image: true },
|
|
34
35
|
'openai/gpt-5.6-sol': { pdf: false, image: true },
|
|
35
36
|
'openai/gpt-6-astra': { pdf: false, image: true },
|
|
37
|
+
'openai/gpt-6.1-sol': { pdf: false, image: true },
|
|
36
38
|
'openai/gpt-5.4': { pdf: false, image: true },
|
|
37
39
|
'openai/gpt-5.4-mini': { pdf: false, image: true },
|
|
38
40
|
'openai/gpt-5.4-nano': { pdf: false, image: true },
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { z } from 'zod'
|
|
2
|
+
|
|
3
|
+
/** Google’s signed 32-bit seed ceiling, shared by provider and Robot validation. */
|
|
4
|
+
export const googleImageSeedMaximum = 2_147_483_647
|
|
5
|
+
|
|
6
|
+
/** Validation message for the seed range supported by Google and the cloudai CLI. */
|
|
7
|
+
export const googleImageSeedValidationMessage = `seed must be an integer from 0 to ${googleImageSeedMaximum}`
|
|
8
|
+
|
|
9
|
+
/** Google image seeds must fit int32 and preserve the CLI’s nonnegative seed contract. */
|
|
10
|
+
export const googleImageSeedSchema = z
|
|
11
|
+
.number()
|
|
12
|
+
.int(googleImageSeedValidationMessage)
|
|
13
|
+
.min(0, googleImageSeedValidationMessage)
|
|
14
|
+
.max(googleImageSeedMaximum, googleImageSeedValidationMessage)
|
|
@@ -2048,25 +2048,23 @@ While we recommend to use <dfn>Template Credentials</dfn> at all times, some use
|
|
|
2048
2048
|
})
|
|
2049
2049
|
.strict()
|
|
2050
2050
|
|
|
2051
|
-
|
|
2052
|
-
export
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
.string()
|
|
2056
|
-
.optional()
|
|
2057
|
-
.describe(`
|
|
2058
|
-
Create a new [Google service account](https://cloud.google.com/storage/docs/authentication). Set its role to "Storage Object Creator". Choose "JSON" for the key file format and download it to your computer. You will need to upload this file when creating your <dfn>Template Credentials</dfn>.
|
|
2051
|
+
/** Shared Google credential setup with permissions supplied by the importing or storing Robot. */
|
|
2052
|
+
export function getGoogleCredentialsDescription(permissions: string): string {
|
|
2053
|
+
return `
|
|
2054
|
+
Create a new [Google service account](https://cloud.google.com/storage/docs/authentication). Choose “JSON” for the key file format and download it to your computer. You will need to upload this file when creating your <dfn>Template Credentials</dfn>.
|
|
2059
2055
|
|
|
2060
2056
|
Go back to your Google credentials project and enable the "Google Cloud Storage JSON API" for it. Wait around ten minutes for the action to propagate through the Google network. Grab the project ID from the dropdown menu in the header bar on the Google site. You will also need it later on.
|
|
2061
2057
|
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
To do this from the Google Cloud console, navigate to "IAM & Admin" and select "Roles". From here, click "Create Role", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.
|
|
2065
|
-
|
|
2066
|
-
Next, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "Add Member", enter your service account as a new member, and select your newly created role.
|
|
2058
|
+
${permissions.trim()}
|
|
2067
2059
|
|
|
2068
2060
|
Then, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your <dfn>Template Credentials</dfn> as this parameter's value.
|
|
2069
|
-
`
|
|
2061
|
+
`
|
|
2062
|
+
}
|
|
2063
|
+
|
|
2064
|
+
export type GoogleBase = z.infer<typeof googleBase>
|
|
2065
|
+
export const googleBase = z
|
|
2066
|
+
.object({
|
|
2067
|
+
credentials: z.string().optional(),
|
|
2070
2068
|
})
|
|
2071
2069
|
.strict()
|
|
2072
2070
|
|
|
@@ -2314,7 +2312,7 @@ For example:
|
|
|
2314
2312
|
}
|
|
2315
2313
|
\`\`\`
|
|
2316
2314
|
|
|
2317
|
-
This will crop the area from \`(80, 100)\` to \`(600, 800)\` from a 1000×1000 pixels video, which is a
|
|
2315
|
+
This will crop the area from \`(80, 100)\` to \`(600, 800)\` from a 1000×1000 pixels video, which is a rectangle whose width is 520px and height is 700px. If \`crop\` is set, the width and height parameters are ignored, and the \`resize_strategy\` is set to \`crop\` automatically.
|
|
2318
2316
|
|
|
2319
2317
|
You can also use a JSON string of such an object with coordinates in similar fashion:
|
|
2320
2318
|
|
|
@@ -51,13 +51,12 @@ type Part<Type extends MessagePart['type']> = Extract<MessagePart, { type: Type
|
|
|
51
51
|
type ToolOutput = Part<'tool-result'>['output']
|
|
52
52
|
|
|
53
53
|
type ProviderMetadata = NonNullable<z.output<typeof providerMetadataSchema>>
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
'providerOptions'
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
}
|
|
54
|
+
// Zod output retains explicit undefined even when the consumer enables exact optional properties.
|
|
55
|
+
type CompatibleProviderOptions<Part extends { providerOptions?: ProviderMetadata | undefined }> =
|
|
56
|
+
Omit<Part, 'providerOptions'> & {
|
|
57
|
+
providerOptions?: ProviderMetadata
|
|
58
|
+
experimental_providerMetadata?: ProviderMetadata
|
|
59
|
+
}
|
|
61
60
|
type MessageProviderOptions = {
|
|
62
61
|
providerOptions?: ProviderMetadata
|
|
63
62
|
experimental_providerMetadata?: ProviderMetadata
|
|
@@ -9,6 +9,7 @@ import { z } from 'zod'
|
|
|
9
9
|
import {
|
|
10
10
|
createStorageImportExample,
|
|
11
11
|
defineRobot,
|
|
12
|
+
getGoogleCredentialsDescription,
|
|
12
13
|
googleBase,
|
|
13
14
|
next_page_token,
|
|
14
15
|
path,
|
|
@@ -37,6 +38,11 @@ export const robotGoogleImportInstructionsSchema = robotBase
|
|
|
37
38
|
.merge(googleBase)
|
|
38
39
|
.extend({
|
|
39
40
|
robot: z.literal('/google/import'),
|
|
41
|
+
credentials: googleBase.shape.credentials.describe(
|
|
42
|
+
getGoogleCredentialsDescription(`
|
|
43
|
+
Grant the service account the “Storage Object Viewer” role on the bucket you want to import from. This provides \`storage.objects.get\` to download objects and \`storage.objects.list\` to list them. Imports do not need permission to create or delete objects. See [Google’s IAM roles for Cloud Storage](https://docs.cloud.google.com/storage/docs/access-control/iam-roles).
|
|
44
|
+
`),
|
|
45
|
+
),
|
|
40
46
|
path: path.describe(`
|
|
41
47
|
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\`.
|
|
42
48
|
|
|
@@ -51,7 +57,7 @@ You can also use an array of path strings here to import multiple paths in the s
|
|
|
51
57
|
recursive: recursive.describe(`
|
|
52
58
|
Setting this to \`true\` will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.
|
|
53
59
|
|
|
54
|
-
Please use the pagination parameters \`
|
|
60
|
+
Please use the pagination parameters \`next_page_token\` and \`files_per_page\` wisely here.
|
|
55
61
|
`),
|
|
56
62
|
next_page_token: next_page_token.describe(`
|
|
57
63
|
A string token used for pagination. The returned files of one paginated call have the next page token inside of their meta data, which needs to be used for the subsequent paging call.
|
|
@@ -9,6 +9,7 @@ import { z } from 'zod'
|
|
|
9
9
|
import {
|
|
10
10
|
createStorageStoreExample,
|
|
11
11
|
defineRobot,
|
|
12
|
+
getGoogleCredentialsDescription,
|
|
12
13
|
googleBase,
|
|
13
14
|
robotBase,
|
|
14
15
|
robotStoreMeta,
|
|
@@ -39,19 +40,13 @@ The URL to the exported file in your Google bucket will be presented in the Tran
|
|
|
39
40
|
.boolean()
|
|
40
41
|
.optional()
|
|
41
42
|
.describe('Whether the results of this Step should be present in the Assembly Status JSON'),
|
|
42
|
-
credentials: z.string().describe(
|
|
43
|
-
|
|
43
|
+
credentials: z.string().describe(
|
|
44
|
+
getGoogleCredentialsDescription(`
|
|
45
|
+
Grant the service account \`storage.objects.create\` on the bucket you want to export to. The “Storage Object Creator” role provides this permission for new objects, but does not allow overwriting existing objects. Add \`storage.objects.delete\` only if you need to overwrite existing objects. See [Google’s IAM roles for Cloud Storage](https://docs.cloud.google.com/storage/docs/access-control/iam-roles).
|
|
44
46
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
Now you can set up the \`storage.objects.create\` and \`storage.objects.delete\` permissions. The latter is optional and only required if you intend to overwrite existing paths.
|
|
48
|
-
|
|
49
|
-
To do this from the Google Cloud console, navigate to "IAM & Admin" and select "Roles". From here, click "Create Role", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.
|
|
50
|
-
|
|
51
|
-
Next, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "Add Member", enter your service account as a new member, and select your newly created role.
|
|
52
|
-
|
|
53
|
-
Then, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your <dfn>Template Credentials</dfn> as this parameter's value.
|
|
47
|
+
For overwrites, create a custom role in “IAM & Admin” → “Roles” with \`storage.objects.create\` and \`storage.objects.delete\`, then grant it to the service account on your bucket.
|
|
54
48
|
`),
|
|
49
|
+
),
|
|
55
50
|
path: z
|
|
56
51
|
.string()
|
|
57
52
|
.default('${unique_prefix}/${file.url_name}')
|
|
@@ -55,12 +55,16 @@ The URL from which the file to be imported can be retrieved.
|
|
|
55
55
|
HTTPS URLs must present a valid certificate trusted by Transloadit and matching the requested hostname. Self-signed, expired, or hostname-mismatched certificates cause \`${httpImportRobotErrors.HTTP_IMPORT_FAILURE.error}\`.
|
|
56
56
|
|
|
57
57
|
You can also specify an array of URLs or a string of \`|\` delimited URLs to import several files at once. Please also check the \`url_delimiter\` parameter for that.
|
|
58
|
+
|
|
59
|
+
Delimited URL lists are split before variables are interpolated. A delimiter introduced by a variable remains part of that URL. To supply several URLs through a variable, have the entire \`url\` value interpolate to an array of URLs.
|
|
58
60
|
`),
|
|
59
61
|
url_delimiter: z
|
|
60
62
|
.string()
|
|
61
63
|
.default('|')
|
|
62
64
|
.describe(`
|
|
63
65
|
Provides the delimiter that is used to split the URLs in your \`url\` parameter value.
|
|
66
|
+
|
|
67
|
+
The delimiter must be literal. Only delimiters outside interpolation expressions in the original \`url\` value separate imports; variable values are never split.
|
|
64
68
|
`),
|
|
65
69
|
headers: z
|
|
66
70
|
.union([
|
|
@@ -7,6 +7,7 @@ import {
|
|
|
7
7
|
imageGenerateLegacyModelAlias,
|
|
8
8
|
imageGenerateModelIdentifiers,
|
|
9
9
|
} from './_ai-models.ts'
|
|
10
|
+
import { googleImageSeedMaximum } from './_google-image-seed.ts'
|
|
10
11
|
import {
|
|
11
12
|
autoProviderDescription,
|
|
12
13
|
interpolateRobot,
|
|
@@ -101,7 +102,13 @@ Best practice:
|
|
|
101
102
|
.describe(
|
|
102
103
|
'Output format. Defaults depend on model: png for Google and OpenAI models, svg for recraft-v3, jpeg for others. Google models currently return PNG only.',
|
|
103
104
|
),
|
|
104
|
-
seed
|
|
105
|
+
// Provider-specific limits are checked by the Robot so other models retain their seed range.
|
|
106
|
+
seed: z
|
|
107
|
+
.number()
|
|
108
|
+
.optional()
|
|
109
|
+
.describe(
|
|
110
|
+
`${robotParameterDocs.seed.description} For Google models, use an integer from 0 to ${googleImageSeedMaximum}. Each output increments the seed by 1, so the final output’s seed must also fit this range. A seed does not guarantee identical images.`,
|
|
111
|
+
),
|
|
105
112
|
aspect_ratio: z
|
|
106
113
|
.string()
|
|
107
114
|
.optional()
|
|
@@ -29,6 +29,34 @@ import {
|
|
|
29
29
|
|
|
30
30
|
const imageResizeGravitySchema = z.union([positionSchema, z.enum(['attention', 'entropy'])])
|
|
31
31
|
|
|
32
|
+
/** Input MIME types eligible for automatic libvips processing in /image/resize. */
|
|
33
|
+
export const imageResizeDaemonInputMimes: readonly string[] = [
|
|
34
|
+
'image/jpg',
|
|
35
|
+
'image/jpeg',
|
|
36
|
+
'image/jxl',
|
|
37
|
+
'image/png',
|
|
38
|
+
'image/tiff',
|
|
39
|
+
'image/tiff-fx',
|
|
40
|
+
'image/gif',
|
|
41
|
+
'image/webp',
|
|
42
|
+
'image/svg',
|
|
43
|
+
'image/svg+xml',
|
|
44
|
+
]
|
|
45
|
+
|
|
46
|
+
/** Output formats eligible for automatic libvips processing in /image/resize. */
|
|
47
|
+
export const imageResizeDaemonOutputFormats: readonly string[] = [
|
|
48
|
+
'heic',
|
|
49
|
+
'heif',
|
|
50
|
+
'jpeg',
|
|
51
|
+
'jpg',
|
|
52
|
+
'jxl',
|
|
53
|
+
'png',
|
|
54
|
+
'raw',
|
|
55
|
+
'tiff',
|
|
56
|
+
'webp',
|
|
57
|
+
'avif',
|
|
58
|
+
]
|
|
59
|
+
|
|
32
60
|
export const meta: RobotMetaInput = {
|
|
33
61
|
...robotImageProcessingMeta,
|
|
34
62
|
example_code: createProcessingExample('resized', '/image/resize', {
|
|
@@ -171,14 +199,14 @@ Height of the new image, in pixels. If not specified, will default to the height
|
|
|
171
199
|
.union([
|
|
172
200
|
z
|
|
173
201
|
.literal('crop')
|
|
174
|
-
.describe(`Cuts an area out of an image
|
|
202
|
+
.describe(`Cuts an area out of an image. Coordinates in the \`crop\` parameter imply this strategy. With coordinates, ImageMagick crops without resizing; libvips enlarges the image if \`x2\` or \`y2\` exceeds its dimensions, even with \`zoom: false\`. Without coordinates, set both \`width\` and \`height\`; this uses \`fillcrop\`, with \`gravity\` selecting which part is kept. With the default \`zoom\` setting, this coordinate-free path scales the image to cover that rectangle before trimming.
|
|
175
203
|
|
|
176
204
|
To crop around human faces, see [🤖/image/facedetect](https://transloadit.com/docs/robots/image-facedetect/) instead.`),
|
|
177
205
|
z
|
|
178
206
|
.literal('fillcrop')
|
|
179
207
|
.describe(`Scales the image to fit into our 100×100 target while preserving aspect ratio, while trimming away any excess surface. This means both sides will become exactly 100 pixels, at the tradeoff of destroying parts of the image.
|
|
180
208
|
|
|
181
|
-
By default the resulting image is horizontally/vertically centered to fill the target rectangle. Use the \`gravity\` parameter to change where to crop the image, such as \`"bottom\`
|
|
209
|
+
By default the resulting image is horizontally/vertically centered to fill the target rectangle. Use the \`gravity\` parameter to change where to crop the image, such as \`"bottom"\` or \`"left"\`.`),
|
|
182
210
|
z
|
|
183
211
|
.literal('fit')
|
|
184
212
|
.describe(`Uses the larger side of the original image as a base for the resize. Aspect ratio is preserved. Either side will become at most 100 pixels.
|
|
@@ -224,7 +252,7 @@ For example:
|
|
|
224
252
|
}
|
|
225
253
|
\`\`\`
|
|
226
254
|
|
|
227
|
-
This will crop the area from \`(80, 100)\` to \`(600, 800)\` from a 1000×1000 pixels image, which is a
|
|
255
|
+
This will crop the area from \`(80, 100)\` to \`(600, 800)\` from a 1000×1000 pixels image, which is a rectangle whose width is 520px and height is 700px. If \`crop\` is set, the width and height parameters are ignored, and the \`resize_strategy\` is set to \`crop\` automatically.
|
|
228
256
|
|
|
229
257
|
You can also use a JSON string of such an object with coordinates in similar fashion:
|
|
230
258
|
|
|
@@ -235,9 +263,11 @@ You can also use a JSON string of such an object with coordinates in similar fas
|
|
|
235
263
|
To crop around human faces, see [🤖/image/facedetect](/docs/robots/image-facedetect/).
|
|
236
264
|
`),
|
|
237
265
|
gravity: imageResizeGravitySchema.default('center').describe(`
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
266
|
+
Sets crop direction for \`crop\` or \`fillcrop\` without explicit coordinates.
|
|
267
|
+
Content-aware \`attention\` and \`entropy\` need libvips, \`fillcrop\`, \`width\` and \`height\`.
|
|
268
|
+
Effects such as \`sepia\` or \`text\`, and inputs such as HEIC, can use ImageMagick.
|
|
269
|
+
It centers these crops and the Assembly reports a warning.
|
|
270
|
+
Crop in a separate /image/resize Step before effects, or convert unsupported inputs to PNG first.
|
|
241
271
|
`),
|
|
242
272
|
strip: z
|
|
243
273
|
.boolean()
|
|
@@ -38,48 +38,54 @@ export const robotS3StoreInstructionsSchema = robotBase
|
|
|
38
38
|
.merge(robotUse)
|
|
39
39
|
.merge(s3Base)
|
|
40
40
|
.extend({
|
|
41
|
+
// URL rewriting does not fix bucket addressing, and custom paths need not use file.url_name.
|
|
42
|
+
// Keep the bucket warning separate from the old blanket filename-sanitization claim.
|
|
41
43
|
robot: z.literal('/s3/store').describe(`
|
|
42
44
|
If you are new to Amazon S3, see our tutorial on [using your own S3 bucket](/docs/faq/how-to-set-up-an-amazon-s3-bucket/).
|
|
43
45
|
|
|
44
|
-
The URL to the result file in your S3 bucket will be returned in the <dfn>Assembly Status JSON</dfn>. If your S3 bucket has versioning enabled, the version ID of the file will be returned within \`meta.version_id
|
|
46
|
+
The URL to the result file in your S3 bucket will be returned in the <dfn>Assembly Status JSON</dfn>. A returned URL does not make a private object public or grant read access. If your S3 bucket has versioning enabled, the version ID of the file will be returned within \`meta.version_id\`.
|
|
45
47
|
|
|
46
48
|
> [!Warning]
|
|
47
|
-
> **
|
|
49
|
+
> **Configure private buckets explicitly.** The Robot’s default \`acl\` is still \`"${s3StoreAclSchema.parse(undefined)}"\`. For a private bucket, set \`acl: "bucket-default"\` and do not supply ACL or grant headers. This omits the generated ACL header and works with [Bucket owner enforced Object Ownership](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html), where ACLs are disabled. Keep S3 Block Public Access enabled. Setting \`acl: "private"\` still sends an ACL and is not equivalent to omitting it.
|
|
48
50
|
|
|
49
51
|
> [!Warning]
|
|
50
|
-
> **Use DNS-compliant bucket names.**
|
|
52
|
+
> **Use DNS-compliant bucket names.** Follow AWS’s [bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The \`url_prefix\` parameter changes returned URLs; it does not change the bucket or its access permissions.
|
|
51
53
|
|
|
52
54
|
<span id="minimum-s3-iam-permissions" aria-hidden="true"></span>
|
|
53
55
|
|
|
54
56
|
## Limit access
|
|
55
57
|
|
|
56
|
-
|
|
58
|
+
Use a dedicated AWS identity with access limited to the destination bucket and object prefix. Do not use [AWS root access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/root-user-best-practices.html). Store its access key ID, secret access key, bucket name and region as \`key\`, \`secret\`, \`bucket\` and \`bucket_region\` in <dfn>Template Credentials</dfn>, then reference their name with \`credentials\`. Trusted backend integrations can instead supply those parameters directly; do not expose AWS secrets in browser instructions.
|
|
57
59
|
|
|
58
|
-
|
|
60
|
+
The following is an [identity-based IAM policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html), attached to that dedicated identity, not a bucket policy. It intentionally has no \`Principal\`. Replace \`{BUCKET_NAME}\` and use a Robot \`path\` beginning with \`uploads/\`, or adapt both the policy prefix and the path together.
|
|
61
|
+
|
|
62
|
+
This example covers uploads and failed multipart-upload cleanup with an explicit \`bucket_region\`, \`acl: "bucket-default"\`, no ACL/grant headers, no tags and S3-managed encryption (SSE-S3). Existing bucket policies, organization controls or endpoint policies can still deny access.
|
|
59
63
|
|
|
60
64
|
\`\`\`json
|
|
61
65
|
{
|
|
62
66
|
"Version": "2012-10-17",
|
|
63
67
|
"Statement": [
|
|
64
68
|
{
|
|
65
|
-
"Sid": "
|
|
69
|
+
"Sid": "UploadAndAbortWithinPrefix",
|
|
66
70
|
"Effect": "Allow",
|
|
67
|
-
"Action": ["s3:
|
|
68
|
-
"Resource":
|
|
71
|
+
"Action": ["s3:PutObject", "s3:AbortMultipartUpload"],
|
|
72
|
+
"Resource": "arn:aws:s3:::{BUCKET_NAME}/uploads/*"
|
|
69
73
|
}
|
|
70
74
|
]
|
|
71
75
|
}
|
|
72
76
|
\`\`\`
|
|
73
77
|
|
|
74
|
-
The \`
|
|
78
|
+
The uploader uses either \`PutObject\` or \`CreateMultipartUpload\`, \`UploadPart\` and \`CompleteMultipartUpload\`; failed multipart uploads can trigger \`AbortMultipartUpload\`. AWS maps the successful upload operations to \`s3:PutObject\`. Write access can **overwrite an existing object key**; it is not add-only. Choose unique object paths and consider versioning for recovery.
|
|
75
79
|
|
|
76
|
-
|
|
80
|
+
Add permissions only for features you use, following AWS’s [operation permission reference](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-policy-actions.html):
|
|
77
81
|
|
|
78
|
-
|
|
82
|
+
- Without an explicit \`bucket_region\`, region discovery can require \`s3:GetBucketLocation\` and fallback \`s3:ListBucket\` on the bucket ARN, \`arn:aws:s3:::{BUCKET_NAME}\`, without an object suffix. Supplying the correct region avoids these discovery requests.
|
|
83
|
+
- ACL or grant headers require \`s3:PutObjectAcl\`; tags require \`s3:PutObjectTagging\` on the allowed object prefix. \`bucket-default\` does not remove ACL/grant headers you supply in \`headers\`.
|
|
84
|
+
- Downloading private results requires separate read authorization. Even a URL generated with \`sign_urls_for\` needs the signing identity to have the appropriate read permissions.
|
|
79
85
|
|
|
80
|
-
|
|
86
|
+
S3 applies its [bucket encryption configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/default-bucket-encryption.html) when no encryption override is sent. You can request SSE-KMS through \`headers\`, using \`x-amz-server-side-encryption: aws:kms\` and \`x-amz-server-side-encryption-aws-kms-key-id\`. When either bucket default encryption or request headers select [SSE-KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html), the uploading identity needs \`kms:GenerateDataKey\` on the relevant key, plus \`kms:Decrypt\` for multipart uploads. For a customer-managed key, grant these permissions with a compatible KMS key policy; the base S3 policy above does not include them. Do not add blanket \`kms:*\` or \`sts:*\` grants.
|
|
81
87
|
|
|
82
|
-
|
|
88
|
+
Short-lived AWS credentials are a matching set of \`key\`, \`secret\` and \`session_token\`. Have a trusted backend obtain and refresh all three, then supply them together when it creates the Assembly. It can pass them directly in Robot instructions or save and update them together through the [Template Credentials API](/docs/api/template-credentials-post/). Keep all three out of browser instructions; replacing only the session token does not refresh expired access keys. This Robot passes the supplied credentials to S3; it does not assume a role or refresh expired credentials. Keep temporary credentials valid for the upload.
|
|
83
89
|
`),
|
|
84
90
|
path: storeFilePath,
|
|
85
91
|
url_prefix: z
|
|
@@ -89,9 +95,7 @@ Please keep in mind that if you use bucket encryption you may also need to add \
|
|
|
89
95
|
The URL prefix used for the returned URL, such as \`"http://my.cdn.com/some/path/"\`.
|
|
90
96
|
`),
|
|
91
97
|
acl: s3StoreAclSchema.describe(`
|
|
92
|
-
The
|
|
93
|
-
|
|
94
|
-
Please keep in mind that the default value \`"${s3StoreAclSchema.parse(undefined)}"\` can lead to permission errors due to the \`"Block all public access"\` checkbox that is checked by default when creating a new Amazon S3 Bucket in the AWS console.
|
|
98
|
+
The ACL used for this file. The default remains \`"${s3StoreAclSchema.parse(undefined)}"\`, which can conflict with S3 Block Public Access and disabled ACLs. For modern private buckets, explicitly set \`"bucket-default"\` to omit the generated ACL header, and do not supply ACL/grant headers in \`headers\`. \`"private"\` still sends an ACL.
|
|
95
99
|
`),
|
|
96
100
|
check_integrity: z
|
|
97
101
|
.boolean()
|
|
@@ -139,7 +143,7 @@ This parameter provides signed URLs in the result JSON (in the \`signed_url\` an
|
|
|
139
143
|
.string()
|
|
140
144
|
.optional()
|
|
141
145
|
.describe(`
|
|
142
|
-
The session token to
|
|
146
|
+
The session token belonging to the temporary AWS access key ID and secret access key supplied for this upload. The Robot does not assume a role or refresh these credentials; they must remain valid for the upload.
|
|
143
147
|
`),
|
|
144
148
|
})
|
|
145
149
|
.strict()
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { MODEL_CAPABILITIES } from './_ai-models.ts'
|
|
1
2
|
import type {
|
|
2
3
|
RobotDefinition,
|
|
3
4
|
RobotMetaInput,
|
|
@@ -22,6 +23,15 @@ import {
|
|
|
22
23
|
/** Markup over the AI provider cost for smart thumbnail selection. */
|
|
23
24
|
export const smartThumbnailMarkupPercent = 50
|
|
24
25
|
|
|
26
|
+
/** Dedicated vision model so /ai/chat default upgrades do not change thumbnail analysis costs. */
|
|
27
|
+
export const smartThumbnailModel = 'openai/gpt-5.4-mini' satisfies keyof typeof MODEL_CAPABILITIES
|
|
28
|
+
|
|
29
|
+
/** Maximum long-side dimension of scoring previews; returned thumbnails keep their output size. */
|
|
30
|
+
export const smartThumbnailAnalysisMaxSize = 512
|
|
31
|
+
|
|
32
|
+
/** Frame ranking needs little reasoning compared with general-purpose chat. */
|
|
33
|
+
export const smartThumbnailReasoningEffort = 'low'
|
|
34
|
+
|
|
25
35
|
const thumbnailCountSchema = z.number().int().min(1).max(999).default(8)
|
|
26
36
|
const smartMaximumCandidatesSchema = z.number().int().min(2).max(100).default(20)
|
|
27
37
|
const defaultThumbnailCount = thumbnailCountSchema.parse(undefined)
|
|
@@ -58,13 +68,15 @@ export const robotVideoThumbsInstructionsSchema = robotBase
|
|
|
58
68
|
.merge(robotFFmpeg)
|
|
59
69
|
.extend({
|
|
60
70
|
robot: z.literal('/video/thumbs').describe(`
|
|
61
|
-
Set \`smart: true\` to select strong preview images with AI instead of taking frames only at regular intervals. The Robot scores candidate frames for clarity, brightness, composition, faces, expressions, action, and visual interest, then returns the best \`count\` frames in chronological order. Smart results include \`file.meta.smart_score\` and \`file.meta.smart_reasons\`. If AI scoring is unavailable, the Assembly continues with the candidate frames in fallback order. No AI credentials are required.
|
|
71
|
+
Set \`smart: true\` to select strong preview images with AI instead of taking frames only at regular intervals. The Robot scores candidate frames for clarity, brightness, composition, faces, expressions, action, and visual interest, then returns the best \`count\` frames in chronological order. Smart results include \`file.meta.smart_score\` and \`file.meta.smart_reasons\`. If AI scoring is unavailable, the Assembly continues with the candidate frames in fallback order and includes a warning. No AI credentials are required.
|
|
62
72
|
|
|
63
73
|
## AI pricing
|
|
64
74
|
|
|
65
|
-
Regular \`/video/thumbs\` processing charges still apply. AI frame analysis is billed separately at the underlying provider cost plus a ${smartThumbnailMarkupPercent}% Transloadit markup. The exact AI charge varies with the number of candidate frames
|
|
75
|
+
Regular \`/video/thumbs\` processing charges still apply. AI frame analysis is billed separately at the underlying provider cost plus a ${smartThumbnailMarkupPercent}% Transloadit markup. Smart selection uses the dedicated \`${smartThumbnailModel}\` vision model with \`${smartThumbnailReasoningEffort}\` reasoning, independently of the \`/ai/chat\` default. The exact AI charge varies with the number of candidate frames and provider pricing.
|
|
66
76
|
|
|
67
|
-
|
|
77
|
+
The AI scores preview copies capped at ${smartThumbnailAnalysisMaxSize} pixels on the long side, preserving aspect ratio and without enlarging smaller images. Returned thumbnails keep the requested output dimensions and format; larger outputs do not increase the scoring preview beyond this limit.
|
|
78
|
+
|
|
79
|
+
\`smart_max_candidates\` is the main cost and latency control. The Robot analyzes up to three candidates per requested thumbnail, capped by \`smart_max_candidates\`, but never fewer than \`count\`. With the defaults of \`count: ${defaultThumbnailCount}\` and \`smart_max_candidates: ${defaultSmartMaximumCandidates}\`, it analyzes ${getSmartThumbnailCandidateCount(defaultThumbnailCount, defaultSmartMaximumCandidates)} frames and returns the best ${defaultThumbnailCount}. Lower the candidate limit to reduce AI cost and latency. Raising it can enlarge the pool up to three times \`count\`; higher limits have no effect.
|
|
68
80
|
|
|
69
81
|
> [!Note]
|
|
70
82
|
> Use \`count\` with smart selection. To consistently extract exact timestamps with \`offsets\`, set \`smart: false\`.
|
|
@@ -146,17 +158,19 @@ The AI evaluates frames based on:
|
|
|
146
158
|
- Action and motion (avoiding transition frames)
|
|
147
159
|
- Overall visual interest
|
|
148
160
|
|
|
149
|
-
Regular \`/video/thumbs\` processing charges still apply. AI frame analysis is billed separately at the underlying provider cost plus a ${smartThumbnailMarkupPercent}% Transloadit markup. You do not need to provide AI credentials.
|
|
161
|
+
Regular \`/video/thumbs\` processing charges still apply. AI frame analysis uses a dedicated low-cost vision model with \`${smartThumbnailReasoningEffort}\` reasoning and preview copies capped at ${smartThumbnailAnalysisMaxSize} pixels on the long side. Returned thumbnails retain their requested dimensions and format. Analysis is billed separately at the underlying provider cost plus a ${smartThumbnailMarkupPercent}% Transloadit markup. You do not need to provide AI credentials.
|
|
150
162
|
|
|
151
163
|
Smart mode generates its own regularly spaced candidate timestamps; use \`smart: false\` with \`offsets\` when you need specified timestamps. Selected smart thumbnails are returned in chronological order, not score order. Inspect \`meta.thumb_offset\`, \`meta.smart_score\`, and \`meta.smart_reasons\` when evaluating the selection.
|
|
152
164
|
|
|
153
|
-
If AI scoring fails, the Robot selects
|
|
165
|
+
If AI scoring fails, the Robot selects extracted candidates in chronological order and records a fallback reason. With no candidates, it attempts standard extraction. Both fallbacks add an Assembly warning. A completed Assembly does not guarantee a representative or publication-safe poster; check that outputs exist and apply your application’s review policy.
|
|
154
166
|
`),
|
|
155
167
|
smart_max_candidates: smartMaximumCandidatesSchema.describe(`
|
|
156
168
|
The maximum size of the candidate pool when \`smart\` is \`true\`. The Robot analyzes up to three candidates per requested thumbnail, capped by this value, but it will never analyze fewer candidates than the requested \`count\`.
|
|
157
169
|
|
|
158
170
|
A higher number may yield better results but increases processing time and AI cost. With the defaults of \`count: ${defaultThumbnailCount}\` and \`smart_max_candidates: ${defaultSmartMaximumCandidates}\`, the Robot analyzes ${getSmartThumbnailCandidateCount(defaultThumbnailCount, defaultSmartMaximumCandidates)} frames and returns the best ${defaultThumbnailCount} in chronological order.
|
|
159
171
|
|
|
172
|
+
Raising this limit above three times \`count\` does not enlarge the pool. For example, \`count: 1\` analyzes at most three candidates.
|
|
173
|
+
|
|
160
174
|
This parameter is only used when \`smart\` is \`true\`.
|
|
161
175
|
`),
|
|
162
176
|
})
|