class DeepSeekGateway implements StepTextGateway

Traits

Methods

string|null
composeInstructions(string|null $instructions, array|null $schema)

Add structured output requirements to the instructions.

array
buildStepBody(Provider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options, StepContext $stepContext)

Build the request body for the current text generation step.

array
buildTextRequestBody(Provider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options)

Build the request body for the Chat Completions API.

array
buildResponseFormat()

Build the response format options for structured output.

createClient(string $baseUrl, array $headers = [], array $configuredHeaders = [], int|null $timeout = 60, bool $throw = true)

Create an HTTP client with the provider's request options.

string
httpConnection(Provider $provider)

Select a boot-registered connection without retaining dynamic provider names.

client(Provider $provider, int|null $timeout = null)

Get an HTTP client for the DeepSeek API.

string
baseUrl(Provider $provider)

Get the base URL for the DeepSeek API.

processTextStream(string $invocationId, Provider $provider, string $model, StreamInterface $streamBody)

Process a Chat Completions streaming response and yield Hypervel stream events.

array
mapStreamToolCalls(array $toolCalls)

Map raw streaming tool call data to ToolCall DTOs.

string
generateEventId()

Generate a lowercase UUID v7 for use as a stream event ID.

array
mapAttachments(Collection $attachments)

Map the given Hypervel attachments to Chat Completions content parts.

bool
isImage(UploadedFile $attachment)

Determine if the given uploaded file is an image.

array
mapMessagesToChat(array $messages, string|null $instructions = null)

Map the given Hypervel messages to Chat Completions messages format.

void
mapUserMessage(UserMessage|Message $message, array $chatMessages)

Map a user message to Chat Completions format.

void
mapAssistantMessage(AssistantMessage|Message $message, array $chatMessages)

Map an assistant message to Chat Completions format.

void
mapToolResultMessage(ToolResultMessage|Message $message, array $chatMessages)

Map a tool result message to Chat Completions format.

array
serializeToolCallToChat(ToolCall $toolCall)

Serialize a tool call DTO to Chat Completions array format.

array
decodeStructuredOutput(string|null $text)

Decode a structured output payload, tolerating markdown code fences.

void
validateTextResponse(array $data)

Validate the DeepSeek response data.

parseTextResponse(array $data, Provider $provider, bool $structured)

Parse the DeepSeek response data into a single step response.

extractUsage(array $data)

Extract usage data from the response.

FinishReason
extractFinishReason(array $choice)

Extract and map the finish reason from the response.

mixed
withErrorHandling(string $providerName, Closure $callback)

Execute a callback with failoverable error handling.

int|null
retryAfterSeconds(Throwable $exception)

Get the short Retry-After delay of a rate limited or overloaded response, if it has one.

bool
isInsufficientCredits(RequestException $exception)

Determine if the response is a 402, or a 429 insufficient credits or quota error rather than a rate limit.

array
overloadedStatusCodes()

Get the status codes that indicate a provider is transiently unavailable and the request should fail over.

array
insufficientCreditPatterns()

Get the patterns used to detect insufficient credits or quota errors.

array
insufficientCreditCodes()

Get the error codes or types that indicate insufficient credits or quota on a 429 response.

array
mapTools(array $tools, Provider $provider)

Map the given tools to Chat Completions function definitions.

array
mapProviderTool(ProviderTool $tool, Provider $provider)

Map a provider tool to a Chat Completions tool definition.

array
mapTool(Tool $tool)

Map a regular tool to a Chat Completions function definition.

string|array
mapToolChoice(ToolChoice $choice)

Map a tool choice to the Chat Completions tool_choice shape.

parseServerSentEvents(StreamInterface $streamBody)

Parse an SSE stream body into decoded JSON data objects.

string
readLine(StreamInterface $streamBody)

Read one line without waiting for a larger body buffer to fill.

generateTextStep(TextProvider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options, int|null $timeout, StepContext $stepContext)

Generate text for a single Chat Completions step.

generateStreamStep(string $invocationId, TextProvider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options, int|null $timeout, StepContext $stepContext)

Stream text for a single Chat Completions step.

array|null
streamOptions(Provider $provider)

Get the stream options sent with a streaming Chat Completions request.

__construct(Dispatcher $events)

Create a DeepSeek gateway.

Details

protected string|null composeInstructions(string|null $instructions, array|null $schema)

Add structured output requirements to the instructions.

Parameters

string|null $instructions
array|null $schema

Return Value

string|null

in BuildsTextRequests at line 21
protected array buildStepBody(Provider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options, StepContext $stepContext)

Build the request body for the current text generation step.

Parameters

Provider $provider
string $model
string|null $instructions
array $messages
array $tools
array|null $schema
TextGenerationOptions|null $options
StepContext $stepContext

Return Value

array

in BuildsTextRequests at line 37
protected array buildTextRequestBody(Provider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options)

Build the request body for the Chat Completions API.

Parameters

Provider $provider
string $model
string|null $instructions
array $messages
array $tools
array|null $schema
TextGenerationOptions|null $options

Return Value

array

in BuildsTextRequests at line 90
protected array buildResponseFormat()

Build the response format options for structured output.

Return Value

array

in CreatesClient at line 21
protected PendingRequest createClient(string $baseUrl, array $headers = [], array $configuredHeaders = [], int|null $timeout = 60, bool $throw = true)

Create an HTTP client with the provider's request options.

Parameters

string $baseUrl
array $headers
array $configuredHeaders
int|null $timeout
bool $throw

Return Value

PendingRequest

in CreatesClient at line 43
protected string httpConnection(Provider $provider)

Select a boot-registered connection without retaining dynamic provider names.

Parameters

Provider $provider

Return Value

string

protected PendingRequest client(Provider $provider, int|null $timeout = null)

Get an HTTP client for the DeepSeek API.

Parameters

Provider $provider
int|null $timeout

Return Value

PendingRequest

protected string baseUrl(Provider $provider)

Get the base URL for the DeepSeek API.

Parameters

Provider $provider

Return Value

string

protected Generator processTextStream(string $invocationId, Provider $provider, string $model, StreamInterface $streamBody)

Process a Chat Completions streaming response and yield Hypervel stream events.

Parameters

string $invocationId
Provider $provider
string $model
StreamInterface $streamBody

Return Value

Generator

in HandlesTextStreaming at line 232
protected array mapStreamToolCalls(array $toolCalls)

Map raw streaming tool call data to ToolCall DTOs.

Parameters

array $toolCalls

Return Value

array

in HandlesTextStreaming at line 245
protected string generateEventId()

Generate a lowercase UUID v7 for use as a stream event ID.

Return Value

string

in MapsAttachments at line 22
protected array mapAttachments(Collection $attachments)

Map the given Hypervel attachments to Chat Completions content parts.

Parameters

Collection $attachments

Return Value

array

in MapsAttachments at line 62
protected bool isImage(UploadedFile $attachment)

Determine if the given uploaded file is an image.

Parameters

UploadedFile $attachment

Return Value

bool

in MapsMessages at line 19
protected array mapMessagesToChat(array $messages, string|null $instructions = null)

Map the given Hypervel messages to Chat Completions messages format.

Parameters

array $messages
string|null $instructions

Return Value

array

in MapsMessages at line 46
protected void mapUserMessage(UserMessage|Message $message, array $chatMessages)

Map a user message to Chat Completions format.

Parameters

UserMessage|Message $message
array $chatMessages

Return Value

void

in MapsMessages at line 69
protected void mapAssistantMessage(AssistantMessage|Message $message, array $chatMessages)

Map an assistant message to Chat Completions format.

Parameters

AssistantMessage|Message $message
array $chatMessages

Return Value

void

in MapsMessages at line 97
protected void mapToolResultMessage(ToolResultMessage|Message $message, array $chatMessages)

Map a tool result message to Chat Completions format.

Parameters

ToolResultMessage|Message $message
array $chatMessages

Return Value

void

in MapsMessages at line 115
protected array serializeToolCallToChat(ToolCall $toolCall)

Serialize a tool call DTO to Chat Completions array format.

Parameters

ToolCall $toolCall

Return Value

array

protected array decodeStructuredOutput(string|null $text)

Decode a structured output payload, tolerating markdown code fences.

Parameters

string|null $text

Return Value

array

protected void validateTextResponse(array $data)

Validate the DeepSeek response data.

Parameters

array $data

Return Value

void

Exceptions

AiException

protected StepResponse parseTextResponse(array $data, Provider $provider, bool $structured)

Parse the DeepSeek response data into a single step response.

DeepSeek thinking-mode responses can include reasoning_content on each choice's message. We capture it into replayBlocks; the message mapper only replays it for assistant messages that include tool calls.

Parameters

array $data
Provider $provider
bool $structured

Return Value

StepResponse

protected TextUsage extractUsage(array $data)

Extract usage data from the response.

Parameters

array $data

Return Value

TextUsage

protected FinishReason extractFinishReason(array $choice)

Extract and map the finish reason from the response.

Parameters

array $choice

Return Value

FinishReason

protected mixed withErrorHandling(string $providerName, Closure $callback)

Execute a callback with failoverable error handling.

Parameters

string $providerName
Closure $callback

Return Value

mixed

protected int|null retryAfterSeconds(Throwable $exception)

Get the short Retry-After delay of a rate limited or overloaded response, if it has one.

Parameters

Throwable $exception

Return Value

int|null

protected bool isInsufficientCredits(RequestException $exception)

Determine if the response is a 402, or a 429 insufficient credits or quota error rather than a rate limit.

Parameters

RequestException $exception

Return Value

bool

protected array overloadedStatusCodes()

Get the status codes that indicate a provider is transiently unavailable and the request should fail over.

Return Value

array

protected array insufficientCreditPatterns()

Get the patterns used to detect insufficient credits or quota errors.

Return Value

array

protected array insufficientCreditCodes()

Get the error codes or types that indicate insufficient credits or quota on a 429 response.

Return Value

array

protected array mapTools(array $tools, Provider $provider)

Map the given tools to Chat Completions function definitions.

Parameters

array $tools
Provider $provider

Return Value

array

protected array mapProviderTool(ProviderTool $tool, Provider $provider)

Map a provider tool to a Chat Completions tool definition.

Parameters

ProviderTool $tool
Provider $provider

Return Value

array

protected array mapTool(Tool $tool)

Map a regular tool to a Chat Completions function definition.

Parameters

Tool $tool

Return Value

array

protected string|array mapToolChoice(ToolChoice $choice)

Map a tool choice to the Chat Completions tool_choice shape.

Parameters

ToolChoice $choice

Return Value

string|array

protected Generator parseServerSentEvents(StreamInterface $streamBody)

Parse an SSE stream body into decoded JSON data objects.

Parameters

StreamInterface $streamBody

Return Value

Generator

protected string readLine(StreamInterface $streamBody)

Read one line without waiting for a larger body buffer to fill.

Parameters

StreamInterface $streamBody

Return Value

string

StepResponse generateTextStep(TextProvider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options, int|null $timeout, StepContext $stepContext)

Generate text for a single Chat Completions step.

Parameters

TextProvider $provider
string $model
string|null $instructions
array $messages
array $tools
array|null $schema
TextGenerationOptions|null $options
int|null $timeout
StepContext $stepContext

Return Value

StepResponse

Generator generateStreamStep(string $invocationId, TextProvider $provider, string $model, string|null $instructions, array $messages, array $tools, array|null $schema, TextGenerationOptions|null $options, int|null $timeout, StepContext $stepContext)

Stream text for a single Chat Completions step.

Parameters

string $invocationId
TextProvider $provider
string $model
string|null $instructions
array $messages
array $tools
array|null $schema
TextGenerationOptions|null $options
int|null $timeout
StepContext $stepContext

Return Value

Generator

protected array|null streamOptions(Provider $provider)

Get the stream options sent with a streaming Chat Completions request.

Parameters

Provider $provider

Return Value

array|null

at line 30
__construct(Dispatcher $events)

Create a DeepSeek gateway.

Parameters

Dispatcher $events