feat(pinecone): Add rerank task for Pinecone component #773
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
Define task in pinecone's definition.json Define inputs and outputs of component in task.json
URL is no longer required as Rerank task does not require an index
…tput response Implement required structs to parse input data to API request and parse API output to component output Introduce new client to make rerank task
…changes run campogen to update documentation with new changes
Test DetailsTested locally by creating a pinecone component's rerank task and verified data using sample input from API documentation Sample Pipeline Recipe:Input:
Component Output:
|
MubeenKodvavi
requested review from
GeorgeWilliamStrong,
donch1989,
jvallesm and
chuang8511
as code owners
… formed remove api version 2024-10 from headers as this is latest stable version now and supports rerank api by default
…client pinecone is redirecting towards oldest stable version that does not support rerank endpoint also recommended by pinecone in their documentation to specify api version in headers
chuang8511
requested changes
Oct 29, 2024
| } | ||
|
|
||
| return &rerankReq{ | ||
| Model: "bge-reranker-v2-m3", |
There was a problem hiding this comment.
Though it only provides a model now, we can make it a field with a default value.
You can refer to this.
| "instillUIOrder": 0, | ||
| "properties": { | ||
| "query": { | ||
| "description": "The query to rerank the documents", |
There was a problem hiding this comment.
Suggested change
| "description": "The query to rerank the documents", | |
| "description": "The query to rerank the documents.", |
Now, we always add period in the end for description fields.
| "type": "string" | ||
| }, | ||
| "documents": { | ||
| "description": "The documents to rerank", |
There was a problem hiding this comment.
Suggested change
| "description": "The documents to rerank", | |
| "description": "The documents to rerank.", |
| "type": "array" | ||
| }, | ||
| "top-n": { | ||
| "description": "The number of results to return sorted by relevance. Defaults to the number of inputs.\n\n", |
There was a problem hiding this comment.
Suggested change
| "description": "The number of results to return sorted by relevance. Defaults to the number of inputs.\n\n", | |
| "description": "The number of results to return sorted by relevance. Defaults to the number of inputs.", |
| "instillUIOrder": 0, | ||
| "properties": { | ||
| "documents": { | ||
| "description": "Reranked documents", |
There was a problem hiding this comment.
Suggested change
| "description": "Reranked documents", | |
| "description": "Reranked documents.", |
| "type": "string" | ||
| }, | ||
| "instillUIOrder": 0, | ||
| "title": "Reranked documents", |
There was a problem hiding this comment.
Suggested change
| "title": "Reranked documents", | |
| "title": "Reranked Documents", |
| resp := rerankResp{} | ||
| req.SetResult(&resp).SetBody(inputStruct.asRequest()) | ||
| if _, err := req.Post(rerankPath); err != nil { | ||
| job.Error.Error(ctx, httpclient.WrapURLError(err)) |
There was a problem hiding this comment.
Recently, I found the clients don't reply the meaningful error message in err when sending http request.
Could you add the errMsg like this?
There was a problem hiding this comment.
WrapURLError is a helper to add an end-user message to http transport errors.
This message is extracted in ErrorHandler interface for component job.
| @@ -145,7 +167,34 @@ func (e *execution) Execute(ctx context.Context, jobs []*base.Job) error { | |||
| job.Error.Error(ctx, err) | |||
| continue | |||
| } | |||
| case taskRerank: | |||
There was a problem hiding this comment.
It'd be good to have the test code if possible.
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.
Because
This commit