Skip to content

docs(model): update model provider documentation to match the new interface #138

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.

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
merged 3 commits into from
Jul 13, 2025

Conversation

mkmeral
Copy link
Contributor

@mkmeral mkmeral commented Jul 13, 2025

Update Custom Model Provider Documentation for Stream-First Interface

Description

  • Updated Strands Agents SDK version
  • Updated the custom model provider documentation to reflect the current stream-first model interface. Rewrote the implementation guide to focus on the single stream method entry point, clarified that helper methods are optional recommendations rather than requirements, and removed references to historical interface changes to maintain focus on current functionality.

See related feature PR in SDK: strands-agents/sdk-python#400

Type of Change

Content update/revision

Motivation and Context

The documentation was referencing an outdated model interface pattern and needed to be updated to match the current SDK implementation. The previous documentation referenced abstract methods that are no longer required.

This update ensures developers have accurate, current guidance for implementing custom model providers.

Areas Affected

  • /docs/user-guide/concepts/model-providers/custom_model_provider.md
    • Section 2: Complete rewrite of stream method implementation
    • Section 4: Updated structured output implementation
    • Section 5: Simplified usage examples
    • Key Implementation Considerations: Updated all subsections to reflect current interface

Screenshots

N/A - Text-only documentation changes

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using mkdocs serve
  • Links in the documentation are valid and working
  • Images/diagrams are properly sized and formatted
  • All new and existing tests pass

Additional Notes

None

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@mkmeral mkmeral merged commit 1fc66ad into strands-agents:main Jul 13, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants