AgentPrompt

__construct(Agent $agent, string $prompt, Collection|array $attachments, TextProvider $provider, string $model, int|null $timeout = null, string|null $invocationId = null, Decisions|null $approvalDecisions = null, string|null $parentInvocationId = null, string|null $parentToolInvocationId = null, bool $isFinalAttempt = true, array|null $messages = null, array|null $tools = null, Closure|null $contextRunner = null, array $middleware = [], ConversationSelection|null $conversationSelection = null, array|null $conversationMessages = null)

Create an agent prompt.

hasApprovalDecisions()

Determine whether the prompt has tool approval decisions.

contains(string $string)

Determine if the prompt contains the given string.

prepend(string $prompt)

Prepend to the prompt and return a new prompt instance.

append(string $prompt)

Append to the prompt and return a new prompt instance.

revise(string $prompt, Collection|array|null $attachments = null)

Revise the prompt and return a new prompt instance.

withTools(iterable $tools)

Replace the tools for this run, returning a new prompt instance.

withAttachments(Collection|array $attachments)

Add new attachment to the prompt, returning a new prompt instance.

provider()

Get the provider instance.

isFinalAttempt()

Determine whether the caller has run out of providers to retry this prompt against.

markAsStreaming()

Mark this prompt for lazy streaming execution.

isStreaming()

Determine whether provider execution is deferred until stream consumption.

setPendingConversationTitle(PendingConversationTitle|null $title)

Attach the title request owned by the current attempt.

pendingConversationTitle()

Get the title request owned by the current attempt.

captureConversation()

Capture the conversation selection and history for this invocation.

conversationSelection()

Get the conversation owned by this invocation.

conversationMessages()

Get the conversational history captured for this invocation.

setRunContext(RunContext|null $context)

Set the context the run dispatched for this prompt records its steps on.

runContext()

Get the context the run dispatched for this prompt is recording its steps on.

approvalClaim()

Get the claim a conversation store must verify when settling this continuation.

contextRunner()

Get the captured operation context runner.

setContextRunner(Closure|null $runner)

Set the operation context captured by the streaming factory.

willRetry(Throwable $exception)

Determine whether the caller will retry this prompt against another provider.

__serialize()

Prepare the prompt for serialization without its live execution state.