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.

Sign up for GitHub

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

Jump to bottom

Chat Response: Add logprobs #533

Merged

iBotPeaches merged 4 commits into openai-php:main from klmork:add-chat-response-logprobs

Apr 8, 2025

Contributor

klmork commented Mar 11, 2025 •

edited by iBotPeaches

Loading

What:

Bug Fix
New Feature

Description:

Add logprobs to CreateResponseChoice.

logprobs defaults to false if not provided in the request: https://platform.openai.com/docs/api-reference/chat/create#chat-create-logprobs
We can return the logprobs value or null: https://platform.openai.com/docs/api-reference/chat/object

Updates tests and docs.

This pull does not:

Add logprobs to CreateStreamedResponseChoice.
Add all of the logprob fields at this time (e.g. refusal or content's field of top_logprobs array).

Related:

fixes: #455

Collaborator

iBotPeaches commented Apr 4, 2025

Do you mind rebasing? I allowed CI to run, but since this is an older PR its still using cache/v1 which is dead. A simple rebase will solve that and we can see if this will pass CI.

thanks!

klmork added 4 commits

April 4, 2025 14:29


          Chat Response: Add class for logprobs content

78a6af0


          Chat response: add logprobs

0c7f7a1

Only add content for now.


          Chat response: add logprobs to CreateResponse

9f27383

Now that we have our classes for logprobs (CreateResponseChoiceLogprobs
and CreateResponseChoiceLogbropsContent), let's actually add logprobs in
the CreateResponseChoice / CreateResponse objects.

Update types, fixtures, tests.


          Update readme

1dbd60a

klmork force-pushed the add-chat-response-logprobs branch from 7c0bea4 to 1dbd60a Compare

April 4, 2025 21:43

Contributor Author

klmork commented Apr 4, 2025

Thanks @iBotPeaches! Just rebased 👍

iBotPeaches approved these changes

View reviewed changes

iBotPeaches merged commit babb3e1 into openai-php:main

10 checks passed

Collaborator

iBotPeaches commented Apr 8, 2025

thanks! Tested it out a bit with on/off and worked as I expect. Thanks for 1st PR with perfect CI/CD passing and quick response.

iBotPeaches added the enhancement label

Contributor Author

klmork commented Apr 8, 2025

Awesome! Yay, thanks 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels