Skip to main content

​
Extracting Scalar Values

Sometimes we just want to get quick results without defining a class for the response model, especially if we’re trying to get a straight, simple answer in a form of string, integer, boolean or float. Instructor provides a simplified API for such cases. 
<?php
use Cognesy\Instructor\StructuredOutput;

$value = (new StructuredOutput)
    ->with(
        messages: "His name is Jason, he is 28 years old.",
        responseModel: Scalar::integer('age'),
    )
    ->get();

var_dump($value);
// int(28)
// @doctest id="1871"
In this example, we’re extracting a single integer value from the text. You can also use Scalar::string(), Scalar::boolean() and Scalar::float() to extract other types of values. Additionally, you can use Scalar adapter to extract enums via Scalar::enum().

​
Examples

​
String result

<?php
$value = (new StructuredOutput)
    ->with(
        messages: "His name is Jason, he is 28 years old.",
        responseModel: Scalar::string(name: 'firstName'),
    )
    ->get();
// expect($value)->toBeString();
// expect($value)->toBe("Jason");
// @doctest id="5e17"

​
Integer result

<?php
$value = (new StructuredOutput)
    ->with(
        messages: "His name is Jason, he is 28 years old.",
        responseModel: Scalar::integer('age'),
    )
    ->get();
// expect($value)->toBeInt();
// expect($value)->toBe(28);
// @doctest id="b7fb"

​
Boolean result

<?php
$value = (new StructuredOutput)
    ->with(
        messages: "His name is Jason, he is 28 years old.",
        responseModel: Scalar::boolean(name: 'isAdult'),
    )
    ->get();
// expect($value)->toBeBool();
// expect($value)->toBe(true);
// @doctest id="ab9c"

​
Float result

<?php
$value = (new StructuredOutput)
    ->with(
        messages: "His name is Jason, he is 28 years old and his 100m sprint record is 11.6 seconds.",
        responseModel: Scalar::float(name: 'recordTime'),
    )
    ->get();
// expect($value)->toBeFloat();
// expect($value)->toBe(11.6);
// @doctest id="379c"

​
Enum result / select one of the options

<?php
$text = "His name is Jason, he is 28 years old and he lives in Germany.";
$value = (new StructuredOutput)
    ->with(
        messages: [
            ['role' => 'system', 'content' => $text],
            ['role' => 'user', 'content' => 'What is Jason\'s citizenship?'],
        ],
        responseModel: Scalar::enum(CitizenshipGroup::class, name: 'citizenshipGroup'),
    )->get();
// expect($value)->toBeString();
// expect($value)->toBe('other');
// @doctest id="3bed"
⌘I