docs: update TypeScript SDK model provider class names and import paths#682
Draft
pgrayy wants to merge 1 commit intostrands-agents:mainfrom
Draft
docs: update TypeScript SDK model provider class names and import paths#682pgrayy wants to merge 1 commit intostrands-agents:mainfrom
pgrayy wants to merge 1 commit intostrands-agents:mainfrom
Conversation
7 tasks
Contributor
Documentation Preview FailedThe documentation deployment encountered an error. Please check the deployment logs for more details. |
3b3dc77 to
a825f49
Compare
Contributor
Documentation Preview FailedThe documentation deployment encountered an error. Please check the deployment logs for more details. |
Update documentation to reflect SDK model provider reorganization: - BedrockModel -> BedrockConverseModel - OpenAIModel -> OpenAIChatModel - GeminiModel -> GoogleGenAIModel - Import paths: @strands-agents/sdk/<name> -> @strands-agents/sdk/models/<name> - gemini subpath -> google subpath - Update all TypeScript code snippets, examples, API links, and tests
a825f49 to
98578ee
Compare
Contributor
Documentation Preview FailedThe documentation deployment encountered an error. Please check the deployment logs for more details. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Update documentation to reflect the TypeScript SDK model provider reorganization (strands-agents/sdk-typescript#694).
Class renames:
BedrockModel->ConverseModelOpenAIModel->ChatModelAnthropicModel->MessagesModelGeminiModel->GenAIModelImport path changes:
@strands-agents/sdk/bedrock->@strands-agents/sdk/models/bedrock@strands-agents/sdk/openai->@strands-agents/sdk/models/openai@strands-agents/sdk/anthropic->@strands-agents/sdk/models/anthropic@strands-agents/sdk/gemini->@strands-agents/sdk/models/googleThe new class names describe the API each provider wraps, not the company. The subpath already communicates the provider. For example,
ConverseModelfrom@strands-agents/sdk/models/bedrockwraps the Bedrock Converse API.Only TypeScript code, snippets, API links, and tests are updated. All Python references are unchanged. Anthropic does not have TypeScript examples in the docs yet, so no Anthropic files are touched.
Related Issues
N/A
Type of Change
Checklist
npm run devBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.