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

doc: Update documentation of GoogleAI and VertexAI to show streaming example #1036

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

Comments

@Amnah199
Copy link
Contributor

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

  • VertexAIGeminiChatGenerator
  • VertexAIGeminiGenerator
  • GoogleAIGeminiChatGenerator
  • GoogleAIGeminiGenerator

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.

@julian-risch
Copy link
Member

Daria added a section about streaming to the docs of all generators that support streaming. For example this section https://docs.haystack.deepset.ai/docs/vertexaigeminichatgenerator#streaming points to https://docs.haystack.deepset.ai/docs/choosing-the-right-generator#streaming-support

And there is a new column in the overview for streaming support https://docs.haystack.deepset.ai/docs/generators

With all that being done, we can close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants