Instructor for PHP

Structured data processing in PHP, powered by LLMs. Designed for simplicity, transparency, and control.

Introduction

Start processing your data with LLMs in under 5 minutes

Quickstart

Set up Instructor in your project and start processing data with LLMs

Setup

Learn how to upgrade your Instructor installation.

Upgrading Instructor

Command line tools included with Instructor

CLI Tools

Why use Instructor?

Managing and rendering prompts in Instructor

Prompt Templates

Response model defines the structure of results returned by LLM.

Response Models

Configure your environment for Instructor

Environment

How to set up location of Instructor configuration directory for your project

Configuration Path

Instructor supports a number of LLM API providers.

LLM API Providers

Polyglot is a PHP library that provides a unified API to access various LLM API providers.

Overview

Start working with LLMs in under 5 minutes

Overview of Inference

Learn how to create requests to LLM providers using Polyglot.

Creating Requests

Learn how to handle responses from Polyglot.

Response Handling

How to use the Inference class in Polyglot for LLM requests

Inference Class

Learn how to customize request options for LLM inference in Polyglot.

Request Options

Learn how to work with streaming responses in Polyglot.

Overview of Streaming

How to use advanced stream processing features in Polyglot

Advanced Stream Processing

Embeddings are a way to represent data (text, images, audio) in a continuous vector space.

Overview of Embeddings

Learn how to work with vector embeddings in Polyglot.

Working with Embeddings

Learn how to work with different output modes in Polyglot.

Overview of Output Modes

Learn how to use text mode in Polyglot for LLM responses.

Text Mode

Learn how to use JSON mode in Polyglot for structured LLM responses.

JSON Mode

Learn how to use JSON Schema mode in Polyglot for structured and validated LLM responses.

JSON Schema Mode

Learn how to use Markdown JSON mode in Polyglot for structured LLM responses.

MdJSON Mode

Learn how to use tools mode in Polyglot for LLM function calling.

Tools Mode

Learn how to use JSON Schemas to generate structured outputs using LLMs.

Structured outputs with JsonSchema class

Context Caching

How to manage LLM connection presets in Polyglot

Preset Management

Learn how to configure different LLM providers and models in Polyglot.

Configuration Deep Dive

Learn how to use custom HTTP clients in Polyglot.

Customizing HTTP Client

Learn how to extend Polyglot with custom providers and middleware.

Extending Polyglot

Learn how to troubleshoot issues with Polyglot.

Overview of Troubleshooting

Learn how to troubleshoot authentication errors when using Polyglot.

Authentication

Learn how to troubleshoot connection issues when using Polyglot.

Connection Issues

Learn how to troubleshoot streaming issues when using Polyglot.

Streaming

Learn how to handle rate limiting issues when using Polyglot.

Rate Limits

Learn how to troubleshoot model-specific issues when using Polyglot.

Model-Specific Issues

Learn how to troubleshoot provider-specific issues when using Polyglot.

Provider-Specific Issues

How to troubleshoot provider configurations in Polyglot

Connection Configurations

Debugging LLM interactions is essential for troubleshooting and optimizing your applications.

Debugging Requests and Responses

A detailed look at Polyglot's internal architecture

Overview of Architecture

Explore the public API layer of Polyglot, including the Inference and Embeddings classes.

Public API Layer

Learn about the request and response objects used in Polyglot.

Request and Response Objects

Learn about the internal request/response lifecycle in Polyglot.

Request/Response Lifecycle

Learn about the provider abstraction layer in Polyglot.

Provider Abstraction Layer

Learn about the adapters used in Polyglot for LLM providers.

Adapters

Understanding the HTTP client layer in Polyglot

HTTP Client Layer

Understanding the configuration layer of Polyglot for LLM and Embeddings.

Configuration Layer

Learn about the events system in Polyglot.

Events System

Instructor HTTP client layer - framework agnostic, middleware support, and streaming capabilities.

Learn how to use the Instructor HTTP client API in your PHP project.

Getting Started

Learn how to create and send HTTP requests using the Instructor HTTP client API.

Making HTTP Requests

Learn how to handle HTTP responses using the Instructor HTTP client API.

Handling Responses

Learn how to handle streaming responses using the Instructor HTTP client API.

Streaming Responses

Learn how to switch between different HTTP client implementations using the Instructor HTTP client API.

Changing the Underlying Client

Learn how to configure different HTTP clients using the Instructor HTTP client API.

Customizing Client Configuration

Learn how to create and use custom HTTP client drivers.

Using Custom HTTP Clients

Learn how to use middleware in the Instructor HTTP client API.

Middleware

Learn how to use middleware to process HTTP requests and responses using the Instructor HTTP client API.

Custom Processing with Middleware

Learn how to troubleshoot issues with the Instructor HTTP client API.

Troubleshooting

Running and viewing cookbooks with Instructor Hub tool

Release Notes

V0.17.12