Skip to content

Model3DActivityOptions

ts
type Model3DActivityOptions<TAdapter, TStream, TWait> = Model3DActivityBaseOptions<TAdapter> & object & [TStream, TWait] extends [true, true] ? object : unknown;

Defined in: packages/ai/src/activities/generate3DModel/index.ts:165

Experimental

Options for generate3DModel.

  • No stream and no wait: submit the job and return { jobId, model }.
  • stream: true: run the full job and return StreamChunks (for SSE).
  • wait: true: run the full job and return the finished model.

stream and wait cannot both be true.

Type Parameters

TAdapter

TAdapter extends Model3DAdapter<string, any, any, any>

The 3D model adapter type

TStream

TStream extends boolean = false

Whether to stream the job lifecycle

TWait

TWait extends boolean = false

Whether to wait for the finished model

3D model generation is experimental and may change.

Type Declaration

stream?

ts
optional stream?: TStream;

Run the full job and return an AsyncIterable: RUN_STARTED, one generation:progress per poll, generation:result, RUN_FINISHED.

Default

ts
false

wait?

ts
optional wait?: TWait;

Run the full job and return a Promise of the finished model.

Default

ts
false