-
-
Notifications
You must be signed in to change notification settings - Fork 588
Add support for Responses API #541
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
base: main
Are you sure you want to change the base?
Conversation
Full support to the new Responses API https://platform.openai.com/docs/api-reference/responses
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I started going through this, but it doesn't really follow the pattern at all :/
Some top level comments
- Place the Contract into src/Contracts/Resources
- Drop the Transporter/Payload iterations - you can reuse that logic.
- Move the Response API into src/Resources
- Split the Response/Resource into src/Resources & src/Responses
- Introduce some heavy tests.
Thanks for reviewing the PR, I will go over it again and let you know |
Can you run some of the tooling locally? Without tests and the bar having to be at 100% and some linting errors - this has a bit further to go.
I put them in order of complexity. |
Please find attached test results, sorry I don't have time to fix all errors. Phpstan already gave me a lot of headaches. test:unit.txt |
@iBotPeaches Please check my last commit 412f35c with above commit I tested live all models and all are working. Thank you for your understanding |
@momostafa - thanks for your work so far. I triggered the pipeline so you can see the failures right now. I'll look for some time if you've tapped out to take this further. |
You are welcome and thank you for your time looking into my PR. I am seriously overloaded but since there only 2 fails I will work on it tonight and I will get back to you. |
Hi, Now test:lint pass on my local machine please check momostafa@29436e8 |
Sorry... I will check the other failing |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Getting closer! A few things here and there, but the major aspect I see missing is the tests. You produced some fixtures, but nothing to assert any of the work you did - works.
- You'll need a Resource test, ie like Assistants
- You'll need a Response test for all types of responses, ie like Assistants
- Finally, a simple test to assert the mocking/pass-through all works with a more full body Response test - ie w/ Assistants again
src/Testing/Responses/Fixtures/Responses/CreateStreamedResponseFixture.txt
Show resolved
Hide resolved
Yeah getting closer : ) thank you for your patience and detailed inputs on what's needs to be fixed. I will try to resolve it today |
No worries, I'm excited to get this as well. Thanks for continuing to work on it. I know this is a big new endpoint, which I'll probably migrate all my Chat endpoints towards once completed. |
@momostafa , thank you for this great contribution! I am also looking forward to see this merged. Question: Does the documentation in the description reflect the current state of this PR? In your readme file this can be found:
According to the Responses API specification,
Also, it is also not mentioned, what would be the implied role if it is not given in Updating the repository README file as part of this PR would be very helpful. |
I had to modify OpenAI\Testing\Responses\Concerns\Fakeable as $class = str_replace('Responses\\', 'Testing\\Responses\\Fixtures\\', static::class).'Fixture'; was conflicting with newly added Responses folder and added docblock explaining the modification and tested against all files. Updated readme can be found at README-RESPONSES.md Added dedicated ClientFake for Responses tests/Testing/ClientFakeResponses.php
You are most welcome, I am glad to be able to make a small contribution to the community. Sorry for the delay since last update as it was quite a challenge to pass Pest tests as finally I found that fake function at Fakeable trait. I have submitted a review and I hope it will pass this time. Thank you |
@iBotPeaches Hi, Please check last commit caf4413
Please review and I appreciate if you can fix what is left so we can all benefit of using the Response API. Thank you for your understanding and guidance through the process. |
This is going to be a large large pr. Making my way through it. I didn't fully understand the scope of the Responses API until I sat down and dove into it. It has support for everything (reasoning, tool call, computer calling, file searching, function call, regular text) on top of custom tools and formats. If I had to summarize remaining work:
With Easter near, will lose a few days of time, but otherwise I'm hoping to get this all done & merged before April is over. |
Hi, I feel sorry that I overwhelmed you with the list of tasks that keeps growing.... I though it will just be fixing unit test and I was expecting that Streaming would require some changes or even total refactoring as I wasn't confident about it. Please give me example class for 1 tool call and a Task list/structure of all the Tool & Functions that you want to integrate and I will do it ASAP I already digested the whole Responses API (Except streaming :) was a confusing for me how to match it with the codebase pattern. Wish you Happy Easter in advance |
Don't feel bad - I didn't know it was going to be large. I'm of the opinion that we should launch this with near everything typed - otherwise downstream users deal with untyped arrays and a future release gives them typed classes. Its not the best developer experience, so yeah I did increase the scope of this work to get to that fully typed setup like other endpoints have.
Do you want to take ListInputItems? I won't touch that, I'm almost done with Retrieve/Create Response so I wouldn't touch those. Basically the InputItem result has this data array with a ton of types These types are iterations of existing types (more properties or less). I would create a new folder in Responses/InputItems and make a type for each one:
These types I've already made a good chunk of, but none of them seem to be a 100% match. So you can make new class objects in that folder and the array parsing can follow what you see here - you are welcome to take the parsing from any class I did that helps you type those objects quicker. (ps start with WebSearchToolCall as easiest). As any class that has inner object/arrays have to be further typed. If you get done with that - we are basically taking all those sub-classes and writing smaller tests. See this file for an example As you can tell in that example - it uses the existing Thanks! Happy to split working on this with you. Push code often and I'll do the same. Don't worry about breaking the build for now.
Thanks :) |
You are welcome Connor. I will happily do all of the above and thanks for the detailed instructions. I will review all of the above tonight and start fresh from tomorrow and I will be committing after each completion of each sub class / task |
- Added Classes related to InputMessage types - refactored ListInputItems to reflect the newly added classes
@iBotPeaches Hi, Please check momostafa@e811af7
|
Looking good! I saw you fixed the camelCase already. One thing I'm not sure about is the newlines/spaces in the php array shape docblocks. It increases readability majorly, but I vaguely it remember not being supported like that in some IDE which is what forced those massive 1 line array array shape docblocks. Don't worry about changing that for now - I'll dig into that. |
$data = array_map( | ||
function (array $item): array { | ||
$content = array_map( | ||
fn (array $contentItem): InputMessageContentInputText|InputMessageContentInputImage|InputMessageContentInputFile => match ($contentItem['type']) { | ||
'input_text' => InputMessageContentInputText::from($contentItem), | ||
'input_image' => InputMessageContentInputImage::from($contentItem), | ||
'input_file' => InputMessageContentInputFile::from($contentItem), | ||
}, | ||
$item['content'], | ||
); | ||
return [ | ||
'type' => $item['type'], | ||
'id' => $item['id'], | ||
'status' => $item['status'], | ||
'role' => $item['role'], | ||
'content' => $content, | ||
]; | ||
}, | ||
$attributes['data'], | ||
); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@momostafa - I wouldn't expect a double array_map. I think you want to map these items into an InputMessage
as that contains the inner object that would then handle the array_map of the child content items.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I totally got blind at this part by the time I got to this file my eyes was were soaring after copy/past from api docs then making my own docs then going 10X+ times over each array. I will fix that
Glad that you found it good with any major issues. About the expanded docblocks I am aware of the limitation I will refactor once you approve on this initial start I made like that to help me verify that everything in place. |
I made a comparison between array properties and type hints of below Classes: Findings
public readonly array $content
✔ Matches the Documentation:
public readonly array $annotations
✔ Matches the Documentation:
public readonly string $fileId
✔ Matches the Documentation but filename is present in the Documentation for file_citation, but missing in the class
#source: https://platform.openai.com/docs/api-reference/responses/create File Search Output example
public readonly string $fileId
✔ Matches the Documentation:
public readonly int $endIndex
✔ Matches the Documentation: #Conclusion All properties and type hints match the Documentation. I don't think there is a need to recreate the classes. under Responses/Input/
|
If they match 100%, reuse them and I'll fix the naming of classes to reflect that once all done. |
you just need to add filename to OutputMessageContentOutputTextAnnotationsFileCitation.php |
What:
Adds the new feature Responses API: https://platform.openai.com/docs/api-reference/responses
Fixes: #535
Laravel PR: openai-php/laravel#147