Add /rerank and /import sections to README #82
Conversation
README.md
Outdated
|
|
||
| if err != nil { | ||
| log.Fatalf("Failed to create Client: %v", err) | ||
| } else { |
There was a problem hiding this comment.
nit: Let's drop the else here, I'd like to cut down on some of the verbosity in our Go documentation and stuff like this isn't really necessary.
I don't think we need the success messages for any of the errors below either.
|
|
||
| errorMode := "abort" // Will abort if error encountered; other option: "continue" | ||
|
|
||
| importRes, err := idxConnection.StartImport(ctx, storageURI, nil, (*pinecone.ImportErrorMode)(&errorMode)) |
There was a problem hiding this comment.
The need to cast this errorMode pointer feels messy. I think updating the argument type so it's a bit easier to work with would be good.
You don't need to do anything here, and this is fine and accurate for now. Just made me realize - I added a ticket.
|
|
||
| pc, err := pinecone.NewClient(pinecone.NewClientParams{ | ||
| ApiKey: "YOUR-API-KEY" | ||
| }) |
There was a problem hiding this comment.
nit: Indentation may be off here.
There was a problem hiding this comment.
It looks good on my screen; it's aligned with pc. What are you seeing?
There was a problem hiding this comment.
I think it's just gh formatting, nevermind.
## Problem In anticipation of the upcoming major release, we need to update the Go README to incorporate sections for `rerank` and `import`. ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] 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) - [x] Non-code change (docs, etc) - [ ] None of the above: (explain here)
Problem
In anticipation of the upcoming major release, we need to update the Go README to incorporate sections for
rerankandimport.Type of Change