forked from amikos-tech/chroma-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathchroma.go
795 lines (726 loc) · 24.8 KB
/
chroma.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
package chromago
import (
"context"
"crypto/tls"
"crypto/x509"
"fmt"
"net/http"
"net/url"
"os"
"reflect"
"strings"
"github.com/Masterminds/semver" //nolint:gci
"github.com/szirtesitidom/chroma-go/collection"
openapiclient "github.com/szirtesitidom/chroma-go/swagger"
"github.com/szirtesitidom/chroma-go/types"
)
type ClientConfiguration struct {
BasePath string `json:"basePath,omitempty"`
DefaultHeaders map[string]string `json:"defaultHeader,omitempty"`
EmbeddingFunction types.EmbeddingFunction `json:"embeddingFunction,omitempty"`
}
func APIEmbeddingToEmbedding(embedding openapiclient.EmbeddingsInner) *types.Embedding {
switch {
case embedding.ArrayOfInt32 != nil:
return types.NewEmbeddingFromInt32(*embedding.ArrayOfInt32)
case embedding.ArrayOfFloat32 != nil:
return types.NewEmbeddingFromFloat32(*embedding.ArrayOfFloat32)
default:
return &types.Embedding{}
}
}
func APIEmbeddingsToEmbeddings(embeddings []openapiclient.EmbeddingsInner) []*types.Embedding {
result := make([]*types.Embedding, 0)
for _, v := range embeddings {
result = append(result, APIEmbeddingToEmbedding(v))
}
return result
}
// Client represents the ChromaDB Client
type Client struct {
ApiClient *openapiclient.APIClient //nolint
Tenant string
Database string
APIVersion semver.Version
preFlightConfig map[string]interface{}
preFlightCompleted bool
apiConfiguration *openapiclient.Configuration
httpTransport *http.Transport
userHTTPClient *http.Client
BasePath string
}
type ClientOption func(p *Client) error
func WithTenant(tenant string) ClientOption {
return func(c *Client) error {
// TODO validate here?
c.Tenant = tenant
return nil
}
}
// WithBasePath sets the base path for the client. The base path must be a valid URL.
func WithBasePath(basePath string) ClientOption {
return func(c *Client) error {
if basePath == "" {
return fmt.Errorf("basePath cannot be empty")
}
if _, err := url.ParseRequestURI(basePath); err != nil {
return fmt.Errorf("invalid basePath URL: %s", err)
}
c.BasePath = basePath
return nil
}
}
func WithDatabase(database string) ClientOption {
return func(c *Client) error {
// TODO validate here?
c.Database = database
return nil
}
}
func WithDebug(debug bool) ClientOption {
return func(c *Client) error {
if c.apiConfiguration == nil {
c.apiConfiguration = openapiclient.NewConfiguration()
}
c.apiConfiguration.Debug = debug
return nil
}
}
func WithDefaultHeaders(headers map[string]string) ClientOption {
return func(c *Client) error {
if c.apiConfiguration == nil {
c.apiConfiguration = openapiclient.NewConfiguration()
}
c.apiConfiguration.DefaultHeader = headers
return nil
}
}
func WithAuth(provider types.CredentialsProvider) ClientOption {
return func(c *Client) error {
if c == nil {
return fmt.Errorf("client is nil")
}
if c.apiConfiguration == nil {
return fmt.Errorf("api configuration is nil")
}
return provider.Authenticate(c.apiConfiguration)
}
}
// WithSSLCert adds a custom SSL certificate to the client. The certificate must be in PEM format. The Option can be added multiple times to add multiple certificates. The option is mutually exclusive with WithHttpClient.
func WithSSLCert(certPath string) ClientOption {
return func(c *Client) error {
if _, err := os.Stat(certPath); certPath == "" || err != nil {
return fmt.Errorf("invalid cert path %v", err)
}
if c.httpTransport == nil {
c.httpTransport = &http.Transport{}
}
cert, err := os.ReadFile(certPath)
if err != nil {
return err
}
// Create or reuse existing a certificate pool and add the custom certificate
var certPool *x509.CertPool
switch {
case c.httpTransport.TLSClientConfig == nil:
c.httpTransport.TLSClientConfig = &tls.Config{}
certPool = x509.NewCertPool()
c.httpTransport.TLSClientConfig.RootCAs = certPool
case c.httpTransport.TLSClientConfig.RootCAs == nil:
certPool = x509.NewCertPool()
c.httpTransport.TLSClientConfig.RootCAs = certPool
default:
certPool = c.httpTransport.TLSClientConfig.RootCAs
}
if ok := certPool.AppendCertsFromPEM(cert); !ok {
return fmt.Errorf("failed to append cert to pool")
}
c.httpTransport.TLSClientConfig.RootCAs = certPool
return nil
}
}
// WithInsecure disables SSL certificate verification. This option is not recommended for production use. The option is mutually exclusive with WithHttpClient.
func WithInsecure() ClientOption {
return func(c *Client) error {
if c.httpTransport == nil {
c.httpTransport = &http.Transport{}
}
if c.httpTransport.TLSClientConfig == nil {
c.httpTransport.TLSClientConfig = &tls.Config{
InsecureSkipVerify: true,
}
} else {
c.httpTransport.TLSClientConfig.InsecureSkipVerify = true
}
return nil
}
}
// WithHTTPClient sets a custom http.Client for the client. The option is mutually exclusive with WithSSLCert and WithIgnoreSSLCert.
func WithHTTPClient(client *http.Client) ClientOption {
return func(c *Client) error {
if client == nil {
return fmt.Errorf("client cannot be nil")
}
c.userHTTPClient = client
return nil
}
}
func applyOptions(c *Client, options ...ClientOption) error {
for _, opt := range options {
if err := opt(c); err != nil {
return err
}
}
return nil
}
func NewClient(options ...ClientOption) (*Client, error) {
c := &Client{
Tenant: types.DefaultTenant,
Database: types.DefaultDatabase,
apiConfiguration: openapiclient.NewConfiguration(),
httpTransport: &http.Transport{TLSClientConfig: &tls.Config{}},
BasePath: "http://localhost:8000",
}
err := applyOptions(c, options...)
if err != nil {
return nil, err
}
c.apiConfiguration.Servers = openapiclient.ServerConfigurations{
{
URL: c.BasePath,
Description: "No description provided",
},
}
if c.userHTTPClient != nil {
c.apiConfiguration.HTTPClient = c.userHTTPClient
} else {
c.apiConfiguration.HTTPClient = &http.Client{
Transport: c.httpTransport,
}
}
c.ApiClient = openapiclient.NewAPIClient(c.apiConfiguration)
return c, nil
}
func (c *Client) SetTenant(tenant string) {
c.Tenant = tenant
}
func (c *Client) SetDatabase(database string) {
c.Database = database
}
func (c *Client) preFlightChecks(ctx context.Context) error {
if c.preFlightCompleted {
return nil
}
_version, _, err := c.ApiClient.DefaultApi.Version(ctx).Execute()
if err != nil {
return err
}
version, err := semver.NewVersion(strings.ReplaceAll(_version, `"`, ""))
if err != nil {
return err
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
c.APIVersion = *version
multiTenantAPIVersion, _ := semver.NewConstraint(">=0.4.15")
if multiTenantAPIVersion.Check(&c.APIVersion) {
_, err := c.GetTenant(ctx, c.Tenant)
if err != nil {
return err
}
_, err = c.GetDatabase(ctx, c.Database, &c.Tenant)
if err != nil {
return err
}
preFlightCfg, err := c.PreflightChecks(ctx)
if err != nil {
return err
}
c.preFlightConfig = preFlightCfg
}
c.preFlightCompleted = true
return nil
}
func (c *Client) GetCollection(ctx context.Context, collectionName string, embeddingFunction types.EmbeddingFunction) (*Collection, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
err := c.preFlightChecks(ctx)
if err != nil {
return nil, err
}
tenantName := types.DefaultTenant
databaseName := types.DefaultDatabase
col, httpResp, err := c.ApiClient.DefaultApi.GetCollection(ctx, collectionName).Tenant(c.Tenant).Database(c.Database).Execute()
if err != nil {
return nil, err
}
if httpResp.StatusCode != 200 {
return nil, fmt.Errorf("error getting collection: %v", httpResp)
}
return NewCollection(c.ApiClient, col.Id, col.Name, getMetadataFromAPI(col.Metadata), embeddingFunction, tenantName, databaseName), nil
}
func (c *Client) Heartbeat(ctx context.Context) (map[string]float32, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.Heartbeat(ctx).Execute()
return resp, err
}
func GetStringTypeOfEmbeddingFunction(ef types.EmbeddingFunction) string {
if ef == nil {
return ""
}
typ := reflect.TypeOf(ef)
if typ.Kind() == reflect.Ptr {
typ = typ.Elem() // Dereference if it's a pointer
}
return typ.String()
}
func (c *Client) CreateTenant(ctx context.Context, tenantName string) (*openapiclient.Tenant, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.CreateTenant(ctx).CreateTenant(openapiclient.CreateTenant{Name: tenantName}).Execute()
return resp, err
}
func (c *Client) GetTenant(ctx context.Context, tenantName string) (*openapiclient.Tenant, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.GetTenant(ctx, tenantName).Execute()
return resp, err
}
func (c *Client) CreateDatabase(ctx context.Context, databaseName string, tenantName *string) (*openapiclient.Database, error) {
if tenantName == nil {
tenantName = &c.Tenant
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.CreateDatabase(ctx).Tenant(*tenantName).CreateDatabase(openapiclient.CreateDatabase{Name: databaseName}).Execute()
return resp, err
}
func (c *Client) GetDatabase(ctx context.Context, databaseName string, tenantName *string) (*openapiclient.Database, error) {
if tenantName == nil {
tenantName = &c.Tenant
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.GetDatabase(ctx, databaseName).Tenant(*tenantName).Execute()
return resp, err
}
// copyMap returns a new map with the same key-value pairs as the original map, if the original is nil then returns a new empty map
func copyMap(originalMap map[string]interface{}) map[string]interface{} {
newMap := make(map[string]interface{})
if originalMap == nil {
return newMap
}
for key, value := range originalMap {
newMap[key] = value
}
return newMap
}
func (c *Client) CreateCollection(ctx context.Context, collectionName string, metadata map[string]interface{}, createOrGet bool, embeddingFunction types.EmbeddingFunction, distanceFunction types.DistanceFunction) (*Collection, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
err := c.preFlightChecks(ctx)
if err != nil {
return nil, err
}
var _metadata = copyMap(metadata)
if metadata["embedding_function"] == nil && embeddingFunction != nil {
_metadata["embedding_function"] = GetStringTypeOfEmbeddingFunction(embeddingFunction)
}
if distanceFunction == "" {
_metadata[types.HNSWSpace] = strings.ToLower(string(types.L2))
} else {
_metadata[types.HNSWSpace] = strings.ToLower(string(distanceFunction))
}
col := openapiclient.CreateCollection{
Name: collectionName,
GetOrCreate: &createOrGet,
Metadata: _metadata,
}
resp, _, err := c.ApiClient.DefaultApi.CreateCollection(ctx).CreateCollection(col).Execute()
if err != nil {
return nil, err
}
mtd := resp.Metadata
return NewCollection(c.ApiClient, resp.Id, resp.Name, getMetadataFromAPI(mtd), embeddingFunction, c.Tenant, c.Database), nil
}
func (c *Client) NewCollection(ctx context.Context, name string, options ...collection.Option) (*Collection, error) {
b := &collection.Builder{Metadata: make(map[string]interface{})}
for _, option := range options {
if err := option(b); err != nil {
return nil, err
}
}
if name == "" {
return nil, fmt.Errorf("collection name cannot be empty")
}
b.Name = name
var distanceFunction types.DistanceFunction
if df := b.Metadata[types.HNSWSpace]; df == nil {
b.Metadata[types.HNSWSpace] = types.L2
} else {
var derr error
distanceFunction, derr = types.ToDistanceFunction(df)
if derr != nil {
return nil, derr
}
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
return c.CreateCollection(ctx, b.Name, b.Metadata, b.CreateIfNotExist, b.EmbeddingFunction, distanceFunction)
}
func (c *Client) DeleteCollection(ctx context.Context, collectionName string) (*Collection, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
err := c.preFlightChecks(ctx)
if err != nil {
return nil, err
}
col, _, gcerr := c.ApiClient.DefaultApi.GetCollection(ctx, collectionName).Execute()
if gcerr != nil {
return nil, gcerr
}
deletedCol, _, err := c.ApiClient.DefaultApi.DeleteCollection(ctx, collectionName).Execute()
if err != nil {
return nil, err
}
if deletedCol == nil {
return NewCollection(c.ApiClient, col.Id, col.Name, getMetadataFromAPI(col.Metadata), nil, c.Tenant, c.Database), nil
} else {
return NewCollection(c.ApiClient, deletedCol.Id, deletedCol.Name, getMetadataFromAPI(deletedCol.Metadata), nil, c.Tenant, c.Database), nil
}
}
func (c *Client) Reset(ctx context.Context) (bool, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.Reset(ctx).Execute()
return resp, err
}
func (c *Client) ListCollections(ctx context.Context) ([]*Collection, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
err := c.preFlightChecks(ctx)
if err != nil {
return nil, err
}
req := c.ApiClient.DefaultApi.ListCollections(ctx)
resp, _, err := req.Execute()
if err != nil {
return nil, err
}
collections := make([]*Collection, len(resp))
for i, col := range resp {
collections[i] = NewCollection(c.ApiClient, col.Id, col.Name, getMetadataFromAPI(col.Metadata), nil, c.Tenant, c.Database)
}
return collections, nil
}
func (c *Client) CountCollections(ctx context.Context) (int32, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
err := c.preFlightChecks(ctx)
if err != nil {
return -1, err
}
resp, _, err := c.ApiClient.DefaultApi.CountCollections(ctx).Tenant(c.Tenant).Database(c.Database).Execute()
return resp, err
}
func (c *Client) PreflightChecks(ctx context.Context) (map[string]interface{}, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.PreFlightChecks(ctx).Execute()
return resp, err
}
func (c *Client) Version(ctx context.Context) (string, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
resp, _, err := c.ApiClient.DefaultApi.Version(ctx).Execute()
version := strings.ReplaceAll(resp, `"`, "")
return version, err
}
type GetResults struct {
Ids []string
Documents []string
Metadatas []map[string]interface{}
Embeddings []*types.Embedding
}
type Collection struct {
Name string
EmbeddingFunction types.EmbeddingFunction
ApiClient *openapiclient.APIClient //nolint
Metadata map[string]interface{}
ID string
Tenant string
Database string
}
func (c *Collection) String() string {
return fmt.Sprintf("Collection{ Name: %s, ID: %s, Tenant: %s, Database: %s, Metadata: %v }",
c.Name, c.ID, c.Tenant, c.Database, c.Metadata)
}
func NewCollection(apiClient *openapiclient.APIClient, id string, name string, metadata *map[string]interface{}, embeddingFunction types.EmbeddingFunction, tenant string, database string) *Collection {
_metadata := make(map[string]interface{})
if metadata != nil {
_metadata = *metadata
}
return &Collection{
Name: name,
EmbeddingFunction: embeddingFunction,
ApiClient: apiClient,
Metadata: _metadata,
ID: id,
Tenant: tenant,
Database: database,
}
}
func (c *Collection) Add(ctx context.Context, embeddings []*types.Embedding, metadatas []map[string]interface{}, documents []string, ids []string) (*Collection, error) {
var _embeddings []openapiclient.EmbeddingsInner
if len(ids) != len(documents) && len(documents) != len(metadatas) {
return c, fmt.Errorf("ids and embeddings must have the same length")
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
if len(embeddings) == 0 {
embds, embErr := c.EmbeddingFunction.EmbedDocuments(ctx, documents)
if embErr != nil {
return c, embErr
}
_embeddings = types.ToAPIEmbeddings(embds)
} else {
_embeddings = types.ToAPIEmbeddings(embeddings)
}
if len(ids) == 0 {
return c, fmt.Errorf("ids cannot be empty")
}
var addEmbedding = openapiclient.AddEmbedding{
Embeddings: _embeddings,
Metadatas: metadatas,
Documents: documents,
Ids: ids,
}
_, _, err := c.ApiClient.DefaultApi.Add(ctx, c.ID).AddEmbedding(addEmbedding).Execute()
if err != nil {
return c, err
}
return c, nil
}
func (c *Collection) AddRecords(ctx context.Context, recordSet *types.RecordSet) (*Collection, error) {
return c.Add(ctx, recordSet.GetEmbeddings(), recordSet.GetMetadatas(), recordSet.GetDocuments(), recordSet.GetIDs())
}
func (c *Collection) Upsert(ctx context.Context, embeddings []*types.Embedding, metadatas []map[string]interface{}, documents []string, ids []string) (*Collection, error) {
var _embeddings []openapiclient.EmbeddingsInner
if len(ids) != len(documents) && len(documents) != len(metadatas) {
return c, fmt.Errorf("ids and embeddings must have the same length")
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
if len(embeddings) == 0 {
embds, embErr := c.EmbeddingFunction.EmbedDocuments(ctx, documents)
if embErr != nil {
return c, embErr
}
_embeddings = types.ToAPIEmbeddings(embds)
} else {
_embeddings = types.ToAPIEmbeddings(embeddings)
}
if len(ids) == 0 {
return c, fmt.Errorf("ids cannot be empty")
}
var addEmbedding = openapiclient.AddEmbedding{
Embeddings: _embeddings,
Metadatas: metadatas,
Documents: documents,
Ids: ids,
}
_, _, err := c.ApiClient.DefaultApi.Upsert(ctx, c.ID).AddEmbedding(addEmbedding).Execute()
if err != nil {
return c, err
}
return c, nil
}
func (c *Collection) Modify(ctx context.Context, embeddings []*types.Embedding, metadatas []map[string]interface{}, documents []string, ids []string) (*Collection, error) {
var _embeddings []openapiclient.EmbeddingsInner
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
if len(embeddings) == 0 {
embds, embErr := c.EmbeddingFunction.EmbedDocuments(ctx, documents)
if embErr != nil {
return c, embErr
}
_embeddings = types.ToAPIEmbeddings(embds)
} else {
_embeddings = types.ToAPIEmbeddings(embeddings)
}
var updateEmbedding = openapiclient.UpdateEmbedding{
Embeddings: _embeddings,
Metadatas: metadatas,
Documents: documents,
Ids: ids,
}
_, _, err := c.ApiClient.DefaultApi.Update(ctx, c.ID).UpdateEmbedding(updateEmbedding).Execute()
if err != nil {
return c, err
}
return c, nil
}
func (c *Collection) GetWithOptions(ctx context.Context, options ...types.CollectionQueryOption) (*GetResults, error) {
query := &types.CollectionQueryBuilder{}
for _, opt := range options {
err := opt(query)
if err != nil {
return nil, err
}
}
if query.Include == nil {
query.Include = []types.QueryEnum{types.IDocuments, types.IMetadatas}
}
inc := make([]openapiclient.IncludeInner, len(query.Include))
for i, v := range query.Include {
_v := string(v)
inc[i] = openapiclient.IncludeInner{
String: &_v,
}
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
cd, _, err := c.ApiClient.DefaultApi.Get(ctx, c.ID).GetEmbedding(openapiclient.GetEmbedding{
Ids: query.Ids,
Where: query.Where,
WhereDocument: query.WhereDocument,
Include: inc,
Limit: &query.Limit,
Offset: &query.Offset,
}).Execute()
if err != nil {
return nil, err
}
results := &GetResults{
Ids: cd.Ids,
Documents: cd.Documents,
Metadatas: cd.Metadatas,
Embeddings: APIEmbeddingsToEmbeddings(cd.Embeddings),
}
return results, nil
}
func (c *Collection) Get(ctx context.Context, where map[string]interface{}, whereDocuments map[string]interface{}, ids []string, include []types.QueryEnum) (*GetResults, error) {
return c.GetWithOptions(ctx, types.WithWhereMap(where), types.WithWhereDocumentMap(whereDocuments), types.WithIds(ids), types.WithInclude(include...))
}
type QueryResults struct {
Documents [][]string `json:"documents,omitempty"`
Ids [][]string `json:"ids,omitempty"`
Metadatas [][]map[string]interface{} `json:"metadatas,omitempty"`
Distances [][]float32 `json:"distances,omitempty"`
QueryTexts []string
QueryEmbeddings []*types.Embedding
QueryTextsGeneratedEmbeddings []*types.Embedding // the generated embeddings from the query texts
}
func getMetadataFromAPI(metadata *map[string]openapiclient.Metadata) *map[string]interface{} {
if metadata == nil {
return nil
}
result := make(map[string]interface{})
for key, value := range *metadata {
switch {
case value.String != nil:
result[key] = *value.String
case value.Bool != nil:
result[key] = *value.Bool
case value.Float32 != nil:
result[key] = *value.Float32
case value.Int32 != nil:
result[key] = *value.Int32
}
}
return &result
}
func (c *Collection) Query(ctx context.Context, queryTexts []string, nResults int32, where map[string]interface{}, whereDocuments map[string]interface{}, include []types.QueryEnum) (*QueryResults, error) {
return c.QueryWithOptions(ctx, types.WithQueryTexts(queryTexts), types.WithNResults(nResults), types.WithWhereMap(where), types.WithWhereDocumentMap(whereDocuments), types.WithInclude(include...))
}
func (c *Collection) QueryWithOptions(ctx context.Context, queryOptions ...types.CollectionQueryOption) (*QueryResults, error) {
b := &types.CollectionQueryBuilder{
QueryTexts: make([]string, 0),
QueryEmbeddings: make([]*types.Embedding, 0),
Where: make(map[string]interface{}),
WhereDocument: make(map[string]interface{}),
}
for _, opt := range queryOptions {
if err := opt(b); err != nil {
return nil, err
}
}
var localInclude = b.Include
if len(b.Include) == 0 {
localInclude = []types.QueryEnum{types.IDocuments, types.IMetadatas, types.IDistances}
}
_includes := make([]openapiclient.IncludeInner, len(localInclude))
for i, v := range localInclude {
_v := string(v)
_includes[i] = openapiclient.IncludeInner{
String: &_v,
}
}
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
if len(b.QueryEmbeddings) == 0 && c.EmbeddingFunction == nil {
return nil, fmt.Errorf("embedding function is not set. Please configure the embedding function when you get or create the collection, or provide the query embeddings")
}
embds, embErr := c.EmbeddingFunction.EmbedDocuments(ctx, b.QueryTexts)
if embErr != nil {
return nil, embErr
}
var queryEmbeds = make([]openapiclient.EmbeddingsInner, 0)
queryEmbeds = append(queryEmbeds, types.ToAPIEmbeddings(b.QueryEmbeddings)...)
queryEmbeds = append(queryEmbeds, types.ToAPIEmbeddings(embds)...)
qr, _, err := c.ApiClient.DefaultApi.GetNearestNeighbors(ctx, c.ID).QueryEmbedding(openapiclient.QueryEmbedding{
Where: b.Where,
WhereDocument: b.WhereDocument,
NResults: &b.NResults,
Include: _includes,
QueryEmbeddings: queryEmbeds,
}).Execute()
if err != nil {
return nil, err
}
qresults := QueryResults{
Documents: qr.Documents,
Ids: qr.Ids,
Metadatas: qr.Metadatas,
Distances: qr.Distances,
QueryTexts: b.QueryTexts,
QueryEmbeddings: b.QueryEmbeddings,
QueryTextsGeneratedEmbeddings: embds,
}
return &qresults, nil
}
func (c *Collection) Count(ctx context.Context) (int32, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
req := c.ApiClient.DefaultApi.Count(ctx, c.ID)
cd, _, err := req.Execute()
if err != nil {
return -1, err
}
return cd, nil
}
func (c *Collection) Update(ctx context.Context, newName string, newMetadata *map[string]interface{}) (*Collection, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
_newMetadata := make(map[string]interface{})
if newMetadata != nil {
_newMetadata = *newMetadata
}
_, _, err := c.ApiClient.DefaultApi.UpdateCollection(ctx, c.ID).UpdateCollection(openapiclient.UpdateCollection{NewName: &newName, NewMetadata: _newMetadata}).Execute()
if err != nil {
return c, err
}
c.Name = newName
c.Metadata = _newMetadata
return c, nil
}
func (c *Collection) Delete(ctx context.Context, ids []string, where map[string]interface{}, whereDocuments map[string]interface{}) ([]string, error) {
ctx, cancel := context.WithTimeout(ctx, types.DefaultTimeout)
defer cancel()
dr, _, err := c.ApiClient.DefaultApi.Delete(ctx, c.ID).DeleteEmbedding(openapiclient.DeleteEmbedding{Where: where, WhereDocument: whereDocuments, Ids: ids}).Execute()
if err != nil {
return nil, err
}
return dr, nil
}