PendingStep

__construct(int $number, bool $isFinalStep, string $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options, array $steps = [], TextUsage $usage = new TextUsage(), int|null $timeout = null, string|null $invocationId = null)

Create a generation step for agent middleware.

isFirstStep()

Determine whether this is the first generation step.

withModel(string $model)

Create a copy using a different model.

withInstructions(string|null $instructions)

Create a copy using different instructions.

withMessages(iterable $messages)

Replace the history sent for this step only; the run's history still grows from the original.

withTools(iterable $tools)

Create a copy using the given tools.

onlyTools(string ...$names)

Create a copy containing only the named tools.

withoutTools(string ...$names)

Create a copy excluding the named tools.

withToolChoice(ToolChoice|string|array|null $toolChoice)

Create a copy using a different tool choice.

withMaxTokens(int|null $maxTokens)

Create a copy using a different maximum token count.

withProviderOptions(array $providerOptions)

Create a copy using the given provider options.

withOptions(TextGenerationOptions $options)

Create a copy using the given options.

resolvedOptions()

Get the step options, creating an empty set when none were provided.

with(array $overrides)

Create a copy with the given property overrides.