@relevanceai/sdk 1.2.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/generated/VectorApi.js +99 -3
- package/dist-cjs/services/discovery/Dataset.js +4 -1
- package/dist-cjs/services/discovery/index.js +61 -48
- package/dist-es/generated/VectorApi.js +147 -3
- package/dist-es/services/discovery/Dataset.js +4 -1
- package/dist-es/services/discovery/index.js +81 -51
- package/dist-types/generated/VectorApi.d.ts +45 -9
- package/dist-types/generated/_VectorApiSchemaTypes.d.ts +579 -18
- package/dist-types/services/discovery/Dataset.d.ts +1 -0
- package/dist-types/services/discovery/index.d.ts +42 -9
- package/package.json +1 -1
- package/dist-cjs/generated/Discovery.js +0 -82
- package/dist-cjs/generated/Vector.js +0 -634
- package/dist-cjs/generated/_DiscoverySchemaTypes.js +0 -6
- package/dist-cjs/generated/_VectorSchemaTypes.js +0 -6
- package/dist-cjs/generated/clients.js +0 -82
- package/dist-es/generated/Discovery.js +0 -179
- package/dist-es/generated/Vector.js +0 -1007
- package/dist-es/generated/_DiscoverySchemaTypes.js +0 -5
- package/dist-es/generated/_VectorSchemaTypes.js +0 -5
- package/dist-es/generated/clients.js +0 -179
- package/dist-types/generated/Discovery.d.ts +0 -32
- package/dist-types/generated/Vector.d.ts +0 -239
- package/dist-types/generated/_DiscoverySchemaTypes.d.ts +0 -911
- package/dist-types/generated/_VectorSchemaTypes.d.ts +0 -5017
- package/dist-types/generated/clients.d.ts +0 -942
|
@@ -164,6 +164,10 @@ export interface paths {
|
|
|
164
164
|
* {'field' : 'price', 'filter_type' : 'numeric', "condition":">=", "condition_value":90}
|
|
165
165
|
* 7. **"ids"**: for filtering by document ids.
|
|
166
166
|
* {'field' : 'ids', 'filter_type' : 'ids', "condition":"==", "condition_value":["1", "10"]}
|
|
167
|
+
* 8. **"or"**: for filtering with multiple conditions
|
|
168
|
+
* {'filter_type' : 'or',
|
|
169
|
+
* "condition_value": [{'field' : 'price', 'filter_type' : 'numeric', "condition":"<=", "condition_value":90},
|
|
170
|
+
* {'field' : 'price', 'filter_type' : 'numeric', "condition":">=", "condition_value":150}]}
|
|
167
171
|
*
|
|
168
172
|
* These are the available conditions:
|
|
169
173
|
*
|
|
@@ -627,6 +631,17 @@ export interface paths {
|
|
|
627
631
|
* - "groupby" is the fields you want to split the data into. These are the available groupby types:
|
|
628
632
|
* - category" : groupby a field that is a category
|
|
629
633
|
* - numeric: groupby a field that is a numeric
|
|
634
|
+
* - wordcloud: groupby the words. You can also additionally include stop words in your aggregation
|
|
635
|
+
* if you add `remove_words` as a field.
|
|
636
|
+
*
|
|
637
|
+
* {
|
|
638
|
+
* "name": "wordcloud_research",
|
|
639
|
+
* "field": "title",
|
|
640
|
+
* "agg": "wordcloud",
|
|
641
|
+
* "remove_words": ["learning"]
|
|
642
|
+
* }
|
|
643
|
+
*
|
|
644
|
+
*
|
|
630
645
|
* - "metrics" is the fields you want to metrics you want to calculate in each of those, every aggregation includes a frequency metric. These are the available metric types:
|
|
631
646
|
* - "avg", "max", "min", "sum", "cardinality"
|
|
632
647
|
*
|
|
@@ -650,28 +665,60 @@ export interface paths {
|
|
|
650
665
|
post: operations["aggregate_v2_api_services_aggregate_aggregate_post"];
|
|
651
666
|
};
|
|
652
667
|
"/services/cluster/centroids/list": {
|
|
653
|
-
/**
|
|
668
|
+
/** Retrieves a list of cluster centroids */
|
|
654
669
|
get: operations["cluster_centroids_api_services_cluster_centroids_list_get"];
|
|
670
|
+
/** Retrieves a list of cluster centroids */
|
|
671
|
+
post: operations["cluster_centroids_api_v2_services_cluster_centroids_list_post"];
|
|
655
672
|
};
|
|
656
673
|
"/services/cluster/centroids/get": {
|
|
657
674
|
/** Retrieve the cluster centroids by IDs */
|
|
658
675
|
get: operations["cluster_centroids_get_api_services_cluster_centroids_get_get"];
|
|
676
|
+
/** Retrieve the cluster centroids by IDs */
|
|
677
|
+
post: operations["cluster_centroids_get_api_services_cluster_centroids_get_post"];
|
|
659
678
|
};
|
|
660
679
|
"/services/cluster/centroids/insert": {
|
|
661
680
|
/** Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations. */
|
|
662
|
-
post: operations["
|
|
681
|
+
post: operations["insert_cluster_centroids_2_api_services_cluster_centroids_insert_post"];
|
|
682
|
+
};
|
|
683
|
+
"/services/cluster/centroids/update": {
|
|
684
|
+
/** Update a centroid by ID */
|
|
685
|
+
post: operations["update_centroids_api_v2_services_cluster_centroids_update_post"];
|
|
686
|
+
};
|
|
687
|
+
"/services/cluster/centroids/{centroid_id}/delete": {
|
|
688
|
+
/** Delete a centroid by ID */
|
|
689
|
+
get: operations["delete_centroids_api_services_cluster_centroids__centroid_id__delete_get"];
|
|
690
|
+
/** Delete a centroid by ID */
|
|
691
|
+
post: operations["delete_centroids_api_services_cluster_centroids__centroid_id__delete_post"];
|
|
692
|
+
};
|
|
693
|
+
"/services/cluster/centroids/delete": {
|
|
694
|
+
/** Delete centroids by dataset ID, vector field and alias */
|
|
695
|
+
post: operations["cluster_centroids_delete_api_services_cluster_centroids_delete_post"];
|
|
663
696
|
};
|
|
664
697
|
"/services/cluster/centroids/documents": {
|
|
665
698
|
/** Retrieve the cluster centroids by IDs */
|
|
666
699
|
post: operations["cluster_centroids_get_api_services_cluster_centroids_documents_post"];
|
|
667
700
|
};
|
|
701
|
+
"/services/cluster/centroids/metadata": {
|
|
702
|
+
/** Retrieves metadata about a dataset. notably description, data source, etc */
|
|
703
|
+
get: operations["centroids_metadata_get_api_services_cluster_centroids_metadata_get"];
|
|
704
|
+
/** You can store the metadata about your cluster here. */
|
|
705
|
+
post: operations["centroids_metadata_post_api_v2_services_cluster_centroids_metadata_post"];
|
|
706
|
+
};
|
|
707
|
+
"/services/cluster/centroids/list_closest_to_center": {
|
|
708
|
+
/** List of documents closest from the centre. */
|
|
709
|
+
post: operations["centroids_list_closest_to_center_v2_services_cluster_centroids_list_closest_to_center_post"];
|
|
710
|
+
};
|
|
711
|
+
"/services/cluster/centroids/list_furthest_from_center": {
|
|
712
|
+
/** List of documents from from the centre */
|
|
713
|
+
post: operations["centroids_list_furthest_from_center_v2_services_cluster_centroids_list_furthest_from_center_post"];
|
|
714
|
+
};
|
|
668
715
|
"/services/cluster/aggregate": {
|
|
669
716
|
/**
|
|
670
717
|
* Takes an aggregation query and gets the aggregate of each cluster in a collection. This helps you interpret each cluster and what is in them.
|
|
671
718
|
*
|
|
672
719
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
673
720
|
*/
|
|
674
|
-
post: operations["
|
|
721
|
+
post: operations["cluster_aggregate_api_v2_services_cluster_aggregate_post"];
|
|
675
722
|
};
|
|
676
723
|
"/services/cluster/facets": {
|
|
677
724
|
/**
|
|
@@ -679,7 +726,13 @@ export interface paths {
|
|
|
679
726
|
*
|
|
680
727
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
681
728
|
*/
|
|
682
|
-
get: operations["
|
|
729
|
+
get: operations["advanced_cluster_facets_api_services_cluster_facets_get"];
|
|
730
|
+
};
|
|
731
|
+
"/services/cluster/list": {
|
|
732
|
+
/** Get a list of cluster IDs based on the relevant information */
|
|
733
|
+
get: operations["cluster_list_services_cluster_list_get"];
|
|
734
|
+
/** Get a list of cluster IDs */
|
|
735
|
+
post: operations["cluster_list_multi_services_cluster_list_post"];
|
|
683
736
|
};
|
|
684
737
|
"/services/tagger/tag": {
|
|
685
738
|
/** Tag documents or vectors. */
|
|
@@ -1345,18 +1398,143 @@ export interface components {
|
|
|
1345
1398
|
/** Similarity Metric, choose from ['cosine', 'l1', 'l2', 'dp'] */
|
|
1346
1399
|
similarity_metric?: string;
|
|
1347
1400
|
};
|
|
1348
|
-
/**
|
|
1349
|
-
|
|
1350
|
-
/**
|
|
1401
|
+
/** Adds support for multi vector field clustering */
|
|
1402
|
+
CentroidInsertBodyV2: {
|
|
1403
|
+
/** Unique name of dataset */
|
|
1351
1404
|
dataset_id: string;
|
|
1352
1405
|
/** Cluster centers with the key being the index number */
|
|
1353
1406
|
cluster_centers: {
|
|
1354
1407
|
[key: string]: unknown;
|
|
1408
|
+
}[];
|
|
1409
|
+
/** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
|
|
1410
|
+
vector_fields: unknown[];
|
|
1411
|
+
/** Include the inserted IDs in the response */
|
|
1412
|
+
include_inserted_ids?: boolean;
|
|
1413
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1414
|
+
alias?: string;
|
|
1415
|
+
};
|
|
1416
|
+
/** Base class for all abstractmodels */
|
|
1417
|
+
CentroidMetadataV2: {
|
|
1418
|
+
/** Unique name of dataset */
|
|
1419
|
+
dataset_id: string;
|
|
1420
|
+
/** Description for a metadata */
|
|
1421
|
+
metadata?: {
|
|
1422
|
+
[key: string]: unknown;
|
|
1423
|
+
};
|
|
1424
|
+
/** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
|
|
1425
|
+
vector_fields: unknown[];
|
|
1426
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1427
|
+
alias?: string;
|
|
1428
|
+
};
|
|
1429
|
+
/** Base class for all abstractmodels */
|
|
1430
|
+
CentroidUpdateBodyV2: {
|
|
1431
|
+
/** Unique name of dataset */
|
|
1432
|
+
dataset_id: string;
|
|
1433
|
+
/** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
|
|
1434
|
+
vector_fields: unknown[];
|
|
1435
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1436
|
+
alias?: string;
|
|
1437
|
+
/** ID of a centroid in a dataset. */
|
|
1438
|
+
id: string;
|
|
1439
|
+
/** A dictionary to edit and add fields to a document. */
|
|
1440
|
+
update: {
|
|
1441
|
+
[key: string]: unknown;
|
|
1355
1442
|
};
|
|
1356
|
-
|
|
1357
|
-
|
|
1443
|
+
};
|
|
1444
|
+
/** Base class for all abstractmodels */
|
|
1445
|
+
CentroidsClosestToCenterV2: {
|
|
1446
|
+
/** Unique name of dataset */
|
|
1447
|
+
dataset_id: string;
|
|
1448
|
+
/** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
|
|
1449
|
+
vector_fields: unknown[];
|
|
1450
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1451
|
+
alias?: string;
|
|
1452
|
+
/** List of cluster IDs */
|
|
1453
|
+
cluster_ids?: string[];
|
|
1454
|
+
/** Centroid vector field */
|
|
1455
|
+
centroid_vector_fields?: string[];
|
|
1456
|
+
/** Centroid vector field */
|
|
1457
|
+
centroid_vector_field?: string[];
|
|
1458
|
+
/** Fields to include in the search results, empty array/list means all fields. */
|
|
1459
|
+
select_fields?: string[];
|
|
1460
|
+
/** Used for approximate search to speed up search. The higher the number, faster the search but potentially less accurate. */
|
|
1461
|
+
approx?: number;
|
|
1462
|
+
/** Whether to sum the multiple vectors similarity search score as 1 or seperate */
|
|
1463
|
+
sum_fields?: boolean;
|
|
1464
|
+
/** Size of each page of results */
|
|
1465
|
+
page_size?: number;
|
|
1466
|
+
/** Page of the results */
|
|
1467
|
+
page?: number;
|
|
1468
|
+
/** Similarity Metric, choose from ['cosine', 'l1', 'l2', 'dp'] */
|
|
1469
|
+
similarity_metric?: string;
|
|
1470
|
+
/** Query for filtering the search results */
|
|
1471
|
+
filters?: unknown[];
|
|
1472
|
+
/** Fields to include in the facets, if [] then all */
|
|
1473
|
+
facets?: unknown[];
|
|
1474
|
+
/** Minimum score for similarity metric */
|
|
1475
|
+
min_score?: number;
|
|
1476
|
+
/** Include vectors in the search results */
|
|
1477
|
+
include_vector?: boolean;
|
|
1478
|
+
/** Include the total count of results in the search results */
|
|
1479
|
+
include_count?: boolean;
|
|
1480
|
+
/** Include facets in the search results */
|
|
1481
|
+
include_facets?: boolean;
|
|
1482
|
+
};
|
|
1483
|
+
/** Base class for all abstractmodels */
|
|
1484
|
+
CentroidsFurthestFromCenterV2: {
|
|
1485
|
+
/** Unique name of dataset */
|
|
1486
|
+
dataset_id: string;
|
|
1487
|
+
/** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
|
|
1488
|
+
vector_fields: unknown[];
|
|
1489
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1490
|
+
alias?: string;
|
|
1491
|
+
/** List of cluster IDs */
|
|
1492
|
+
cluster_ids?: string[];
|
|
1493
|
+
/** Centroid vector field */
|
|
1494
|
+
centroid_vector_field?: string[];
|
|
1495
|
+
/** Centroid vector field */
|
|
1496
|
+
centroid_vector_fields?: string[];
|
|
1497
|
+
/** Fields to include in the search results, empty array/list means all fields. */
|
|
1498
|
+
select_fields?: string[];
|
|
1499
|
+
/** Used for approximate search to speed up search. The higher the number, faster the search but potentially less accurate. */
|
|
1500
|
+
approx?: number;
|
|
1501
|
+
/** Whether to sum the multiple vectors similarity search score as 1 or seperate */
|
|
1502
|
+
sum_fields?: boolean;
|
|
1503
|
+
/** Size of each page of results */
|
|
1504
|
+
page_size?: number;
|
|
1505
|
+
/** Page of the results */
|
|
1506
|
+
page?: number;
|
|
1507
|
+
/** Similarity Metric, choose from ['cosine', 'l1', 'l2', 'dp'] */
|
|
1508
|
+
similarity_metric?: string;
|
|
1509
|
+
/** Query for filtering the search results */
|
|
1510
|
+
filters?: unknown[];
|
|
1511
|
+
/** Fields to include in the facets, if [] then all */
|
|
1512
|
+
facets?: unknown[];
|
|
1513
|
+
/** Minimum score for similarity metric */
|
|
1514
|
+
min_score?: number;
|
|
1515
|
+
/** Include vectors in the search results */
|
|
1516
|
+
include_vector?: boolean;
|
|
1517
|
+
/** Include the total count of results in the search results */
|
|
1518
|
+
include_count?: boolean;
|
|
1519
|
+
/** Include facets in the search results */
|
|
1520
|
+
include_facets?: boolean;
|
|
1521
|
+
};
|
|
1522
|
+
/** Base class for all abstractmodels */
|
|
1523
|
+
CentroidsGetV2: {
|
|
1524
|
+
/** Unique name of dataset */
|
|
1525
|
+
dataset_id: string;
|
|
1526
|
+
/** List of cluster IDs */
|
|
1527
|
+
cluster_ids: string[];
|
|
1528
|
+
/** The vector field where a clustering task was run. */
|
|
1529
|
+
vector_fields: unknown[];
|
|
1358
1530
|
/** Alias is used to name a cluster */
|
|
1359
1531
|
alias?: string;
|
|
1532
|
+
/** Size of each page of results */
|
|
1533
|
+
page_size?: number;
|
|
1534
|
+
/** Cursor to paginate the document retrieval */
|
|
1535
|
+
cursor?: string;
|
|
1536
|
+
/** Include vectors in the search results */
|
|
1537
|
+
include_vector?: boolean;
|
|
1360
1538
|
};
|
|
1361
1539
|
/** Base class for all abstractmodels */
|
|
1362
1540
|
ChunkSearchQuery: {
|
|
@@ -1407,7 +1585,7 @@ export interface components {
|
|
|
1407
1585
|
count?: number;
|
|
1408
1586
|
};
|
|
1409
1587
|
/** Base class for all abstractmodels */
|
|
1410
|
-
|
|
1588
|
+
ClusterAggregateQueryCommonsV2: {
|
|
1411
1589
|
/** Unique name of dataset */
|
|
1412
1590
|
dataset_id: string;
|
|
1413
1591
|
/** Aggregation query to aggregate data */
|
|
@@ -1425,8 +1603,23 @@ export interface components {
|
|
|
1425
1603
|
flatten?: boolean;
|
|
1426
1604
|
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1427
1605
|
alias?: string;
|
|
1428
|
-
/** The vector field
|
|
1429
|
-
|
|
1606
|
+
/** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
|
|
1607
|
+
vector_fields: string[];
|
|
1608
|
+
};
|
|
1609
|
+
/** Base class for all abstractmodels */
|
|
1610
|
+
ClustercentroidsList: {
|
|
1611
|
+
/** Unique name of dataset */
|
|
1612
|
+
dataset_id: string;
|
|
1613
|
+
/** The vector field where a clustering task was run. */
|
|
1614
|
+
vector_fields: unknown[];
|
|
1615
|
+
/** Alias is used to name a cluster */
|
|
1616
|
+
alias?: string;
|
|
1617
|
+
/** Size of each page of results */
|
|
1618
|
+
page_size?: number;
|
|
1619
|
+
/** Cursor to paginate the document retrieval */
|
|
1620
|
+
cursor?: string;
|
|
1621
|
+
/** Include vectors in the search results */
|
|
1622
|
+
include_vector?: boolean;
|
|
1430
1623
|
};
|
|
1431
1624
|
/** Cluster Task */
|
|
1432
1625
|
Clusterer: {
|
|
@@ -2927,6 +3120,10 @@ export interface operations {
|
|
|
2927
3120
|
* {'field' : 'price', 'filter_type' : 'numeric', "condition":">=", "condition_value":90}
|
|
2928
3121
|
* 7. **"ids"**: for filtering by document ids.
|
|
2929
3122
|
* {'field' : 'ids', 'filter_type' : 'ids', "condition":"==", "condition_value":["1", "10"]}
|
|
3123
|
+
* 8. **"or"**: for filtering with multiple conditions
|
|
3124
|
+
* {'filter_type' : 'or',
|
|
3125
|
+
* "condition_value": [{'field' : 'price', 'filter_type' : 'numeric', "condition":"<=", "condition_value":90},
|
|
3126
|
+
* {'field' : 'price', 'filter_type' : 'numeric', "condition":">=", "condition_value":150}]}
|
|
2930
3127
|
*
|
|
2931
3128
|
* These are the available conditions:
|
|
2932
3129
|
*
|
|
@@ -4205,6 +4402,17 @@ export interface operations {
|
|
|
4205
4402
|
* - "groupby" is the fields you want to split the data into. These are the available groupby types:
|
|
4206
4403
|
* - category" : groupby a field that is a category
|
|
4207
4404
|
* - numeric: groupby a field that is a numeric
|
|
4405
|
+
* - wordcloud: groupby the words. You can also additionally include stop words in your aggregation
|
|
4406
|
+
* if you add `remove_words` as a field.
|
|
4407
|
+
*
|
|
4408
|
+
* {
|
|
4409
|
+
* "name": "wordcloud_research",
|
|
4410
|
+
* "field": "title",
|
|
4411
|
+
* "agg": "wordcloud",
|
|
4412
|
+
* "remove_words": ["learning"]
|
|
4413
|
+
* }
|
|
4414
|
+
*
|
|
4415
|
+
*
|
|
4208
4416
|
* - "metrics" is the fields you want to metrics you want to calculate in each of those, every aggregation includes a frequency metric. These are the available metric types:
|
|
4209
4417
|
* - "avg", "max", "min", "sum", "cardinality"
|
|
4210
4418
|
*
|
|
@@ -4252,7 +4460,7 @@ export interface operations {
|
|
|
4252
4460
|
};
|
|
4253
4461
|
};
|
|
4254
4462
|
};
|
|
4255
|
-
/**
|
|
4463
|
+
/** Retrieves a list of cluster centroids */
|
|
4256
4464
|
cluster_centroids_api_services_cluster_centroids_list_get: {
|
|
4257
4465
|
parameters: {
|
|
4258
4466
|
query: {
|
|
@@ -4289,6 +4497,34 @@ export interface operations {
|
|
|
4289
4497
|
};
|
|
4290
4498
|
};
|
|
4291
4499
|
};
|
|
4500
|
+
/** Retrieves a list of cluster centroids */
|
|
4501
|
+
cluster_centroids_api_v2_services_cluster_centroids_list_post: {
|
|
4502
|
+
parameters: {
|
|
4503
|
+
header: {
|
|
4504
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4505
|
+
Authorization: string;
|
|
4506
|
+
};
|
|
4507
|
+
};
|
|
4508
|
+
responses: {
|
|
4509
|
+
/** Successful Response */
|
|
4510
|
+
200: {
|
|
4511
|
+
content: {
|
|
4512
|
+
"application/json": unknown;
|
|
4513
|
+
};
|
|
4514
|
+
};
|
|
4515
|
+
/** Validation Error */
|
|
4516
|
+
422: {
|
|
4517
|
+
content: {
|
|
4518
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4519
|
+
};
|
|
4520
|
+
};
|
|
4521
|
+
};
|
|
4522
|
+
requestBody: {
|
|
4523
|
+
content: {
|
|
4524
|
+
"application/json": components["schemas"]["ClustercentroidsList"];
|
|
4525
|
+
};
|
|
4526
|
+
};
|
|
4527
|
+
};
|
|
4292
4528
|
/** Retrieve the cluster centroids by IDs */
|
|
4293
4529
|
cluster_centroids_get_api_services_cluster_centroids_get_get: {
|
|
4294
4530
|
parameters: {
|
|
@@ -4326,8 +4562,36 @@ export interface operations {
|
|
|
4326
4562
|
};
|
|
4327
4563
|
};
|
|
4328
4564
|
};
|
|
4565
|
+
/** Retrieve the cluster centroids by IDs */
|
|
4566
|
+
cluster_centroids_get_api_services_cluster_centroids_get_post: {
|
|
4567
|
+
parameters: {
|
|
4568
|
+
header: {
|
|
4569
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4570
|
+
Authorization: string;
|
|
4571
|
+
};
|
|
4572
|
+
};
|
|
4573
|
+
responses: {
|
|
4574
|
+
/** Successful Response */
|
|
4575
|
+
200: {
|
|
4576
|
+
content: {
|
|
4577
|
+
"application/json": unknown;
|
|
4578
|
+
};
|
|
4579
|
+
};
|
|
4580
|
+
/** Validation Error */
|
|
4581
|
+
422: {
|
|
4582
|
+
content: {
|
|
4583
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4584
|
+
};
|
|
4585
|
+
};
|
|
4586
|
+
};
|
|
4587
|
+
requestBody: {
|
|
4588
|
+
content: {
|
|
4589
|
+
"application/json": components["schemas"]["CentroidsGetV2"];
|
|
4590
|
+
};
|
|
4591
|
+
};
|
|
4592
|
+
};
|
|
4329
4593
|
/** Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations. */
|
|
4330
|
-
|
|
4594
|
+
insert_cluster_centroids_2_api_services_cluster_centroids_insert_post: {
|
|
4331
4595
|
parameters: {
|
|
4332
4596
|
header: {
|
|
4333
4597
|
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
@@ -4350,7 +4614,125 @@ export interface operations {
|
|
|
4350
4614
|
};
|
|
4351
4615
|
requestBody: {
|
|
4352
4616
|
content: {
|
|
4353
|
-
"application/json": components["schemas"]["
|
|
4617
|
+
"application/json": components["schemas"]["CentroidInsertBodyV2"];
|
|
4618
|
+
};
|
|
4619
|
+
};
|
|
4620
|
+
};
|
|
4621
|
+
/** Update a centroid by ID */
|
|
4622
|
+
update_centroids_api_v2_services_cluster_centroids_update_post: {
|
|
4623
|
+
parameters: {
|
|
4624
|
+
header: {
|
|
4625
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4626
|
+
Authorization: string;
|
|
4627
|
+
};
|
|
4628
|
+
};
|
|
4629
|
+
responses: {
|
|
4630
|
+
/** Successful Response */
|
|
4631
|
+
200: {
|
|
4632
|
+
content: {
|
|
4633
|
+
"application/json": unknown;
|
|
4634
|
+
};
|
|
4635
|
+
};
|
|
4636
|
+
/** Validation Error */
|
|
4637
|
+
422: {
|
|
4638
|
+
content: {
|
|
4639
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4640
|
+
};
|
|
4641
|
+
};
|
|
4642
|
+
};
|
|
4643
|
+
requestBody: {
|
|
4644
|
+
content: {
|
|
4645
|
+
"application/json": components["schemas"]["CentroidUpdateBodyV2"];
|
|
4646
|
+
};
|
|
4647
|
+
};
|
|
4648
|
+
};
|
|
4649
|
+
/** Delete a centroid by ID */
|
|
4650
|
+
delete_centroids_api_services_cluster_centroids__centroid_id__delete_get: {
|
|
4651
|
+
parameters: {
|
|
4652
|
+
path: {
|
|
4653
|
+
centroid_id: string;
|
|
4654
|
+
};
|
|
4655
|
+
query: {
|
|
4656
|
+
dataset_id: string;
|
|
4657
|
+
vector_field: string;
|
|
4658
|
+
alias: string;
|
|
4659
|
+
};
|
|
4660
|
+
header: {
|
|
4661
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4662
|
+
Authorization: string;
|
|
4663
|
+
};
|
|
4664
|
+
};
|
|
4665
|
+
responses: {
|
|
4666
|
+
/** Successful Response */
|
|
4667
|
+
200: {
|
|
4668
|
+
content: {
|
|
4669
|
+
"application/json": unknown;
|
|
4670
|
+
};
|
|
4671
|
+
};
|
|
4672
|
+
/** Validation Error */
|
|
4673
|
+
422: {
|
|
4674
|
+
content: {
|
|
4675
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4676
|
+
};
|
|
4677
|
+
};
|
|
4678
|
+
};
|
|
4679
|
+
};
|
|
4680
|
+
/** Delete a centroid by ID */
|
|
4681
|
+
delete_centroids_api_services_cluster_centroids__centroid_id__delete_post: {
|
|
4682
|
+
parameters: {
|
|
4683
|
+
path: {
|
|
4684
|
+
centroid_id: string;
|
|
4685
|
+
};
|
|
4686
|
+
query: {
|
|
4687
|
+
dataset_id: string;
|
|
4688
|
+
vector_field: string;
|
|
4689
|
+
alias: string;
|
|
4690
|
+
};
|
|
4691
|
+
header: {
|
|
4692
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4693
|
+
Authorization: string;
|
|
4694
|
+
};
|
|
4695
|
+
};
|
|
4696
|
+
responses: {
|
|
4697
|
+
/** Successful Response */
|
|
4698
|
+
200: {
|
|
4699
|
+
content: {
|
|
4700
|
+
"application/json": unknown;
|
|
4701
|
+
};
|
|
4702
|
+
};
|
|
4703
|
+
/** Validation Error */
|
|
4704
|
+
422: {
|
|
4705
|
+
content: {
|
|
4706
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4707
|
+
};
|
|
4708
|
+
};
|
|
4709
|
+
};
|
|
4710
|
+
};
|
|
4711
|
+
/** Delete centroids by dataset ID, vector field and alias */
|
|
4712
|
+
cluster_centroids_delete_api_services_cluster_centroids_delete_post: {
|
|
4713
|
+
parameters: {
|
|
4714
|
+
query: {
|
|
4715
|
+
dataset_id: string;
|
|
4716
|
+
vector_field: string;
|
|
4717
|
+
alias: string;
|
|
4718
|
+
};
|
|
4719
|
+
header: {
|
|
4720
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4721
|
+
Authorization: string;
|
|
4722
|
+
};
|
|
4723
|
+
};
|
|
4724
|
+
responses: {
|
|
4725
|
+
/** Successful Response */
|
|
4726
|
+
200: {
|
|
4727
|
+
content: {
|
|
4728
|
+
"application/json": unknown;
|
|
4729
|
+
};
|
|
4730
|
+
};
|
|
4731
|
+
/** Validation Error */
|
|
4732
|
+
422: {
|
|
4733
|
+
content: {
|
|
4734
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4735
|
+
};
|
|
4354
4736
|
};
|
|
4355
4737
|
};
|
|
4356
4738
|
};
|
|
@@ -4382,12 +4764,127 @@ export interface operations {
|
|
|
4382
4764
|
};
|
|
4383
4765
|
};
|
|
4384
4766
|
};
|
|
4767
|
+
/** Retrieves metadata about a dataset. notably description, data source, etc */
|
|
4768
|
+
centroids_metadata_get_api_services_cluster_centroids_metadata_get: {
|
|
4769
|
+
parameters: {
|
|
4770
|
+
query: {
|
|
4771
|
+
/** Unique name of dataset */
|
|
4772
|
+
dataset_id: string;
|
|
4773
|
+
/** It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']). */
|
|
4774
|
+
vector_field: string;
|
|
4775
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
4776
|
+
alias?: string;
|
|
4777
|
+
};
|
|
4778
|
+
header: {
|
|
4779
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4780
|
+
Authorization: string;
|
|
4781
|
+
};
|
|
4782
|
+
};
|
|
4783
|
+
responses: {
|
|
4784
|
+
/** Successful Response */
|
|
4785
|
+
200: {
|
|
4786
|
+
content: {
|
|
4787
|
+
"application/json": unknown;
|
|
4788
|
+
};
|
|
4789
|
+
};
|
|
4790
|
+
/** Validation Error */
|
|
4791
|
+
422: {
|
|
4792
|
+
content: {
|
|
4793
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4794
|
+
};
|
|
4795
|
+
};
|
|
4796
|
+
};
|
|
4797
|
+
};
|
|
4798
|
+
/** You can store the metadata about your cluster here. */
|
|
4799
|
+
centroids_metadata_post_api_v2_services_cluster_centroids_metadata_post: {
|
|
4800
|
+
parameters: {
|
|
4801
|
+
header: {
|
|
4802
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4803
|
+
Authorization: string;
|
|
4804
|
+
};
|
|
4805
|
+
};
|
|
4806
|
+
responses: {
|
|
4807
|
+
/** Successful Response */
|
|
4808
|
+
200: {
|
|
4809
|
+
content: {
|
|
4810
|
+
"application/json": unknown;
|
|
4811
|
+
};
|
|
4812
|
+
};
|
|
4813
|
+
/** Validation Error */
|
|
4814
|
+
422: {
|
|
4815
|
+
content: {
|
|
4816
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4817
|
+
};
|
|
4818
|
+
};
|
|
4819
|
+
};
|
|
4820
|
+
requestBody: {
|
|
4821
|
+
content: {
|
|
4822
|
+
"application/json": components["schemas"]["CentroidMetadataV2"];
|
|
4823
|
+
};
|
|
4824
|
+
};
|
|
4825
|
+
};
|
|
4826
|
+
/** List of documents closest from the centre. */
|
|
4827
|
+
centroids_list_closest_to_center_v2_services_cluster_centroids_list_closest_to_center_post: {
|
|
4828
|
+
parameters: {
|
|
4829
|
+
header: {
|
|
4830
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4831
|
+
Authorization: string;
|
|
4832
|
+
};
|
|
4833
|
+
};
|
|
4834
|
+
responses: {
|
|
4835
|
+
/** Successful Response */
|
|
4836
|
+
200: {
|
|
4837
|
+
content: {
|
|
4838
|
+
"application/json": unknown;
|
|
4839
|
+
};
|
|
4840
|
+
};
|
|
4841
|
+
/** Validation Error */
|
|
4842
|
+
422: {
|
|
4843
|
+
content: {
|
|
4844
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4845
|
+
};
|
|
4846
|
+
};
|
|
4847
|
+
};
|
|
4848
|
+
requestBody: {
|
|
4849
|
+
content: {
|
|
4850
|
+
"application/json": components["schemas"]["CentroidsClosestToCenterV2"];
|
|
4851
|
+
};
|
|
4852
|
+
};
|
|
4853
|
+
};
|
|
4854
|
+
/** List of documents from from the centre */
|
|
4855
|
+
centroids_list_furthest_from_center_v2_services_cluster_centroids_list_furthest_from_center_post: {
|
|
4856
|
+
parameters: {
|
|
4857
|
+
header: {
|
|
4858
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4859
|
+
Authorization: string;
|
|
4860
|
+
};
|
|
4861
|
+
};
|
|
4862
|
+
responses: {
|
|
4863
|
+
/** Successful Response */
|
|
4864
|
+
200: {
|
|
4865
|
+
content: {
|
|
4866
|
+
"application/json": unknown;
|
|
4867
|
+
};
|
|
4868
|
+
};
|
|
4869
|
+
/** Validation Error */
|
|
4870
|
+
422: {
|
|
4871
|
+
content: {
|
|
4872
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4873
|
+
};
|
|
4874
|
+
};
|
|
4875
|
+
};
|
|
4876
|
+
requestBody: {
|
|
4877
|
+
content: {
|
|
4878
|
+
"application/json": components["schemas"]["CentroidsFurthestFromCenterV2"];
|
|
4879
|
+
};
|
|
4880
|
+
};
|
|
4881
|
+
};
|
|
4385
4882
|
/**
|
|
4386
4883
|
* Takes an aggregation query and gets the aggregate of each cluster in a collection. This helps you interpret each cluster and what is in them.
|
|
4387
4884
|
*
|
|
4388
4885
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
4389
4886
|
*/
|
|
4390
|
-
|
|
4887
|
+
cluster_aggregate_api_v2_services_cluster_aggregate_post: {
|
|
4391
4888
|
parameters: {
|
|
4392
4889
|
header: {
|
|
4393
4890
|
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
@@ -4410,7 +4907,7 @@ export interface operations {
|
|
|
4410
4907
|
};
|
|
4411
4908
|
requestBody: {
|
|
4412
4909
|
content: {
|
|
4413
|
-
"application/json": components["schemas"]["
|
|
4910
|
+
"application/json": components["schemas"]["ClusterAggregateQueryCommonsV2"];
|
|
4414
4911
|
};
|
|
4415
4912
|
};
|
|
4416
4913
|
};
|
|
@@ -4419,11 +4916,13 @@ export interface operations {
|
|
|
4419
4916
|
*
|
|
4420
4917
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
4421
4918
|
*/
|
|
4422
|
-
|
|
4919
|
+
advanced_cluster_facets_api_services_cluster_facets_get: {
|
|
4423
4920
|
parameters: {
|
|
4424
4921
|
query: {
|
|
4425
4922
|
/** Unique name of dataset */
|
|
4426
4923
|
dataset_id: string;
|
|
4924
|
+
/** It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']). */
|
|
4925
|
+
vector_field: string;
|
|
4427
4926
|
/** Fields to include in the facets, if [] then all */
|
|
4428
4927
|
facets_fields?: string[];
|
|
4429
4928
|
/** Size of facet page */
|
|
@@ -4455,6 +4954,68 @@ export interface operations {
|
|
|
4455
4954
|
};
|
|
4456
4955
|
};
|
|
4457
4956
|
};
|
|
4957
|
+
/** Get a list of cluster IDs based on the relevant information */
|
|
4958
|
+
cluster_list_services_cluster_list_get: {
|
|
4959
|
+
parameters: {
|
|
4960
|
+
query: {
|
|
4961
|
+
/** Unique name of dataset */
|
|
4962
|
+
dataset_id: string;
|
|
4963
|
+
/** It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']). */
|
|
4964
|
+
vector_field: string;
|
|
4965
|
+
/** Alias is used to name a cluster */
|
|
4966
|
+
alias?: string;
|
|
4967
|
+
};
|
|
4968
|
+
header: {
|
|
4969
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4970
|
+
Authorization: string;
|
|
4971
|
+
};
|
|
4972
|
+
};
|
|
4973
|
+
responses: {
|
|
4974
|
+
/** Successful Response */
|
|
4975
|
+
200: {
|
|
4976
|
+
content: {
|
|
4977
|
+
"application/json": unknown;
|
|
4978
|
+
};
|
|
4979
|
+
};
|
|
4980
|
+
/** Validation Error */
|
|
4981
|
+
422: {
|
|
4982
|
+
content: {
|
|
4983
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4984
|
+
};
|
|
4985
|
+
};
|
|
4986
|
+
};
|
|
4987
|
+
};
|
|
4988
|
+
/** Get a list of cluster IDs */
|
|
4989
|
+
cluster_list_multi_services_cluster_list_post: {
|
|
4990
|
+
parameters: {
|
|
4991
|
+
query: {
|
|
4992
|
+
/** Unique name of dataset */
|
|
4993
|
+
dataset_id: string;
|
|
4994
|
+
/** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
|
|
4995
|
+
vector_fields: string;
|
|
4996
|
+
/** Alias is used to name a cluster */
|
|
4997
|
+
alias?: string;
|
|
4998
|
+
};
|
|
4999
|
+
header: {
|
|
5000
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
5001
|
+
Authorization: string;
|
|
5002
|
+
};
|
|
5003
|
+
};
|
|
5004
|
+
responses: {
|
|
5005
|
+
/** Successful Response */
|
|
5006
|
+
200: {
|
|
5007
|
+
content: {
|
|
5008
|
+
"application/json": unknown;
|
|
5009
|
+
};
|
|
5010
|
+
};
|
|
5011
|
+
/** Validation Error */
|
|
5012
|
+
422: {
|
|
5013
|
+
content: {
|
|
5014
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
5015
|
+
};
|
|
5016
|
+
};
|
|
5017
|
+
};
|
|
5018
|
+
};
|
|
4458
5019
|
/** Tag documents or vectors. */
|
|
4459
5020
|
tag_api_services_tagger_tag_post: {
|
|
4460
5021
|
parameters: {
|