Normalize client usage
#1173
Merged
Normalize client usage
#1173
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is 📢 Thoughts on this report? Let us know! |
vachillo
force-pushed
the
lazy_client
branch
5 times, most recently
from
2858f4e to
6adac93
Compare
collindutter
requested changes
Sep 23, 2024
CHANGELOG.md
Outdated
Comment on lines
10
to
26
| - **BREAKING**: Renamed parameter `bedrock_client` on `AmazonBedrockCohereEmbeddingDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `bedrock_client` on `AmazonBedrockTitanEmbeddingDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `bedrock_client` on `AmazonBedrockImageGenerationDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `bedrock_client` on `AmazonBedrockImageQueryDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `bedrock_client` on `AmazonBedrockPromptDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `sagemaker_client` on `AmazonSageMakerJumpstartEmbeddingDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `sagemaker_client` on `AmazonSageMakerJumpstartPromptDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `sqs_client` on `AmazonSqsEventListenerDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `iotdata_client` on `AwsIotCoreEventListenerDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `s3_client` on `AmazonS3FileManagerDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `s3_client` on `AwsS3Tool` to `client`. | ||
| - **BREAKING**: Renamed parameter `pusher_client` on `PusherEventListenerDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `mq` on `MarqoVectorStoreDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `model_client` on `GooglePromptDriver` to `client`. | ||
| - **BREAKING**: Renamed parameter `model_client` on `GoogleTokenizer` to `client`. | ||
| - **BREAKING**: Renamed parameter `pipe` on `HuggingFacePipelinePromptDriver` to `text_generation_pipeline`. | ||
| - **BREAKING**: Renamed parameter `engine` on `PgVectorVectorStoreDriver` to `sqlalchemy_engine`. |
There was a problem hiding this comment.
Let's move this under a single BREAKING item with a nested list.
Comment on lines
39
to
41
| _text_generation_pipeline: TextGenerationPipeline = field( | ||
| default=None, kw_only=True, alias="text_generation_pipeline", metadata={"serializable": False} | ||
| ) |
There was a problem hiding this comment.
I know I'm contradicting a point I made offline, but what if we change this to support non-text generation pipelines in the future? Maybe it's better to name off the base class: Pipeline.
There was a problem hiding this comment.
yeah went back and forth, will update
| table_name: str = field(kw_only=True, metadata={"serializable": True}) | ||
| _model: Any = field(default=Factory(lambda self: self.default_vector_model(), takes_self=True)) | ||
| _sqlalchemy_engine: sqlalchemy.Engine = field(default=None, kw_only=True, metadata={"serializable": False}) |
There was a problem hiding this comment.
I think this can stay as engine.
| default=Factory(lambda self: self.session.client("bedrock-runtime"), takes_self=True), | ||
| kw_only=True, | ||
| ) | ||
| _client: Any = field(default=None, kw_only=True, alias="client", metadata={"serializable": False}) |
There was a problem hiding this comment.
Can we add types to all the Amazon Drivers or does that break tests?
collindutter
previously approved these changes
Sep 23, 2024
vachillo
force-pushed
the
lazy_client
branch
from
4d2f81f to
4b7eee2
Compare
vachillo
force-pushed
the
lazy_client
branch
from
19460b6 to
dde87f2
Compare
collindutter
approved these changes
Sep 23, 2024
Closed
1 task
|
closes #1174 |
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.
Describe your changes
This normalizes the usage and naming of API clients in various drivers throughout the framework.
Today, any parameters set after init on any drivers that use a
clientare ignored because theclientis typically initialized during driver initialization via an attrsFactory. Adding@lazy_propertyto the clients allow for making parameter modifications on theDriverbefore the client is used, namely in the globalDefaultsobject. see #1174 for an example.Issue ticket number and link
#1174