​
Overview

Instructor offers FunctionCall class to extract arguments of a function or method from content.

This is useful when you want to build tool use capability, e.g. for AI chatbots or agents.

​
Example

<?php
$loader = require 'vendor/autoload.php';
$loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');

use Cognesy\Instructor\Extras\FunctionCall\FunctionCall;
use Cognesy\Instructor\Instructor;

class DataStore
{
    /** Save user data to storage */
    public function saveUser(string $name, int $age, string $country) : void {
        // Save user to database
        echo "Saving user ... saveUser('$name', $age, '$country')\n";
    }
}

$text = "His name is Jason, he is 28 years old and he lives in Germany.";
$args = (new Instructor)->respond(
    messages: $text,
    responseModel: FunctionCall::fromMethodName(DataStore::class, 'saveUser'),
);

echo "\nCalling the function with the extracted arguments:\n";
(new DataStore)->saveUser(...$args);

echo "\nExtracted arguments:\n";
dump($args);

assert(count($args) == 3);
expect($args['name'] == 'Jason');
expect($args['age'] == 28);
expect($args['country'] == 'Germany');
?>
Using structured data as an inputStreaming partial updates during inference