Skip to content

Commit

Permalink
v1.0.0 README tweaks (#61)
Browse files Browse the repository at this point in the history
## Problem
There's a couple minor things we want to tweak in the `README` before
releasing v1.

## Solution
- Update the `metadataMap` code in the Query by Vector Values example to
the correct syntax.
- Add a few more links to the `Support` section for the community forums
and GitHub issues.

## 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)

## Test Plan
Check out the README.
  • Loading branch information
austin-denoble authored Aug 5, 2024
1 parent 42af45b commit 3b524c0
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,6 @@ func main() {
metadataMap := map[string]interface{}{
"genre": "classical",
}

metadata, err := structpb.NewStruct(metadataMap)

sparseValues := pinecone.SparseValues{
Expand Down Expand Up @@ -633,9 +632,18 @@ func main() {

queryVector := []float32{0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3}

metadataMap := map[string]interface{}{
"genre": map[string]interface{}{
"$eq": "documentary",
},
"year": 2019,
}

metadataFilter, err := structpb.NewStruct(map[string]interface{}{
"genre": {"$eq": "documentary"},
"year": 2019,
"genre": map[string]interface{}{
"$eq": "documentary",
},
"year": 2019,
})
if err != nil {
log.Fatalf("Failed to create metadataFilter: %v", err)
Expand Down Expand Up @@ -1304,4 +1312,5 @@ func main() {

## Support

To get help using go-pinecone, reach out to [email protected].
To get help using go-pinecone you can file an issue on [GitHub](https://github.com/pinecone-io/go-pinecone/issues), visit the [community forum](https://community.pinecone.io/),
or reach out to [email protected].

0 comments on commit 3b524c0

Please sign in to comment.