@relevanceai/sdk 1.0.0 → 1.5.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/README.md +31 -23
- package/dist-cjs/generated/VectorApi.js +123 -3
- package/dist-cjs/services/discovery/Dataset.js +10 -5
- package/dist-cjs/services/discovery/index.js +100 -60
- package/dist-es/generated/VectorApi.js +183 -3
- package/dist-es/services/discovery/Dataset.js +8 -4
- package/dist-es/services/discovery/index.js +124 -82
- package/dist-types/generated/VectorApi.d.ts +54 -9
- package/dist-types/generated/_VectorApiSchemaTypes.d.ts +732 -37
- package/dist-types/services/discovery/Dataset.d.ts +1 -0
- package/dist-types/services/discovery/index.d.ts +53 -15
- 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
|
*
|
|
@@ -247,6 +251,29 @@ export interface paths {
|
|
|
247
251
|
/** Get status of a collection level job. Whether its starting, running, failed or finished. */
|
|
248
252
|
get: operations["tasks_status_api_datasets__dataset_id__tasks__task_id__status_get"];
|
|
249
253
|
};
|
|
254
|
+
"/datasets/{dataset_id}/vectorize": {
|
|
255
|
+
/** Queue the encoding of a dataset using the method given by model_id. */
|
|
256
|
+
post: operations["encode_by_model_api_datasets__dataset_id__vectorize_post"];
|
|
257
|
+
};
|
|
258
|
+
"/datasets/{dataset_id}/task_status": {
|
|
259
|
+
/**
|
|
260
|
+
* Check the status of an existing encoding task on the given dataset.
|
|
261
|
+
*
|
|
262
|
+
* The required task_id was returned in the original encoding request
|
|
263
|
+
* such as /vectorize.
|
|
264
|
+
*/
|
|
265
|
+
get: operations["task_status_by_model_api_datasets__dataset_id__task_status_get"];
|
|
266
|
+
};
|
|
267
|
+
"/datasets/{dataset_id}/tasks": {
|
|
268
|
+
/**
|
|
269
|
+
* List the tasks being encoded for the dataset_id that
|
|
270
|
+
* you are authorized to read.
|
|
271
|
+
*
|
|
272
|
+
* If dataset_id is the wildcard "*" then all tasks for the
|
|
273
|
+
* user project are listed.
|
|
274
|
+
*/
|
|
275
|
+
get: operations["list_tasks_api_datasets__dataset_id__tasks_get"];
|
|
276
|
+
};
|
|
250
277
|
"/services/search/vector": {
|
|
251
278
|
/**
|
|
252
279
|
* Allows you to leverage vector similarity search to create a semantic search engine.
|
|
@@ -604,6 +631,17 @@ export interface paths {
|
|
|
604
631
|
* - "groupby" is the fields you want to split the data into. These are the available groupby types:
|
|
605
632
|
* - category" : groupby a field that is a category
|
|
606
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
|
+
*
|
|
607
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:
|
|
608
646
|
* - "avg", "max", "min", "sum", "cardinality"
|
|
609
647
|
*
|
|
@@ -627,28 +665,60 @@ export interface paths {
|
|
|
627
665
|
post: operations["aggregate_v2_api_services_aggregate_aggregate_post"];
|
|
628
666
|
};
|
|
629
667
|
"/services/cluster/centroids/list": {
|
|
630
|
-
/**
|
|
668
|
+
/** Retrieves a list of cluster centroids */
|
|
631
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"];
|
|
632
672
|
};
|
|
633
673
|
"/services/cluster/centroids/get": {
|
|
634
674
|
/** Retrieve the cluster centroids by IDs */
|
|
635
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"];
|
|
636
678
|
};
|
|
637
679
|
"/services/cluster/centroids/insert": {
|
|
638
680
|
/** Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations. */
|
|
639
|
-
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"];
|
|
640
696
|
};
|
|
641
697
|
"/services/cluster/centroids/documents": {
|
|
642
698
|
/** Retrieve the cluster centroids by IDs */
|
|
643
699
|
post: operations["cluster_centroids_get_api_services_cluster_centroids_documents_post"];
|
|
644
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
|
+
};
|
|
645
715
|
"/services/cluster/aggregate": {
|
|
646
716
|
/**
|
|
647
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.
|
|
648
718
|
*
|
|
649
719
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
650
720
|
*/
|
|
651
|
-
post: operations["
|
|
721
|
+
post: operations["cluster_aggregate_api_v2_services_cluster_aggregate_post"];
|
|
652
722
|
};
|
|
653
723
|
"/services/cluster/facets": {
|
|
654
724
|
/**
|
|
@@ -656,7 +726,13 @@ export interface paths {
|
|
|
656
726
|
*
|
|
657
727
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
658
728
|
*/
|
|
659
|
-
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"];
|
|
660
736
|
};
|
|
661
737
|
"/services/tagger/tag": {
|
|
662
738
|
/** Tag documents or vectors. */
|
|
@@ -986,7 +1062,7 @@ export interface components {
|
|
|
986
1062
|
dataset_id: string;
|
|
987
1063
|
/** Query for advance search that allows for multiple vector and field querying. */
|
|
988
1064
|
multivector_query: components["schemas"]["VectorQuery"][];
|
|
989
|
-
/** Field
|
|
1065
|
+
/** Field where the array of chunked documents are. */
|
|
990
1066
|
chunk_field?: string;
|
|
991
1067
|
/** Scoring method for determining for ranking between document chunks. */
|
|
992
1068
|
chunk_scoring?: string;
|
|
@@ -1322,18 +1398,139 @@ export interface components {
|
|
|
1322
1398
|
/** Similarity Metric, choose from ['cosine', 'l1', 'l2', 'dp'] */
|
|
1323
1399
|
similarity_metric?: string;
|
|
1324
1400
|
};
|
|
1325
|
-
/**
|
|
1326
|
-
|
|
1327
|
-
/**
|
|
1401
|
+
/** Adds support for multi vector field clustering */
|
|
1402
|
+
CentroidInsertBodyV2: {
|
|
1403
|
+
/** Unique name of dataset */
|
|
1328
1404
|
dataset_id: string;
|
|
1329
1405
|
/** Cluster centers with the key being the index number */
|
|
1330
1406
|
cluster_centers: {
|
|
1331
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;
|
|
1332
1442
|
};
|
|
1333
|
-
|
|
1334
|
-
|
|
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_field?: string[];
|
|
1456
|
+
/** Fields to include in the search results, empty array/list means all fields. */
|
|
1457
|
+
select_fields?: string[];
|
|
1458
|
+
/** Used for approximate search to speed up search. The higher the number, faster the search but potentially less accurate. */
|
|
1459
|
+
approx?: number;
|
|
1460
|
+
/** Whether to sum the multiple vectors similarity search score as 1 or seperate */
|
|
1461
|
+
sum_fields?: boolean;
|
|
1462
|
+
/** Size of each page of results */
|
|
1463
|
+
page_size?: number;
|
|
1464
|
+
/** Page of the results */
|
|
1465
|
+
page?: number;
|
|
1466
|
+
/** Similarity Metric, choose from ['cosine', 'l1', 'l2', 'dp'] */
|
|
1467
|
+
similarity_metric?: string;
|
|
1468
|
+
/** Query for filtering the search results */
|
|
1469
|
+
filters?: unknown[];
|
|
1470
|
+
/** Fields to include in the facets, if [] then all */
|
|
1471
|
+
facets?: unknown[];
|
|
1472
|
+
/** Minimum score for similarity metric */
|
|
1473
|
+
min_score?: number;
|
|
1474
|
+
/** Include vectors in the search results */
|
|
1475
|
+
include_vector?: boolean;
|
|
1476
|
+
/** Include the total count of results in the search results */
|
|
1477
|
+
include_count?: boolean;
|
|
1478
|
+
/** Include facets in the search results */
|
|
1479
|
+
include_facets?: boolean;
|
|
1480
|
+
};
|
|
1481
|
+
/** Base class for all abstractmodels */
|
|
1482
|
+
CentroidsFurthestFromCenterV2: {
|
|
1483
|
+
/** Unique name of dataset */
|
|
1484
|
+
dataset_id: string;
|
|
1485
|
+
/** 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}) */
|
|
1486
|
+
vector_fields: unknown[];
|
|
1487
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1488
|
+
alias?: string;
|
|
1489
|
+
/** List of cluster IDs */
|
|
1490
|
+
cluster_ids?: string[];
|
|
1491
|
+
/** Centroid vector field */
|
|
1492
|
+
centroid_vector_field?: string[];
|
|
1493
|
+
/** Fields to include in the search results, empty array/list means all fields. */
|
|
1494
|
+
select_fields?: string[];
|
|
1495
|
+
/** Used for approximate search to speed up search. The higher the number, faster the search but potentially less accurate. */
|
|
1496
|
+
approx?: number;
|
|
1497
|
+
/** Whether to sum the multiple vectors similarity search score as 1 or seperate */
|
|
1498
|
+
sum_fields?: boolean;
|
|
1499
|
+
/** Size of each page of results */
|
|
1500
|
+
page_size?: number;
|
|
1501
|
+
/** Page of the results */
|
|
1502
|
+
page?: number;
|
|
1503
|
+
/** Similarity Metric, choose from ['cosine', 'l1', 'l2', 'dp'] */
|
|
1504
|
+
similarity_metric?: string;
|
|
1505
|
+
/** Query for filtering the search results */
|
|
1506
|
+
filters?: unknown[];
|
|
1507
|
+
/** Fields to include in the facets, if [] then all */
|
|
1508
|
+
facets?: unknown[];
|
|
1509
|
+
/** Minimum score for similarity metric */
|
|
1510
|
+
min_score?: number;
|
|
1511
|
+
/** Include vectors in the search results */
|
|
1512
|
+
include_vector?: boolean;
|
|
1513
|
+
/** Include the total count of results in the search results */
|
|
1514
|
+
include_count?: boolean;
|
|
1515
|
+
/** Include facets in the search results */
|
|
1516
|
+
include_facets?: boolean;
|
|
1517
|
+
};
|
|
1518
|
+
/** Base class for all abstractmodels */
|
|
1519
|
+
CentroidsGetV2: {
|
|
1520
|
+
/** Unique name of dataset */
|
|
1521
|
+
dataset_id: string;
|
|
1522
|
+
/** List of cluster IDs */
|
|
1523
|
+
cluster_ids: string[];
|
|
1524
|
+
/** The vector field where a clustering task was run. */
|
|
1525
|
+
vector_fields: unknown[];
|
|
1335
1526
|
/** Alias is used to name a cluster */
|
|
1336
1527
|
alias?: string;
|
|
1528
|
+
/** Size of each page of results */
|
|
1529
|
+
page_size?: number;
|
|
1530
|
+
/** Cursor to paginate the document retrieval */
|
|
1531
|
+
cursor?: string;
|
|
1532
|
+
/** Include vectors in the search results */
|
|
1533
|
+
include_vector?: boolean;
|
|
1337
1534
|
};
|
|
1338
1535
|
/** Base class for all abstractmodels */
|
|
1339
1536
|
ChunkSearchQuery: {
|
|
@@ -1341,7 +1538,7 @@ export interface components {
|
|
|
1341
1538
|
dataset_id: string;
|
|
1342
1539
|
/** Query for advance search that allows for multiple vector and field querying. */
|
|
1343
1540
|
multivector_query: components["schemas"]["VectorQuery"][];
|
|
1344
|
-
/** Field
|
|
1541
|
+
/** Field where the array of chunked documents are. */
|
|
1345
1542
|
chunk_field?: string;
|
|
1346
1543
|
/** Scoring method for determining for ranking between document chunks. */
|
|
1347
1544
|
chunk_scoring?: string;
|
|
@@ -1384,7 +1581,7 @@ export interface components {
|
|
|
1384
1581
|
count?: number;
|
|
1385
1582
|
};
|
|
1386
1583
|
/** Base class for all abstractmodels */
|
|
1387
|
-
|
|
1584
|
+
ClusterAggregateQueryCommonsV2: {
|
|
1388
1585
|
/** Unique name of dataset */
|
|
1389
1586
|
dataset_id: string;
|
|
1390
1587
|
/** Aggregation query to aggregate data */
|
|
@@ -1402,8 +1599,23 @@ export interface components {
|
|
|
1402
1599
|
flatten?: boolean;
|
|
1403
1600
|
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
1404
1601
|
alias?: string;
|
|
1405
|
-
/** The vector field
|
|
1406
|
-
|
|
1602
|
+
/** 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}) */
|
|
1603
|
+
vector_fields: string[];
|
|
1604
|
+
};
|
|
1605
|
+
/** Base class for all abstractmodels */
|
|
1606
|
+
ClustercentroidsList: {
|
|
1607
|
+
/** Unique name of dataset */
|
|
1608
|
+
dataset_id: string;
|
|
1609
|
+
/** The vector field where a clustering task was run. */
|
|
1610
|
+
vector_fields: unknown[];
|
|
1611
|
+
/** Alias is used to name a cluster */
|
|
1612
|
+
alias?: string;
|
|
1613
|
+
/** Size of each page of results */
|
|
1614
|
+
page_size?: number;
|
|
1615
|
+
/** Cursor to paginate the document retrieval */
|
|
1616
|
+
cursor?: string;
|
|
1617
|
+
/** Include vectors in the search results */
|
|
1618
|
+
include_vector?: boolean;
|
|
1407
1619
|
};
|
|
1408
1620
|
/** Cluster Task */
|
|
1409
1621
|
Clusterer: {
|
|
@@ -2209,6 +2421,23 @@ export interface components {
|
|
|
2209
2421
|
vector: number[];
|
|
2210
2422
|
};
|
|
2211
2423
|
/** Base class for all abstractmodels */
|
|
2424
|
+
VectorizeEncodeDataset: {
|
|
2425
|
+
/** Fields to remove ['random_field', 'another_random_field']. Defaults to no removes */
|
|
2426
|
+
fields?: string[];
|
|
2427
|
+
/** Filters to run against */
|
|
2428
|
+
filters?: unknown[];
|
|
2429
|
+
/** If True, re-runs encoding on whole dataset. */
|
|
2430
|
+
refresh?: boolean;
|
|
2431
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
2432
|
+
alias?: string;
|
|
2433
|
+
/** batch for each encoding. Change at your own risk. */
|
|
2434
|
+
chunksize?: number;
|
|
2435
|
+
/** The chunk field. If the chunk field is specified, the field to be encoded should not include the chunk field. */
|
|
2436
|
+
chunk_field?: string;
|
|
2437
|
+
/** Model ID to use for vectorizing (encoding.) */
|
|
2438
|
+
model_id: string;
|
|
2439
|
+
};
|
|
2440
|
+
/** Base class for all abstractmodels */
|
|
2212
2441
|
WordCloudModel: {
|
|
2213
2442
|
/** Unique name of dataset */
|
|
2214
2443
|
dataset_id: string;
|
|
@@ -2887,6 +3116,10 @@ export interface operations {
|
|
|
2887
3116
|
* {'field' : 'price', 'filter_type' : 'numeric', "condition":">=", "condition_value":90}
|
|
2888
3117
|
* 7. **"ids"**: for filtering by document ids.
|
|
2889
3118
|
* {'field' : 'ids', 'filter_type' : 'ids', "condition":"==", "condition_value":["1", "10"]}
|
|
3119
|
+
* 8. **"or"**: for filtering with multiple conditions
|
|
3120
|
+
* {'filter_type' : 'or',
|
|
3121
|
+
* "condition_value": [{'field' : 'price', 'filter_type' : 'numeric', "condition":"<=", "condition_value":90},
|
|
3122
|
+
* {'field' : 'price', 'filter_type' : 'numeric', "condition":">=", "condition_value":150}]}
|
|
2890
3123
|
*
|
|
2891
3124
|
* These are the available conditions:
|
|
2892
3125
|
*
|
|
@@ -3447,6 +3680,104 @@ export interface operations {
|
|
|
3447
3680
|
};
|
|
3448
3681
|
};
|
|
3449
3682
|
};
|
|
3683
|
+
/** Queue the encoding of a dataset using the method given by model_id. */
|
|
3684
|
+
encode_by_model_api_datasets__dataset_id__vectorize_post: {
|
|
3685
|
+
parameters: {
|
|
3686
|
+
path: {
|
|
3687
|
+
dataset_id: string;
|
|
3688
|
+
};
|
|
3689
|
+
header: {
|
|
3690
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
3691
|
+
Authorization: string;
|
|
3692
|
+
};
|
|
3693
|
+
};
|
|
3694
|
+
responses: {
|
|
3695
|
+
/** Successful Response */
|
|
3696
|
+
200: {
|
|
3697
|
+
content: {
|
|
3698
|
+
"application/json": unknown;
|
|
3699
|
+
};
|
|
3700
|
+
};
|
|
3701
|
+
/** Validation Error */
|
|
3702
|
+
422: {
|
|
3703
|
+
content: {
|
|
3704
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3705
|
+
};
|
|
3706
|
+
};
|
|
3707
|
+
};
|
|
3708
|
+
requestBody: {
|
|
3709
|
+
content: {
|
|
3710
|
+
"application/json": components["schemas"]["VectorizeEncodeDataset"];
|
|
3711
|
+
};
|
|
3712
|
+
};
|
|
3713
|
+
};
|
|
3714
|
+
/**
|
|
3715
|
+
* Check the status of an existing encoding task on the given dataset.
|
|
3716
|
+
*
|
|
3717
|
+
* The required task_id was returned in the original encoding request
|
|
3718
|
+
* such as /vectorize.
|
|
3719
|
+
*/
|
|
3720
|
+
task_status_by_model_api_datasets__dataset_id__task_status_get: {
|
|
3721
|
+
parameters: {
|
|
3722
|
+
path: {
|
|
3723
|
+
dataset_id: string;
|
|
3724
|
+
};
|
|
3725
|
+
query: {
|
|
3726
|
+
/** The task ID of the earlier queued vectorize task */
|
|
3727
|
+
task_id: string;
|
|
3728
|
+
};
|
|
3729
|
+
header: {
|
|
3730
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
3731
|
+
Authorization: string;
|
|
3732
|
+
};
|
|
3733
|
+
};
|
|
3734
|
+
responses: {
|
|
3735
|
+
/** Successful Response */
|
|
3736
|
+
200: {
|
|
3737
|
+
content: {
|
|
3738
|
+
"application/json": unknown;
|
|
3739
|
+
};
|
|
3740
|
+
};
|
|
3741
|
+
/** Validation Error */
|
|
3742
|
+
422: {
|
|
3743
|
+
content: {
|
|
3744
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3745
|
+
};
|
|
3746
|
+
};
|
|
3747
|
+
};
|
|
3748
|
+
};
|
|
3749
|
+
/**
|
|
3750
|
+
* List the tasks being encoded for the dataset_id that
|
|
3751
|
+
* you are authorized to read.
|
|
3752
|
+
*
|
|
3753
|
+
* If dataset_id is the wildcard "*" then all tasks for the
|
|
3754
|
+
* user project are listed.
|
|
3755
|
+
*/
|
|
3756
|
+
list_tasks_api_datasets__dataset_id__tasks_get: {
|
|
3757
|
+
parameters: {
|
|
3758
|
+
path: {
|
|
3759
|
+
dataset_id: string;
|
|
3760
|
+
};
|
|
3761
|
+
header: {
|
|
3762
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
3763
|
+
Authorization: string;
|
|
3764
|
+
};
|
|
3765
|
+
};
|
|
3766
|
+
responses: {
|
|
3767
|
+
/** Successful Response */
|
|
3768
|
+
200: {
|
|
3769
|
+
content: {
|
|
3770
|
+
"application/json": unknown;
|
|
3771
|
+
};
|
|
3772
|
+
};
|
|
3773
|
+
/** Validation Error */
|
|
3774
|
+
422: {
|
|
3775
|
+
content: {
|
|
3776
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3777
|
+
};
|
|
3778
|
+
};
|
|
3779
|
+
};
|
|
3780
|
+
};
|
|
3450
3781
|
/**
|
|
3451
3782
|
* Allows you to leverage vector similarity search to create a semantic search engine.
|
|
3452
3783
|
* Powerful features of VecDB vector search:
|
|
@@ -4067,6 +4398,17 @@ export interface operations {
|
|
|
4067
4398
|
* - "groupby" is the fields you want to split the data into. These are the available groupby types:
|
|
4068
4399
|
* - category" : groupby a field that is a category
|
|
4069
4400
|
* - numeric: groupby a field that is a numeric
|
|
4401
|
+
* - wordcloud: groupby the words. You can also additionally include stop words in your aggregation
|
|
4402
|
+
* if you add `remove_words` as a field.
|
|
4403
|
+
*
|
|
4404
|
+
* {
|
|
4405
|
+
* "name": "wordcloud_research",
|
|
4406
|
+
* "field": "title",
|
|
4407
|
+
* "agg": "wordcloud",
|
|
4408
|
+
* "remove_words": ["learning"]
|
|
4409
|
+
* }
|
|
4410
|
+
*
|
|
4411
|
+
*
|
|
4070
4412
|
* - "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:
|
|
4071
4413
|
* - "avg", "max", "min", "sum", "cardinality"
|
|
4072
4414
|
*
|
|
@@ -4114,7 +4456,7 @@ export interface operations {
|
|
|
4114
4456
|
};
|
|
4115
4457
|
};
|
|
4116
4458
|
};
|
|
4117
|
-
/**
|
|
4459
|
+
/** Retrieves a list of cluster centroids */
|
|
4118
4460
|
cluster_centroids_api_services_cluster_centroids_list_get: {
|
|
4119
4461
|
parameters: {
|
|
4120
4462
|
query: {
|
|
@@ -4151,23 +4493,9 @@ export interface operations {
|
|
|
4151
4493
|
};
|
|
4152
4494
|
};
|
|
4153
4495
|
};
|
|
4154
|
-
/**
|
|
4155
|
-
|
|
4496
|
+
/** Retrieves a list of cluster centroids */
|
|
4497
|
+
cluster_centroids_api_v2_services_cluster_centroids_list_post: {
|
|
4156
4498
|
parameters: {
|
|
4157
|
-
query: {
|
|
4158
|
-
/** Unique name of dataset */
|
|
4159
|
-
dataset_id: string;
|
|
4160
|
-
/** List of cluster IDs */
|
|
4161
|
-
cluster_ids: string[];
|
|
4162
|
-
/** The vector field where a clustering task was run. */
|
|
4163
|
-
vector_field: string;
|
|
4164
|
-
/** Alias is used to name a cluster */
|
|
4165
|
-
alias?: string;
|
|
4166
|
-
/** Size of each page of results */
|
|
4167
|
-
page_size?: number;
|
|
4168
|
-
/** Cursor to paginate the document retrieval */
|
|
4169
|
-
cursor?: string;
|
|
4170
|
-
};
|
|
4171
4499
|
header: {
|
|
4172
4500
|
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4173
4501
|
Authorization: string;
|
|
@@ -4187,9 +4515,79 @@ export interface operations {
|
|
|
4187
4515
|
};
|
|
4188
4516
|
};
|
|
4189
4517
|
};
|
|
4518
|
+
requestBody: {
|
|
4519
|
+
content: {
|
|
4520
|
+
"application/json": components["schemas"]["ClustercentroidsList"];
|
|
4521
|
+
};
|
|
4522
|
+
};
|
|
4190
4523
|
};
|
|
4191
|
-
/**
|
|
4192
|
-
|
|
4524
|
+
/** Retrieve the cluster centroids by IDs */
|
|
4525
|
+
cluster_centroids_get_api_services_cluster_centroids_get_get: {
|
|
4526
|
+
parameters: {
|
|
4527
|
+
query: {
|
|
4528
|
+
/** Unique name of dataset */
|
|
4529
|
+
dataset_id: string;
|
|
4530
|
+
/** List of cluster IDs */
|
|
4531
|
+
cluster_ids: string[];
|
|
4532
|
+
/** The vector field where a clustering task was run. */
|
|
4533
|
+
vector_field: string;
|
|
4534
|
+
/** Alias is used to name a cluster */
|
|
4535
|
+
alias?: string;
|
|
4536
|
+
/** Size of each page of results */
|
|
4537
|
+
page_size?: number;
|
|
4538
|
+
/** Cursor to paginate the document retrieval */
|
|
4539
|
+
cursor?: string;
|
|
4540
|
+
};
|
|
4541
|
+
header: {
|
|
4542
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4543
|
+
Authorization: string;
|
|
4544
|
+
};
|
|
4545
|
+
};
|
|
4546
|
+
responses: {
|
|
4547
|
+
/** Successful Response */
|
|
4548
|
+
200: {
|
|
4549
|
+
content: {
|
|
4550
|
+
"application/json": unknown;
|
|
4551
|
+
};
|
|
4552
|
+
};
|
|
4553
|
+
/** Validation Error */
|
|
4554
|
+
422: {
|
|
4555
|
+
content: {
|
|
4556
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4557
|
+
};
|
|
4558
|
+
};
|
|
4559
|
+
};
|
|
4560
|
+
};
|
|
4561
|
+
/** Retrieve the cluster centroids by IDs */
|
|
4562
|
+
cluster_centroids_get_api_services_cluster_centroids_get_post: {
|
|
4563
|
+
parameters: {
|
|
4564
|
+
header: {
|
|
4565
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4566
|
+
Authorization: string;
|
|
4567
|
+
};
|
|
4568
|
+
};
|
|
4569
|
+
responses: {
|
|
4570
|
+
/** Successful Response */
|
|
4571
|
+
200: {
|
|
4572
|
+
content: {
|
|
4573
|
+
"application/json": unknown;
|
|
4574
|
+
};
|
|
4575
|
+
};
|
|
4576
|
+
/** Validation Error */
|
|
4577
|
+
422: {
|
|
4578
|
+
content: {
|
|
4579
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4580
|
+
};
|
|
4581
|
+
};
|
|
4582
|
+
};
|
|
4583
|
+
requestBody: {
|
|
4584
|
+
content: {
|
|
4585
|
+
"application/json": components["schemas"]["CentroidsGetV2"];
|
|
4586
|
+
};
|
|
4587
|
+
};
|
|
4588
|
+
};
|
|
4589
|
+
/** Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations. */
|
|
4590
|
+
insert_cluster_centroids_2_api_services_cluster_centroids_insert_post: {
|
|
4193
4591
|
parameters: {
|
|
4194
4592
|
header: {
|
|
4195
4593
|
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
@@ -4212,7 +4610,125 @@ export interface operations {
|
|
|
4212
4610
|
};
|
|
4213
4611
|
requestBody: {
|
|
4214
4612
|
content: {
|
|
4215
|
-
"application/json": components["schemas"]["
|
|
4613
|
+
"application/json": components["schemas"]["CentroidInsertBodyV2"];
|
|
4614
|
+
};
|
|
4615
|
+
};
|
|
4616
|
+
};
|
|
4617
|
+
/** Update a centroid by ID */
|
|
4618
|
+
update_centroids_api_v2_services_cluster_centroids_update_post: {
|
|
4619
|
+
parameters: {
|
|
4620
|
+
header: {
|
|
4621
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4622
|
+
Authorization: string;
|
|
4623
|
+
};
|
|
4624
|
+
};
|
|
4625
|
+
responses: {
|
|
4626
|
+
/** Successful Response */
|
|
4627
|
+
200: {
|
|
4628
|
+
content: {
|
|
4629
|
+
"application/json": unknown;
|
|
4630
|
+
};
|
|
4631
|
+
};
|
|
4632
|
+
/** Validation Error */
|
|
4633
|
+
422: {
|
|
4634
|
+
content: {
|
|
4635
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4636
|
+
};
|
|
4637
|
+
};
|
|
4638
|
+
};
|
|
4639
|
+
requestBody: {
|
|
4640
|
+
content: {
|
|
4641
|
+
"application/json": components["schemas"]["CentroidUpdateBodyV2"];
|
|
4642
|
+
};
|
|
4643
|
+
};
|
|
4644
|
+
};
|
|
4645
|
+
/** Delete a centroid by ID */
|
|
4646
|
+
delete_centroids_api_services_cluster_centroids__centroid_id__delete_get: {
|
|
4647
|
+
parameters: {
|
|
4648
|
+
path: {
|
|
4649
|
+
centroid_id: string;
|
|
4650
|
+
};
|
|
4651
|
+
query: {
|
|
4652
|
+
dataset_id: string;
|
|
4653
|
+
vector_field: string;
|
|
4654
|
+
alias: string;
|
|
4655
|
+
};
|
|
4656
|
+
header: {
|
|
4657
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4658
|
+
Authorization: string;
|
|
4659
|
+
};
|
|
4660
|
+
};
|
|
4661
|
+
responses: {
|
|
4662
|
+
/** Successful Response */
|
|
4663
|
+
200: {
|
|
4664
|
+
content: {
|
|
4665
|
+
"application/json": unknown;
|
|
4666
|
+
};
|
|
4667
|
+
};
|
|
4668
|
+
/** Validation Error */
|
|
4669
|
+
422: {
|
|
4670
|
+
content: {
|
|
4671
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4672
|
+
};
|
|
4673
|
+
};
|
|
4674
|
+
};
|
|
4675
|
+
};
|
|
4676
|
+
/** Delete a centroid by ID */
|
|
4677
|
+
delete_centroids_api_services_cluster_centroids__centroid_id__delete_post: {
|
|
4678
|
+
parameters: {
|
|
4679
|
+
path: {
|
|
4680
|
+
centroid_id: string;
|
|
4681
|
+
};
|
|
4682
|
+
query: {
|
|
4683
|
+
dataset_id: string;
|
|
4684
|
+
vector_field: string;
|
|
4685
|
+
alias: string;
|
|
4686
|
+
};
|
|
4687
|
+
header: {
|
|
4688
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4689
|
+
Authorization: string;
|
|
4690
|
+
};
|
|
4691
|
+
};
|
|
4692
|
+
responses: {
|
|
4693
|
+
/** Successful Response */
|
|
4694
|
+
200: {
|
|
4695
|
+
content: {
|
|
4696
|
+
"application/json": unknown;
|
|
4697
|
+
};
|
|
4698
|
+
};
|
|
4699
|
+
/** Validation Error */
|
|
4700
|
+
422: {
|
|
4701
|
+
content: {
|
|
4702
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4703
|
+
};
|
|
4704
|
+
};
|
|
4705
|
+
};
|
|
4706
|
+
};
|
|
4707
|
+
/** Delete centroids by dataset ID, vector field and alias */
|
|
4708
|
+
cluster_centroids_delete_api_services_cluster_centroids_delete_post: {
|
|
4709
|
+
parameters: {
|
|
4710
|
+
query: {
|
|
4711
|
+
dataset_id: string;
|
|
4712
|
+
vector_field: string;
|
|
4713
|
+
alias: string;
|
|
4714
|
+
};
|
|
4715
|
+
header: {
|
|
4716
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4717
|
+
Authorization: string;
|
|
4718
|
+
};
|
|
4719
|
+
};
|
|
4720
|
+
responses: {
|
|
4721
|
+
/** Successful Response */
|
|
4722
|
+
200: {
|
|
4723
|
+
content: {
|
|
4724
|
+
"application/json": unknown;
|
|
4725
|
+
};
|
|
4726
|
+
};
|
|
4727
|
+
/** Validation Error */
|
|
4728
|
+
422: {
|
|
4729
|
+
content: {
|
|
4730
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4731
|
+
};
|
|
4216
4732
|
};
|
|
4217
4733
|
};
|
|
4218
4734
|
};
|
|
@@ -4244,12 +4760,127 @@ export interface operations {
|
|
|
4244
4760
|
};
|
|
4245
4761
|
};
|
|
4246
4762
|
};
|
|
4763
|
+
/** Retrieves metadata about a dataset. notably description, data source, etc */
|
|
4764
|
+
centroids_metadata_get_api_services_cluster_centroids_metadata_get: {
|
|
4765
|
+
parameters: {
|
|
4766
|
+
query: {
|
|
4767
|
+
/** Unique name of dataset */
|
|
4768
|
+
dataset_id: string;
|
|
4769
|
+
/** It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']). */
|
|
4770
|
+
vector_field: string;
|
|
4771
|
+
/** Alias used to name a vector field. Belongs in field_{alias}_vector_ */
|
|
4772
|
+
alias?: string;
|
|
4773
|
+
};
|
|
4774
|
+
header: {
|
|
4775
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4776
|
+
Authorization: string;
|
|
4777
|
+
};
|
|
4778
|
+
};
|
|
4779
|
+
responses: {
|
|
4780
|
+
/** Successful Response */
|
|
4781
|
+
200: {
|
|
4782
|
+
content: {
|
|
4783
|
+
"application/json": unknown;
|
|
4784
|
+
};
|
|
4785
|
+
};
|
|
4786
|
+
/** Validation Error */
|
|
4787
|
+
422: {
|
|
4788
|
+
content: {
|
|
4789
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4790
|
+
};
|
|
4791
|
+
};
|
|
4792
|
+
};
|
|
4793
|
+
};
|
|
4794
|
+
/** You can store the metadata about your cluster here. */
|
|
4795
|
+
centroids_metadata_post_api_v2_services_cluster_centroids_metadata_post: {
|
|
4796
|
+
parameters: {
|
|
4797
|
+
header: {
|
|
4798
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4799
|
+
Authorization: string;
|
|
4800
|
+
};
|
|
4801
|
+
};
|
|
4802
|
+
responses: {
|
|
4803
|
+
/** Successful Response */
|
|
4804
|
+
200: {
|
|
4805
|
+
content: {
|
|
4806
|
+
"application/json": unknown;
|
|
4807
|
+
};
|
|
4808
|
+
};
|
|
4809
|
+
/** Validation Error */
|
|
4810
|
+
422: {
|
|
4811
|
+
content: {
|
|
4812
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4813
|
+
};
|
|
4814
|
+
};
|
|
4815
|
+
};
|
|
4816
|
+
requestBody: {
|
|
4817
|
+
content: {
|
|
4818
|
+
"application/json": components["schemas"]["CentroidMetadataV2"];
|
|
4819
|
+
};
|
|
4820
|
+
};
|
|
4821
|
+
};
|
|
4822
|
+
/** List of documents closest from the centre. */
|
|
4823
|
+
centroids_list_closest_to_center_v2_services_cluster_centroids_list_closest_to_center_post: {
|
|
4824
|
+
parameters: {
|
|
4825
|
+
header: {
|
|
4826
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4827
|
+
Authorization: string;
|
|
4828
|
+
};
|
|
4829
|
+
};
|
|
4830
|
+
responses: {
|
|
4831
|
+
/** Successful Response */
|
|
4832
|
+
200: {
|
|
4833
|
+
content: {
|
|
4834
|
+
"application/json": unknown;
|
|
4835
|
+
};
|
|
4836
|
+
};
|
|
4837
|
+
/** Validation Error */
|
|
4838
|
+
422: {
|
|
4839
|
+
content: {
|
|
4840
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4841
|
+
};
|
|
4842
|
+
};
|
|
4843
|
+
};
|
|
4844
|
+
requestBody: {
|
|
4845
|
+
content: {
|
|
4846
|
+
"application/json": components["schemas"]["CentroidsClosestToCenterV2"];
|
|
4847
|
+
};
|
|
4848
|
+
};
|
|
4849
|
+
};
|
|
4850
|
+
/** List of documents from from the centre */
|
|
4851
|
+
centroids_list_furthest_from_center_v2_services_cluster_centroids_list_furthest_from_center_post: {
|
|
4852
|
+
parameters: {
|
|
4853
|
+
header: {
|
|
4854
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4855
|
+
Authorization: string;
|
|
4856
|
+
};
|
|
4857
|
+
};
|
|
4858
|
+
responses: {
|
|
4859
|
+
/** Successful Response */
|
|
4860
|
+
200: {
|
|
4861
|
+
content: {
|
|
4862
|
+
"application/json": unknown;
|
|
4863
|
+
};
|
|
4864
|
+
};
|
|
4865
|
+
/** Validation Error */
|
|
4866
|
+
422: {
|
|
4867
|
+
content: {
|
|
4868
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4869
|
+
};
|
|
4870
|
+
};
|
|
4871
|
+
};
|
|
4872
|
+
requestBody: {
|
|
4873
|
+
content: {
|
|
4874
|
+
"application/json": components["schemas"]["CentroidsFurthestFromCenterV2"];
|
|
4875
|
+
};
|
|
4876
|
+
};
|
|
4877
|
+
};
|
|
4247
4878
|
/**
|
|
4248
4879
|
* 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.
|
|
4249
4880
|
*
|
|
4250
4881
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
4251
4882
|
*/
|
|
4252
|
-
|
|
4883
|
+
cluster_aggregate_api_v2_services_cluster_aggregate_post: {
|
|
4253
4884
|
parameters: {
|
|
4254
4885
|
header: {
|
|
4255
4886
|
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
@@ -4272,7 +4903,7 @@ export interface operations {
|
|
|
4272
4903
|
};
|
|
4273
4904
|
requestBody: {
|
|
4274
4905
|
content: {
|
|
4275
|
-
"application/json": components["schemas"]["
|
|
4906
|
+
"application/json": components["schemas"]["ClusterAggregateQueryCommonsV2"];
|
|
4276
4907
|
};
|
|
4277
4908
|
};
|
|
4278
4909
|
};
|
|
@@ -4281,11 +4912,13 @@ export interface operations {
|
|
|
4281
4912
|
*
|
|
4282
4913
|
* Only can be used after a vector field has been clustered with /cluster.
|
|
4283
4914
|
*/
|
|
4284
|
-
|
|
4915
|
+
advanced_cluster_facets_api_services_cluster_facets_get: {
|
|
4285
4916
|
parameters: {
|
|
4286
4917
|
query: {
|
|
4287
4918
|
/** Unique name of dataset */
|
|
4288
4919
|
dataset_id: string;
|
|
4920
|
+
/** It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']). */
|
|
4921
|
+
vector_field: string;
|
|
4289
4922
|
/** Fields to include in the facets, if [] then all */
|
|
4290
4923
|
facets_fields?: string[];
|
|
4291
4924
|
/** Size of facet page */
|
|
@@ -4317,6 +4950,68 @@ export interface operations {
|
|
|
4317
4950
|
};
|
|
4318
4951
|
};
|
|
4319
4952
|
};
|
|
4953
|
+
/** Get a list of cluster IDs based on the relevant information */
|
|
4954
|
+
cluster_list_services_cluster_list_get: {
|
|
4955
|
+
parameters: {
|
|
4956
|
+
query: {
|
|
4957
|
+
/** Unique name of dataset */
|
|
4958
|
+
dataset_id: string;
|
|
4959
|
+
/** It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']). */
|
|
4960
|
+
vector_field: string;
|
|
4961
|
+
/** Alias is used to name a cluster */
|
|
4962
|
+
alias?: string;
|
|
4963
|
+
};
|
|
4964
|
+
header: {
|
|
4965
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4966
|
+
Authorization: string;
|
|
4967
|
+
};
|
|
4968
|
+
};
|
|
4969
|
+
responses: {
|
|
4970
|
+
/** Successful Response */
|
|
4971
|
+
200: {
|
|
4972
|
+
content: {
|
|
4973
|
+
"application/json": unknown;
|
|
4974
|
+
};
|
|
4975
|
+
};
|
|
4976
|
+
/** Validation Error */
|
|
4977
|
+
422: {
|
|
4978
|
+
content: {
|
|
4979
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
4980
|
+
};
|
|
4981
|
+
};
|
|
4982
|
+
};
|
|
4983
|
+
};
|
|
4984
|
+
/** Get a list of cluster IDs */
|
|
4985
|
+
cluster_list_multi_services_cluster_list_post: {
|
|
4986
|
+
parameters: {
|
|
4987
|
+
query: {
|
|
4988
|
+
/** Unique name of dataset */
|
|
4989
|
+
dataset_id: string;
|
|
4990
|
+
/** 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}) */
|
|
4991
|
+
vector_fields: string;
|
|
4992
|
+
/** Alias is used to name a cluster */
|
|
4993
|
+
alias?: string;
|
|
4994
|
+
};
|
|
4995
|
+
header: {
|
|
4996
|
+
/** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
|
|
4997
|
+
Authorization: string;
|
|
4998
|
+
};
|
|
4999
|
+
};
|
|
5000
|
+
responses: {
|
|
5001
|
+
/** Successful Response */
|
|
5002
|
+
200: {
|
|
5003
|
+
content: {
|
|
5004
|
+
"application/json": unknown;
|
|
5005
|
+
};
|
|
5006
|
+
};
|
|
5007
|
+
/** Validation Error */
|
|
5008
|
+
422: {
|
|
5009
|
+
content: {
|
|
5010
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
5011
|
+
};
|
|
5012
|
+
};
|
|
5013
|
+
};
|
|
5014
|
+
};
|
|
4320
5015
|
/** Tag documents or vectors. */
|
|
4321
5016
|
tag_api_services_tagger_tag_post: {
|
|
4322
5017
|
parameters: {
|