FSprompt extends BasicPrompt
FSprompt stands for "File, Settings" and is designed for multimodal pipelines that require file inputs, such as OpenAI's Whisper model.
FSprompt extends BasicPrompt and provides methods to set and retrieve the file and associated settings. The encoder method constructs a custom formatted string (FS block) that embeds the file and settings information into a JSON-encoded prompt, while the decoder extracts these parameters from such a prompt.
Table of Contents
Methods
- getFile() : mixed
- Retrieves the file parameter from the prompt.
- getPrompt() : string
- Gets the prompt text.
- getSettings() : mixed
- Retrieves the additional settings from the prompt.
- promptDecode() : static
- Decodes a JSON-encoded prompt string into a BasicPrompt instance.
- promptEncode() : string
- Encodes the prompt data into a JSON string.
- setFile() : $this
- Sets the file parameter for the prompt.
- setPrompt() : $this
- Sets the prompt text.
- settings() : $this
- Sets additional settings for the prompt.
- decoder() : void
- Decodes a JSON-encoded prompt string and extracts file and settings parameters.
- encoder() : string
- Encodes the file and settings parameters into a JSON-encoded prompt string.
Methods
getFile()
Retrieves the file parameter from the prompt.
public
getFile() : mixed
Return values
mixed —The file value, or null if not set.
getPrompt()
Gets the prompt text.
public
getPrompt() : string
Return values
string —$this Returns the current prompt string.
getSettings()
Retrieves the additional settings from the prompt.
public
getSettings() : mixed
Return values
mixed —The settings array, or null if not set.
promptDecode()
Decodes a JSON-encoded prompt string into a BasicPrompt instance.
public
static promptDecode(string $promptString) : static
This static method creates a new instance of BasicPrompt, decodes the provided JSON string, and sets the prompt data accordingly.
Parameters
- $promptString : string
-
JSON-encoded prompt string.
Return values
static —A new instance of BasicPrompt with the decoded prompt data.
promptEncode()
Encodes the prompt data into a JSON string.
public
promptEncode() : string
This method utilizes the internal encoder to transform the prompt stored in the collection into a JSON representation.
Return values
string —JSON-encoded prompt data.
setFile()
Sets the file parameter for the prompt.
public
setFile(string $string) : $this
Parameters
- $string : string
-
The file identifier or path.
Return values
$this —Returns the current instance for method chaining.
setPrompt()
Sets the prompt text.
public
setPrompt(string $prompt) : $this
Stores the provided prompt text in the collection under the key "prompt".
Parameters
- $prompt : string
-
The prompt text.
Return values
$this —Returns the current instance for method chaining.
settings()
Sets additional settings for the prompt.
public
settings(array<string|int, mixed> $keyValueArray) : $this
Parameters
- $keyValueArray : array<string|int, mixed>
-
An associative array of settings.
Return values
$this —Returns the current instance for method chaining.
decoder()
Decodes a JSON-encoded prompt string and extracts file and settings parameters.
protected
decoder(string $prompt) : void
This method looks for an FS block in the prompt (using a regular expression). If found, it splits the block into its components, extracting the file identifier and settings values. If no FS block is present, the entire prompt is treated as the file value.
Parameters
- $prompt : string
-
The JSON-encoded prompt string.
encoder()
Encodes the file and settings parameters into a JSON-encoded prompt string.
protected
encoder() : string
This method constructs an FS block with the following format: "{{FS:file,settingKey1|settingValue1,settingKey2|settingValue2,...}}" which is then stored under the "prompt" key and JSON-encoded.
Return values
string —The JSON-encoded prompt containing the FS block.