Skip to content

Conversation

seratch
Copy link
Member

@seratch seratch commented Aug 21, 2025

This document update needs to be merged after releasing #363 changes.

@seratch seratch requested a review from dkundel-openai August 21, 2025 14:42
@seratch seratch added the documentation Improvements or additions to documentation label Aug 21, 2025
Copy link

changeset-bot bot commented Aug 21, 2025

⚠️ No Changeset found

Latest commit: 00144d1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@seratch seratch marked this pull request as ready for review August 21, 2025 14:42
name: 'My Agent',
instructions: "You're a helpful agent.",
modelSettings: {
reasoning: { effort: 'minimal' },
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also encourage people to try out medium and high. Just always optimizing for latency doesn't seem like an ideal recommendation. We already dumb down the model with low to make the latency closer to what people expect from non-reasoning models. However, just because that's the fastest and an okay default doesn't mean it's what people should strive for.

| `truncation` | `'auto' \| 'disabled'` | Token truncation strategy. |
| `maxTokens` | `number` | Maximum tokens in the response. |
| `store` | `boolean` | Persist the response for retrieval / RAG workflows. |
| `reasoning.effort` | `'minimal' \| 'low' \| 'medium' \| 'high'` | Reasoning effort for gpt-5 etc. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In your other code samples from other PRs these were still under providerDetails. If they are top level I think that's better. Just calling it out.

Also GPT-5 should be capitalized in here

@dkundel-openai dkundel-openai merged commit 770bae7 into main Aug 28, 2025
5 checks passed
@dkundel-openai dkundel-openai deleted the gpt-5-docs branch August 28, 2025 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants