Add Index tags + small updates to generated code #317
Merged
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
aulorbe
commented
Dec 17, 2024
| tags: { | ||
| example: 'tag', | ||
| }, | ||
| deletionProtection: 'disabled', // Redundant, but for example purposes |
There was a problem hiding this comment.
Added deletionProtection to this test just b/c I noticed it was missing while doing index tag stuffs
austin-denoble
approved these changes
Dec 17, 2024
README.md
Outdated
| @@ -344,6 +346,31 @@ await pc.configureIndex('deletion-protected-index', { | |||
| }); | |||
| ``` | |||
|
|
|||
| #### Create or configure an index with index tags | |||
|
|
|||
| You can configure both serverless and pod indexes with [tags](https://docs.pinecone.io/guides/indexes/tag-an-index). | |||
There was a problem hiding this comment.
nit: I'd mention "create" and "configure" explicitly here.
Comment on lines
+352
to
+353
| Indexes can hold an arbitrary number of tags outlining metadata | ||
| you would like attached to the index object itself, such as team ownership, project, or any other relevant information. |
There was a problem hiding this comment.
I know you've linked to the docs, but do you think it's worth demonstrating how to perform a tag deletion here? With tag: "" - empty string I mean.
There was a problem hiding this comment.
Sure, I can add that!
| @@ -35,6 +35,7 @@ const CreateIndexOptionsProperties: CreateIndexOptionsType[] = [ | |||
| 'deletionProtection', | |||
| 'waitUntilReady', | |||
| 'suppressConflicts', | |||
| 'tags', | |||
There was a problem hiding this comment.
Would it be worth adding any createIndex unit test coverage for this? I know you're integration testing as well, so maybe not.
aulorbe
changed the title
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
This is a late addition to the current version of our client to incorporate Index Tags, as introduced in the
2024-10spec.Once merged, this will be a
minorrelease of the current version.Note: This PR also contains some generated code that was added into the
2024-10spec after the latest code gen onmain.Type of Change
Test Plan
CI passes w/new tests and additions to old tests.