Generate code based on 2024-10 api spec #158
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
rohanshah18
commented
Oct 18, 2024
| @@ -3,7 +3,7 @@ | |||
| set -eux -o pipefail | |||
|
|
|||
| version=$1 # e.g. 2024-07 | |||
| modules=("control") | |||
| modules=("db_control" "db_data" "inference") | |||
There was a problem hiding this comment.
- replaced control with db_control
- added db_data for bulk import (actual feature is going to be a part of the next PR).
- added inference which is now broken out of control plane
rohanshah18
commented
Oct 18, 2024
| @@ -5,7 +5,7 @@ | |||
| import io.pinecone.clients.Pinecone; | |||
| import io.pinecone.exceptions.PineconeException; | |||
| import io.pinecone.proto.DescribeIndexStatsResponse; | |||
| import org.openapitools.control.client.model.*; | |||
| import org.openapitools.db_control.client.model.*; | |||
There was a problem hiding this comment.
example of updating import statement since db_ is now appended to control and data modules.
rohanshah18
commented
Oct 18, 2024
| import org.openapitools.control.client.model.EmbeddingsList; | ||
| import io.pinecone.configs.PineconeConfig; | ||
| import okhttp3.OkHttpClient; | ||
| import org.openapitools.inference.client.ApiClient; |
There was a problem hiding this comment.
example of updating import statement since inference is broken out of control module
rohanshah18
commented
Oct 18, 2024
| @@ -1033,14 +1033,14 @@ public Builder withProxy(String proxyHost, int proxyPort) { | |||
| * @return A new {@link Pinecone} instance configured based on the builder parameters. | |||
| */ | |||
| public Pinecone build() { | |||
| PineconeConfig config = new PineconeConfig(apiKey, sourceTag, proxyConfig); | |||
| PineconeConfig config = new PineconeConfig(apiKey, sourceTag, proxyConfig, customOkHttpClient); | |||
There was a problem hiding this comment.
customOkHttpClient being passed to the PineconeConfig constructor at the time of initializing PineconeConfig in Pinecone class
rohanshah18
commented
Oct 18, 2024
| } | ||
|
|
||
| /** | ||
| * Constructs a {@link PineconeConfig} instance with the specified API key, source tag, control plane proxy | ||
| * configuration, and data plane proxy configuration. | ||
| * Constructs a {@link PineconeConfig} instance with the specified API key, source tag, a HTTP proxy configuration, |
There was a problem hiding this comment.
customOkHttpClient is now a member of PineconeConfig. It makes a lot of sense since gRPC custom channel is already a part of this config class.
rohanshah18
requested review from
jhamon,
aulorbe,
austin-denoble and
ssmith-pc
ssmith-pc
approved these changes
Oct 18, 2024
rohanshah18
changed the base branch from
main
to
rshah/release-candidate/2024-10
rohanshah18
added a commit
that referenced
this pull request
Oct 24, 2024
## Problem Generate code based on 2024-10 api spec. ## Solution OpenAPI based code was regenerated using the 2024-10 api sec which resulted in the following changes: 1. Updated `build-oas.sh` to include all control plane, data plane, and inference modules. 2. Inference is now broken out of control plane so the underlying `inference` code generated by openAPI spec is now updated. This also resulted in instantiating a separate `ApiClient` which is a part of inference module now instead of the shared `ApiClient` class of control plane. Also as a part of this refactoring, the `customOkHttpClient` is now a part of the `PineconeConfig` class, so once the `customOkHttpClient` is set by the user at the time of instantiating `Pinecone` using its builder class, it'll be stored in the `PineconeConfig` instance which can further be leveraged by the `Inference` api calls as well. 3. Control and data plane modules are now prepended with `db_` so this resulted in updating import statements for a lot of existing classes. ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [X] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [ ] Non-code change (docs, etc) - [ ] None of the above: (explain here) ## Test Plan Since no new functionality is added, the existing integration tests should run fine.
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
Generate code based on 2024-10 api spec.
Solution
OpenAPI based code was regenerated using the 2024-10 api sec which resulted in the following changes:
build-oas.shto include all control plane, data plane, and inference modules.inferencecode generated by openAPI spec is now updated. This also resulted in instantiating a separateApiClientwhich is a part of inference module now instead of the sharedApiClientclass of control plane. Also as a part of this refactoring, thecustomOkHttpClientis now a part of thePineconeConfigclass, so once thecustomOkHttpClientis set by the user at the time of instantiatingPineconeusing its builder class, it'll be stored in thePineconeConfiginstance which can further be leveraged by theInferenceapi calls as well.db_so this resulted in updating import statements for a lot of existing classes.Type of Change
Test Plan
Since no new functionality is added, the existing integration tests should run fine.