refactor: introduce model capabilities with generic base model instead of interfaces with supportsX methods

Author: chr-hertel

README.md

@@ -96,7 +96,7 @@ use PhpLlm\LlmChain\Model\Message\MessageBag;
 
 // Platform & LLM instantiation
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a helpful chatbot answering questions about LLM Chain.'),
     Message::ofUser('Hello, how are you?'),
@@ -156,7 +156,7 @@ $yourTool = new YourTool();
 $toolbox = Toolbox::create($yourTool);
 $toolProcessor = new ChainProcessor($toolbox);
 
-$chain = new Chain($platform, $llm, inputProcessor: [$toolProcessor], outputProcessor: [$toolProcessor]);
+$chain = new Chain($platform, $model, inputProcessor: [$toolProcessor], outputProcessor: [$toolProcessor]);
 ```
 
 Custom tools can basically be any class, but must configure by the `#[AsTool]` attribute.
@@ -314,7 +314,7 @@ use PhpLlm\LlmChain\Chain\Toolbox\FaultTolerantToolbox;
 $toolbox = new FaultTolerantToolbox($innerToolbox);
 $toolProcessor = new ChainProcessor($toolbox);
 
-$chain = new Chain($platform, $llm, inputProcessor: [$toolProcessor], outputProcessor: [$toolProcessor]);
+$chain = new Chain($platform, $model, inputProcessor: [$toolProcessor], outputProcessor: [$toolProcessor]);
 ```
 
 #### Tool Filtering
@@ -411,7 +411,7 @@ use PhpLlm\LlmChain\Chain\Toolbox\Toolbox;
 $similaritySearch = new SimilaritySearch($embeddings, $store);
 $toolbox = Toolbox::create($similaritySearch);
 $processor = new ChainProcessor($toolbox);
-$chain = new Chain($platform, $llm, [$processor], [$processor]);
+$chain = new Chain($platform, $model, [$processor], [$processor]);
 
 $messages = new MessageBag(
     Message::forSystem(<<<PROMPT
@@ -450,6 +450,7 @@ LLM Chain supports that use-case by abstracting the hustle of defining and provi
 the response back to PHP objects.
 
 To achieve this, a specific chain processor needs to be registered:
+
 ```php
 use PhpLlm\LlmChain\Chain;
 use PhpLlm\LlmChain\Model\Message\Message;
@@ -465,7 +466,7 @@ use Symfony\Component\Serializer\Serializer;
 
 $serializer = new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);
 $processor = new ChainProcessor(new ResponseFormatFactory(), $serializer);
-$chain = new Chain($platform, $llm, [$processor], [$processor]);
+$chain = new Chain($platform, $model, [$processor], [$processor]);
 
 $messages = new MessageBag(
     Message::forSystem('You are a helpful math tutor. Guide the user through the solution step by step.'),
@@ -524,7 +525,7 @@ use PhpLlm\LlmChain\Message\MessageBag;
 
 // Initialize Platform and LLM
 
-$chain = new Chain($llm);
+$chain = new Chain($model);
 $messages = new MessageBag(
     Message::forSystem('You are a thoughtful philosopher.'),
     Message::ofUser('What is the purpose of an ant?'),
@@ -659,7 +660,7 @@ use PhpLlm\LlmChain\Chain;
 
 // Initialize Platform, LLM and processors
 
-$chain = new Chain($platform, $llm, $inputProcessors, $outputProcessors);
+$chain = new Chain($platform, $model, $inputProcessors, $outputProcessors);
 ```
 
 #### InputProcessor

examples/anthropic/chat.php

@@ -16,9 +16,9 @@
 }
 
 $platform = PlatformFactory::create($_ENV['ANTHROPIC_API_KEY']);
-$llm = new Claude(Claude::SONNET_37);
+$model = new Claude(Claude::SONNET_37);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a pirate and you write funny.'),
     Message::ofUser('What is the Symfony framework?'),

examples/anthropic/stream.php

@@ -16,9 +16,9 @@
 }
 
 $platform = PlatformFactory::create($_ENV['ANTHROPIC_API_KEY']);
-$llm = new Claude();
+$model = new Claude();
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a thoughtful philosopher.'),
     Message::ofUser('What is the purpose of an ant?'),

examples/anthropic/toolcall.php

@@ -20,12 +20,12 @@
 }
 
 $platform = PlatformFactory::create($_ENV['ANTHROPIC_API_KEY']);
-$llm = new Claude();
+$model = new Claude();
 
 $wikipedia = new Wikipedia(HttpClient::create());
 $toolbox = Toolbox::create($wikipedia);
 $processor = new ChainProcessor($toolbox);
-$chain = new Chain($platform, $llm, [$processor], [$processor]);
+$chain = new Chain($platform, $model, [$processor], [$processor]);
 
 $messages = new MessageBag(Message::ofUser('Who is the current chancellor of Germany?'));
 $response = $chain->call($messages);

examples/azure/chat-gpt.php

@@ -22,9 +22,9 @@
     $_ENV['AZURE_OPENAI_GPT_API_VERSION'],
     $_ENV['AZURE_OPENAI_KEY'],
 );
-$llm = new GPT(GPT::GPT_4O_MINI);
+$model = new GPT(GPT::GPT_4O_MINI);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a pirate and you write funny.'),
     Message::ofUser('What is the Symfony framework?'),

examples/azure/chat-llama.php

@@ -16,9 +16,9 @@
 }
 
 $platform = PlatformFactory::create($_ENV['AZURE_LLAMA_BASEURL'], $_ENV['AZURE_LLAMA_KEY']);
-$llm = new Llama(Llama::V3_3_70B_INSTRUCT);
+$model = new Llama(Llama::V3_3_70B_INSTRUCT);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(Message::ofUser('I am going to Paris, what should I see?'));
 $response = $chain->call($messages, [
     'max_tokens' => 2048,

examples/bedrock/chat-claude.php

@@ -20,9 +20,9 @@
 $platform = PlatformFactory::create(
     new BedrockRuntimeClient()
 );
-$llm = new Claude();
+$model = new Claude();
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a pirate and you write funny.'),
     Message::ofUser('What is the Symfony framework?'),

examples/bedrock/chat-llama.php

@@ -20,9 +20,9 @@
 $platform = PlatformFactory::create(
     new BedrockRuntimeClient()
 );
-$llm = new Llama('llama-3.2-3b-instruct');
+$model = new Llama('llama-3.2-3b-instruct');
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a pirate and you write funny.'),
     Message::ofUser('What is the Symfony framework?'),

examples/bedrock/chat-nova.php

@@ -20,9 +20,9 @@
 $platform = PlatformFactory::create(
     new BedrockRuntimeClient()
 );
-$llm = new Nova(Nova::PRO);
+$model = new Nova(Nova::PRO);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a pirate and you write funny.'),
     Message::ofUser('What is the Symfony framework?'),

examples/bedrock/image-claude-binary.php

@@ -21,9 +21,9 @@
 $platform = PlatformFactory::create(
     new BedrockRuntimeClient()
 );
-$llm = new Claude();
+$model = new Claude();
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are an image analyzer bot that helps identify the content of images.'),
     Message::ofUser(

examples/bedrock/image-nova.php

@@ -21,9 +21,9 @@
 $platform = PlatformFactory::create(
     new BedrockRuntimeClient()
 );
-$llm = new Nova(Nova::PRO);
+$model = new Nova(Nova::PRO);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are an image analyzer bot that helps identify the content of images.'),
     Message::ofUser(

examples/bedrock/toolcall-claude.php

@@ -24,12 +24,12 @@
 $platform = PlatformFactory::create(
     new BedrockRuntimeClient()
 );
-$llm = new Claude();
+$model = new Claude();
 
 $wikipedia = new Wikipedia(HttpClient::create());
 $toolbox = Toolbox::create($wikipedia);
 $processor = new ChainProcessor($toolbox);
-$chain = new Chain($platform, $llm, [$processor], [$processor]);
+$chain = new Chain($platform, $model, [$processor], [$processor]);
 
 $messages = new MessageBag(Message::ofUser('Who is the current chancellor of Germany?'));
 $response = $chain->call($messages);

examples/chat-system-prompt.php

@@ -17,11 +17,11 @@
 }
 
 $platform = PlatformFactory::create($_ENV['OPENAI_API_KEY']);
-$llm = new GPT(GPT::GPT_4O_MINI);
+$model = new GPT(GPT::GPT_4O_MINI);
 
 $processor = new SystemPromptInputProcessor('You are Yoda and write like he speaks. But short.');
 
-$chain = new Chain($platform, $llm, [$processor]);
+$chain = new Chain($platform, $model, [$processor]);
 $messages = new MessageBag(Message::ofUser('What is the meaning of life?'));
 $response = $chain->call($messages);
 

examples/google/chat.php

@@ -16,9 +16,9 @@
 }
 
 $platform = PlatformFactory::create($_ENV['GOOGLE_API_KEY']);
-$llm = new Gemini(Gemini::GEMINI_2_FLASH);
+$model = new Gemini(Gemini::GEMINI_2_FLASH);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a pirate and you write funny.'),
     Message::ofUser('What is the Symfony framework?'),

examples/google/image-input.php

@@ -17,9 +17,9 @@
 }
 
 $platform = PlatformFactory::create($_ENV['GOOGLE_API_KEY']);
-$llm = new Gemini(Gemini::GEMINI_1_5_FLASH);
+$model = new Gemini(Gemini::GEMINI_1_5_FLASH);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are an image analyzer bot that helps identify the content of images.'),
     Message::ofUser(

examples/google/stream.php

@@ -16,9 +16,9 @@
 }
 
 $platform = PlatformFactory::create($_ENV['GOOGLE_API_KEY']);
-$llm = new Gemini(Gemini::GEMINI_2_FLASH);
+$model = new Gemini(Gemini::GEMINI_2_FLASH);
 
-$chain = new Chain($platform, $llm);
+$chain = new Chain($platform, $model);
 $messages = new MessageBag(
     Message::forSystem('You are a funny clown that entertains people.'),
     Message::ofUser('What is the purpose of an ant?'),

examples/huggingface/_model-listing.php

@@ -1,7 +1,7 @@
 <?php
 
 use PhpLlm\LlmChain\Bridge\HuggingFace\ApiClient;
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;

examples/huggingface/audio-classification.php

@@ -1,9 +1,9 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
 use PhpLlm\LlmChain\Model\Message\Content\Audio;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/automatic-speech-recognition.php

@@ -1,9 +1,9 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
 use PhpLlm\LlmChain\Model\Message\Content\Audio;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/chat-completion.php

@@ -1,10 +1,10 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
 use PhpLlm\LlmChain\Model\Message\Message;
 use PhpLlm\LlmChain\Model\Message\MessageBag;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/feature-extraction.php

@@ -1,8 +1,8 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
+use PhpLlm\LlmChain\Model\Model;
 use PhpLlm\LlmChain\Model\Response\VectorResponse;
 use Symfony\Component\Dotenv\Dotenv;
 

examples/huggingface/fill-mask.php

@@ -1,8 +1,8 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/image-classification.php

@@ -1,9 +1,9 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
 use PhpLlm\LlmChain\Model\Message\Content\Image;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/image-segmentation.php

@@ -1,9 +1,9 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
 use PhpLlm\LlmChain\Model\Message\Content\Image;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/image-to-text.php

@@ -1,9 +1,9 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
 use PhpLlm\LlmChain\Model\Message\Content\Image;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/object-detection.php

@@ -1,9 +1,9 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
 use PhpLlm\LlmChain\Model\Message\Content\Image;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/question-answering.php

@@ -1,8 +1,8 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/sentence-similarity.php

@@ -1,8 +1,8 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';

examples/huggingface/summarization.php

@@ -1,8 +1,8 @@
 <?php
 
-use PhpLlm\LlmChain\Bridge\HuggingFace\Model;
 use PhpLlm\LlmChain\Bridge\HuggingFace\PlatformFactory;
 use PhpLlm\LlmChain\Bridge\HuggingFace\Task;
+use PhpLlm\LlmChain\Model\Model;
 use Symfony\Component\Dotenv\Dotenv;
 
 require_once dirname(__DIR__, 2).'/vendor/autoload.php';