Basics
Private vs public object field
Basics
- Basic use
- Basic use via mixin
- Handling errors with `Maybe` helper class
- Modes
- Making some fields optional
- Private vs public object field
- Automatic correction based on validation results
- Using attributes
- Using LLM API connections from config file
- Validation
- Custom validation using Symfony Validator
- Validation across multiple fields
Advanced
- Context caching
- Context caching (Anthropic)
- Customize parameters of OpenAI client
- Custom prompts
- Using structured data as an input
- Extracting arguments of function or method
- Streaming partial updates during inference
- Providing example inputs and outputs
- Extracting scalar values
- Extracting sequences of objects
- Streaming
- Structures
Troubleshooting
LLM API Support
Extras
- Extraction of complex objects
- Extraction of complex objects (Anthropic)
- Extraction of complex objects (Cohere)
- Extraction of complex objects (Gemini)
- Embeddings
- Image processing - car damage detection
- Image to data (OpenAI)
- Image to data (Anthropic)
- Image to data (Gemini)
- Working directly with LLMs
- Working directly with LLMs and JSON - JSON mode
- Working directly with LLMs and JSON - JSON Schema mode
- Working directly with LLMs and JSON - MdJSON mode
- Working directly with LLMs and JSON - Tools mode
- Prompts
- Generating JSON Schema from PHP classes
- Generating JSON Schema dynamically
- Simple content summary
- Create tasks from meeting transcription
- Translating UI text fields
- Web page to PHP objects
Basics
Private vs public object field
Overview
Instructor only sets public fields of the object with the data provided by LLM. Private and protected fields are left unchanged. If you want to access them directly after extraction, consider providing default values for them.
Example
<?php
$loader = require 'vendor/autoload.php';
$loader->add('Cognesy\\Instructor\\', __DIR__.'../../src/');
use Cognesy\Instructor\Instructor;
class User
{
public string $name;
public int $age;
public string $password = '';
public function getAge(): int {
return $this->age;
}
public function getPassword(): string {
return $this->password;
}
}
class UserWithPrivateField
{
public string $name;
private int $age = 0;
private string $password = '';
public function getAge(): int {
return $this->age;
}
public function getPassword(): string {
return $this->password;
}
}
$text = <<<TEXT
Jason is 25 years old. His password is '123admin'.
TEXT;
// CASE 1: Class with public fields
$user = (new Instructor)->respond(
messages: $text,
responseModel: User::class
);
echo "User with public fields\n";
dump($user);
assert($user->name === "Jason");
assert($user->getAge() === 25);
assert($user->getPassword() === '123admin');
// CASE 2: Class with some private fields
$userPriv = (new Instructor)->respond(
messages: $text,
responseModel: UserWithPrivateField::class,
);
echo "User with private 'password' and 'age' fields\n";
dump($userPriv);
assert($userPriv->name === "Jason");
assert($userPriv->getAge() === 0);
assert($userPriv->getPassword() === '');
?>