Skip to content

feat: add reasoning_content field to chat completions response #536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Responses/Chat/CreateResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
use OpenAI\Testing\Responses\Concerns\Fakeable;

/**
* @implements ResponseContract<array{id: string, object: string, created: int, model: string, system_fingerprint?: string, choices: array<int, array{index: int, message: array{role: string, content: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, logprobs: ?array{content: ?array<int, array{token: string, logprob: float, bytes: ?array<int, int>}>}, finish_reason: string|null}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
* @implements ResponseContract<array{id: string, object: string, created: int, model: string, system_fingerprint?: string, choices: array<int, array{index: int, message: array{role: string, content: string|null, reasoning_content?: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, finish_reason: string|null}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
*/
final class CreateResponse implements ResponseContract, ResponseHasMetaInformationContract
{
/**
* @use ArrayAccessible<array{id: string, object: string, created: int, model: string, system_fingerprint?: string, choices: array<int, array{index: int, message: array{role: string, content: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, logprobs: ?array{content: ?array<int, array{token: string, logprob: float, bytes: ?array<int, int>}>}, finish_reason: string|null}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
* @use ArrayAccessible<array{id: string, object: string, created: int, model: string, system_fingerprint?: string, choices: array<int, array{index: int, message: array{role: string, content: string|null, reasoning_content?: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, finish_reason: string|null}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
*/
use ArrayAccessible;

Expand All @@ -41,7 +41,7 @@ private function __construct(
/**
* Acts as static factory, and returns a new Response instance.
*
* @param array{id: string, object: string, created: int, model: string, system_fingerprint?: string, choices: array<int, array{index: int, message: array{role: string, content: ?string, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, logprobs: ?array{content: ?array<int, array{token: string, logprob: float, bytes: ?array<int, int>}>}, finish_reason: string|null}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int, prompt_tokens_details?:array{cached_tokens:int}, completion_tokens_details?:array{audio_tokens?:int, reasoning_tokens:int, accepted_prediction_tokens:int, rejected_prediction_tokens:int}}} $attributes
* @param array{id: string, object: string, created: int, model: string, system_fingerprint?: string, choices: array<int, array{index: int, message: array{role: string, content: ?string, reasoning_content?: ?string, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, finish_reason: string|null}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int, prompt_tokens_details?:array{cached_tokens:int}, completion_tokens_details?:array{audio_tokens?:int, reasoning_tokens:int, accepted_prediction_tokens:int, rejected_prediction_tokens:int}}} $attributes
*/
public static function from(array $attributes, MetaInformation $meta): self
{
Expand Down
7 changes: 2 additions & 5 deletions src/Responses/Chat/CreateResponseChoice.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,29 @@ final class CreateResponseChoice
private function __construct(
public readonly int $index,
public readonly CreateResponseMessage $message,
public readonly ?CreateResponseChoiceLogprobs $logprobs,
public readonly ?string $finishReason,
) {}

/**
* @param array{index: int, message: array{role: string, content: ?string, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, logprobs: ?array{content: ?array<int, array{token: string, logprob: float, bytes: ?array<int, int>}>}, finish_reason: string|null} $attributes
* @param array{index: int, message: array{role: string, content: ?string, reasoning_content?: ?string, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, finish_reason: string|null} $attributes
*/
public static function from(array $attributes): self
{
return new self(
$attributes['index'],
CreateResponseMessage::from($attributes['message']),
$attributes['logprobs'] ? CreateResponseChoiceLogprobs::from($attributes['logprobs']) : null,
$attributes['finish_reason'] ?? null,
);
}

/**
* @return array{index: int, message: array{role: string, content: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, logprobs: ?array{content: ?array<int, array{token: string, logprob: float, bytes: ?array<int, int>}>}, finish_reason: string|null}
* @return array{index: int, message: array{role: string, content: string|null, reasoning_content?: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}, finish_reason: string|null}
*/
public function toArray(): array
{
return [
'index' => $this->index,
'message' => $this->message->toArray(),
'logprobs' => $this->logprobs?->toArray(),
'finish_reason' => $this->finishReason,
];
}
Expand Down
10 changes: 8 additions & 2 deletions src/Responses/Chat/CreateResponseMessage.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ private function __construct(
public readonly string $role,
public readonly ?string $content,
public readonly array $toolCalls,
public readonly ?string $reasoningContent,
public readonly ?CreateResponseFunctionCall $functionCall,
) {}

/**
* @param array{role: string, content: ?string, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>} $attributes
* @param array{role: string, content: ?string, reasoning_content?: ?string, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>} $attributes
*/
public static function from(array $attributes): self
{
Expand All @@ -29,12 +30,13 @@ public static function from(array $attributes): self
$attributes['role'],
$attributes['content'] ?? null,
$toolCalls,
$attributes['reasoning_content'] ?? null,
isset($attributes['function_call']) ? CreateResponseFunctionCall::from($attributes['function_call']) : null,
);
}

/**
* @return array{role: string, content: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}
* @return array{role: string, content: string|null, reasoning_content?: string|null, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}
*/
public function toArray(): array
{
Expand All @@ -43,6 +45,10 @@ public function toArray(): array
'content' => $this->content,
];

if ($this->reasoningContent !== null) {
$data['reasoning_content'] = $this->reasoningContent;
}

if ($this->functionCall instanceof CreateResponseFunctionCall) {
$data['function_call'] = $this->functionCall->toArray();
}
Expand Down
6 changes: 3 additions & 3 deletions src/Responses/Chat/CreateStreamedResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
use OpenAI\Testing\Responses\Concerns\FakeableForStreamedResponse;

/**
* @implements ResponseContract<array{id: string, object: string, created: int, model: string, choices: array<int, array{index: int, delta: array{role?: string, content?: string}|array{role?: string, content: null, function_call: array{name?: string, arguments?: string}}, finish_reason: string|null}>, usage?: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
* @implements ResponseContract<array{id: string, object: string, created: int, model: string, choices: array<int, array{index: int, delta: array{role?: string, content?: string, reasoning_content?: string}|array{role?: string, content: null, reasoning_content?: string, function_call: array{name?: string, arguments?: string}}, finish_reason: string|null}>, usage?: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
*/
final class CreateStreamedResponse implements ResponseContract
{
/**
* @use ArrayAccessible<array{id: string, object: string, created: int, model: string, choices: array<int, array{index: int, delta: array{role?: string, content?: string}|array{role?: string, content: null, function_call: array{name?: string, arguments?: string}}, finish_reason: string|null}>, usage?: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
* @use ArrayAccessible<array{id: string, object: string, created: int, model: string, choices: array<int, array{index: int, delta: array{role?: string, content?: string, reasoning_content?: string}|array{role?: string, content: null, reasoning_content?: string, function_call: array{name?: string, arguments?: string}}, finish_reason: string|null}>, usage?: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}>
*/
use ArrayAccessible;

Expand All @@ -35,7 +35,7 @@ private function __construct(
/**
* Acts as static factory, and returns a new Response instance.
*
* @param array{id: string, object: string, created: int, model: string, choices: array<int, array{index: int, delta: array{role?: string, content?: string}, finish_reason: string|null}>, usage?: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}} $attributes
* @param array{id: string, object: string, created: int, model: string, choices: array<int, array{index: int, delta: array{role?: string, content?: string, reasoning_content?: string}, finish_reason: string|null}>, usage?: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}} $attributes
*/
public static function from(array $attributes): self
{
Expand Down
4 changes: 2 additions & 2 deletions src/Responses/Chat/CreateStreamedResponseChoice.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ private function __construct(
) {}

/**
* @param array{index: int, delta?: array{role?: string, content?: string}, finish_reason: string|null} $attributes
* @param array{index: int, delta?: array{role?: string, content?: string, reasoning_content?: string}, finish_reason: string|null} $attributes
*/
public static function from(array $attributes): self
{
Expand All @@ -25,7 +25,7 @@ public static function from(array $attributes): self
}

/**
* @return array{index: int, delta: array{role?: string, content?: string}|array{role?: string, content: null, function_call: array{name?: string, arguments?: string}}, finish_reason: string|null}
* @return array{index: int, delta: array{role?: string, content?: string, reasoning_content?: string}|array{role?: string, content: null, reasoning_content?: string, function_call: array{name?: string, arguments?: string}}, finish_reason: string|null}
*/
public function toArray(): array
{
Expand Down
7 changes: 5 additions & 2 deletions src/Responses/Chat/CreateStreamedResponseDelta.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ private function __construct(
public readonly ?string $role,
public readonly ?string $content,
public readonly array $toolCalls,
public readonly ?string $reasoningContent,
public readonly ?CreateStreamedResponseFunctionCall $functionCall,
) {}

/**
* @param array{role?: string, content?: string, function_call?: array{name?: ?string, arguments?: ?string}, tool_calls?: array<int, array{id?: string, type?: string, function: array{name?: string, arguments: string}}>} $attributes
* @param array{role?: string, content?: string, reasoning_content?: string, function_call?: array{name?: ?string, arguments?: ?string}, tool_calls?: array<int, array{id?: string, type?: string, function: array{name?: string, arguments: string}}>} $attributes
*/
public static function from(array $attributes): self
{
Expand All @@ -29,18 +30,20 @@ public static function from(array $attributes): self
$attributes['role'] ?? null,
$attributes['content'] ?? null,
$toolCalls,
$attributes['reasoning_content'] ?? null,
isset($attributes['function_call']) ? CreateStreamedResponseFunctionCall::from($attributes['function_call']) : null,
);
}

/**
* @return array{role?: string, content?: string}|array{role?: string, content: null, function_call: array{name?: string, arguments?: string}}
* @return array{role?: string, content?: string, reasoning_content?: string}|array{role?: string, content: null, reasoning_content?: string, function_call: array{name?: string, arguments?: string}}
*/
public function toArray(): array
{
$data = array_filter([
'role' => $this->role,
'content' => $this->content,
'reasoning_content' => $this->reasoningContent,
], fn (?string $value): bool => ! is_null($value));

if ($this->functionCall instanceof CreateStreamedResponseFunctionCall) {
Expand Down
Loading