[spruce] Regenerate OpenAPI core, update query and fetch to return usage / readUnits #183
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
austin-denoble
changed the title
haruska
approved these changes
Jan 11, 2024
austin-denoble
force-pushed
the
adenoble/regenerate-openapi-core
branch
from
ca8bea5 to
d0a6210
Compare
austin-denoble
added a commit
that referenced
this pull request
Jan 13, 2024
…age / readUnits (#183) ## Problem The backend is now support `readUnits` in responses for the `query` and `fetch` operations. We've updated the `vector_service.proto` file to include the new response shapes, and this needs to be pulled into the clients: pinecone-io/pinecone-protos#105 ## Solution - Regenerate `pinecone-generated-ts-fetch` core and drop it in. This includes @haruska's updates to our tags, thus the renaming of `ManagePodIndexesApi` -> `ManageIndexesApi`. - Add new `OperationUsage` type to `/src/data/types.ts` (open to changing the name `OperationUsage`). - Update our custom types for `QueryResponse` and `FetchResponse` to include `usage`. ## Type of Change - [X] New feature (non-breaking change which adds functionality) - [X] This change requires a documentation update ## Test Plan You will need to call either `fetch()` or `query()` and validate the field is returned in the response. ``` await client.index('test-dim-2').fetch(['1', '2']) // { // records: { // '1': { // id: '1', // values: [Array], // sparseValues: undefined, // metadata: undefined // }, // '2': { // id: '2', // values: [Array], // sparseValues: undefined, // metadata: undefined // } // }, // namespace: '', // usage: { readUnits: 1 } // } await client.index('test-dim-2').query({ vector: [0.2, 0.3], topK: 5, includeValues: true }) // { // matches: [ // { // id: '1', // score: 1.00242746, // values: [Array], // sparseValues: undefined, // metadata: undefined // }, // { // id: '2', // score: 1.00034547, // values: [Array], // sparseValues: undefined, // metadata: undefined // } // ], // namespace: '', // usage: { readUnits: 5 } // } ```
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
The backend is now support
readUnitsin responses for thequeryandfetchoperations. We've updated thevector_service.protofile to include the new response shapes, and this needs to be pulled into the clients: https://github.com/pinecone-io/pinecone-protos/pull/105Solution
pinecone-generated-ts-fetchcore and drop it in. This includes @haruska's updates to our tags, thus the renaming ofManagePodIndexesApi->ManageIndexesApi.OperationUsagetype to/src/data/types.ts(open to changing the nameOperationUsage).QueryResponseandFetchResponseto includeusage.Type of Change
Test Plan
You will need to call either
fetch()orquery()and validate the field is returned in the response.