Weave Code
Weaver
Helps Laravel developers discover, compare, and choose open-source packages. See popularity, security, maintainers, and scores at a glance to make better decisions.
Feedback
Share your thoughts, report bugs, or suggest improvements.
Subject
Message
developing-with-prism
particle-academy/prism
claude-code
prism
llm-integration
structured-output
streaming
tool-calling
multi-modal
providers

Guide for developing with Prism PHP package - a Laravel package for integrating LLMs. Activate or use when working with Prism features including text generation, structured output, embeddings, image generation, audio processing, streaming, tools/function calling, or any LLM provider integration (OpenAI, Anthropic, Gemini, Mistral, Groq, XAI, DeepSeek, OpenRouter, Ollama, VoyageAI, ElevenLabs). Activate for any Prism-related development tasks.

Install
php artisan boost:add-skill particle-academy/prism

Save this content to: .claude/skills/developing-with-prism/SKILL.md

# Developing with Prism

Prism is a Laravel package for integrating Large Language Models (LLMs) into applications with a fluent, expressive and eloquent API.

## Basic Usage Examples

### Text Generation

```php
use Prism\Prism\Facades\Prism;
use Prism\Prism\Enums\Provider;

$response = Prism::text()
    ->using(Provider::Anthropic, 'claude-sonnet-5-5')
    ->withSystemPrompt('You are an expert mathematician.')
    ->withPrompt('Explain the Pythagorean theorem.')
    ->asText();

echo $response->text;
```

### Structured Output

```php
use Prism\Prism\Facades\Prism;
use Prism\Prism\Enums\Provider;
use Prism\Prism\Schema\ObjectSchema;
use Prism\Prism\Schema\StringSchema;

$schema = new ObjectSchema(
    name: 'movie_review',
    description: 'A structured movie review',
    properties: [
        new StringSchema('title', 'The movie title'),
        new StringSchema('rating', 'Rating out of 5 stars'),
        new StringSchema('summary', 'Brief review summary')
    ],
    requiredFields: ['title', 'rating', 'summary']
);

$response = Prism::structured()
    ->using(Provider::OpenAI, 'gpt-6.1-sol')
    ->withSchema($schema)
    ->withPrompt('Review the movie Inception')
    ->asStructured();

$review = $response->structured;
echo $review['title'];
```

### Streaming (Server-Sent Events)

```php
Route::get('/chat', function () {
    return Prism::text()
        ->using('anthropic', 'claude-sonnet-5-5')
        ->withPrompt(request('message'))
        ->asEventStreamResponse();
});
```

### Tools / Function Calling

```php
use Prism\Prism\Facades\Prism;
use Prism\Prism\Facades\Tool;

$weatherTool = Tool::as('get_weather')
    ->for('Get current weather for a location')
    ->withStringParameter('location', 'The city and state')
    ->using(fn (string $location): string =>
        "Weather in {$location}: 72F, sunny"
    );

$response = Prism::text()
    ->using('anthropic', 'claude-sonnet-5-5')
    ->withTools([$weatherTool])
    ->withMaxSteps(3)
    ->withPrompt('What is the weather in San Francisco?')
    ->asText();
```

### Multi-Modal (Images/Documents)

```php
use Prism\Prism\ValueObjects\Media\Image;
use Prism\Prism\ValueObjects\Media\Document;

$response = Prism::text()
    ->using(Provider::Anthropic, 'claude-sonnet-5-5')
    ->withPrompt(
        'What objects do you see in this image?',
        [Image::fromLocalPath('/path/to/image.jpg')]
    )
    ->asText();
```

## Prism Documentation

**IMPORTANT:** Always search the docs before implementing Prism features.

### How to Search

1. **Read a specific doc file directly:**
   ```
   read vendor/prism-php/prism/docs/core-concepts/text-generation.md
   read vendor/prism-php/prism/docs/providers/openai.md
   ```

2. **Search for a topic across docs:**
   ```
   grep "streaming" vendor/prism-php/prism/docs/
   grep "withProviderOptions" vendor/prism-php/prism/docs/providers/
   ```

3. **Find all doc files:**
   ```
   glob "vendor/prism-php/prism/docs/**/*.md"
   ```

### Documentation Paths

| Need | Read This File |
|------|----------------|
| Text generation | `docs/core-concepts/text-generation.md` |
| Streaming responses | `docs/core-concepts/streaming-output.md` |
| Tools / function calling | `docs/core-concepts/tools-function-calling.md` |
| Structured JSON output | `docs/core-concepts/structured-output.md` |
| Embeddings | `docs/core-concepts/embeddings.md` |
| Image generation | `docs/core-concepts/image-generation.md` |
| Audio (TTS/STT) | `docs/core-concepts/audio.md` |
| Schema definitions | `docs/core-concepts/schemas.md` |
| Testing | `docs/core-concepts/testing.md` |
| Image input | `docs/input-modalities/images.md` |
| Document input (PDF) | `docs/input-modalities/documents.md` |
| OpenAI options | `docs/providers/openai.md` |
| Anthropic options | `docs/providers/anthropic.md` |
| Other providers | `docs/providers/{provider}.md` |
| Error handling | `docs/advanced/error-handling.md` |

### Source Code Reference

For implementation details:
```
glob "src/**/*.php"
grep "class Tool" src/
```

## Key Patterns

- Use `Prism\Prism\Facades\Prism` facade or `prism()` helper
- Core methods: `Prism::text()`, `Prism::structured()`, `Prism::embeddings()`, `Prism::image()`, `Prism::audio()`
- Chain `->using(Provider::Name, 'model-id')` to specify provider/model
- Finalize with: `->asText()`, `->asStructured()`, `->asStream()`, `->asEventStreamResponse()`, `->asDataStreamResponse()`

## Provider-Specific Options

Use `->withProviderOptions([...])` to pass provider-specific features:

```php
$response = Prism::text()
    ->using('anthropic', 'claude-opus-5-5')
    ->withPrompt('Your prompt')
    ->withProviderOptions([  // Anthropic-specific
        'thinking' => ['type' => 'adaptive'],
        'effort' => 'high',
    ])
    ->asText();
```

**Always search the provider docs first** to find available options for each provider:
- `docs/providers/openai.md` - strict mode, reasoning, image generation options
- `docs/providers/anthropic.md` - thinking mode, prompt caching, citations
- `docs/providers/gemini.md`, `docs/providers/mistral.md`, etc.

## Common Pitfalls

### Continuing Conversations

Pass `$response->messages` back with `withMessages()` to continue a conversation, and persist each message's `additionalContent` when storing it. Rebuilding `AssistantMessage`s from `$response->text` drops the thinking blocks and reasoning items that current Claude and OpenAI models expect back. For streamed responses, build the messages with `StreamedMessages::fromEvents($events)` inside the streaming callback. See `docs/core-concepts/text-generation.md` and `docs/core-concepts/streaming-output.md`.

### Check the Finish Reason

Refusals return a normal response with `FinishReason::Refusal` rather than throwing, and structured output is empty in that case. Check `$response->finishReason` before using `$response->text` or `$response->structured`.

### Current Model Parameters

- Claude 5.x models reject `['thinking' => ['enabled' => true, 'budgetTokens' => ...]]`. Use `['thinking' => ['type' => 'adaptive']]` with `effort`.
- Claude 5.x and GPT-6.x / GPT-5.5+ reject non-default `temperature` and `top_p` (OpenAI accepts them only with reasoning effort `none`). Don't call `usingTemperature()` / `usingTopP()` for these models.
- For Anthropic structured output on Claude Opus 5.5, Sonnet 5.5 and Fable 5.1, keep the default native mode; `use_tool_calling` forces a tool choice those models reject.

### Wrong Package Name

**NEVER use the old package:** `echolabsdev/prism` is deprecated.

**ALWAYS use:** `prism-php/prism`

```bash
# Correct
composer require prism-php/prism
```

<!-- factcheck-ignore-next: Deliberate deprecated package counter-example. -->
```bash
# Wrong - do not use
composer require echolabsdev/prism
```

### Wrong Namespace

**ALWAYS use the `Prism\Prism` namespace** for all Prism classes:

```php
// Correct
use Prism\Prism\Facades\Prism;
use Prism\Prism\Enums\Provider;
use Prism\Prism\Tool;
use Prism\Prism\Schema\ObjectSchema;
```

<!-- factcheck-ignore-next: Deliberate nonexistent namespace counter-examples. -->
```php
// Wrong - these namespaces do not exist
use EchoLabs\Prism\Prism;
use Prism\Facades\Prism;
```

### Decision Workflow

When working with Prism, follow this pattern:

1. Determine what you need:

**Text generation?** → Use `Prism::text()`
   **Structured JSON output?** → Use `Prism::structured()`
   **Embeddings?** → Use `Prism::embeddings()`
   **Image generation?** → Use `Prism::image()`
   **Audio (TTS/STT)?** → Use `Prism::audio()`

2. Always read the relevant docs first before implementing.

## Related Packages

- **Prism Relay** - MCP tools integration for Prism. See `references/relay.md`
- **Prism Bedrock** - AWS Bedrock provider: https://github.com/prism-php/bedrock

Developing with Prism

Prism is a Laravel package for integrating Large Language Models (LLMs) into applications with a fluent, expressive and eloquent API.

Basic Usage Examples

Text Generation

use Prism\Prism\Facades\Prism;
use Prism\Prism\Enums\Provider;

$response = Prism::text()
    ->using(Provider::Anthropic, 'claude-sonnet-5-5')
    ->withSystemPrompt('You are an expert mathematician.')
    ->withPrompt('Explain the Pythagorean theorem.')
    ->asText();

echo $response->text;

Structured Output

use Prism\Prism\Facades\Prism;
use Prism\Prism\Enums\Provider;
use Prism\Prism\Schema\ObjectSchema;
use Prism\Prism\Schema\StringSchema;

$schema = new ObjectSchema(
    name: 'movie_review',
    description: 'A structured movie review',
    properties: [
        new StringSchema('title', 'The movie title'),
        new StringSchema('rating', 'Rating out of 5 stars'),
        new StringSchema('summary', 'Brief review summary')
    ],
    requiredFields: ['title', 'rating', 'summary']
);

$response = Prism::structured()
    ->using(Provider::OpenAI, 'gpt-6.1-sol')
    ->withSchema($schema)
    ->withPrompt('Review the movie Inception')
    ->asStructured();

$review = $response->structured;
echo $review['title'];

Streaming (Server-Sent Events)

Route::get('/chat', function () {
    return Prism::text()
        ->using('anthropic', 'claude-sonnet-5-5')
        ->withPrompt(request('message'))
        ->asEventStreamResponse();
});

Tools / Function Calling

use Prism\Prism\Facades\Prism;
use Prism\Prism\Facades\Tool;

$weatherTool = Tool::as('get_weather')
    ->for('Get current weather for a location')
    ->withStringParameter('location', 'The city and state')
    ->using(fn (string $location): string =>
        "Weather in {$location}: 72F, sunny"
    );

$response = Prism::text()
    ->using('anthropic', 'claude-sonnet-5-5')
    ->withTools([$weatherTool])
    ->withMaxSteps(3)
    ->withPrompt('What is the weather in San Francisco?')
    ->asText();

Multi-Modal (Images/Documents)

use Prism\Prism\ValueObjects\Media\Image;
use Prism\Prism\ValueObjects\Media\Document;

$response = Prism::text()
    ->using(Provider::Anthropic, 'claude-sonnet-5-5')
    ->withPrompt(
        'What objects do you see in this image?',
        [Image::fromLocalPath('/path/to/image.jpg')]
    )
    ->asText();

Prism Documentation

IMPORTANT: Always search the docs before implementing Prism features.

How to Search

  1. Read a specific doc file directly:

    read vendor/prism-php/prism/docs/core-concepts/text-generation.md
    read vendor/prism-php/prism/docs/providers/openai.md
    
  2. Search for a topic across docs:

    grep "streaming" vendor/prism-php/prism/docs/
    grep "withProviderOptions" vendor/prism-php/prism/docs/providers/
    
  3. Find all doc files:

    glob "vendor/prism-php/prism/docs/**/*.md"
    

Documentation Paths

Need Read This File
Text generation docs/core-concepts/text-generation.md
Streaming responses docs/core-concepts/streaming-output.md
Tools / function calling docs/core-concepts/tools-function-calling.md
Structured JSON output docs/core-concepts/structured-output.md
Embeddings docs/core-concepts/embeddings.md
Image generation docs/core-concepts/image-generation.md
Audio (TTS/STT) docs/core-concepts/audio.md
Schema definitions docs/core-concepts/schemas.md
Testing docs/core-concepts/testing.md
Image input docs/input-modalities/images.md
Document input (PDF) docs/input-modalities/documents.md
OpenAI options docs/providers/openai.md
Anthropic options docs/providers/anthropic.md
Other providers docs/providers/{provider}.md
Error handling docs/advanced/error-handling.md

Source Code Reference

For implementation details:

glob "src/**/*.php"
grep "class Tool" src/

Key Patterns

  • Use Prism\Prism\Facades\Prism facade or prism() helper
  • Core methods: Prism::text(), Prism::structured(), Prism::embeddings(), Prism::image(), Prism::audio()
  • Chain ->using(Provider::Name, 'model-id') to specify provider/model
  • Finalize with: ->asText(), ->asStructured(), ->asStream(), ->asEventStreamResponse(), ->asDataStreamResponse()

Provider-Specific Options

Use ->withProviderOptions([...]) to pass provider-specific features:

$response = Prism::text()
    ->using('anthropic', 'claude-opus-5-5')
    ->withPrompt('Your prompt')
    ->withProviderOptions([  // Anthropic-specific
        'thinking' => ['type' => 'adaptive'],
        'effort' => 'high',
    ])
    ->asText();

Always search the provider docs first to find available options for each provider:

  • docs/providers/openai.md - strict mode, reasoning, image generation options
  • docs/providers/anthropic.md - thinking mode, prompt caching, citations
  • docs/providers/gemini.md, docs/providers/mistral.md, etc.

Common Pitfalls

Continuing Conversations

Pass $response->messages back with withMessages() to continue a conversation, and persist each message's additionalContent when storing it. Rebuilding AssistantMessages from $response->text drops the thinking blocks and reasoning items that current Claude and OpenAI models expect back. For streamed responses, build the messages with StreamedMessages::fromEvents($events) inside the streaming callback. See docs/core-concepts/text-generation.md and docs/core-concepts/streaming-output.md.

Check the Finish Reason

Refusals return a normal response with FinishReason::Refusal rather than throwing, and structured output is empty in that case. Check $response->finishReason before using $response->text or $response->structured.

Current Model Parameters

  • Claude 5.x models reject ['thinking' => ['enabled' => true, 'budgetTokens' => ...]]. Use ['thinking' => ['type' => 'adaptive']] with effort.
  • Claude 5.x and GPT-6.x / GPT-5.5+ reject non-default temperature and top_p (OpenAI accepts them only with reasoning effort none). Don't call usingTemperature() / usingTopP() for these models.
  • For Anthropic structured output on Claude Opus 5.5, Sonnet 5.5 and Fable 5.1, keep the default native mode; use_tool_calling forces a tool choice those models reject.

Wrong Package Name

NEVER use the old package: echolabsdev/prism is deprecated.

ALWAYS use: prism-php/prism

# Correct
composer require prism-php/prism
# Wrong - do not use
composer require echolabsdev/prism

Wrong Namespace

ALWAYS use the Prism\Prism namespace for all Prism classes:

// Correct
use Prism\Prism\Facades\Prism;
use Prism\Prism\Enums\Provider;
use Prism\Prism\Tool;
use Prism\Prism\Schema\ObjectSchema;
// Wrong - these namespaces do not exist
use EchoLabs\Prism\Prism;
use Prism\Facades\Prism;

Decision Workflow

When working with Prism, follow this pattern:

  1. Determine what you need:

Text generation? → Use Prism::text() Structured JSON output? → Use Prism::structured() Embeddings? → Use Prism::embeddings() Image generation? → Use Prism::image() Audio (TTS/STT)? → Use Prism::audio()

  1. Always read the relevant docs first before implementing.

Related Packages

Weaver

How can I help you explore Laravel packages today?

Conversation history is not saved when not logged in.
Prompt
Add packages to context
No packages found.
uni-method/symfony-lib
tacticmedia/scim-server-bundle
neika-ai/symfony-bundle
mattleads/agent-publishing-bundle
glavweb/framework-bundle
glavweb/extra-bundle
glavweb/api-bundle
glavweb/admin-bundle
adachsoft/api-version-bundle
elsayed85/laravel-api-exceptions
ouhssini/laravel-demo-mode
daworks/ncloud-outbound-mailer-driver
gp247/cms
ignibyte/aic-gates
nexa-merchant/blog
novasa/laravel-language-center
opencage/geocode
adolfoholzer/parameters
livenetworks/ln-starter
shitoudev/permissionmanager