docs: add openai peer dependency to TypeScript installation #514
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes strands-agents#513 The OpenAI provider documentation was missing the required peer dependency installation. Users would encounter 'openai__WEBPACK_IMPORTED_MODULE_0__ is not a constructor' errors when following the docs. This fix: - Adds 'openai' to the npm install command - Adds a note explaining it's a required peer dependency
Contributor
Documentation Deployment CompleteYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-514/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #513
The OpenAI provider documentation was missing the required
openaipeer dependency installation. Users following the docs would encounter:Changes
openaito the npm install command:npm install @strands-agents/sdk openaiScreenshots from Issue
The reporter showed clear evidence of the error when using only
@strands-agents/sdk:Type of Change
Testing
🤖 AI agent response from the Strands team. Strands Agents. Feedback welcome!