Skip to content

[Platform] Ollama structured output support #304

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions examples/ollama/structured-output-math.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

use Symfony\AI\Agent\Agent;
use Symfony\AI\Agent\StructuredOutput\AgentProcessor;
use Symfony\AI\Fixtures\StructuredOutput\MathReasoning;
use Symfony\AI\Platform\Bridge\Ollama\Ollama;
use Symfony\AI\Platform\Bridge\Ollama\PlatformFactory;
use Symfony\AI\Platform\Message\Message;
use Symfony\AI\Platform\Message\MessageBag;

require_once dirname(__DIR__).'/bootstrap.php';

$platform = PlatformFactory::create(env('OLLAMA_HOST_URL'), http_client());
$model = new Ollama();

$processor = new AgentProcessor();
$agent = new Agent($platform, $model, [$processor], [$processor], logger());
$messages = new MessageBag(
Message::forSystem('You are a helpful math tutor. Guide the user through the solution step by step.'),
Message::ofUser('how can I solve 8x + 7 = -23'),
);
$result = $agent->call($messages, ['output_structure' => MathReasoning::class]);

dump($result->getContent());
1 change: 1 addition & 0 deletions src/platform/src/Bridge/Ollama/Ollama.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ class Ollama extends Model
'/./' => [
Capability::INPUT_MESSAGES,
Capability::OUTPUT_TEXT,
Capability::OUTPUT_STRUCTURED,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it valid just to assume all models support that?

],
'/^llama\D*3(\D*\d+)/' => [
Capability::TOOL_CALLING,
Expand Down
31 changes: 18 additions & 13 deletions src/platform/src/Bridge/Ollama/OllamaClient.php
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for changing the methods order? Is it because one is public? I think it shouldn't be public - could you fix that please while you're at it? 🙏

Original file line number Diff line number Diff line change
Expand Up @@ -58,28 +58,33 @@ public function request(Model $model, array|string $payload, array $options = []
* @param array<string|int, mixed> $payload
* @param array<string, mixed> $options
*/
private function doCompletionRequest(array|string $payload, array $options = []): RawHttpResult
public function doEmbeddingsRequest(Model $model, array|string $payload, array $options = []): RawHttpResult
{
// Revert Ollama's default streaming behavior
$options['stream'] ??= false;

return new RawHttpResult($this->httpClient->request('POST', \sprintf('%s/api/chat', $this->hostUrl), [
'headers' => ['Content-Type' => 'application/json'],
'json' => array_merge($options, $payload),
return new RawHttpResult($this->httpClient->request('POST', \sprintf('%s/api/embed', $this->hostUrl), [
'json' => array_merge($options, [
'model' => $model->getName(),
'input' => $payload,
]),
]));
}

/**
* @param array<string|int, mixed> $payload
* @param array<string, mixed> $options
*/
public function doEmbeddingsRequest(Model $model, array|string $payload, array $options = []): RawHttpResult
private function doCompletionRequest(array|string $payload, array $options = []): RawHttpResult
{
return new RawHttpResult($this->httpClient->request('POST', \sprintf('%s/api/embed', $this->hostUrl), [
'json' => array_merge($options, [
'model' => $model->getName(),
'input' => $payload,
]),
// Revert Ollama's default streaming behavior
$options['stream'] ??= false;

if (\array_key_exists('response_format', $options) && \array_key_exists('json_schema', $options['response_format'])) {
$options['format'] = $options['response_format']['json_schema']['schema'];
unset($options['response_format']);
}

return new RawHttpResult($this->httpClient->request('POST', \sprintf('%s/api/chat', $this->hostUrl), [
'headers' => ['Content-Type' => 'application/json'],
'json' => array_merge($options, $payload),
]));
}
}
90 changes: 90 additions & 0 deletions src/platform/tests/Bridge/Ollama/OllamaClientTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Bridge\Ollama;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be

Suggested change
namespace Bridge\Ollama;
namespace Symfony\AI\Platform\Tests\Bridge\Ollama;


use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\UsesClass;
use PHPUnit\Framework\TestCase;
use Symfony\AI\Platform\Bridge\Ollama\Ollama;
use Symfony\AI\Platform\Bridge\Ollama\OllamaClient;
use Symfony\AI\Platform\Model;
use Symfony\Component\HttpClient\MockHttpClient;
use Symfony\Component\HttpClient\Response\JsonMockResponse;

#[CoversClass(OllamaClient::class)]
#[UsesClass(Ollama::class)]
#[UsesClass(Model::class)]
final class OllamaClientTest extends TestCase
{
public function testSupportsModel()
{
$client = new OllamaClient(new MockHttpClient(), 'http://localhost:1234');

$this->assertTrue($client->supports(new Ollama()));
$this->assertFalse($client->supports(new Model('any-model')));
}

public function testOutputStructureIsSupported()
{
$httpClient = new MockHttpClient([
new JsonMockResponse([
'capabilities' => ['completion', 'tools'],
]),
new JsonMockResponse([
'model' => 'foo',
'response' => [
'age' => 22,
'available' => true,
],
'done' => true,
]),
], 'http://127.0.0.1:1234');

$client = new OllamaClient($httpClient, 'http://127.0.0.1:1234');
$response = $client->request(new Ollama(), [
'messages' => [
[
'role' => 'user',
'content' => 'Ollama is 22 years old and is busy saving the world. Respond using JSON',
],
],
'model' => 'llama3.2',
], [
'response_format' => [
'type' => 'json_schema',
'json_schema' => [
'name' => 'clock',
'strict' => true,
'schema' => [
'type' => 'object',
'properties' => [
'age' => ['type' => 'integer'],
'available' => ['type' => 'boolean'],
],
'required' => ['age', 'available'],
'additionalProperties' => false,
],
],
],
]);

$this->assertSame(2, $httpClient->getRequestsCount());
$this->assertSame([
'model' => 'foo',
'response' => [
'age' => 22,
'available' => true,
],
'done' => true,
], $response->getData());
}
}