Extras
Embeddings
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
Extras
Embeddings
Overview
Embeddings
class offers access to embeddings APIs and convenient methods
to find top K vectors or documents most similar to provided query.
Embeddings
class supports following embeddings providers:
- Azure
- Cohere
- Gemini
- Jina
- Mistral
- OpenAI
Embeddings providers access details can be found and modified via
/config/embed.php
.
Example
<?php
$loader = require 'vendor/autoload.php';
$loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
use Cognesy\Instructor\Extras\Embeddings\Embeddings;
$documents = [
'Computer vision models are used to analyze images and videos.',
'The bakers at the Nashville Bakery baked 200 loaves of bread on Monday morning.',
'The new movie starring Tom Hanks is now playing in theaters.',
'Famous soccer player Lionel Messi has arrived in town.',
'News about the latest iPhone model has been leaked.',
'New car model by Tesla is now available for pre-order.',
'Philip K. Dick is an author of many sci-fi novels.',
];
$query = "technology news";
$connections = [
'azure',
'cohere1',
'gemini',
'jina',
'mistral',
//'ollama',
'openai'
];
foreach($connections as $connection) {
$bestMatches = (new Embeddings)->withConnection($connection)->findSimilar(
query: $query,
documents: $documents,
topK: 3
);
echo "\n[$connection]\n";
dump($bestMatches);
}
?>