Skip to content

feat!: Implement include parameter specifically for adding logprobs in the output message #4261

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

Merged
ashwinb merged 10 commits into from
Dec 11, 2025
Merged

feat!: Implement include parameter specifically for adding logprobs in the output message #4261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e8e11e3
Implement include parameter specifically for adding logprobs in the o…
s-akhtar-baig Nov 30, 2025
ce9f210
Update docs
s-akhtar-baig Nov 30, 2025
5c21283
Avoid recreating most recordings
s-akhtar-baig Dec 3, 2025
d8f6154
Add new recordings
s-akhtar-baig Dec 3, 2025
39be3b3
Merge branch 'main' into add_include_param
s-akhtar-baig Dec 3, 2025
dc7af8a
Merge branch 'main' into add_include_param
s-akhtar-baig Dec 3, 2025
958909e
Merge branch 'main' into add_include_param
s-akhtar-baig Dec 3, 2025
cd3609f
Use client_with_models in helper functions
s-akhtar-baig Dec 4, 2025
3ff4371
Merge branch 'main' into add_include_param
mattf Dec 10, 2025
fa49fb9
Merge branch 'main' into add_include_param
ashwinb Dec 11, 2025
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
171 changes: 139 additions & 32 deletions client-sdks/stainless/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4476,15 +4476,15 @@ components:
type: number
title: Logprob
top_logprobs:
items:
$ref: '#/components/schemas/OpenAITopLogProb'
type: array
title: Top Logprobs
anyOf:
- items:
$ref: '#/components/schemas/OpenAITopLogProb'
type: array
- type: 'null'
type: object
required:
- token
- logprob
- top_logprobs
title: OpenAITokenLogProb
description: |-
The log probability for a token from an OpenAI-compatible chat completion response.
Expand Down Expand Up @@ -5572,15 +5572,22 @@ components:
OpenAIResponseOutputMessageContentOutputText:
properties:
text:
type: string
title: Text
type:
type: string
type:
const: output_text
title: Type
default: output_text
title: Type
type: string
annotations:
items:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
Expand All @@ -5590,20 +5597,20 @@ components:
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
type: object
type: array
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
type: object
OpenAIResponseOutputMessageFileSearchToolCall:
properties:
id:
Expand Down Expand Up @@ -7219,7 +7226,7 @@ components:
include:
anyOf:
- items:
type: string
$ref: '#/components/schemas/ResponseItemInclude'
type: array
- type: 'null'
max_infer_iters:
Expand Down Expand Up @@ -7418,8 +7425,7 @@ components:
logprobs:
anyOf:
- items:
additionalProperties: true
type: object
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
Expand Down Expand Up @@ -8181,6 +8187,13 @@ components:
item_id:
title: Item Id
type: string
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
output_index:
title: Output Index
type: integer
Expand Down Expand Up @@ -11859,19 +11872,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
title: OpenAIResponseOutputMessageContentOutputText
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
title: OpenAIResponseOutputMessageContentOutputText-Input
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal
discriminator:
propertyName: type
mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
title: OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal
type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
title: list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
role:
title: Role
type: string
Expand Down Expand Up @@ -11928,19 +11941,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
title: OpenAIResponseOutputMessageContentOutputText
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
title: OpenAIResponseOutputMessageContentOutputText-Output
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal
discriminator:
propertyName: type
mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal
type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
role:
title: Role
type: string
Expand Down Expand Up @@ -11973,6 +11986,88 @@ components:
They are all under one type because the Responses API gives them all
the same "type" value, and there is no way to tell them apart in certain
scenarios.
OpenAIResponseOutputMessageContentOutputText-Input:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageContentOutputText-Output:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageFileSearchToolCallResults:
properties:
attributes:
Expand Down Expand Up @@ -12132,6 +12227,18 @@ components:
required:
- reasoning_tokens
title: OutputTokensDetails
ResponseItemInclude:
type: string
enum:
- web_search_call.action.sources
- code_interpreter_call.outputs
- computer_call_output.output.image_url
- file_search_call.results
- message.input_image.image_url
- message.output_text.logprobs
- reasoning.encrypted_content
title: ResponseItemInclude
description: Specify additional output data to include in the model response.
SearchRankingOptions:
properties:
ranker:
Expand Down
Loading
Loading