Output formats

By default, Instructor deserializes LLM responses into PHP objects based on your response model class. The Output Format API lets you change this behavior while keeping the same schema definition. This decouples schema specification (what structure the LLM should produce) from output format (how you receive the result).

use Cognesy\Instructor\StructuredOutput;

// Schema from User class, output as object (default)
$user = (new StructuredOutput)
    ->with(messages: $text, responseModel: User::class)
    ->get();

// Same schema, output as array
$data = (new StructuredOutput)
    ->withResponseClass(User::class)
    ->intoArray()
    ->withMessages($text)
    ->get();
// @doctest id="c758"

Available Output Formats

intoArray()

Returns extracted data as a plain associative array instead of an object.

$data = (new StructuredOutput)
    ->withResponseClass(User::class)
    ->intoArray()
    ->with(messages: 'Extract: John Doe, 30 years old')
    ->get();

// Result: ['name' => 'John Doe', 'age' => 30]
// @doctest id="e152"

This is useful for database insertion, JSON API responses, array manipulation, or when integrating with code that expects arrays.

// Store directly in database
DB::table('users')->insert($data);

// Or return as JSON API response
return response()->json($data);
// @doctest id="21f9"

intoInstanceOf()

Uses one class for the schema definition and a different class for the output object.

class UserProfile {
    public string $fullName;
    public int $age;
    public string $email;
    public string $phoneNumber;
    public string $address;
}

class UserDTO {
    public function __construct(
        public string $fullName = '',
        public string $email = '',
    ) {}
}

$user = (new StructuredOutput)
    ->withResponseClass(UserProfile::class)
    ->intoInstanceOf(UserDTO::class)
    ->with(messages: 'Extract: John Smith, 30, john@example.com, 555-1234, 123 Main St')
    ->get();

// $user is UserDTO with only fullName and email populated
// @doctest id="1a5b"

The LLM still sees all five fields from UserProfile, ensuring thorough extraction. The output is then hydrated into the simpler UserDTO. This is valuable when you want to separate API contracts from internal models, simplify complex extraction results, or decouple domain models from presentation layers.

intoObject()

Provides a custom object that controls its own deserialization from the extracted array. The object must implement the CanDeserializeSelf interface.

use Cognesy\Instructor\Deserialization\Contracts\CanDeserializeSelf;

class Money implements CanDeserializeSelf
{
    public function __construct(
        private int $amountInCents = 0,
        private string $currency = 'USD',
    ) {}

    public function fromArray(array $data): static {
        return new self(
            amountInCents: (int)(($data['amount'] ?? 0) * 100),
            currency: strtoupper($data['currency'] ?? 'USD'),
        );
    }
}

$price = (new StructuredOutput)
    ->withResponseClass(Product::class)
    ->intoObject(new Money())
    ->with(messages: 'Extract price: $19.99 USD')
    ->get();
// @doctest id="9a9c"

This is particularly useful with the built-in Scalar adapter for extracting single values.

use Cognesy\Instructor\Extras\Scalar\Scalar;

$rating = (new StructuredOutput)
    ->with(
        messages: 'Rate this review: "Absolutely fantastic product!"',
        responseModel: Scalar::integer(
            name: 'rating',
            description: 'Rating from 1 to 5',
        ),
    )
    ->get();

// Result: 5 (integer)
// @doctest id="daa9"

Streaming with Output Formats

Output formats work seamlessly with streaming. During streaming, partial updates are always returned as objects (for validation and deduplication). The final result respects the output format you specified.

$stream = (new StructuredOutput)
    ->withResponseClass(Article::class)
    ->intoArray()
    ->with(messages: 'Extract article data')
    ->stream();

foreach ($stream->partials() as $partial) {
    // $partial is an Article object during streaming
}

$finalArticle = $stream->finalValue();
// Returns: ['title' => '...', 'author' => '...', 'content' => '...']
// @doctest id="c2d4"

Comparison

Feature	Default (Object)	intoArray()	intoInstanceOf()	intoObject()
Output type	Schema class	Array	Target class	Custom object
Validation	Yes	Skipped	Yes	Custom
Streaming partials	Object	Object	Object	Object
Streaming final	Object	Array	Target class	Custom object

Common Patterns

Conditional Deserialization

Inspect data before choosing the target class.

$data = (new StructuredOutput)
    ->withResponseClass(User::class)
    ->intoArray()
    ->with(messages: 'Extract user')
    ->get();

$user = $data['age'] < 18
    ? new MinorUser(...$data)
    : new AdultUser(...$data);
// @doctest id="354a"

Multi-Layer Architecture

Use a rich domain model for extraction and a simplified DTO for your application layer.

class OrderDomain {
    public string $orderId;
    public CustomerInfo $customer;
    public array $items;
    public PaymentDetails $payment;
}

class OrderDTO {
    public function __construct(
        public string $orderId,
        public string $customerName,
        public float $total,
    ) {}
}

$order = (new StructuredOutput)
    ->withResponseClass(OrderDomain::class)
    ->intoInstanceOf(OrderDTO::class)
    ->with(messages: 'Extract order details')
    ->get();
// @doctest id="e4e3"

Pluggable Extraction

Instructor uses a pluggable extraction pipeline to convert raw LLM responses into canonical arrays. You can customize this pipeline on the StructuredOutputRuntime to support non-standard response formats. See JSON Extraction for details on the extraction pipeline and how to write custom extractors.

Packages

Instructor

Polyglot

Agents

Agent-ctrl

Telemetry

Sandbox

HTTP Client

Laravel

Symfony

Xprompt

Available Output Formats

intoArray()

intoInstanceOf()

intoObject()

Streaming with Output Formats

Comparison

Common Patterns

Conditional Deserialization

Multi-Layer Architecture

Pluggable Extraction

​Available Output Formats

​intoArray()

​intoInstanceOf()

​intoObject()

​Streaming with Output Formats

​Comparison

​Common Patterns

​Conditional Deserialization

​Multi-Layer Architecture

​Pluggable Extraction

Available Output Formats

intoArray()

intoInstanceOf()

intoObject()

Streaming with Output Formats

Comparison

Common Patterns

Conditional Deserialization

Multi-Layer Architecture

Pluggable Extraction