Skip to content

Adjust config kwargs to Pinecone and PineconeAsyncio#447

Merged
jhamon merged 8 commits intorelease-candidate/2025-01from
jhamon/deprecate-kwargs
Feb 3, 2025
Merged

Adjust config kwargs to Pinecone and PineconeAsyncio#447
jhamon merged 8 commits intorelease-candidate/2025-01from
jhamon/deprecate-kwargs

Conversation

@jhamon
Copy link
Collaborator

@jhamon jhamon commented Feb 3, 2025

Problem

We want to deprecate a few kwargs and give more helpful error messages.

Solution

  • Deprecate config and openapi_config kwargs; as far as I know these were only used for tests. They have not appeared in documentation. It adds quite a bit of complexity trying to merge configuration from all these sources so going forward we would prefer to just expect configuration from a single source, which are named kwargs.
  • Add NotImplementedError messages that clearly explain some features that are not implemented yet for PineconeAsyncio. This is preferrable to allowing users to pass kwargs that have no effect, then getting frustrated when they seem not to work.
  • Give more informative error when it looks like the user has passed an invalid value as the host

Type of Change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

@jhamon jhamon changed the title Adjust kwargs Adjust config kwargs to Pinecone and PineconeAsyncio Feb 3, 2025
@jhamon jhamon marked this pull request as ready for review February 3, 2025 17:50
@jhamon jhamon merged commit 9b4a2a1 into release-candidate/2025-01 Feb 3, 2025
56 checks passed
@jhamon jhamon deleted the jhamon/deprecate-kwargs branch February 3, 2025 18:24
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.

1 participant