xintongsong commented on PR #221: URL: https://github.com/apache/flink-agents/pull/221#issuecomment-3341654091
@alnzng, thanks for the really nice work on these documentations. A few suggestions from my side. ### Embedding Models In general, I'd suggest the following order to introduce things to our users. 1. How to use embedding models in general 2. What built-in providers are available, and their specifics 3. How to provide custom provider support, in the built-in ones do not meet requirements In that sense, I'd suggest the following changes. 1. Move the introduction of the connection and setup concepts, and why we have this separation, to the `Overview` section. 2. Change the `Embedding Interfaces` section name into something like `Use Embedding Models in Agents`, move `BaseEmbeddingModelConnection` and `BaseEmbeddingModelSetup` out, and add a general example that not only shows how to define the model connection and setup with the decorators, but also how to obtain the embedding model with `RunnerContext.get_resource()` and call the `embed()` method on it. 3. Add another section `Support Custom Providers` after `Built-in Providers`, and introduce `BaseEmbeddingModelConnection` and `BaseEmbeddingModelSetup`, which are the interfaces need to be implemented for custom supports. In addition, I'd suggest to add a notice for the `Support Custom Providers` section, reminding users that the APIs are experimental and unstable, subject to in-compatible changes in future releases. ### Vector Stores My suggestions are similar to those on Embedding Models, to separate the sections from the user's perspective: how to use it, what built-in supports are available, and how to customize in built-in supports don't meet requirements. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
