Function generateArray

generateArray<TSchema extends ZodType>(
    args: {
        prompt: string;
        schema: TSchema;
        schemaDescription?: string;
        schemaName?: string;
        variables?: Record<string, string | number | boolean>;
    } & Partial<Omit<CallSettings, "maxOutputTokens">>,
): Promise<GenerateObjectResult<infer<TSchema>[]>>
Use an LLM model to generate an array of values with a fixed schema.
Type Parameters
- TSchema extends ZodType
Parameters
- args: {
      prompt: string;
      schema: TSchema;
      schemaDescription?: string;
      schemaName?: string;
      variables?: Record<string, string | number | boolean>;
  } & Partial<Omit<CallSettings, "maxOutputTokens">>
  Generation arguments.
  - prompt: string
    Prompt file name.
  - schema: TSchema
    Output schema (array item).
  - OptionalschemaDescription?: string
    Output schema description.
  - OptionalschemaName?: string
    Output schema name.
  - Optionalvariables?: Record<string, string | number | boolean>
    Variables to interpolate.
  - prompt
    Prompt file name.
  - variables
    Variables to interpolate.
  - schema
    Output schema (array item).
  - schemaName
    Output schema name.
  - schemaDescription
    Output schema description.
Returns Promise<GenerateObjectResult<infer<TSchema>[]>>
AI SDK response with array and metadata.
Deprecated
Since v0.3.0. Use generateText() with Output.array({ element }) instead. Will be removed in v1.0.0.
Example: Migration:
```
// Before (deprecated):
const { object } = await generateArray({ prompt: 'my_prompt', schema: ItemSchema });

// After (recommended):
const { output } = await generateText({ prompt: 'my_prompt', output: Output.array({ element: ItemSchema }) });
```
See
generateText for the recommended replacement