PromptReference
extends ElementReference
in package
Tags
Table of Contents
Properties
- $completionProviders : array<string|int, mixed>
- $handler : Closure|array<string|int, mixed>|string
- $isManual : bool
- $prompt : Prompt
Methods
- __construct() : mixed
- formatResult() : array<string|int, PromptMessage>
- Formats the raw result of a prompt generator into an array of MCP PromptMessages.
- formatAudioContent() : AudioContent
- formatContent() : TextContent|ImageContent|AudioContent|EmbeddedResource
- Formats content into a proper Content object.
- formatImageContent() : ImageContent
- formatMessage() : PromptMessage
- Formats a single message into a PromptMessage.
- formatResourceContent() : EmbeddedResource
- formatTextContent() : TextContent
- formatTypedContent() : TextContent|ImageContent|AudioContent|EmbeddedResource
- Formats typed content arrays into Content objects.
Properties
$completionProviders read-only
public
array<string|int, mixed>
$completionProviders
= []
$handler read-only
public
Closure|array<string|int, mixed>|string
$handler
$isManual read-only
public
bool
$isManual
= false
$prompt read-only
public
Prompt
$prompt
Methods
__construct()
public
__construct(Prompt $prompt, Handler $handler[, bool $isManual = false ][, array<string, class-string|object> $completionProviders = [] ]) : mixed
Parameters
- $prompt : Prompt
- $handler : Handler
- $isManual : bool = false
- $completionProviders : array<string, class-string|object> = []
formatResult()
Formats the raw result of a prompt generator into an array of MCP PromptMessages.
public
formatResult(mixed $promptGenerationResult) : array<string|int, PromptMessage>
Parameters
- $promptGenerationResult : mixed
-
expected: array of message structures
Tags
Return values
array<string|int, PromptMessage> —array of PromptMessage objects
formatAudioContent()
private
formatAudioContent(array<string, mixed> $content, string $indexStr) : AudioContent
Parameters
- $content : array<string, mixed>
- $indexStr : string
Return values
AudioContentformatContent()
Formats content into a proper Content object.
private
formatContent(mixed $content[, int|null $index = null ]) : TextContent|ImageContent|AudioContent|EmbeddedResource
Parameters
- $content : mixed
- $index : int|null = null
Return values
TextContent|ImageContent|AudioContent|EmbeddedResourceformatImageContent()
private
formatImageContent(array<string, mixed> $content, string $indexStr) : ImageContent
Parameters
- $content : array<string, mixed>
- $indexStr : string
Return values
ImageContentformatMessage()
Formats a single message into a PromptMessage.
private
formatMessage(mixed $message[, int|null $index = null ]) : PromptMessage
Parameters
- $message : mixed
- $index : int|null = null
Return values
PromptMessageformatResourceContent()
private
formatResourceContent(array<string, mixed> $content, string $indexStr) : EmbeddedResource
Parameters
- $content : array<string, mixed>
- $indexStr : string
Return values
EmbeddedResourceformatTextContent()
private
formatTextContent(array<string, mixed> $content, string $indexStr) : TextContent
Parameters
- $content : array<string, mixed>
- $indexStr : string
Return values
TextContentformatTypedContent()
Formats typed content arrays into Content objects.
private
formatTypedContent(array<string, mixed> $content[, int|null $index = null ]) : TextContent|ImageContent|AudioContent|EmbeddedResource
Parameters
- $content : array<string, mixed>
- $index : int|null = null