Skip to content

Adds MessageBuilder class #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Sep 5, 2025
Merged

Adds MessageBuilder class #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
39ff98f
feat: adds MessageBuilder class
JasonTheAdams Sep 2, 2025
0b50eef
chore: ignores IDE folders
JasonTheAdams Sep 2, 2025
181ae18
chore: updates architecture to reflect builder
JasonTheAdams Sep 2, 2025
c7495b3
test: adds MessageBuilder tests
JasonTheAdams Sep 2, 2025
f50e726
chore: adds missing methods to architecture
JasonTheAdams Sep 2, 2025
2887413
test: resolving linting issues
JasonTheAdams Sep 2, 2025
739345e
refactor: removes validation already handled by Message
JasonTheAdams Sep 2, 2025
5ea1fef
chore: corrects class description due to last commit
JasonTheAdams Sep 2, 2025
b51ca57
chore: updates PromptBuilder architecture methods
JasonTheAdams Sep 5, 2025
13a3529
feat: adds support for additional input types
JasonTheAdams Sep 5, 2025
6244bf2
chore: fixes linting error
JasonTheAdams Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ vendor/
*.DS_store
.DS_store?

############
## IDEs
############

.idea/
.vscode/

############
## AI Tools
############
Expand Down
114 changes: 56 additions & 58 deletions docs/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,69 +296,68 @@ direction LR
namespace AiClientNamespace {
class AiClient {
+prompt(string|Message|null $text = null) PromptBuilder$
+message(?string $text) MessageBuilder$
+message($input = null) MessageBuilder$
}
}

namespace AiClientNamespace.Builders {
class PromptBuilder {
+withText(string $text) self
+withInlineImage(string $base64Blob, string $mimeType)
+withRemoteImage(string $uri, string $mimeType)
+withImageFile(File $file) self
+withAudioFile(File $file) self
+withVideoFile(File $file) self
+withFile($file, ?string $mimeType) self
+withFunctionResponse(FunctionResponse $functionResponse) self
+withMessageParts(...MessagePart $part) self
+withMessageParts(...MessagePart $parts) self
+withHistory(...Message $messages) self
+usingModel(ModelInterface $model) self
+usingModelConfig(ModelConfig $config) self
+usingProvider(string $providerIdOrClassName) self
+usingSystemInstruction(string $systemInstruction) self
+usingMaxTokens(int $maxTokens) self
+usingTemperature(float $temperature) self
+usingTopP(float $topP) self
+usingTopK(int $topK) self
+usingStopSequences(...string $stopSequences) self
+usingCandidateCount(int $candidateCount) self
+usingOutputMime(string $mimeType) self
+usingOutputSchema(array< string, mixed > $schema) self
+usingOutputModalities(...ModalityEnum $modalities) self
+usingFunctionDeclarations(...FunctionDeclaration $functionDeclarations) self
+usingPresencePenalty(float $presencePenalty) self
+usingFrequencyPenalty(float $frequencyPenalty) self
+usingWebSearch(WebSearch $webSearch) self
+usingTopLogprobs(?int $topLogprobs) self
+asOutputMimeType(string $mimeType) self
+asOutputSchema(array< string, mixed > $schema) self
+asOutputModalities(...ModalityEnum $modalities) self
+asOutputFileType(FileTypeEnum $fileType) self
+asJsonResponse(?array< string, mixed > $schema) self
+generateResult() GenerativeAiResult
+generateOperation() GenerativeAiOperation
+generateResult(?CapabilityEnum $capability) GenerativeAiResult
+generateTextResult() GenerativeAiResult
+streamGenerateTextResult() Generator< GenerativeAiResult >
+generateImageResult() GenerativeAiResult
+convertTextToSpeechResult() GenerativeAiResult
+generateSpeechResult() GenerativeAiResult
+generateEmbeddingsResult() EmbeddingResult
+generateTextOperation() GenerativeAiOperation
+generateImageOperation() GenerativeAiOperation
+convertTextToSpeechOperation() GenerativeAiOperation
+generateSpeechOperation() GenerativeAiOperation
+generateEmbeddingsOperation() EmbeddingOperation
+convertTextToSpeechResult() GenerativeAiResult
+generateText() string
+generateTexts(?int $candidateCount) string[]
+streamGenerateText() Generator< string >
+generateImage() File
+generateImages(?int $candidateCount) File[]
+convertTextToSpeech() File
+convertTextToSpeeches(?int $candidateCount) File[]
+generateSpeech() File
+generateSpeeches(?int $candidateCount) File[]
+generateEmbeddings() Embedding[]
+getModelRequirements() ModelRequirements
+isSupported() bool
+isSupportedForTextGeneration() bool
+isSupportedForImageGeneration() bool
+isSupportedForTextToSpeechConversion() bool
+isSupportedForVideoGeneration() bool
+isSupportedForSpeechGeneration() bool
+isSupportedForMusicGeneration() bool
+isSupportedForEmbeddingGeneration() bool
}

class MessageBuilder {
+usingRole(MessageRole $role) self
+usingRole(MessageRoleEnum $role) self
+usingUserRole() self
+usingModelRole() self
+withText(string $text) self
+withImageFile(File $file) self
+withAudioFile(File $file) self
+withVideoFile(File $file) self
+withFile($file, ?string $mimeType) self
+withFunctionCall(FunctionCall $functionCall) self
+withFunctionResponse(FunctionResponse $functionResponse) self
+withMessageParts(...MessagePart $part) self
+withMessageParts(...MessagePart $parts) self
+get() Message
}
}
Expand Down Expand Up @@ -444,7 +443,7 @@ direction LR
namespace AiClientNamespace {
class AiClient {
+prompt(string|Message|null $text = null) PromptBuilder$
+message(?string $text) MessageBuilder$
+message($input = null) MessageBuilder$
+defaultRegistry() ProviderRegistry$
+isConfigured(ProviderAvailabilityInterface $availability) bool$
+generateResult(string|MessagePart|MessagePart[]|Message|Message[] $prompt, ModelInterface $model) GenerativeAiResult$
Expand All @@ -466,62 +465,61 @@ direction LR
namespace AiClientNamespace.Builders {
class PromptBuilder {
+withText(string $text) self
+withInlineImage(string $base64Blob, string $mimeType)
+withRemoteImage(string $uri, string $mimeType)
+withImageFile(File $file) self
+withAudioFile(File $file) self
+withVideoFile(File $file) self
+withFile($file, ?string $mimeType) self
+withFunctionResponse(FunctionResponse $functionResponse) self
+withMessageParts(...MessagePart $part) self
+withMessageParts(...MessagePart $parts) self
+withHistory(...Message $messages) self
+usingModel(ModelInterface $model) self
+usingModelConfig(ModelConfig $config) self
+usingProvider(string $providerIdOrClassName) self
+usingSystemInstruction(string $systemInstruction) self
+usingMaxTokens(int $maxTokens) self
+usingTemperature(float $temperature) self
+usingTopP(float $topP) self
+usingTopK(int $topK) self
+usingStopSequences(...string $stopSequences) self
+usingCandidateCount(int $candidateCount) self
+usingOutputMime(string $mimeType) self
+usingOutputSchema(array< string, mixed > $schema) self
+usingOutputModalities(...ModalityEnum $modalities) self
+usingFunctionDeclarations(...FunctionDeclaration $functionDeclarations) self
+usingPresencePenalty(float $presencePenalty) self
+usingFrequencyPenalty(float $frequencyPenalty) self
+usingWebSearch(WebSearch $webSearch) self
+usingTopLogprobs(?int $topLogprobs) self
+asOutputMimeType(string $mimeType) self
+asOutputSchema(array< string, mixed > $schema) self
+asOutputModalities(...ModalityEnum $modalities) self
+asOutputFileType(FileTypeEnum $fileType) self
+asJsonResponse(?array< string, mixed > $schema) self
+generateResult() GenerativeAiResult
+generateOperation() GenerativeAiOperation
+generateResult(?CapabilityEnum $capability) GenerativeAiResult
+generateTextResult() GenerativeAiResult
+streamGenerateTextResult() Generator< GenerativeAiResult >
+generateImageResult() GenerativeAiResult
+convertTextToSpeechResult() GenerativeAiResult
+generateSpeechResult() GenerativeAiResult
+generateEmbeddingsResult() EmbeddingResult
+generateTextOperation() GenerativeAiOperation
+generateImageOperation() GenerativeAiOperation
+convertTextToSpeechOperation() GenerativeAiOperation
+generateSpeechOperation() GenerativeAiOperation
+generateEmbeddingsOperation() EmbeddingOperation
+convertTextToSpeechResult() GenerativeAiResult
+generateText() string
+generateTexts(?int $candidateCount) string[]
+streamGenerateText() Generator< string >
+generateImage() File
+generateImages(?int $candidateCount) File[]
+convertTextToSpeech() File
+convertTextToSpeeches(?int $candidateCount) File[]
+generateSpeech() File
+generateSpeeches(?int $candidateCount) File[]
+generateEmbeddings() Embedding[]
+getModelRequirements() ModelRequirements
+isSupported() bool
+isSupportedForTextGeneration() bool
+isSupportedForImageGeneration() bool
+isSupportedForTextToSpeechConversion() bool
+isSupportedForVideoGeneration() bool
+isSupportedForSpeechGeneration() bool
+isSupportedForMusicGeneration() bool
+isSupportedForEmbeddingGeneration() bool
}

class MessageBuilder {
+usingRole(MessageRole $role) self
+usingRole(MessageRoleEnum $role) self
+usingUserRole() self
+usingModelRole() self
+withText(string $text) self
+withImageFile(File $file) self
+withAudioFile(File $file) self
+withVideoFile(File $file) self
+withFile($file, ?string $mimeType) self
+withFunctionCall(FunctionCall $functionCall) self
+withFunctionResponse(FunctionResponse $functionResponse) self
+withMessageParts(...MessagePart $part) self
+withMessageParts(...MessagePart $parts) self
+get() Message
}
}
Expand Down
Loading