Skip to content

Commit a67651a

Browse files
Update packaging for /v5/, update README.md (#126)
## Problem To bump the Go SDK to the next major version, we need to update the module packaging for `/v5/`. The `README` and a few other pieces of documentation need to be updated for the release. ## Solution - Update `go.mod` and relevant imports to move to `/v5/`. - Update `README`. Update comments. Etc. ## 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) - [X] This change requires a documentation update - [X] Infrastructure change (CI configs, etc) - [ ] Non-code change (docs, etc) - [ ] None of the above: (explain here) ## Test Plan CI - unit, integration, etc --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1211903965624968
1 parent 53c4647 commit a67651a

File tree

11 files changed

+119
-81
lines changed

11 files changed

+119
-81
lines changed

README.md

Lines changed: 56 additions & 48 deletions
Large diffs are not rendered by default.

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/pinecone-io/go-pinecone/v4
1+
module github.com/pinecone-io/go-pinecone/v5
22

33
go 1.21
44

internal/useragent/useragent.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"fmt"
55
"strings"
66

7-
"github.com/pinecone-io/go-pinecone/v4/internal"
7+
"github.com/pinecone-io/go-pinecone/v5/internal"
88
)
99

1010
func getPackageVersion() string {

justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ gen:
3939
./codegen/build-clients.sh {{api_version}}
4040

4141
docs:
42-
@echo "Serving docs at http://localhost:6060/pkg/github.com/pinecone-io/go-pinecone/v4/pinecone/"
42+
@echo "Serving docs at http://localhost:6060/pkg/github.com/pinecone-io/go-pinecone/v5/pinecone/"
4343
@godoc -http=:6060 >/dev/null

pinecone/admin_client.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ import (
1111
"os"
1212

1313
"github.com/google/uuid"
14-
"github.com/pinecone-io/go-pinecone/v4/internal/gen"
15-
"github.com/pinecone-io/go-pinecone/v4/internal/gen/admin"
16-
"github.com/pinecone-io/go-pinecone/v4/internal/provider"
17-
"github.com/pinecone-io/go-pinecone/v4/internal/useragent"
14+
"github.com/pinecone-io/go-pinecone/v5/internal/gen"
15+
"github.com/pinecone-io/go-pinecone/v5/internal/gen/admin"
16+
"github.com/pinecone-io/go-pinecone/v5/internal/provider"
17+
"github.com/pinecone-io/go-pinecone/v5/internal/useragent"
1818
)
1919

2020
// [AdminClient] provides access to Pinecone's administrative APIs, which supports

pinecone/admin_client_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"testing"
88

99
"github.com/google/uuid"
10-
"github.com/pinecone-io/go-pinecone/v4/internal/gen/admin"
10+
"github.com/pinecone-io/go-pinecone/v5/internal/gen/admin"
1111
"github.com/stretchr/testify/assert"
1212
"github.com/stretchr/testify/require"
1313
)

pinecone/client.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ import (
1515
"os"
1616
"strings"
1717

18-
"github.com/pinecone-io/go-pinecone/v4/internal/gen"
19-
"github.com/pinecone-io/go-pinecone/v4/internal/gen/db_control"
20-
db_data_rest "github.com/pinecone-io/go-pinecone/v4/internal/gen/db_data/rest"
21-
"github.com/pinecone-io/go-pinecone/v4/internal/gen/inference"
22-
"github.com/pinecone-io/go-pinecone/v4/internal/provider"
23-
"github.com/pinecone-io/go-pinecone/v4/internal/useragent"
18+
"github.com/pinecone-io/go-pinecone/v5/internal/gen"
19+
"github.com/pinecone-io/go-pinecone/v5/internal/gen/db_control"
20+
db_data_rest "github.com/pinecone-io/go-pinecone/v5/internal/gen/db_data/rest"
21+
"github.com/pinecone-io/go-pinecone/v5/internal/gen/inference"
22+
"github.com/pinecone-io/go-pinecone/v5/internal/provider"
23+
"github.com/pinecone-io/go-pinecone/v5/internal/useragent"
2424
"google.golang.org/grpc"
2525
)
2626

pinecone/client_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ import (
1414

1515
"github.com/google/go-cmp/cmp"
1616
"github.com/google/uuid"
17-
"github.com/pinecone-io/go-pinecone/v4/internal/gen"
18-
"github.com/pinecone-io/go-pinecone/v4/internal/gen/db_control"
19-
"github.com/pinecone-io/go-pinecone/v4/internal/provider"
20-
"github.com/pinecone-io/go-pinecone/v4/internal/utils"
17+
"github.com/pinecone-io/go-pinecone/v5/internal/gen"
18+
"github.com/pinecone-io/go-pinecone/v5/internal/gen/db_control"
19+
"github.com/pinecone-io/go-pinecone/v5/internal/provider"
20+
"github.com/pinecone-io/go-pinecone/v5/internal/utils"
2121

2222
"github.com/stretchr/testify/assert"
2323
"github.com/stretchr/testify/require"

pinecone/index_connection.go

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ import (
1212
"net/url"
1313
"strings"
1414

15-
"github.com/pinecone-io/go-pinecone/v4/internal/gen"
16-
db_data_grpc "github.com/pinecone-io/go-pinecone/v4/internal/gen/db_data/grpc"
17-
db_data_rest "github.com/pinecone-io/go-pinecone/v4/internal/gen/db_data/rest"
18-
"github.com/pinecone-io/go-pinecone/v4/internal/useragent"
15+
"github.com/pinecone-io/go-pinecone/v5/internal/gen"
16+
db_data_grpc "github.com/pinecone-io/go-pinecone/v5/internal/gen/db_data/grpc"
17+
db_data_rest "github.com/pinecone-io/go-pinecone/v5/internal/gen/db_data/rest"
18+
"github.com/pinecone-io/go-pinecone/v5/internal/useragent"
1919
"google.golang.org/grpc"
2020
"google.golang.org/grpc/credentials"
2121
"google.golang.org/grpc/credentials/insecure"
@@ -1203,6 +1203,18 @@ func (idx *IndexConnection) SearchRecords(ctx context.Context, in *SearchRecords
12031203
}
12041204
}
12051205

1206+
var matchTerms *db_data_rest.SearchMatchTerms
1207+
if in.Query.MatchTerms != nil {
1208+
strat := "all"
1209+
if in.Query.MatchTerms.Strategy != nil {
1210+
strat = *in.Query.MatchTerms.Strategy
1211+
}
1212+
matchTerms = &db_data_rest.SearchMatchTerms{
1213+
Strategy: &strat,
1214+
Terms: in.Query.MatchTerms.Terms,
1215+
}
1216+
}
1217+
12061218
req := db_data_rest.SearchRecordsRequest{
12071219
Fields: in.Fields,
12081220
Query: struct {
@@ -1213,10 +1225,11 @@ func (idx *IndexConnection) SearchRecords(ctx context.Context, in *SearchRecords
12131225
TopK int32 `json:"top_k"`
12141226
Vector *db_data_rest.SearchRecordsVector `json:"vector,omitempty"`
12151227
}{
1216-
Filter: in.Query.Filter,
1217-
Id: in.Query.Id,
1218-
TopK: in.Query.TopK,
1219-
Vector: convertedVector,
1228+
Filter: in.Query.Filter,
1229+
Id: in.Query.Id,
1230+
TopK: in.Query.TopK,
1231+
Vector: convertedVector,
1232+
MatchTerms: matchTerms,
12201233
},
12211234
}
12221235

pinecone/index_connection_test.go

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ import (
77
"testing"
88

99
"github.com/google/go-cmp/cmp"
10-
db_data_grpc "github.com/pinecone-io/go-pinecone/v4/internal/gen/db_data/grpc"
11-
"github.com/pinecone-io/go-pinecone/v4/internal/utils"
10+
db_data_grpc "github.com/pinecone-io/go-pinecone/v5/internal/gen/db_data/grpc"
11+
"github.com/pinecone-io/go-pinecone/v5/internal/utils"
1212
"google.golang.org/grpc"
1313
"google.golang.org/grpc/metadata"
1414
"google.golang.org/protobuf/types/known/structpb"
@@ -148,6 +148,8 @@ func (ts *integrationTests) TestDescribeIndexStats() {
148148
assert.NotNil(ts.T(), res)
149149
}
150150

151+
// MetadataFilter on this operation isPods-based indexes only.
152+
// This primarily just validates passing the MetadataFilter to the method.
151153
func (ts *integrationTests) TestDescribeIndexStatsFiltered() {
152154
ctx := context.Background()
153155
res, err := ts.idxConn.DescribeIndexStatsFiltered(ctx, &MetadataFilter{})
@@ -601,6 +603,9 @@ func (ts *integrationTests) TestIntegratedInference() {
601603
Inputs: &map[string]interface{}{
602604
"text": "Disease prevention",
603605
},
606+
MatchTerms: &SearchMatchTerms{
607+
Terms: &[]string{"disease", "prevention"},
608+
},
604609
},
605610
})
606611
if err != nil {

0 commit comments

Comments
 (0)