Skip to content
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

docs: Update Bedrock documentation to show streaming example #979

Closed
Amnah199 opened this issue Aug 14, 2024 · 1 comment
Closed

docs: Update Bedrock documentation to show streaming example #979

Amnah199 opened this issue Aug 14, 2024 · 1 comment
Assignees
Labels
feature request Ideas to improve an integration integration:amazon-bedrock P2 type:documentation Improvements or additions to documentation

Comments

@Amnah199
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The BedrockGenerator now supports streaming_callback, similar to the OpenAIGenerator. After its release, it would be beneficial to include an example of 'Streaming' in the documentation to demonstrate its usage.

Describe the solution you'd like
Add a separate example code for streaming, similar to the example provided for the OpenAIGenerator in the documentation:
OpenAIGenerator Example.

Describe alternatives you've considered
NA
Additional context
NA

@Amnah199 Amnah199 added feature request Ideas to improve an integration type:documentation Improvements or additions to documentation integration:amazon-bedrock labels Aug 14, 2024
@dfokina
Copy link
Contributor

dfokina commented Aug 27, 2024

I attempted to make the information about streaming support more visible to users without manually rewriting examples for each component page:

This way, all three pages are somewhat interconnected, so users should be able to easily find this information.

@Amnah199 @julian-risch please take a look if this makes sense before I close this :)

@dfokina dfokina closed this as completed Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Ideas to improve an integration integration:amazon-bedrock P2 type:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants