Allow embed as a parameter to configureIndex
#338
Merged
Conversation
This file contains hidden or 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
jhamon
approved these changes
Apr 9, 2025
| @@ -37,7 +37,7 @@ describe('configureIndex argument validations', () => { | |||
|
|
|||
| await expect(toThrow).rejects.toThrowError(PineconeArgumentError); | |||
| await expect(toThrow).rejects.toThrowError( | |||
| 'Object contained invalid properties: speculoos. Valid properties include deletionProtection, spec, tags.' | |||
| 'Object contained invalid properties: speculoos. Valid properties include deletionProtection, spec, tags, embed.' | |||
There was a problem hiding this comment.
Yeah, it's the invalid object key which ends up in the error message.
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.
Problem
Currently, the
ConfigureIndexRequestinterface supportsembed?: ConfigureIndexRequestEmbedas a parameter, which aligns with the OAS spec and how the endpoint can be used:pinecone-ts-client/src/pinecone-generated-ts-fetch/db_control/models/ConfigureIndexRequest.ts
Line 64 in e5b39d7
However, the
embedfield was not added toConfigureIndexRequestProperties, defining what we expect a user to provide in a request. We also error out if the user attempts to configure an index with just theembedproperty.Solution
Update
ConfigureIndexRequestPropertiesand the validation logic in theconfigureIndexaction to allow leveragingembedproperly.Type of Change
Test Plan
CI Unit & Integration Tests