@relevanceai/sdk 1.115.0 → 1.117.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.
@@ -1068,6 +1068,24 @@ export interface paths {
1068
1068
  */
1069
1069
  get: operations["ListProjectsInOrganization"];
1070
1070
  };
1071
+ "/organizations/{organization_id}/metrics/aggregate": {
1072
+ /**
1073
+ * ### Required permissions
1074
+ * > [
1075
+ * {
1076
+ * "actions": [
1077
+ * "organizations:read"
1078
+ * ],
1079
+ * "organizations": [
1080
+ * {
1081
+ * "params": "organization_id"
1082
+ * }
1083
+ * ]
1084
+ * }
1085
+ * ]
1086
+ */
1087
+ post: operations["AggregateOrganizationMetrics"];
1088
+ };
1071
1089
  "/connectors/create": {
1072
1090
  /**
1073
1091
  * ### Required permissions
@@ -1291,6 +1309,21 @@ export interface paths {
1291
1309
  */
1292
1310
  post: operations["DeleteWorkflowStatus"];
1293
1311
  };
1312
+ "/workflows/{workflow_id}/terminate": {
1313
+ /**
1314
+ * Terminate a workflow
1315
+ *
1316
+ * ### Required permissions
1317
+ * > [
1318
+ * {
1319
+ * "actions": [
1320
+ * "datasets:write"
1321
+ * ]
1322
+ * }
1323
+ * ]
1324
+ */
1325
+ post: operations["TerminateWorkflow"];
1326
+ };
1294
1327
  "/workflows/{workflow_id}/metadata": {
1295
1328
  /**
1296
1329
  * Update metadata for a workflow run
@@ -2048,6 +2081,26 @@ export interface paths {
2048
2081
  */
2049
2082
  post: operations["MergeTags"];
2050
2083
  };
2084
+ "/datasets/{dataset_id}/tags/edit": {
2085
+ /**
2086
+ * Perform all tagging operations on a field in one payload.
2087
+ *
2088
+ * ### Required permissions
2089
+ * > [
2090
+ * {
2091
+ * "actions": [
2092
+ * "datasets:write"
2093
+ * ],
2094
+ * "datasets": [
2095
+ * {
2096
+ * "params": "dataset_id"
2097
+ * }
2098
+ * ]
2099
+ * }
2100
+ * ]
2101
+ */
2102
+ post: operations["EditTags"];
2103
+ };
2051
2104
  "/datasets/{dataset_id}/facets": {
2052
2105
  /**
2053
2106
  * Takes a high level aggregation of every field, return their unique values and frequencies. This is used to help create the filter bar for search.
@@ -2517,6 +2570,90 @@ export interface paths {
2517
2570
  */
2518
2571
  post: operations["CreateComponent"];
2519
2572
  };
2573
+ "/datasets/{dataset_id}/editor/history/list": {
2574
+ /**
2575
+ * ### Required permissions
2576
+ * > []
2577
+ */
2578
+ post: operations["ListDatasetEditorHistorys"];
2579
+ };
2580
+ "/datasets/{dataset_id}/editor/history/create": {
2581
+ /**
2582
+ * ### Required permissions
2583
+ * > []
2584
+ */
2585
+ post: operations["CreateDatasetEditorHistory"];
2586
+ };
2587
+ "/datasets/{dataset_id}/editor/configuration/list": {
2588
+ /**
2589
+ * ### Required permissions
2590
+ * > []
2591
+ */
2592
+ post: operations["ListDatasetEditorConfigurations"];
2593
+ };
2594
+ "/datasets/{dataset_id}/editor/configuration/create": {
2595
+ /**
2596
+ * ### Required permissions
2597
+ * > []
2598
+ */
2599
+ post: operations["CreateDatasetEditorConfiguration"];
2600
+ };
2601
+ "/datasets/{dataset_id}/editor/configuration/{dataseteditorconfiguration_id}/update": {
2602
+ /**
2603
+ * ### Required permissions
2604
+ * > []
2605
+ */
2606
+ post: operations["UpdateDatasetEditorConfiguration"];
2607
+ };
2608
+ "/datasets/{dataset_id}/editor/configuration/{dataseteditorconfiguration_id}/delete": {
2609
+ /**
2610
+ * ### Required permissions
2611
+ * > []
2612
+ */
2613
+ post: operations["DeleteDatasetEditorConfiguration"];
2614
+ };
2615
+ "/datasets/{dataset_id}/editor/configuration/{dataseteditorconfiguration_id}/get": {
2616
+ /**
2617
+ * ### Required permissions
2618
+ * > []
2619
+ */
2620
+ get: operations["GetDatasetEditorConfiguration"];
2621
+ };
2622
+ "/datasets/{dataset_id}/fields/{field}/keyphrase/list": {
2623
+ /**
2624
+ * ### Required permissions
2625
+ * > []
2626
+ */
2627
+ post: operations["ListKeyphrases"];
2628
+ };
2629
+ "/datasets/{dataset_id}/fields/{field}/keyphrase/{keyphrase_id}/update": {
2630
+ /**
2631
+ * ### Required permissions
2632
+ * > []
2633
+ */
2634
+ post: operations["UpdateKeyphrase"];
2635
+ };
2636
+ "/datasets/{dataset_id}/fields/{field}/keyphrase/{keyphrase_id}/delete": {
2637
+ /**
2638
+ * ### Required permissions
2639
+ * > []
2640
+ */
2641
+ post: operations["DeleteKeyphrase"];
2642
+ };
2643
+ "/datasets/{dataset_id}/fields/{field}/keyphrase/{keyphrase_id}/get": {
2644
+ /**
2645
+ * ### Required permissions
2646
+ * > []
2647
+ */
2648
+ get: operations["GetKeyphrase"];
2649
+ };
2650
+ "/datasets/{dataset_id}/fields/{field}/keyphrase/bulk_update": {
2651
+ /**
2652
+ * ### Required permissions
2653
+ * > []
2654
+ */
2655
+ post: operations["BulkUpdateKeyphrases"];
2656
+ };
2520
2657
  }
2521
2658
  export interface components {
2522
2659
  schemas: {
@@ -2615,7 +2752,12 @@ export interface components {
2615
2752
  DeleteDeployableGroupInput: unknown;
2616
2753
  DeleteDeployableGroupOutput: unknown;
2617
2754
  ListDeployableGroupsInput: {
2618
- [key: string]: unknown;
2755
+ page?: number;
2756
+ page_size?: number;
2757
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
2758
+ sort?: (string | {
2759
+ [key: string]: "asc" | "desc";
2760
+ })[];
2619
2761
  };
2620
2762
  ListDeployableGroupsOutput: {
2621
2763
  results: {
@@ -6389,59 +6531,606 @@ export interface components {
6389
6531
  updated_at?: string;
6390
6532
  }[];
6391
6533
  };
6392
- CreateConnectorInput: {
6393
- source_type: "Snowflake";
6394
- source_database?: string;
6395
- source_collection: string;
6396
- /** @description If provided, use this field as the _id value in documents. */
6397
- id_field?: string;
6398
- source_settings: {
6399
- custom?: {
6400
- [key: string]: unknown;
6534
+ AggregateOrganizationMetricsInput: {
6535
+ filters?: (Partial<{
6536
+ /** @description Match where document[field] is in value list. */
6537
+ match?: {
6538
+ /** @description If matching on text, match even if there are extra words / case insensitivity */
6539
+ fuzzy?: boolean;
6540
+ /** @description Field to match on. */
6541
+ field?: string;
6542
+ /** @description Can be either a single item or a list of items to match on. */
6543
+ value: string | boolean | number | unknown[];
6401
6544
  };
6402
- Snowflake?: {
6403
- /** Authorization Method */
6404
- credentials?: {
6405
- /** @default OAuth */
6406
- auth_type: string;
6407
- /**
6408
- * Client ID
6409
- * @description The Client ID of your Snowflake developer application.
6410
- */
6411
- client_id: string;
6545
+ /** @description Match where document._id is in value list. */
6546
+ matchIds?: {
6547
+ /** @description Can be either a single item or a list of items to match on. */
6548
+ value: string | boolean | number | unknown[];
6549
+ };
6550
+ /** @description Match documents where greaterThan < document[field] < lessThan. Supports numbers and date strings. */
6551
+ range?: {
6552
+ /** @description Field to match on. */
6553
+ field?: string;
6554
+ greaterThan?: unknown;
6555
+ lessThan?: unknown;
6556
+ greaterThanOrEqualTo?: unknown;
6557
+ lessThanOrEqualTo?: unknown;
6558
+ };
6559
+ /**
6560
+ * @description
6561
+ * Match documents where the field either contains the value as a substring, or matches a provided matching pattern.
6562
+ *
6563
+ * Possible matching patterns:
6564
+ *
6565
+ * * - documents where the field has any value
6566
+ * ? - documents where a single character from the field matches the provided values
6567
+ *
6568
+ * Example:
6569
+ *
6570
+ * {
6571
+ * wildcard: {
6572
+ * field: "title",
6573
+ * value: [ "Avenger*" ]
6574
+ * }
6575
+ * }
6576
+ */
6577
+ wildcard?: {
6578
+ /** @description Field to match on. */
6579
+ field?: string;
6580
+ /** @description single string or array of valid wildcard strings to match on, for example ['tele*'] */
6581
+ value: string | string[];
6582
+ };
6583
+ /** @description hybrid search query that must reach a certain value to filter */
6584
+ search?: {
6585
+ /**
6586
+ * @description Search for documents that contain this query string in your dataset. Use fieldsToSearch parameter to restrict which fields are searched.
6587
+ *
6588
+ * "tele" matches "Television", "This television is an excellent product…"
6589
+ *
6590
+ * Example: "tele"
6591
+ */
6592
+ query?: string;
6593
+ /** @description Configuration for traditional search query. */
6594
+ queryConfig?: {
6412
6595
  /**
6413
- * Client Secret
6414
- * @description The Client Secret of your Snowflake developer application.
6596
+ * @description Increases or decreases the impact of all traditional search matching when calculating a documents _relevance.
6597
+ * @default 1
6415
6598
  */
6416
- client_secret: string;
6599
+ weight?: number;
6417
6600
  /**
6418
- * Access Token
6419
- * @description Access Token for making authenticated requests.
6601
+ * @description Increases or decreases the impact of sentence matching when calculating a documents _relevance.
6602
+ * For example, with query "A fox jumped", with high sentence weight, 'A fox jumped over the' would match before 'jumped a fox over fox'
6603
+ * @default 1
6420
6604
  */
6421
- access_token?: string;
6605
+ sentenceWeight?: number;
6422
6606
  /**
6423
- * Refresh Token
6424
- * @description Refresh Token for making authenticated requests.
6607
+ * @description Increases or decreases the impact of fuzzy matching when calculating a documents _relevance.
6608
+ * For example, with query "rain", with 0 fuzzy weight, 'brain' would not match.
6609
+ * @default 1
6425
6610
  */
6426
- refresh_token?: string;
6427
- } | {
6428
- /** @default username/password */
6429
- auth_type: string;
6611
+ fuzzyWeight?: number;
6612
+ };
6613
+ /**
6614
+ * @description Prioritise the result list of documents based on semantic similarity to "query" provided here.
6615
+ *
6616
+ * For example if field "animaltype_vector_" contains encoded vector values for "cat", lion, "dog","bird", and "query" is set to "kitten", documents with "cat", "lion" will be returned first in the results list.
6617
+ *
6618
+ * It can be an object or a list of objects.
6619
+ *
6620
+ *
6621
+ *
6622
+ * Example payloads:
6623
+ *
6624
+ * {"field":"animaltype_vector_","query":"kitten"}
6625
+ *
6626
+ * [
6627
+ *
6628
+ * {"field":"animaltype_vector_","query":"kitten","weight":1","model":"text"}, {"field":"animaltype_vector_","query":"https://www.dogimage.com/dogimage.png","model":"image","weight":2}
6629
+ *
6630
+ * ]
6631
+ */
6632
+ vectorSearchQuery?: {
6633
+ /** @description Vector name to search on. For example, title_vector_ */
6634
+ field: string;
6635
+ /** @description Query to transform to a vector and then search with. Default to query in the root body if not provided. */
6636
+ query?: string;
6430
6637
  /**
6431
- * Username
6432
- * @description The username you created to allow Airbyte to access the database.
6638
+ * @description Model name to generate the vector with.
6639
+ * @default text
6433
6640
  */
6434
- username: string;
6641
+ model?: string;
6642
+ /** @description Model url to use for encoding. If model and model_url are both set, model_url will override it. */
6643
+ model_url?: string;
6435
6644
  /**
6436
- * Password
6437
- * @description The password associated with the username.
6645
+ * @description Increases or decreases the impact of this vector fields match on documents relevance score.
6646
+ * @default 1
6438
6647
  */
6439
- password: string;
6440
- };
6441
- /**
6442
- * Account Name
6443
- * @description The host domain of the snowflake instance (must include the account, region, cloud environment, and end with snowflakecomputing.com).
6444
- */
6648
+ weight?: number;
6649
+ /** @description Instead of generating a vector by vectorising the query, use the vector provided here for vector search. */
6650
+ vector?: number[];
6651
+ chunkConfig?: {
6652
+ chunkField: string;
6653
+ page?: number;
6654
+ pageSize?: number;
6655
+ };
6656
+ } | {
6657
+ /** @description Vector name to search on. For example, title_vector_ */
6658
+ field: string;
6659
+ /** @description Query to transform to a vector and then search with. Default to query in the root body if not provided. */
6660
+ query?: string;
6661
+ /**
6662
+ * @description Model name to generate the vector with.
6663
+ * @default text
6664
+ */
6665
+ model?: string;
6666
+ /** @description Model url to use for encoding. If model and model_url are both set, model_url will override it. */
6667
+ model_url?: string;
6668
+ /**
6669
+ * @description Increases or decreases the impact of this vector fields match on documents relevance score.
6670
+ * @default 1
6671
+ */
6672
+ weight?: number;
6673
+ /** @description Instead of generating a vector by vectorising the query, use the vector provided here for vector search. */
6674
+ vector?: number[];
6675
+ chunkConfig?: {
6676
+ chunkField: string;
6677
+ page?: number;
6678
+ pageSize?: number;
6679
+ };
6680
+ }[];
6681
+ realtimeClustering?: {
6682
+ /** @default 4 */
6683
+ nClusters?: number;
6684
+ /** @default kmeans-realtime-4 */
6685
+ alias?: string;
6686
+ vectorField: string;
6687
+ /** @default _cluster_.{vector_field}.{alias} */
6688
+ outputField?: string;
6689
+ };
6690
+ /**
6691
+ * @description A list of fields to search using the "query" parameter.
6692
+ *
6693
+ * Each item can be field name as a string, or an object with 'field' as field name and optional parameters such as field weight.
6694
+ *
6695
+ * Default behaviour is to search all fields.
6696
+ *
6697
+ * Example: ["name",{"field":"favourite_color","weight":0.2}]
6698
+ */
6699
+ fieldsToSearch?: (string | {
6700
+ /** @description Field name to search. */
6701
+ field?: string;
6702
+ /**
6703
+ * @description Multiply the relevance contribution of a specific field when using traditional search.
6704
+ * @default 1
6705
+ */
6706
+ weight?: number;
6707
+ /** @description Enabled text search on chunk fields. Scoring will take the max similarity of any subitem within the chunk. */
6708
+ chunkField?: string;
6709
+ })[];
6710
+ /**
6711
+ * @description Only return documents with a _relevance above this threshold.
6712
+ *
6713
+ * Example: 0.3
6714
+ */
6715
+ minimumRelevance: number;
6716
+ };
6717
+ /** @description Match documents where field specified by 'field' exists in the document. for nested fields, use syntax: a.b.c */
6718
+ fieldExists?: {
6719
+ /** @description Field that must exist. */
6720
+ field?: string;
6721
+ };
6722
+ /** @description Match documents where doc[field] % module == value */
6723
+ matchModulo?: {
6724
+ /** @default _id */
6725
+ field?: string;
6726
+ modulo: number;
6727
+ value: number;
6728
+ };
6729
+ /** @description Filter down to one document for each value of selected field. */
6730
+ dedupeByValue?: {
6731
+ /** @description Field to filter on. */
6732
+ field: string;
6733
+ };
6734
+ /** @description Match documents where document[a] <=/>=/</>/==/!=/stringEquals document[b]. Use stringEquals to compare strings. */
6735
+ selfreference?: {
6736
+ /** @description First field in comparison. */
6737
+ a: string;
6738
+ /** @description Second field in comparison. */
6739
+ b: string;
6740
+ /** @description Operator used to compare a and b. */
6741
+ operation: "<=" | ">=" | "<" | ">" | "==" | "!=" | "stringEquals";
6742
+ };
6743
+ /** @description Match documents where greaterThan < wordCount(document[field]) < lessThan. */
6744
+ wordCount?: {
6745
+ /** @description Field to match on. */
6746
+ field: string;
6747
+ /** @description Minimum word count. */
6748
+ greaterThan?: number;
6749
+ /** @description Maximum word count. */
6750
+ lessThan?: number;
6751
+ };
6752
+ /** @description Match documents where greaterThan < characterCount(document[field]) < lessThan. */
6753
+ characterCount?: {
6754
+ /** @description Field to match on. */
6755
+ field: string;
6756
+ /** @description Minimum character count. */
6757
+ greaterThan?: number;
6758
+ /** @description Maximum character count. */
6759
+ lessThan?: number;
6760
+ };
6761
+ /** @description Used to perform a logical OR of filters. each element of the OR list can itself be a list to perform a nested AND. {or:[[A,B],C]} is equivalent to (A AND B) OR C */
6762
+ or?: (components["schemas"]["simpleSearchAndFlatFilterItem"][] | components["schemas"]["simpleSearchAndFlatFilterItem"])[];
6763
+ /** @description Used to perform NOT filter. Can be a single filter or a list of filters to perform a !(AND). {not:[A,B]} is equivalent to !(A AND B) */
6764
+ not?: components["schemas"]["simpleSearchAndFlatFilterItem"][] | components["schemas"]["simpleSearchAndFlatFilterItem"];
6765
+ /** @description Filter based on data within a _chunk_ field. */
6766
+ chunk?: {
6767
+ /** @description The path of the chunk field to filter on. For example: description_sentences_chunk_ */
6768
+ path: string;
6769
+ filters: components["schemas"]["simpleSearchAndFlatFilterItem"][];
6770
+ };
6771
+ }> & Partial<{
6772
+ strict?: "must" | "should" | "must_or";
6773
+ condition?: string;
6774
+ field?: string;
6775
+ filter_type?: "text_match" | "word_match" | "term" | "terms" | "text" | "texts" | "match" | "contains" | "substring" | "class" | "category" | "exact_match" | "classes" | "categories" | "exists" | "traditional" | "fuzzy" | "regexp" | "ids" | "date" | "numeric" | "search" | "or" | "word_count" | "character_count" | "dedupe_by_value";
6776
+ condition_value?: unknown;
6777
+ fuzzy?: number;
6778
+ join?: boolean;
6779
+ }>)[];
6780
+ /** @description Aggregation query to aggregate data */
6781
+ aggregation_query?: {
6782
+ groupby?: {
6783
+ agg?: "texts" | "categories" | "classes" | "text" | "category" | "class" | "terms" | "number" | "numeric" | "bool" | "wordcloud" | "array" | "boolean_filter" | "histogram";
6784
+ size?: number;
6785
+ field?: string;
6786
+ name?: string;
6787
+ boolean_filter?: Partial<{
6788
+ /** @description Match where document[field] is in value list. */
6789
+ match?: {
6790
+ /** @description If matching on text, match even if there are extra words / case insensitivity */
6791
+ fuzzy?: boolean;
6792
+ /** @description Field to match on. */
6793
+ field?: string;
6794
+ /** @description Can be either a single item or a list of items to match on. */
6795
+ value: string | boolean | number | unknown[];
6796
+ };
6797
+ /** @description Match where document._id is in value list. */
6798
+ matchIds?: {
6799
+ /** @description Can be either a single item or a list of items to match on. */
6800
+ value: string | boolean | number | unknown[];
6801
+ };
6802
+ /** @description Match documents where greaterThan < document[field] < lessThan. Supports numbers and date strings. */
6803
+ range?: {
6804
+ /** @description Field to match on. */
6805
+ field?: string;
6806
+ greaterThan?: unknown;
6807
+ lessThan?: unknown;
6808
+ greaterThanOrEqualTo?: unknown;
6809
+ lessThanOrEqualTo?: unknown;
6810
+ };
6811
+ /**
6812
+ * @description
6813
+ * Match documents where the field either contains the value as a substring, or matches a provided matching pattern.
6814
+ *
6815
+ * Possible matching patterns:
6816
+ *
6817
+ * * - documents where the field has any value
6818
+ * ? - documents where a single character from the field matches the provided values
6819
+ *
6820
+ * Example:
6821
+ *
6822
+ * {
6823
+ * wildcard: {
6824
+ * field: "title",
6825
+ * value: [ "Avenger*" ]
6826
+ * }
6827
+ * }
6828
+ */
6829
+ wildcard?: {
6830
+ /** @description Field to match on. */
6831
+ field?: string;
6832
+ /** @description single string or array of valid wildcard strings to match on, for example ['tele*'] */
6833
+ value: string | string[];
6834
+ };
6835
+ /** @description hybrid search query that must reach a certain value to filter */
6836
+ search?: {
6837
+ /**
6838
+ * @description Search for documents that contain this query string in your dataset. Use fieldsToSearch parameter to restrict which fields are searched.
6839
+ *
6840
+ * "tele" matches "Television", "This television is an excellent product…"
6841
+ *
6842
+ * Example: "tele"
6843
+ */
6844
+ query?: string;
6845
+ /** @description Configuration for traditional search query. */
6846
+ queryConfig?: {
6847
+ /**
6848
+ * @description Increases or decreases the impact of all traditional search matching when calculating a documents _relevance.
6849
+ * @default 1
6850
+ */
6851
+ weight?: number;
6852
+ /**
6853
+ * @description Increases or decreases the impact of sentence matching when calculating a documents _relevance.
6854
+ * For example, with query "A fox jumped", with high sentence weight, 'A fox jumped over the' would match before 'jumped a fox over fox'
6855
+ * @default 1
6856
+ */
6857
+ sentenceWeight?: number;
6858
+ /**
6859
+ * @description Increases or decreases the impact of fuzzy matching when calculating a documents _relevance.
6860
+ * For example, with query "rain", with 0 fuzzy weight, 'brain' would not match.
6861
+ * @default 1
6862
+ */
6863
+ fuzzyWeight?: number;
6864
+ };
6865
+ /**
6866
+ * @description Prioritise the result list of documents based on semantic similarity to "query" provided here.
6867
+ *
6868
+ * For example if field "animaltype_vector_" contains encoded vector values for "cat", lion, "dog","bird", and "query" is set to "kitten", documents with "cat", "lion" will be returned first in the results list.
6869
+ *
6870
+ * It can be an object or a list of objects.
6871
+ *
6872
+ *
6873
+ *
6874
+ * Example payloads:
6875
+ *
6876
+ * {"field":"animaltype_vector_","query":"kitten"}
6877
+ *
6878
+ * [
6879
+ *
6880
+ * {"field":"animaltype_vector_","query":"kitten","weight":1","model":"text"}, {"field":"animaltype_vector_","query":"https://www.dogimage.com/dogimage.png","model":"image","weight":2}
6881
+ *
6882
+ * ]
6883
+ */
6884
+ vectorSearchQuery?: {
6885
+ /** @description Vector name to search on. For example, title_vector_ */
6886
+ field: string;
6887
+ /** @description Query to transform to a vector and then search with. Default to query in the root body if not provided. */
6888
+ query?: string;
6889
+ /**
6890
+ * @description Model name to generate the vector with.
6891
+ * @default text
6892
+ */
6893
+ model?: string;
6894
+ /** @description Model url to use for encoding. If model and model_url are both set, model_url will override it. */
6895
+ model_url?: string;
6896
+ /**
6897
+ * @description Increases or decreases the impact of this vector fields match on documents relevance score.
6898
+ * @default 1
6899
+ */
6900
+ weight?: number;
6901
+ /** @description Instead of generating a vector by vectorising the query, use the vector provided here for vector search. */
6902
+ vector?: number[];
6903
+ chunkConfig?: {
6904
+ chunkField: string;
6905
+ page?: number;
6906
+ pageSize?: number;
6907
+ };
6908
+ } | {
6909
+ /** @description Vector name to search on. For example, title_vector_ */
6910
+ field: string;
6911
+ /** @description Query to transform to a vector and then search with. Default to query in the root body if not provided. */
6912
+ query?: string;
6913
+ /**
6914
+ * @description Model name to generate the vector with.
6915
+ * @default text
6916
+ */
6917
+ model?: string;
6918
+ /** @description Model url to use for encoding. If model and model_url are both set, model_url will override it. */
6919
+ model_url?: string;
6920
+ /**
6921
+ * @description Increases or decreases the impact of this vector fields match on documents relevance score.
6922
+ * @default 1
6923
+ */
6924
+ weight?: number;
6925
+ /** @description Instead of generating a vector by vectorising the query, use the vector provided here for vector search. */
6926
+ vector?: number[];
6927
+ chunkConfig?: {
6928
+ chunkField: string;
6929
+ page?: number;
6930
+ pageSize?: number;
6931
+ };
6932
+ }[];
6933
+ realtimeClustering?: {
6934
+ /** @default 4 */
6935
+ nClusters?: number;
6936
+ /** @default kmeans-realtime-4 */
6937
+ alias?: string;
6938
+ vectorField: string;
6939
+ /** @default _cluster_.{vector_field}.{alias} */
6940
+ outputField?: string;
6941
+ };
6942
+ /**
6943
+ * @description A list of fields to search using the "query" parameter.
6944
+ *
6945
+ * Each item can be field name as a string, or an object with 'field' as field name and optional parameters such as field weight.
6946
+ *
6947
+ * Default behaviour is to search all fields.
6948
+ *
6949
+ * Example: ["name",{"field":"favourite_color","weight":0.2}]
6950
+ */
6951
+ fieldsToSearch?: (string | {
6952
+ /** @description Field name to search. */
6953
+ field?: string;
6954
+ /**
6955
+ * @description Multiply the relevance contribution of a specific field when using traditional search.
6956
+ * @default 1
6957
+ */
6958
+ weight?: number;
6959
+ /** @description Enabled text search on chunk fields. Scoring will take the max similarity of any subitem within the chunk. */
6960
+ chunkField?: string;
6961
+ })[];
6962
+ /**
6963
+ * @description Only return documents with a _relevance above this threshold.
6964
+ *
6965
+ * Example: 0.3
6966
+ */
6967
+ minimumRelevance: number;
6968
+ };
6969
+ /** @description Match documents where field specified by 'field' exists in the document. for nested fields, use syntax: a.b.c */
6970
+ fieldExists?: {
6971
+ /** @description Field that must exist. */
6972
+ field?: string;
6973
+ };
6974
+ /** @description Match documents where doc[field] % module == value */
6975
+ matchModulo?: {
6976
+ /** @default _id */
6977
+ field?: string;
6978
+ modulo: number;
6979
+ value: number;
6980
+ };
6981
+ /** @description Filter down to one document for each value of selected field. */
6982
+ dedupeByValue?: {
6983
+ /** @description Field to filter on. */
6984
+ field: string;
6985
+ };
6986
+ /** @description Match documents where document[a] <=/>=/</>/==/!=/stringEquals document[b]. Use stringEquals to compare strings. */
6987
+ selfreference?: {
6988
+ /** @description First field in comparison. */
6989
+ a: string;
6990
+ /** @description Second field in comparison. */
6991
+ b: string;
6992
+ /** @description Operator used to compare a and b. */
6993
+ operation: "<=" | ">=" | "<" | ">" | "==" | "!=" | "stringEquals";
6994
+ };
6995
+ /** @description Match documents where greaterThan < wordCount(document[field]) < lessThan. */
6996
+ wordCount?: {
6997
+ /** @description Field to match on. */
6998
+ field: string;
6999
+ /** @description Minimum word count. */
7000
+ greaterThan?: number;
7001
+ /** @description Maximum word count. */
7002
+ lessThan?: number;
7003
+ };
7004
+ /** @description Match documents where greaterThan < characterCount(document[field]) < lessThan. */
7005
+ characterCount?: {
7006
+ /** @description Field to match on. */
7007
+ field: string;
7008
+ /** @description Minimum character count. */
7009
+ greaterThan?: number;
7010
+ /** @description Maximum character count. */
7011
+ lessThan?: number;
7012
+ };
7013
+ /** @description Used to perform a logical OR of filters. each element of the OR list can itself be a list to perform a nested AND. {or:[[A,B],C]} is equivalent to (A AND B) OR C */
7014
+ or?: (components["schemas"]["simpleSearchAndFlatFilterItem"][] | components["schemas"]["simpleSearchAndFlatFilterItem"])[];
7015
+ /** @description Used to perform NOT filter. Can be a single filter or a list of filters to perform a !(AND). {not:[A,B]} is equivalent to !(A AND B) */
7016
+ not?: components["schemas"]["simpleSearchAndFlatFilterItem"][] | components["schemas"]["simpleSearchAndFlatFilterItem"];
7017
+ /** @description Filter based on data within a _chunk_ field. */
7018
+ chunk?: {
7019
+ /** @description The path of the chunk field to filter on. For example: description_sentences_chunk_ */
7020
+ path: string;
7021
+ filters: components["schemas"]["simpleSearchAndFlatFilterItem"][];
7022
+ };
7023
+ }> & Partial<{
7024
+ strict?: "must" | "should" | "must_or";
7025
+ condition?: string;
7026
+ field?: string;
7027
+ filter_type?: "text_match" | "word_match" | "term" | "terms" | "text" | "texts" | "match" | "contains" | "substring" | "class" | "category" | "exact_match" | "classes" | "categories" | "exists" | "traditional" | "fuzzy" | "regexp" | "ids" | "date" | "numeric" | "search" | "or" | "word_count" | "character_count" | "dedupe_by_value";
7028
+ condition_value?: unknown;
7029
+ fuzzy?: number;
7030
+ join?: boolean;
7031
+ }>;
7032
+ /** @description Control the number of results for this aggregation level. This will default to the page_size provided in the root body if not provided. */
7033
+ page_size?: number;
7034
+ group_size?: number;
7035
+ select_fields?: string[];
7036
+ remove_words?: string[];
7037
+ /** @default monthly */
7038
+ date_interval?: "monthly" | "daily" | "yearly" | "hourly" | "minutely" | "weekly";
7039
+ /** @description If provided, group by field into n buckets in date range. */
7040
+ n_date_buckets?: number;
7041
+ buckets?: Partial<{
7042
+ histogram?: {
7043
+ interval?: number;
7044
+ min_doc_count?: number;
7045
+ };
7046
+ }> & Partial<{
7047
+ from?: number;
7048
+ to?: number;
7049
+ }[]>;
7050
+ }[];
7051
+ metrics?: {
7052
+ field?: string;
7053
+ fields?: string[];
7054
+ agg?: "avg" | "average" | "cardinality" | "max" | "mean" | "min" | "sum" | "percentiles" | "sum_of_squares" | "variance" | "std_deviation" | "std_deviation_bounds" | "kurtosis" | "covariance" | "skewness" | "character_count" | "count" | "correlation" | "missing";
7055
+ name?: string;
7056
+ }[];
7057
+ sort?: (string | {
7058
+ [key: string]: "asc" | "desc";
7059
+ })[];
7060
+ };
7061
+ /**
7062
+ * @description Size of each page of results
7063
+ * @default 20
7064
+ */
7065
+ page_size?: number;
7066
+ /**
7067
+ * @description Page of the results
7068
+ * @default 1
7069
+ */
7070
+ page?: number;
7071
+ /** @description Whether to sort results by ascending or descending order. */
7072
+ asc?: boolean;
7073
+ dataset_ids?: string[];
7074
+ dataset_id?: string;
7075
+ /** @default monthly */
7076
+ date_interval?: "monthly" | "daily" | "yearly" | "hourly" | "minutely" | "weekly";
7077
+ };
7078
+ AggregateOrganizationMetricsOutput: {
7079
+ results?: unknown[];
7080
+ };
7081
+ CreateConnectorInput: {
7082
+ source_type: "Snowflake";
7083
+ source_database?: string;
7084
+ source_collection: string;
7085
+ /** @description If provided, use this field as the _id value in documents. */
7086
+ id_field?: string;
7087
+ source_settings: {
7088
+ custom?: {
7089
+ [key: string]: unknown;
7090
+ };
7091
+ Snowflake?: {
7092
+ /** Authorization Method */
7093
+ credentials?: {
7094
+ /** @default OAuth */
7095
+ auth_type: string;
7096
+ /**
7097
+ * Client ID
7098
+ * @description The Client ID of your Snowflake developer application.
7099
+ */
7100
+ client_id: string;
7101
+ /**
7102
+ * Client Secret
7103
+ * @description The Client Secret of your Snowflake developer application.
7104
+ */
7105
+ client_secret: string;
7106
+ /**
7107
+ * Access Token
7108
+ * @description Access Token for making authenticated requests.
7109
+ */
7110
+ access_token?: string;
7111
+ /**
7112
+ * Refresh Token
7113
+ * @description Refresh Token for making authenticated requests.
7114
+ */
7115
+ refresh_token?: string;
7116
+ } | {
7117
+ /** @default username/password */
7118
+ auth_type: string;
7119
+ /**
7120
+ * Username
7121
+ * @description The username you created to allow Airbyte to access the database.
7122
+ */
7123
+ username: string;
7124
+ /**
7125
+ * Password
7126
+ * @description The password associated with the username.
7127
+ */
7128
+ password: string;
7129
+ };
7130
+ /**
7131
+ * Account Name
7132
+ * @description The host domain of the snowflake instance (must include the account, region, cloud environment, and end with snowflakecomputing.com).
7133
+ */
6445
7134
  host?: string;
6446
7135
  /**
6447
7136
  * Role
@@ -6927,6 +7616,20 @@ export interface components {
6927
7616
  instance_type?: string;
6928
7617
  dataset_id: string;
6929
7618
  workflow_id?: string;
7619
+ template?: {
7620
+ transformations: {
7621
+ [key: string]: {
7622
+ properties: {
7623
+ params: {
7624
+ [key: string]: unknown;
7625
+ };
7626
+ workflow_id: string;
7627
+ dataset_id: string;
7628
+ };
7629
+ depends_on?: string[];
7630
+ };
7631
+ };
7632
+ };
6930
7633
  };
6931
7634
  TriggerWorkflowOutput: {
6932
7635
  job_id: string;
@@ -6944,20 +7647,35 @@ export interface components {
6944
7647
  };
6945
7648
  _id?: string;
6946
7649
  workflow_id?: string;
7650
+ parent_job_id?: string;
6947
7651
  metadata?: {
6948
7652
  [key: string]: unknown;
6949
7653
  };
6950
7654
  /** @description Status of the workflow. Used for knowing when to send an email notification. */
6951
- status?: "complete" | "inprogress" | "failed";
6952
- job_status?: "InProgress" | "Completed" | "Failed";
7655
+ status?: "complete" | "inprogress" | "failed" | "cancelled";
7656
+ job_status?: "InProgress" | "Completed" | "Failed" | "Cancelled";
6953
7657
  worker_status?: {
6954
7658
  [key: string]: {
6955
- status?: "complete" | "inprogress" | "failed";
7659
+ status?: "complete" | "inprogress" | "failed" | "cancelled";
6956
7660
  completion_time?: string;
6957
7661
  creation_time?: string;
6958
7662
  };
6959
7663
  };
6960
- n_workers?: number;
7664
+ n_workers?: number;
7665
+ template?: {
7666
+ transformations: {
7667
+ [key: string]: {
7668
+ properties: {
7669
+ params: {
7670
+ [key: string]: unknown;
7671
+ };
7672
+ workflow_id: string;
7673
+ dataset_id: string;
7674
+ };
7675
+ depends_on?: string[];
7676
+ };
7677
+ };
7678
+ };
6961
7679
  steps?: {
6962
7680
  [key: string]: {
6963
7681
  worker_progress?: {
@@ -6968,6 +7686,8 @@ export interface components {
6968
7686
  };
6969
7687
  n_processed?: number;
6970
7688
  n_total?: number;
7689
+ job_id?: string;
7690
+ error_message?: string;
6971
7691
  };
6972
7692
  };
6973
7693
  } & {
@@ -6986,20 +7706,35 @@ export interface components {
6986
7706
  };
6987
7707
  _id?: string;
6988
7708
  workflow_id?: string;
7709
+ parent_job_id?: string;
6989
7710
  metadata?: {
6990
7711
  [key: string]: unknown;
6991
7712
  };
6992
7713
  /** @description Status of the workflow. Used for knowing when to send an email notification. */
6993
- status?: "complete" | "inprogress" | "failed";
6994
- job_status?: "InProgress" | "Completed" | "Failed";
7714
+ status?: "complete" | "inprogress" | "failed" | "cancelled";
7715
+ job_status?: "InProgress" | "Completed" | "Failed" | "Cancelled";
6995
7716
  worker_status?: {
6996
7717
  [key: string]: {
6997
- status?: "complete" | "inprogress" | "failed";
7718
+ status?: "complete" | "inprogress" | "failed" | "cancelled";
6998
7719
  completion_time?: string;
6999
7720
  creation_time?: string;
7000
7721
  };
7001
7722
  };
7002
7723
  n_workers?: number;
7724
+ template?: {
7725
+ transformations: {
7726
+ [key: string]: {
7727
+ properties: {
7728
+ params: {
7729
+ [key: string]: unknown;
7730
+ };
7731
+ workflow_id: string;
7732
+ dataset_id: string;
7733
+ };
7734
+ depends_on?: string[];
7735
+ };
7736
+ };
7737
+ };
7003
7738
  steps?: {
7004
7739
  [key: string]: {
7005
7740
  worker_progress?: {
@@ -7010,6 +7745,8 @@ export interface components {
7010
7745
  };
7011
7746
  n_processed?: number;
7012
7747
  n_total?: number;
7748
+ job_id?: string;
7749
+ error_message?: string;
7013
7750
  };
7014
7751
  };
7015
7752
  } & {
@@ -7017,6 +7754,8 @@ export interface components {
7017
7754
  };
7018
7755
  DeleteWorkflowStatusInput: unknown;
7019
7756
  DeleteWorkflowStatusOutput: unknown;
7757
+ TerminateWorkflowInput: unknown;
7758
+ TerminateWorkflowOutput: unknown;
7020
7759
  UpsertWorkflowMetadataInput: {
7021
7760
  /** @description Edit and add metadata for the workflow. */
7022
7761
  metadata: {
@@ -7037,7 +7776,7 @@ export interface components {
7037
7776
  [key: string]: unknown;
7038
7777
  };
7039
7778
  /** @description Status of the workflow. Used for knowing when to send an email notification. */
7040
- status: "complete" | "inprogress" | "failed";
7779
+ status: "complete" | "inprogress" | "failed" | "cancelled";
7041
7780
  /** @description Workflow name that is passed into the email. */
7042
7781
  workflow_name?: string;
7043
7782
  /** @description Additional information of the workflow that is passed into the email. */
@@ -7060,20 +7799,35 @@ export interface components {
7060
7799
  };
7061
7800
  _id?: string;
7062
7801
  workflow_id?: string;
7802
+ parent_job_id?: string;
7063
7803
  metadata?: {
7064
7804
  [key: string]: unknown;
7065
7805
  };
7066
7806
  /** @description Status of the workflow. Used for knowing when to send an email notification. */
7067
- status?: "complete" | "inprogress" | "failed";
7068
- job_status?: "InProgress" | "Completed" | "Failed";
7807
+ status?: "complete" | "inprogress" | "failed" | "cancelled";
7808
+ job_status?: "InProgress" | "Completed" | "Failed" | "Cancelled";
7069
7809
  worker_status?: {
7070
7810
  [key: string]: {
7071
- status?: "complete" | "inprogress" | "failed";
7811
+ status?: "complete" | "inprogress" | "failed" | "cancelled";
7072
7812
  completion_time?: string;
7073
7813
  creation_time?: string;
7074
7814
  };
7075
7815
  };
7076
7816
  n_workers?: number;
7817
+ template?: {
7818
+ transformations: {
7819
+ [key: string]: {
7820
+ properties: {
7821
+ params: {
7822
+ [key: string]: unknown;
7823
+ };
7824
+ workflow_id: string;
7825
+ dataset_id: string;
7826
+ };
7827
+ depends_on?: string[];
7828
+ };
7829
+ };
7830
+ };
7077
7831
  steps?: {
7078
7832
  [key: string]: {
7079
7833
  worker_progress?: {
@@ -7084,6 +7838,8 @@ export interface components {
7084
7838
  };
7085
7839
  n_processed?: number;
7086
7840
  n_total?: number;
7841
+ job_id?: string;
7842
+ error_message?: string;
7087
7843
  };
7088
7844
  };
7089
7845
  } & {
@@ -7094,6 +7850,9 @@ export interface components {
7094
7850
  results: ({
7095
7851
  workflow_id: string;
7096
7852
  workflow_path?: string;
7853
+ template_raw_?: {
7854
+ [key: string]: unknown;
7855
+ };
7097
7856
  parameters_raw_?: {
7098
7857
  [key: string]: unknown;
7099
7858
  };
@@ -7105,6 +7864,9 @@ export interface components {
7105
7864
  GetWorkflowTypeOutput: {
7106
7865
  workflow_id: string;
7107
7866
  workflow_path?: string;
7867
+ template_raw_?: {
7868
+ [key: string]: unknown;
7869
+ };
7108
7870
  parameters_raw_?: {
7109
7871
  [key: string]: unknown;
7110
7872
  };
@@ -8169,38 +8931,295 @@ export interface components {
8169
8931
  /** @description The alias of the clustering. */
8170
8932
  alias?: string;
8171
8933
  };
8172
- }[];
8173
- /** @description A list of jobs to run once all documents are processed. */
8174
- jobs_to_trigger?: {
8175
- /** @description Specify this to run an encoding job after documents are processed. Supports chunk field encoding, encoding many fields, and storing results in a new field specified by alias. */
8176
- encode?: {
8177
- /** @description Chunk field to encode. Will produce a field with _chunkvector_ suffix. */
8178
- chunk_field?: string;
8179
- /** @description Regular fields to encode. Will produce a field with _vector suffix. */
8180
- fields?: string[];
8181
- /** @description If provided, this string will be added to the output field name. */
8182
- alias?: string;
8183
- /** @description Model name to use for encoding. */
8184
- model_name?: string;
8934
+ }[];
8935
+ /** @description A list of jobs to run once all documents are processed. */
8936
+ jobs_to_trigger?: {
8937
+ /** @description Specify this to run an encoding job after documents are processed. Supports chunk field encoding, encoding many fields, and storing results in a new field specified by alias. */
8938
+ encode?: {
8939
+ /** @description Chunk field to encode. Will produce a field with _chunkvector_ suffix. */
8940
+ chunk_field?: string;
8941
+ /** @description Regular fields to encode. Will produce a field with _vector suffix. */
8942
+ fields?: string[];
8943
+ /** @description If provided, this string will be added to the output field name. */
8944
+ alias?: string;
8945
+ /** @description Model name to use for encoding. */
8946
+ model_name?: string;
8947
+ };
8948
+ }[];
8949
+ };
8950
+ BulkUpdateOutput: {
8951
+ /** @description Number of successfully processed documents. */
8952
+ inserted: number;
8953
+ /** @description Information about documents that were not processed successfully. */
8954
+ failed_documents: {
8955
+ /** @description _id field of unprocessed document. */
8956
+ _id?: unknown;
8957
+ error?: {
8958
+ /** @description http status code of individual document insertion operation. */
8959
+ status?: number;
8960
+ /** @description body response of individual document insertion operation. */
8961
+ body?: string;
8962
+ };
8963
+ }[];
8964
+ };
8965
+ UpdateWhereInput: {
8966
+ filters?: (Partial<{
8967
+ /** @description Match where document[field] is in value list. */
8968
+ match?: {
8969
+ /** @description If matching on text, match even if there are extra words / case insensitivity */
8970
+ fuzzy?: boolean;
8971
+ /** @description Field to match on. */
8972
+ field?: string;
8973
+ /** @description Can be either a single item or a list of items to match on. */
8974
+ value: string | boolean | number | unknown[];
8975
+ };
8976
+ /** @description Match where document._id is in value list. */
8977
+ matchIds?: {
8978
+ /** @description Can be either a single item or a list of items to match on. */
8979
+ value: string | boolean | number | unknown[];
8980
+ };
8981
+ /** @description Match documents where greaterThan < document[field] < lessThan. Supports numbers and date strings. */
8982
+ range?: {
8983
+ /** @description Field to match on. */
8984
+ field?: string;
8985
+ greaterThan?: unknown;
8986
+ lessThan?: unknown;
8987
+ greaterThanOrEqualTo?: unknown;
8988
+ lessThanOrEqualTo?: unknown;
8989
+ };
8990
+ /**
8991
+ * @description
8992
+ * Match documents where the field either contains the value as a substring, or matches a provided matching pattern.
8993
+ *
8994
+ * Possible matching patterns:
8995
+ *
8996
+ * * - documents where the field has any value
8997
+ * ? - documents where a single character from the field matches the provided values
8998
+ *
8999
+ * Example:
9000
+ *
9001
+ * {
9002
+ * wildcard: {
9003
+ * field: "title",
9004
+ * value: [ "Avenger*" ]
9005
+ * }
9006
+ * }
9007
+ */
9008
+ wildcard?: {
9009
+ /** @description Field to match on. */
9010
+ field?: string;
9011
+ /** @description single string or array of valid wildcard strings to match on, for example ['tele*'] */
9012
+ value: string | string[];
9013
+ };
9014
+ /** @description hybrid search query that must reach a certain value to filter */
9015
+ search?: {
9016
+ /**
9017
+ * @description Search for documents that contain this query string in your dataset. Use fieldsToSearch parameter to restrict which fields are searched.
9018
+ *
9019
+ * "tele" matches "Television", "This television is an excellent product…"
9020
+ *
9021
+ * Example: "tele"
9022
+ */
9023
+ query?: string;
9024
+ /** @description Configuration for traditional search query. */
9025
+ queryConfig?: {
9026
+ /**
9027
+ * @description Increases or decreases the impact of all traditional search matching when calculating a documents _relevance.
9028
+ * @default 1
9029
+ */
9030
+ weight?: number;
9031
+ /**
9032
+ * @description Increases or decreases the impact of sentence matching when calculating a documents _relevance.
9033
+ * For example, with query "A fox jumped", with high sentence weight, 'A fox jumped over the' would match before 'jumped a fox over fox'
9034
+ * @default 1
9035
+ */
9036
+ sentenceWeight?: number;
9037
+ /**
9038
+ * @description Increases or decreases the impact of fuzzy matching when calculating a documents _relevance.
9039
+ * For example, with query "rain", with 0 fuzzy weight, 'brain' would not match.
9040
+ * @default 1
9041
+ */
9042
+ fuzzyWeight?: number;
9043
+ };
9044
+ /**
9045
+ * @description Prioritise the result list of documents based on semantic similarity to "query" provided here.
9046
+ *
9047
+ * For example if field "animaltype_vector_" contains encoded vector values for "cat", lion, "dog","bird", and "query" is set to "kitten", documents with "cat", "lion" will be returned first in the results list.
9048
+ *
9049
+ * It can be an object or a list of objects.
9050
+ *
9051
+ *
9052
+ *
9053
+ * Example payloads:
9054
+ *
9055
+ * {"field":"animaltype_vector_","query":"kitten"}
9056
+ *
9057
+ * [
9058
+ *
9059
+ * {"field":"animaltype_vector_","query":"kitten","weight":1","model":"text"}, {"field":"animaltype_vector_","query":"https://www.dogimage.com/dogimage.png","model":"image","weight":2}
9060
+ *
9061
+ * ]
9062
+ */
9063
+ vectorSearchQuery?: {
9064
+ /** @description Vector name to search on. For example, title_vector_ */
9065
+ field: string;
9066
+ /** @description Query to transform to a vector and then search with. Default to query in the root body if not provided. */
9067
+ query?: string;
9068
+ /**
9069
+ * @description Model name to generate the vector with.
9070
+ * @default text
9071
+ */
9072
+ model?: string;
9073
+ /** @description Model url to use for encoding. If model and model_url are both set, model_url will override it. */
9074
+ model_url?: string;
9075
+ /**
9076
+ * @description Increases or decreases the impact of this vector fields match on documents relevance score.
9077
+ * @default 1
9078
+ */
9079
+ weight?: number;
9080
+ /** @description Instead of generating a vector by vectorising the query, use the vector provided here for vector search. */
9081
+ vector?: number[];
9082
+ chunkConfig?: {
9083
+ chunkField: string;
9084
+ page?: number;
9085
+ pageSize?: number;
9086
+ };
9087
+ } | {
9088
+ /** @description Vector name to search on. For example, title_vector_ */
9089
+ field: string;
9090
+ /** @description Query to transform to a vector and then search with. Default to query in the root body if not provided. */
9091
+ query?: string;
9092
+ /**
9093
+ * @description Model name to generate the vector with.
9094
+ * @default text
9095
+ */
9096
+ model?: string;
9097
+ /** @description Model url to use for encoding. If model and model_url are both set, model_url will override it. */
9098
+ model_url?: string;
9099
+ /**
9100
+ * @description Increases or decreases the impact of this vector fields match on documents relevance score.
9101
+ * @default 1
9102
+ */
9103
+ weight?: number;
9104
+ /** @description Instead of generating a vector by vectorising the query, use the vector provided here for vector search. */
9105
+ vector?: number[];
9106
+ chunkConfig?: {
9107
+ chunkField: string;
9108
+ page?: number;
9109
+ pageSize?: number;
9110
+ };
9111
+ }[];
9112
+ realtimeClustering?: {
9113
+ /** @default 4 */
9114
+ nClusters?: number;
9115
+ /** @default kmeans-realtime-4 */
9116
+ alias?: string;
9117
+ vectorField: string;
9118
+ /** @default _cluster_.{vector_field}.{alias} */
9119
+ outputField?: string;
9120
+ };
9121
+ /**
9122
+ * @description A list of fields to search using the "query" parameter.
9123
+ *
9124
+ * Each item can be field name as a string, or an object with 'field' as field name and optional parameters such as field weight.
9125
+ *
9126
+ * Default behaviour is to search all fields.
9127
+ *
9128
+ * Example: ["name",{"field":"favourite_color","weight":0.2}]
9129
+ */
9130
+ fieldsToSearch?: (string | {
9131
+ /** @description Field name to search. */
9132
+ field?: string;
9133
+ /**
9134
+ * @description Multiply the relevance contribution of a specific field when using traditional search.
9135
+ * @default 1
9136
+ */
9137
+ weight?: number;
9138
+ /** @description Enabled text search on chunk fields. Scoring will take the max similarity of any subitem within the chunk. */
9139
+ chunkField?: string;
9140
+ })[];
9141
+ /**
9142
+ * @description Only return documents with a _relevance above this threshold.
9143
+ *
9144
+ * Example: 0.3
9145
+ */
9146
+ minimumRelevance: number;
9147
+ };
9148
+ /** @description Match documents where field specified by 'field' exists in the document. for nested fields, use syntax: a.b.c */
9149
+ fieldExists?: {
9150
+ /** @description Field that must exist. */
9151
+ field?: string;
9152
+ };
9153
+ /** @description Match documents where doc[field] % module == value */
9154
+ matchModulo?: {
9155
+ /** @default _id */
9156
+ field?: string;
9157
+ modulo: number;
9158
+ value: number;
9159
+ };
9160
+ /** @description Filter down to one document for each value of selected field. */
9161
+ dedupeByValue?: {
9162
+ /** @description Field to filter on. */
9163
+ field: string;
9164
+ };
9165
+ /** @description Match documents where document[a] <=/>=/</>/==/!=/stringEquals document[b]. Use stringEquals to compare strings. */
9166
+ selfreference?: {
9167
+ /** @description First field in comparison. */
9168
+ a: string;
9169
+ /** @description Second field in comparison. */
9170
+ b: string;
9171
+ /** @description Operator used to compare a and b. */
9172
+ operation: "<=" | ">=" | "<" | ">" | "==" | "!=" | "stringEquals";
9173
+ };
9174
+ /** @description Match documents where greaterThan < wordCount(document[field]) < lessThan. */
9175
+ wordCount?: {
9176
+ /** @description Field to match on. */
9177
+ field: string;
9178
+ /** @description Minimum word count. */
9179
+ greaterThan?: number;
9180
+ /** @description Maximum word count. */
9181
+ lessThan?: number;
8185
9182
  };
8186
- }[];
8187
- };
8188
- BulkUpdateOutput: {
8189
- /** @description Number of successfully processed documents. */
8190
- inserted: number;
8191
- /** @description Information about documents that were not processed successfully. */
8192
- failed_documents: {
8193
- /** @description _id field of unprocessed document. */
8194
- _id?: unknown;
8195
- error?: {
8196
- /** @description http status code of individual document insertion operation. */
8197
- status?: number;
8198
- /** @description body response of individual document insertion operation. */
8199
- body?: string;
9183
+ /** @description Match documents where greaterThan < characterCount(document[field]) < lessThan. */
9184
+ characterCount?: {
9185
+ /** @description Field to match on. */
9186
+ field: string;
9187
+ /** @description Minimum character count. */
9188
+ greaterThan?: number;
9189
+ /** @description Maximum character count. */
9190
+ lessThan?: number;
8200
9191
  };
8201
- }[];
9192
+ /** @description Used to perform a logical OR of filters. each element of the OR list can itself be a list to perform a nested AND. {or:[[A,B],C]} is equivalent to (A AND B) OR C */
9193
+ or?: (components["schemas"]["simpleSearchAndFlatFilterItem"][] | components["schemas"]["simpleSearchAndFlatFilterItem"])[];
9194
+ /** @description Used to perform NOT filter. Can be a single filter or a list of filters to perform a !(AND). {not:[A,B]} is equivalent to !(A AND B) */
9195
+ not?: components["schemas"]["simpleSearchAndFlatFilterItem"][] | components["schemas"]["simpleSearchAndFlatFilterItem"];
9196
+ /** @description Filter based on data within a _chunk_ field. */
9197
+ chunk?: {
9198
+ /** @description The path of the chunk field to filter on. For example: description_sentences_chunk_ */
9199
+ path: string;
9200
+ filters: components["schemas"]["simpleSearchAndFlatFilterItem"][];
9201
+ };
9202
+ }> & Partial<{
9203
+ strict?: "must" | "should" | "must_or";
9204
+ condition?: string;
9205
+ field?: string;
9206
+ filter_type?: "text_match" | "word_match" | "term" | "terms" | "text" | "texts" | "match" | "contains" | "substring" | "class" | "category" | "exact_match" | "classes" | "categories" | "exists" | "traditional" | "fuzzy" | "regexp" | "ids" | "date" | "numeric" | "search" | "or" | "word_count" | "character_count" | "dedupe_by_value";
9207
+ condition_value?: unknown;
9208
+ fuzzy?: number;
9209
+ join?: boolean;
9210
+ }>)[];
9211
+ /** @description Updates to make to the documents. It should be specified in a format of {"field_name": "value"}. e.g. {"item.status" : "Sold Out"} */
9212
+ updates: {
9213
+ [key: string]: unknown;
9214
+ };
8202
9215
  };
8203
- UpdateWhereInput: {
9216
+ UpdateWhereOutput: {
9217
+ /** @description Completion status. */
9218
+ status: string;
9219
+ /** @description Response message for completion state. */
9220
+ message: string;
9221
+ };
9222
+ AppendTagsInput: {
8204
9223
  filters?: (Partial<{
8205
9224
  /** @description Match where document[field] is in value list. */
8206
9225
  match?: {
@@ -8446,18 +9465,11 @@ export interface components {
8446
9465
  fuzzy?: number;
8447
9466
  join?: boolean;
8448
9467
  }>)[];
8449
- /** @description Updates to make to the documents. It should be specified in a format of {"field_name": "value"}. e.g. {"item.status" : "Sold Out"} */
8450
- updates: {
8451
- [key: string]: unknown;
8452
- };
8453
- };
8454
- UpdateWhereOutput: {
8455
- /** @description Completion status. */
8456
- status: string;
8457
- /** @description Response message for completion state. */
8458
- message: string;
9468
+ field: string;
9469
+ tags_to_add: string[];
8459
9470
  };
8460
- AppendTagsInput: {
9471
+ AppendTagsOutput: unknown;
9472
+ DeleteTagsInput: {
8461
9473
  filters?: (Partial<{
8462
9474
  /** @description Match where document[field] is in value list. */
8463
9475
  match?: {
@@ -8704,10 +9716,10 @@ export interface components {
8704
9716
  join?: boolean;
8705
9717
  }>)[];
8706
9718
  field: string;
8707
- tags_to_add: string[];
9719
+ tags_to_delete: string[];
8708
9720
  };
8709
- AppendTagsOutput: unknown;
8710
- DeleteTagsInput: {
9721
+ DeleteTagsOutput: unknown;
9722
+ MergeTagsInput: {
8711
9723
  filters?: (Partial<{
8712
9724
  /** @description Match where document[field] is in value list. */
8713
9725
  match?: {
@@ -8954,10 +9966,12 @@ export interface components {
8954
9966
  join?: boolean;
8955
9967
  }>)[];
8956
9968
  field: string;
8957
- tags_to_delete: string[];
9969
+ tags_to_merge: {
9970
+ [key: string]: string;
9971
+ };
8958
9972
  };
8959
- DeleteTagsOutput: unknown;
8960
- MergeTagsInput: {
9973
+ MergeTagsOutput: unknown;
9974
+ EditTagsInput: {
8961
9975
  filters?: (Partial<{
8962
9976
  /** @description Match where document[field] is in value list. */
8963
9977
  match?: {
@@ -9204,11 +10218,13 @@ export interface components {
9204
10218
  join?: boolean;
9205
10219
  }>)[];
9206
10220
  field: string;
9207
- tags_to_merge: {
10221
+ tags_to_merge?: {
9208
10222
  [key: string]: string;
9209
10223
  };
10224
+ tags_to_delete?: string[];
10225
+ tags_to_add?: string[];
9210
10226
  };
9211
- MergeTagsOutput: unknown;
10227
+ EditTagsOutput: unknown;
9212
10228
  ListFacetsInput: {
9213
10229
  /** @description Fields to include in the facets, if [] then all */
9214
10230
  fields?: string[];
@@ -12015,7 +13031,12 @@ export interface components {
12015
13031
  DeleteFieldChildrenInput: unknown;
12016
13032
  DeleteFieldChildrenOutput: unknown;
12017
13033
  ListFieldChildrensInput: {
12018
- [key: string]: unknown;
13034
+ page?: number;
13035
+ page_size?: number;
13036
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
13037
+ sort?: (string | {
13038
+ [key: string]: "asc" | "desc";
13039
+ })[];
12019
13040
  };
12020
13041
  ListFieldChildrensOutput: {
12021
13042
  results: {
@@ -12041,7 +13062,12 @@ export interface components {
12041
13062
  DeleteFavouriteWorkflowInput: unknown;
12042
13063
  DeleteFavouriteWorkflowOutput: unknown;
12043
13064
  ListFavouriteWorkflowsInput: {
12044
- [key: string]: unknown;
13065
+ page?: number;
13066
+ page_size?: number;
13067
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
13068
+ sort?: (string | {
13069
+ [key: string]: "asc" | "desc";
13070
+ })[];
12045
13071
  };
12046
13072
  ListFavouriteWorkflowsOutput: {
12047
13073
  results: {
@@ -12055,7 +13081,12 @@ export interface components {
12055
13081
  DeleteSavedFilterInput: unknown;
12056
13082
  DeleteSavedFilterOutput: unknown;
12057
13083
  ListSavedFiltersInput: {
12058
- [key: string]: unknown;
13084
+ page?: number;
13085
+ page_size?: number;
13086
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
13087
+ sort?: (string | {
13088
+ [key: string]: "asc" | "desc";
13089
+ })[];
12059
13090
  };
12060
13091
  ListSavedFiltersOutput: {
12061
13092
  results: {
@@ -12099,7 +13130,12 @@ export interface components {
12099
13130
  DeleteComponentInput: unknown;
12100
13131
  DeleteComponentOutput: unknown;
12101
13132
  ListComponentsInput: {
12102
- [key: string]: unknown;
13133
+ page?: number;
13134
+ page_size?: number;
13135
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
13136
+ sort?: (string | {
13137
+ [key: string]: "asc" | "desc";
13138
+ })[];
12103
13139
  };
12104
13140
  ListComponentsOutput: {
12105
13141
  results: {
@@ -12132,6 +13168,145 @@ export interface components {
12132
13168
  CreateComponentOutput: {
12133
13169
  id: string;
12134
13170
  };
13171
+ ListDatasetEditorHistorysInput: {
13172
+ page?: number;
13173
+ page_size?: number;
13174
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
13175
+ sort?: (string | {
13176
+ [key: string]: "asc" | "desc";
13177
+ })[];
13178
+ };
13179
+ ListDatasetEditorHistorysOutput: {
13180
+ results: {
13181
+ _id?: string;
13182
+ metadata?: {
13183
+ [key: string]: unknown;
13184
+ };
13185
+ items?: {
13186
+ [key: string]: {
13187
+ updates?: unknown[];
13188
+ filters?: unknown[];
13189
+ };
13190
+ };
13191
+ }[];
13192
+ };
13193
+ CreateDatasetEditorHistoryInput: {
13194
+ _id?: string;
13195
+ metadata?: {
13196
+ [key: string]: unknown;
13197
+ };
13198
+ items?: {
13199
+ [key: string]: {
13200
+ updates?: unknown[];
13201
+ filters?: unknown[];
13202
+ };
13203
+ };
13204
+ };
13205
+ CreateDatasetEditorHistoryOutput: {
13206
+ id: string;
13207
+ };
13208
+ ListDatasetEditorConfigurationsInput: {
13209
+ page?: number;
13210
+ page_size?: number;
13211
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
13212
+ sort?: (string | {
13213
+ [key: string]: "asc" | "desc";
13214
+ })[];
13215
+ };
13216
+ ListDatasetEditorConfigurationsOutput: {
13217
+ results: {
13218
+ _id?: string;
13219
+ metadata?: {
13220
+ [key: string]: unknown;
13221
+ };
13222
+ items?: {
13223
+ [key: string]: {
13224
+ updates?: unknown[];
13225
+ filters?: unknown[];
13226
+ };
13227
+ };
13228
+ }[];
13229
+ };
13230
+ CreateDatasetEditorConfigurationInput: {
13231
+ _id?: string;
13232
+ metadata?: {
13233
+ [key: string]: unknown;
13234
+ };
13235
+ items?: {
13236
+ [key: string]: {
13237
+ updates?: unknown[];
13238
+ filters?: unknown[];
13239
+ };
13240
+ };
13241
+ };
13242
+ CreateDatasetEditorConfigurationOutput: {
13243
+ id: string;
13244
+ };
13245
+ UpdateDatasetEditorConfigurationInput: {
13246
+ _id?: string;
13247
+ metadata?: {
13248
+ [key: string]: unknown;
13249
+ };
13250
+ items?: {
13251
+ [key: string]: {
13252
+ updates?: unknown[];
13253
+ filters?: unknown[];
13254
+ };
13255
+ };
13256
+ };
13257
+ UpdateDatasetEditorConfigurationOutput: unknown;
13258
+ DeleteDatasetEditorConfigurationInput: unknown;
13259
+ DeleteDatasetEditorConfigurationOutput: unknown;
13260
+ GetDatasetEditorConfigurationInput: unknown;
13261
+ GetDatasetEditorConfigurationOutput: {
13262
+ _id?: string;
13263
+ metadata?: {
13264
+ [key: string]: unknown;
13265
+ };
13266
+ items?: {
13267
+ [key: string]: {
13268
+ updates?: unknown[];
13269
+ filters?: unknown[];
13270
+ };
13271
+ };
13272
+ };
13273
+ ListKeyphrasesInput: {
13274
+ page?: number;
13275
+ page_size?: number;
13276
+ /** @description Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. */
13277
+ sort?: (string | {
13278
+ [key: string]: "asc" | "desc";
13279
+ })[];
13280
+ };
13281
+ ListKeyphrasesOutput: {
13282
+ results: {
13283
+ _id?: string;
13284
+ keyphrase?: string;
13285
+ score?: number;
13286
+ }[];
13287
+ };
13288
+ UpdateKeyphraseInput: {
13289
+ _id?: string;
13290
+ keyphrase?: string;
13291
+ score?: number;
13292
+ };
13293
+ UpdateKeyphraseOutput: unknown;
13294
+ DeleteKeyphraseInput: unknown;
13295
+ DeleteKeyphraseOutput: unknown;
13296
+ GetKeyphraseInput: unknown;
13297
+ GetKeyphraseOutput: {
13298
+ _id?: string;
13299
+ keyphrase?: string;
13300
+ score?: number;
13301
+ };
13302
+ BulkUpdateKeyphrasesInput: {
13303
+ updates?: {
13304
+ _id?: string;
13305
+ keyphrase?: string;
13306
+ score?: number;
13307
+ }[];
13308
+ };
13309
+ BulkUpdateKeyphrasesOutput: unknown;
12135
13310
  };
12136
13311
  }
12137
13312
  export interface operations {
@@ -14422,6 +15597,42 @@ export interface operations {
14422
15597
  };
14423
15598
  };
14424
15599
  };
15600
+ /**
15601
+ * ### Required permissions
15602
+ * > [
15603
+ * {
15604
+ * "actions": [
15605
+ * "organizations:read"
15606
+ * ],
15607
+ * "organizations": [
15608
+ * {
15609
+ * "params": "organization_id"
15610
+ * }
15611
+ * ]
15612
+ * }
15613
+ * ]
15614
+ */
15615
+ AggregateOrganizationMetrics: {
15616
+ parameters: {
15617
+ path: {
15618
+ /** ID of organization */
15619
+ organization_id: string;
15620
+ };
15621
+ };
15622
+ responses: {
15623
+ /** successful operation */
15624
+ 200: {
15625
+ content: {
15626
+ "application/json": components["schemas"]["AggregateOrganizationMetricsOutput"];
15627
+ };
15628
+ };
15629
+ };
15630
+ requestBody: {
15631
+ content: {
15632
+ "application/json": components["schemas"]["AggregateOrganizationMetricsInput"];
15633
+ };
15634
+ };
15635
+ };
14425
15636
  /**
14426
15637
  * ### Required permissions
14427
15638
  * > [
@@ -14871,6 +16082,39 @@ export interface operations {
14871
16082
  };
14872
16083
  };
14873
16084
  };
16085
+ /**
16086
+ * Terminate a workflow
16087
+ *
16088
+ * ### Required permissions
16089
+ * > [
16090
+ * {
16091
+ * "actions": [
16092
+ * "datasets:write"
16093
+ * ]
16094
+ * }
16095
+ * ]
16096
+ */
16097
+ TerminateWorkflow: {
16098
+ parameters: {
16099
+ path: {
16100
+ /** ID of workflow */
16101
+ workflow_id: string;
16102
+ };
16103
+ };
16104
+ responses: {
16105
+ /** successful operation */
16106
+ 200: {
16107
+ content: {
16108
+ "application/json": components["schemas"]["TerminateWorkflowOutput"];
16109
+ };
16110
+ };
16111
+ };
16112
+ requestBody: {
16113
+ content: {
16114
+ "application/json": components["schemas"]["TerminateWorkflowInput"];
16115
+ };
16116
+ };
16117
+ };
14874
16118
  /**
14875
16119
  * Update metadata for a workflow run
14876
16120
  *
@@ -16501,6 +17745,44 @@ export interface operations {
16501
17745
  };
16502
17746
  };
16503
17747
  };
17748
+ /**
17749
+ * Perform all tagging operations on a field in one payload.
17750
+ *
17751
+ * ### Required permissions
17752
+ * > [
17753
+ * {
17754
+ * "actions": [
17755
+ * "datasets:write"
17756
+ * ],
17757
+ * "datasets": [
17758
+ * {
17759
+ * "params": "dataset_id"
17760
+ * }
17761
+ * ]
17762
+ * }
17763
+ * ]
17764
+ */
17765
+ EditTags: {
17766
+ parameters: {
17767
+ path: {
17768
+ /** ID of dataset */
17769
+ dataset_id: string;
17770
+ };
17771
+ };
17772
+ responses: {
17773
+ /** successful operation */
17774
+ 200: {
17775
+ content: {
17776
+ "application/json": components["schemas"]["EditTagsOutput"];
17777
+ };
17778
+ };
17779
+ };
17780
+ requestBody: {
17781
+ content: {
17782
+ "application/json": components["schemas"]["EditTagsInput"];
17783
+ };
17784
+ };
17785
+ };
16504
17786
  /**
16505
17787
  * Takes a high level aggregation of every field, return their unique values and frequencies. This is used to help create the filter bar for search.
16506
17788
  *
@@ -17343,57 +18625,310 @@ export interface operations {
17343
18625
  /** successful operation */
17344
18626
  200: {
17345
18627
  content: {
17346
- "application/json": components["schemas"]["ListDocumentsOutput"];
18628
+ "application/json": components["schemas"]["ListDocumentsOutput"];
18629
+ };
18630
+ };
18631
+ };
18632
+ };
18633
+ /**
18634
+ * Delete documents that match on a filters. At least one filter must be provided.
18635
+ *
18636
+ * ### Required permissions
18637
+ * > [
18638
+ * {
18639
+ * "actions": [
18640
+ * "datasets:write"
18641
+ * ],
18642
+ * "datasets": [
18643
+ * {
18644
+ * "params": "dataset_id"
18645
+ * }
18646
+ * ]
18647
+ * }
18648
+ * ]
18649
+ */
18650
+ DeleteWhere: {
18651
+ parameters: {
18652
+ path: {
18653
+ /** ID of dataset */
18654
+ dataset_id: string;
18655
+ };
18656
+ };
18657
+ responses: {
18658
+ /** successful operation */
18659
+ 200: {
18660
+ content: {
18661
+ "application/json": components["schemas"]["DeleteWhereOutput"];
18662
+ };
18663
+ };
18664
+ };
18665
+ requestBody: {
18666
+ content: {
18667
+ "application/json": components["schemas"]["DeleteWhereInput"];
18668
+ };
18669
+ };
18670
+ };
18671
+ /**
18672
+ * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
18673
+ *
18674
+ * ### Required permissions
18675
+ * > [
18676
+ * {
18677
+ * "actions": [
18678
+ * "datasets:read"
18679
+ * ],
18680
+ * "datasets": [
18681
+ * {
18682
+ * "params": "dataset_id"
18683
+ * }
18684
+ * ]
18685
+ * }
18686
+ * ]
18687
+ */
18688
+ SimpleSearchPost: {
18689
+ parameters: {
18690
+ path: {
18691
+ /** ID of dataset */
18692
+ dataset_id: string;
18693
+ };
18694
+ };
18695
+ responses: {
18696
+ /** successful operation */
18697
+ 200: {
18698
+ content: {
18699
+ "application/json": components["schemas"]["SimpleSearchPostOutput"];
18700
+ };
18701
+ };
18702
+ };
18703
+ requestBody: {
18704
+ content: {
18705
+ "application/json": components["schemas"]["SimpleSearchPostInput"];
18706
+ };
18707
+ };
18708
+ };
18709
+ /**
18710
+ * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
18711
+ *
18712
+ * ### Required permissions
18713
+ * > [
18714
+ * {
18715
+ * "actions": [
18716
+ * "datasets:read"
18717
+ * ],
18718
+ * "datasets": [
18719
+ * {
18720
+ * "params": "dataset_id"
18721
+ * }
18722
+ * ]
18723
+ * }
18724
+ * ]
18725
+ */
18726
+ Search: {
18727
+ parameters: {
18728
+ path: {
18729
+ /** ID of dataset */
18730
+ dataset_id: string;
18731
+ };
18732
+ };
18733
+ responses: {
18734
+ /** successful operation */
18735
+ 200: {
18736
+ content: {
18737
+ "application/json": components["schemas"]["SearchOutput"];
18738
+ };
18739
+ };
18740
+ };
18741
+ requestBody: {
18742
+ content: {
18743
+ "application/json": components["schemas"]["SearchInput"];
18744
+ };
18745
+ };
18746
+ };
18747
+ /**
18748
+ * Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using the documentsToRecommend property.
18749
+ *
18750
+ * ### Required permissions
18751
+ * > [
18752
+ * {
18753
+ * "actions": [
18754
+ * "datasets:read"
18755
+ * ],
18756
+ * "datasets": [
18757
+ * {
18758
+ * "params": "dataset_id"
18759
+ * }
18760
+ * ]
18761
+ * }
18762
+ * ]
18763
+ */
18764
+ Recommend: {
18765
+ parameters: {
18766
+ path: {
18767
+ /** ID of dataset */
18768
+ dataset_id: string;
18769
+ };
18770
+ };
18771
+ responses: {
18772
+ /** successful operation */
18773
+ 200: {
18774
+ content: {
18775
+ "application/json": components["schemas"]["RecommendOutput"];
18776
+ };
18777
+ };
18778
+ };
18779
+ requestBody: {
18780
+ content: {
18781
+ "application/json": components["schemas"]["RecommendInput"];
18782
+ };
18783
+ };
18784
+ };
18785
+ /**
18786
+ * ### Required permissions
18787
+ * > [
18788
+ * {
18789
+ * "actions": [
18790
+ * "datasets:read"
18791
+ * ],
18792
+ * "datasets": [
18793
+ * {
18794
+ * "params": "dataset_id"
18795
+ * }
18796
+ * ]
18797
+ * },
18798
+ * {
18799
+ * "actions": [
18800
+ * "datasets:write"
18801
+ * ],
18802
+ * "datasets": [
18803
+ * {
18804
+ * "body": "new_dataset_id"
18805
+ * }
18806
+ * ]
18807
+ * }
18808
+ * ]
18809
+ */
18810
+ CloneDataset: {
18811
+ parameters: {
18812
+ path: {
18813
+ /** ID of dataset */
18814
+ dataset_id: string;
18815
+ };
18816
+ };
18817
+ responses: {
18818
+ /** successful operation */
18819
+ 200: {
18820
+ content: {
18821
+ "application/json": components["schemas"]["CloneDatasetOutput"];
17347
18822
  };
17348
18823
  };
17349
18824
  };
18825
+ requestBody: {
18826
+ content: {
18827
+ "application/json": components["schemas"]["CloneDatasetInput"];
18828
+ };
18829
+ };
17350
18830
  };
17351
18831
  /**
17352
- * Delete documents that match on a filters. At least one filter must be provided.
18832
+ * Predict using KNN regression.
17353
18833
  *
17354
18834
  * ### Required permissions
17355
18835
  * > [
17356
18836
  * {
17357
18837
  * "actions": [
17358
- * "datasets:write"
18838
+ * "datasets:read"
17359
18839
  * ],
17360
18840
  * "datasets": [
17361
18841
  * {
17362
- * "params": "dataset_id"
18842
+ * "body": "dataset_id"
17363
18843
  * }
17364
18844
  * ]
17365
18845
  * }
17366
18846
  * ]
17367
18847
  */
17368
- DeleteWhere: {
17369
- parameters: {
17370
- path: {
17371
- /** ID of dataset */
17372
- dataset_id: string;
18848
+ PredictKNNRegression: {
18849
+ parameters: {};
18850
+ responses: {
18851
+ /** successful operation */
18852
+ 200: {
18853
+ content: {
18854
+ "application/json": components["schemas"]["PredictKNNRegressionOutput"];
18855
+ };
18856
+ };
18857
+ };
18858
+ requestBody: {
18859
+ content: {
18860
+ "application/json": components["schemas"]["PredictKNNRegressionInput"];
17373
18861
  };
17374
18862
  };
18863
+ };
18864
+ /**
18865
+ * Predict using KNN regression from search results.
18866
+ *
18867
+ * ### Required permissions
18868
+ * > []
18869
+ */
18870
+ PredictKNNFromResults: {
18871
+ parameters: {};
17375
18872
  responses: {
17376
18873
  /** successful operation */
17377
18874
  200: {
17378
18875
  content: {
17379
- "application/json": components["schemas"]["DeleteWhereOutput"];
18876
+ "application/json": components["schemas"]["PredictKNNFromResultsOutput"];
17380
18877
  };
17381
18878
  };
17382
18879
  };
17383
18880
  requestBody: {
17384
18881
  content: {
17385
- "application/json": components["schemas"]["DeleteWhereInput"];
18882
+ "application/json": components["schemas"]["PredictKNNFromResultsInput"];
18883
+ };
18884
+ };
18885
+ };
18886
+ /**
18887
+ * ### Required permissions
18888
+ * > []
18889
+ */
18890
+ BiasEvaluation: {
18891
+ parameters: {};
18892
+ responses: {
18893
+ /** successful operation */
18894
+ 200: {
18895
+ content: {
18896
+ "application/json": components["schemas"]["BiasEvaluationOutput"];
18897
+ };
18898
+ };
18899
+ };
18900
+ requestBody: {
18901
+ content: {
18902
+ "application/json": components["schemas"]["BiasEvaluationInput"];
18903
+ };
18904
+ };
18905
+ };
18906
+ /**
18907
+ * ### Required permissions
18908
+ * > []
18909
+ */
18910
+ Vectorize: {
18911
+ parameters: {};
18912
+ responses: {
18913
+ /** successful operation */
18914
+ 200: {
18915
+ content: {
18916
+ "application/json": components["schemas"]["VectorizeOutput"];
18917
+ };
18918
+ };
18919
+ };
18920
+ requestBody: {
18921
+ content: {
18922
+ "application/json": components["schemas"]["VectorizeInput"];
17386
18923
  };
17387
18924
  };
17388
18925
  };
17389
18926
  /**
17390
- * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
17391
- *
17392
18927
  * ### Required permissions
17393
18928
  * > [
17394
18929
  * {
17395
18930
  * "actions": [
17396
- * "datasets:read"
18931
+ * "datasets:write"
17397
18932
  * ],
17398
18933
  * "datasets": [
17399
18934
  * {
@@ -17403,7 +18938,7 @@ export interface operations {
17403
18938
  * }
17404
18939
  * ]
17405
18940
  */
17406
- SimpleSearchPost: {
18941
+ VectorizeAndInsert: {
17407
18942
  parameters: {
17408
18943
  path: {
17409
18944
  /** ID of dataset */
@@ -17414,24 +18949,22 @@ export interface operations {
17414
18949
  /** successful operation */
17415
18950
  200: {
17416
18951
  content: {
17417
- "application/json": components["schemas"]["SimpleSearchPostOutput"];
18952
+ "application/json": components["schemas"]["VectorizeAndInsertOutput"];
17418
18953
  };
17419
18954
  };
17420
18955
  };
17421
18956
  requestBody: {
17422
18957
  content: {
17423
- "application/json": components["schemas"]["SimpleSearchPostInput"];
18958
+ "application/json": components["schemas"]["VectorizeAndInsertInput"];
17424
18959
  };
17425
18960
  };
17426
18961
  };
17427
18962
  /**
17428
- * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
17429
- *
17430
18963
  * ### Required permissions
17431
18964
  * > [
17432
18965
  * {
17433
18966
  * "actions": [
17434
- * "datasets:read"
18967
+ * "datasets:write"
17435
18968
  * ],
17436
18969
  * "datasets": [
17437
18970
  * {
@@ -17441,7 +18974,7 @@ export interface operations {
17441
18974
  * }
17442
18975
  * ]
17443
18976
  */
17444
- Search: {
18977
+ VectorizeField: {
17445
18978
  parameters: {
17446
18979
  path: {
17447
18980
  /** ID of dataset */
@@ -17452,80 +18985,68 @@ export interface operations {
17452
18985
  /** successful operation */
17453
18986
  200: {
17454
18987
  content: {
17455
- "application/json": components["schemas"]["SearchOutput"];
18988
+ "application/json": components["schemas"]["VectorizeFieldOutput"];
17456
18989
  };
17457
18990
  };
17458
18991
  };
17459
18992
  requestBody: {
17460
18993
  content: {
17461
- "application/json": components["schemas"]["SearchInput"];
18994
+ "application/json": components["schemas"]["VectorizeFieldInput"];
17462
18995
  };
17463
18996
  };
17464
18997
  };
17465
18998
  /**
17466
- * Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using the documentsToRecommend property.
17467
- *
17468
18999
  * ### Required permissions
17469
- * > [
17470
- * {
17471
- * "actions": [
17472
- * "datasets:read"
17473
- * ],
17474
- * "datasets": [
17475
- * {
17476
- * "params": "dataset_id"
17477
- * }
17478
- * ]
17479
- * }
17480
- * ]
19000
+ * > []
17481
19001
  */
17482
- Recommend: {
19002
+ CreateImageFromPrompt: {
19003
+ parameters: {};
19004
+ responses: {
19005
+ /** successful operation */
19006
+ 200: {
19007
+ content: {
19008
+ "application/json": components["schemas"]["CreateImageFromPromptOutput"];
19009
+ };
19010
+ };
19011
+ };
19012
+ requestBody: {
19013
+ content: {
19014
+ "application/json": components["schemas"]["CreateImageFromPromptInput"];
19015
+ };
19016
+ };
19017
+ };
19018
+ /**
19019
+ * ### Required permissions
19020
+ * > []
19021
+ */
19022
+ DeleteFieldChildren: {
17483
19023
  parameters: {
17484
19024
  path: {
17485
19025
  /** ID of dataset */
17486
19026
  dataset_id: string;
19027
+ /** ID of fieldchildren */
19028
+ fieldchildren_id: string;
17487
19029
  };
17488
19030
  };
17489
19031
  responses: {
17490
19032
  /** successful operation */
17491
19033
  200: {
17492
19034
  content: {
17493
- "application/json": components["schemas"]["RecommendOutput"];
19035
+ "application/json": components["schemas"]["DeleteFieldChildrenOutput"];
17494
19036
  };
17495
19037
  };
17496
19038
  };
17497
19039
  requestBody: {
17498
19040
  content: {
17499
- "application/json": components["schemas"]["RecommendInput"];
19041
+ "application/json": components["schemas"]["DeleteFieldChildrenInput"];
17500
19042
  };
17501
19043
  };
17502
19044
  };
17503
19045
  /**
17504
19046
  * ### Required permissions
17505
- * > [
17506
- * {
17507
- * "actions": [
17508
- * "datasets:read"
17509
- * ],
17510
- * "datasets": [
17511
- * {
17512
- * "params": "dataset_id"
17513
- * }
17514
- * ]
17515
- * },
17516
- * {
17517
- * "actions": [
17518
- * "datasets:write"
17519
- * ],
17520
- * "datasets": [
17521
- * {
17522
- * "body": "new_dataset_id"
17523
- * }
17524
- * ]
17525
- * }
17526
- * ]
19047
+ * > []
17527
19048
  */
17528
- CloneDataset: {
19049
+ ListFieldChildrens: {
17529
19050
  parameters: {
17530
19051
  path: {
17531
19052
  /** ID of dataset */
@@ -17536,68 +19057,110 @@ export interface operations {
17536
19057
  /** successful operation */
17537
19058
  200: {
17538
19059
  content: {
17539
- "application/json": components["schemas"]["CloneDatasetOutput"];
19060
+ "application/json": components["schemas"]["ListFieldChildrensOutput"];
17540
19061
  };
17541
19062
  };
17542
19063
  };
17543
19064
  requestBody: {
17544
19065
  content: {
17545
- "application/json": components["schemas"]["CloneDatasetInput"];
19066
+ "application/json": components["schemas"]["ListFieldChildrensInput"];
17546
19067
  };
17547
19068
  };
17548
19069
  };
17549
19070
  /**
17550
- * Predict using KNN regression.
17551
- *
17552
19071
  * ### Required permissions
17553
- * > [
17554
- * {
17555
- * "actions": [
17556
- * "datasets:read"
17557
- * ],
17558
- * "datasets": [
17559
- * {
17560
- * "body": "dataset_id"
17561
- * }
17562
- * ]
17563
- * }
17564
- * ]
19072
+ * > []
17565
19073
  */
17566
- PredictKNNRegression: {
17567
- parameters: {};
19074
+ UpdateFieldChildren: {
19075
+ parameters: {
19076
+ path: {
19077
+ /** ID of dataset */
19078
+ dataset_id: string;
19079
+ /** ID of fieldchildren */
19080
+ fieldchildren_id: string;
19081
+ };
19082
+ };
17568
19083
  responses: {
17569
19084
  /** successful operation */
17570
19085
  200: {
17571
19086
  content: {
17572
- "application/json": components["schemas"]["PredictKNNRegressionOutput"];
19087
+ "application/json": components["schemas"]["UpdateFieldChildrenOutput"];
17573
19088
  };
17574
19089
  };
17575
19090
  };
17576
19091
  requestBody: {
17577
19092
  content: {
17578
- "application/json": components["schemas"]["PredictKNNRegressionInput"];
19093
+ "application/json": components["schemas"]["UpdateFieldChildrenInput"];
17579
19094
  };
17580
19095
  };
17581
19096
  };
17582
19097
  /**
17583
- * Predict using KNN regression from search results.
17584
- *
17585
19098
  * ### Required permissions
17586
19099
  * > []
17587
19100
  */
17588
- PredictKNNFromResults: {
19101
+ DeleteFavouriteWorkflow: {
19102
+ parameters: {
19103
+ path: {
19104
+ /** ID of favouriteworkflow */
19105
+ favouriteworkflow_id: string;
19106
+ };
19107
+ };
19108
+ responses: {
19109
+ /** successful operation */
19110
+ 200: {
19111
+ content: {
19112
+ "application/json": components["schemas"]["DeleteFavouriteWorkflowOutput"];
19113
+ };
19114
+ };
19115
+ };
19116
+ requestBody: {
19117
+ content: {
19118
+ "application/json": components["schemas"]["DeleteFavouriteWorkflowInput"];
19119
+ };
19120
+ };
19121
+ };
19122
+ /**
19123
+ * ### Required permissions
19124
+ * > []
19125
+ */
19126
+ ListFavouriteWorkflows: {
17589
19127
  parameters: {};
17590
19128
  responses: {
17591
19129
  /** successful operation */
17592
19130
  200: {
17593
19131
  content: {
17594
- "application/json": components["schemas"]["PredictKNNFromResultsOutput"];
19132
+ "application/json": components["schemas"]["ListFavouriteWorkflowsOutput"];
19133
+ };
19134
+ };
19135
+ };
19136
+ requestBody: {
19137
+ content: {
19138
+ "application/json": components["schemas"]["ListFavouriteWorkflowsInput"];
19139
+ };
19140
+ };
19141
+ };
19142
+ /**
19143
+ * ### Required permissions
19144
+ * > []
19145
+ */
19146
+ UpdateFavouriteWorkflow: {
19147
+ parameters: {
19148
+ path: {
19149
+ /** ID of favouriteworkflow */
19150
+ favouriteworkflow_id: string;
19151
+ };
19152
+ };
19153
+ responses: {
19154
+ /** successful operation */
19155
+ 200: {
19156
+ content: {
19157
+ "application/json": components["schemas"]["UpdateFavouriteWorkflowOutput"];
17595
19158
  };
17596
19159
  };
17597
19160
  };
17598
19161
  requestBody: {
17599
19162
  content: {
17600
- "application/json": components["schemas"]["PredictKNNFromResultsInput"];
19163
+ "application/json": components["schemas"]["UpdateFavouriteWorkflowInput"];
17601
19164
  };
17602
19165
  };
17603
19166
  };
@@ -17605,19 +19168,24 @@ export interface operations {
17605
19168
  * ### Required permissions
17606
19169
  * > []
17607
19170
  */
17608
- BiasEvaluation: {
17609
- parameters: {};
19171
+ DeleteSavedFilter: {
19172
+ parameters: {
19173
+ path: {
19174
+ /** ID of savedfilter */
19175
+ savedfilter_id: string;
19176
+ };
19177
+ };
17610
19178
  responses: {
17611
19179
  /** successful operation */
17612
19180
  200: {
17613
19181
  content: {
17614
- "application/json": components["schemas"]["BiasEvaluationOutput"];
19182
+ "application/json": components["schemas"]["DeleteSavedFilterOutput"];
17615
19183
  };
17616
19184
  };
17617
19185
  };
17618
19186
  requestBody: {
17619
19187
  content: {
17620
- "application/json": components["schemas"]["BiasEvaluationInput"];
19188
+ "application/json": components["schemas"]["DeleteSavedFilterInput"];
17621
19189
  };
17622
19190
  };
17623
19191
  };
@@ -17625,111 +19193,84 @@ export interface operations {
17625
19193
  * ### Required permissions
17626
19194
  * > []
17627
19195
  */
17628
- Vectorize: {
19196
+ ListSavedFilters: {
17629
19197
  parameters: {};
17630
19198
  responses: {
17631
19199
  /** successful operation */
17632
19200
  200: {
17633
19201
  content: {
17634
- "application/json": components["schemas"]["VectorizeOutput"];
19202
+ "application/json": components["schemas"]["ListSavedFiltersOutput"];
17635
19203
  };
17636
19204
  };
17637
19205
  };
17638
19206
  requestBody: {
17639
19207
  content: {
17640
- "application/json": components["schemas"]["VectorizeInput"];
19208
+ "application/json": components["schemas"]["ListSavedFiltersInput"];
17641
19209
  };
17642
19210
  };
17643
19211
  };
17644
19212
  /**
17645
19213
  * ### Required permissions
17646
- * > [
17647
- * {
17648
- * "actions": [
17649
- * "datasets:write"
17650
- * ],
17651
- * "datasets": [
17652
- * {
17653
- * "params": "dataset_id"
17654
- * }
17655
- * ]
17656
- * }
17657
- * ]
19214
+ * > []
17658
19215
  */
17659
- VectorizeAndInsert: {
19216
+ UpdateSavedFilter: {
17660
19217
  parameters: {
17661
19218
  path: {
17662
- /** ID of dataset */
17663
- dataset_id: string;
19219
+ /** ID of savedfilter */
19220
+ savedfilter_id: string;
17664
19221
  };
17665
19222
  };
17666
19223
  responses: {
17667
19224
  /** successful operation */
17668
19225
  200: {
17669
19226
  content: {
17670
- "application/json": components["schemas"]["VectorizeAndInsertOutput"];
19227
+ "application/json": components["schemas"]["UpdateSavedFilterOutput"];
17671
19228
  };
17672
19229
  };
17673
19230
  };
17674
19231
  requestBody: {
17675
19232
  content: {
17676
- "application/json": components["schemas"]["VectorizeAndInsertInput"];
19233
+ "application/json": components["schemas"]["UpdateSavedFilterInput"];
17677
19234
  };
17678
19235
  };
17679
19236
  };
17680
19237
  /**
17681
19238
  * ### Required permissions
17682
- * > [
17683
- * {
17684
- * "actions": [
17685
- * "datasets:write"
17686
- * ],
17687
- * "datasets": [
17688
- * {
17689
- * "params": "dataset_id"
17690
- * }
17691
- * ]
17692
- * }
17693
- * ]
19239
+ * > []
17694
19240
  */
17695
- VectorizeField: {
19241
+ GetSavedFilter: {
17696
19242
  parameters: {
17697
19243
  path: {
17698
- /** ID of dataset */
17699
- dataset_id: string;
19244
+ /** ID of savedfilter */
19245
+ savedfilter_id: string;
17700
19246
  };
17701
19247
  };
17702
19248
  responses: {
17703
19249
  /** successful operation */
17704
19250
  200: {
17705
19251
  content: {
17706
- "application/json": components["schemas"]["VectorizeFieldOutput"];
19252
+ "application/json": components["schemas"]["GetSavedFilterOutput"];
17707
19253
  };
17708
19254
  };
17709
19255
  };
17710
- requestBody: {
17711
- content: {
17712
- "application/json": components["schemas"]["VectorizeFieldInput"];
17713
- };
17714
- };
17715
19256
  };
17716
19257
  /**
17717
19258
  * ### Required permissions
17718
19259
  * > []
17719
19260
  */
17720
- CreateImageFromPrompt: {
19261
+ CreateSavedFilter: {
17721
19262
  parameters: {};
17722
19263
  responses: {
17723
19264
  /** successful operation */
17724
19265
  200: {
17725
19266
  content: {
17726
- "application/json": components["schemas"]["CreateImageFromPromptOutput"];
19267
+ "application/json": components["schemas"]["CreateSavedFilterOutput"];
17727
19268
  };
17728
19269
  };
17729
19270
  };
17730
19271
  requestBody: {
17731
19272
  content: {
17732
- "application/json": components["schemas"]["CreateImageFromPromptInput"];
19273
+ "application/json": components["schemas"]["CreateSavedFilterInput"];
17733
19274
  };
17734
19275
  };
17735
19276
  };
@@ -17737,26 +19278,24 @@ export interface operations {
17737
19278
  * ### Required permissions
17738
19279
  * > []
17739
19280
  */
17740
- DeleteFieldChildren: {
19281
+ DeleteComponent: {
17741
19282
  parameters: {
17742
19283
  path: {
17743
- /** ID of dataset */
17744
- dataset_id: string;
17745
- /** ID of fieldchildren */
17746
- fieldchildren_id: string;
19284
+ /** ID of component */
19285
+ component_id: string;
17747
19286
  };
17748
19287
  };
17749
19288
  responses: {
17750
19289
  /** successful operation */
17751
19290
  200: {
17752
19291
  content: {
17753
- "application/json": components["schemas"]["DeleteFieldChildrenOutput"];
19292
+ "application/json": components["schemas"]["DeleteComponentOutput"];
17754
19293
  };
17755
19294
  };
17756
19295
  };
17757
19296
  requestBody: {
17758
19297
  content: {
17759
- "application/json": components["schemas"]["DeleteFieldChildrenInput"];
19298
+ "application/json": components["schemas"]["DeleteComponentInput"];
17760
19299
  };
17761
19300
  };
17762
19301
  };
@@ -17764,24 +19303,19 @@ export interface operations {
17764
19303
  * ### Required permissions
17765
19304
  * > []
17766
19305
  */
17767
- ListFieldChildrens: {
17768
- parameters: {
17769
- path: {
17770
- /** ID of dataset */
17771
- dataset_id: string;
17772
- };
17773
- };
19306
+ ListComponents: {
19307
+ parameters: {};
17774
19308
  responses: {
17775
19309
  /** successful operation */
17776
19310
  200: {
17777
19311
  content: {
17778
- "application/json": components["schemas"]["ListFieldChildrensOutput"];
19312
+ "application/json": components["schemas"]["ListComponentsOutput"];
17779
19313
  };
17780
19314
  };
17781
19315
  };
17782
19316
  requestBody: {
17783
19317
  content: {
17784
- "application/json": components["schemas"]["ListFieldChildrensInput"];
19318
+ "application/json": components["schemas"]["ListComponentsInput"];
17785
19319
  };
17786
19320
  };
17787
19321
  };
@@ -17789,26 +19323,24 @@ export interface operations {
17789
19323
  * ### Required permissions
17790
19324
  * > []
17791
19325
  */
17792
- UpdateFieldChildren: {
19326
+ UpdateComponent: {
17793
19327
  parameters: {
17794
19328
  path: {
17795
- /** ID of dataset */
17796
- dataset_id: string;
17797
- /** ID of fieldchildren */
17798
- fieldchildren_id: string;
19329
+ /** ID of component */
19330
+ component_id: string;
17799
19331
  };
17800
19332
  };
17801
19333
  responses: {
17802
19334
  /** successful operation */
17803
19335
  200: {
17804
19336
  content: {
17805
- "application/json": components["schemas"]["UpdateFieldChildrenOutput"];
19337
+ "application/json": components["schemas"]["UpdateComponentOutput"];
17806
19338
  };
17807
19339
  };
17808
19340
  };
17809
19341
  requestBody: {
17810
19342
  content: {
17811
- "application/json": components["schemas"]["UpdateFieldChildrenInput"];
19343
+ "application/json": components["schemas"]["UpdateComponentInput"];
17812
19344
  };
17813
19345
  };
17814
19346
  };
@@ -17816,44 +19348,39 @@ export interface operations {
17816
19348
  * ### Required permissions
17817
19349
  * > []
17818
19350
  */
17819
- DeleteFavouriteWorkflow: {
19351
+ GetComponent: {
17820
19352
  parameters: {
17821
19353
  path: {
17822
- /** ID of favouriteworkflow */
17823
- favouriteworkflow_id: string;
19354
+ /** ID of component */
19355
+ component_id: string;
17824
19356
  };
17825
19357
  };
17826
19358
  responses: {
17827
19359
  /** successful operation */
17828
19360
  200: {
17829
19361
  content: {
17830
- "application/json": components["schemas"]["DeleteFavouriteWorkflowOutput"];
19362
+ "application/json": components["schemas"]["GetComponentOutput"];
17831
19363
  };
17832
19364
  };
17833
19365
  };
17834
- requestBody: {
17835
- content: {
17836
- "application/json": components["schemas"]["DeleteFavouriteWorkflowInput"];
17837
- };
17838
- };
17839
19366
  };
17840
19367
  /**
17841
19368
  * ### Required permissions
17842
19369
  * > []
17843
19370
  */
17844
- ListFavouriteWorkflows: {
19371
+ CreateComponent: {
17845
19372
  parameters: {};
17846
19373
  responses: {
17847
19374
  /** successful operation */
17848
19375
  200: {
17849
19376
  content: {
17850
- "application/json": components["schemas"]["ListFavouriteWorkflowsOutput"];
19377
+ "application/json": components["schemas"]["CreateComponentOutput"];
17851
19378
  };
17852
19379
  };
17853
19380
  };
17854
19381
  requestBody: {
17855
19382
  content: {
17856
- "application/json": components["schemas"]["ListFavouriteWorkflowsInput"];
19383
+ "application/json": components["schemas"]["CreateComponentInput"];
17857
19384
  };
17858
19385
  };
17859
19386
  };
@@ -17861,24 +19388,24 @@ export interface operations {
17861
19388
  * ### Required permissions
17862
19389
  * > []
17863
19390
  */
17864
- UpdateFavouriteWorkflow: {
19391
+ ListDatasetEditorHistorys: {
17865
19392
  parameters: {
17866
19393
  path: {
17867
- /** ID of favouriteworkflow */
17868
- favouriteworkflow_id: string;
19394
+ /** ID of dataset */
19395
+ dataset_id: string;
17869
19396
  };
17870
19397
  };
17871
19398
  responses: {
17872
19399
  /** successful operation */
17873
19400
  200: {
17874
19401
  content: {
17875
- "application/json": components["schemas"]["UpdateFavouriteWorkflowOutput"];
19402
+ "application/json": components["schemas"]["ListDatasetEditorHistorysOutput"];
17876
19403
  };
17877
19404
  };
17878
19405
  };
17879
19406
  requestBody: {
17880
19407
  content: {
17881
- "application/json": components["schemas"]["UpdateFavouriteWorkflowInput"];
19408
+ "application/json": components["schemas"]["ListDatasetEditorHistorysInput"];
17882
19409
  };
17883
19410
  };
17884
19411
  };
@@ -17886,24 +19413,24 @@ export interface operations {
17886
19413
  * ### Required permissions
17887
19414
  * > []
17888
19415
  */
17889
- DeleteSavedFilter: {
19416
+ CreateDatasetEditorHistory: {
17890
19417
  parameters: {
17891
19418
  path: {
17892
- /** ID of savedfilter */
17893
- savedfilter_id: string;
19419
+ /** ID of dataset */
19420
+ dataset_id: string;
17894
19421
  };
17895
19422
  };
17896
19423
  responses: {
17897
19424
  /** successful operation */
17898
19425
  200: {
17899
19426
  content: {
17900
- "application/json": components["schemas"]["DeleteSavedFilterOutput"];
19427
+ "application/json": components["schemas"]["CreateDatasetEditorHistoryOutput"];
17901
19428
  };
17902
19429
  };
17903
19430
  };
17904
19431
  requestBody: {
17905
19432
  content: {
17906
- "application/json": components["schemas"]["DeleteSavedFilterInput"];
19433
+ "application/json": components["schemas"]["CreateDatasetEditorHistoryInput"];
17907
19434
  };
17908
19435
  };
17909
19436
  };
@@ -17911,19 +19438,24 @@ export interface operations {
17911
19438
  * ### Required permissions
17912
19439
  * > []
17913
19440
  */
17914
- ListSavedFilters: {
17915
- parameters: {};
19441
+ ListDatasetEditorConfigurations: {
19442
+ parameters: {
19443
+ path: {
19444
+ /** ID of dataset */
19445
+ dataset_id: string;
19446
+ };
19447
+ };
17916
19448
  responses: {
17917
19449
  /** successful operation */
17918
19450
  200: {
17919
19451
  content: {
17920
- "application/json": components["schemas"]["ListSavedFiltersOutput"];
19452
+ "application/json": components["schemas"]["ListDatasetEditorConfigurationsOutput"];
17921
19453
  };
17922
19454
  };
17923
19455
  };
17924
19456
  requestBody: {
17925
19457
  content: {
17926
- "application/json": components["schemas"]["ListSavedFiltersInput"];
19458
+ "application/json": components["schemas"]["ListDatasetEditorConfigurationsInput"];
17927
19459
  };
17928
19460
  };
17929
19461
  };
@@ -17931,24 +19463,24 @@ export interface operations {
17931
19463
  * ### Required permissions
17932
19464
  * > []
17933
19465
  */
17934
- UpdateSavedFilter: {
19466
+ CreateDatasetEditorConfiguration: {
17935
19467
  parameters: {
17936
19468
  path: {
17937
- /** ID of savedfilter */
17938
- savedfilter_id: string;
19469
+ /** ID of dataset */
19470
+ dataset_id: string;
17939
19471
  };
17940
19472
  };
17941
19473
  responses: {
17942
19474
  /** successful operation */
17943
19475
  200: {
17944
19476
  content: {
17945
- "application/json": components["schemas"]["UpdateSavedFilterOutput"];
19477
+ "application/json": components["schemas"]["CreateDatasetEditorConfigurationOutput"];
17946
19478
  };
17947
19479
  };
17948
19480
  };
17949
19481
  requestBody: {
17950
19482
  content: {
17951
- "application/json": components["schemas"]["UpdateSavedFilterInput"];
19483
+ "application/json": components["schemas"]["CreateDatasetEditorConfigurationInput"];
17952
19484
  };
17953
19485
  };
17954
19486
  };
@@ -17956,39 +19488,53 @@ export interface operations {
17956
19488
  * ### Required permissions
17957
19489
  * > []
17958
19490
  */
17959
- GetSavedFilter: {
19491
+ UpdateDatasetEditorConfiguration: {
17960
19492
  parameters: {
17961
19493
  path: {
17962
- /** ID of savedfilter */
17963
- savedfilter_id: string;
19494
+ /** ID of dataset */
19495
+ dataset_id: string;
19496
+ /** ID of dataseteditorconfiguration */
19497
+ dataseteditorconfiguration_id: string;
17964
19498
  };
17965
19499
  };
17966
19500
  responses: {
17967
19501
  /** successful operation */
17968
19502
  200: {
17969
19503
  content: {
17970
- "application/json": components["schemas"]["GetSavedFilterOutput"];
19504
+ "application/json": components["schemas"]["UpdateDatasetEditorConfigurationOutput"];
17971
19505
  };
17972
19506
  };
17973
19507
  };
19508
+ requestBody: {
19509
+ content: {
19510
+ "application/json": components["schemas"]["UpdateDatasetEditorConfigurationInput"];
19511
+ };
19512
+ };
17974
19513
  };
17975
19514
  /**
17976
19515
  * ### Required permissions
17977
19516
  * > []
17978
19517
  */
17979
- CreateSavedFilter: {
17980
- parameters: {};
19518
+ DeleteDatasetEditorConfiguration: {
19519
+ parameters: {
19520
+ path: {
19521
+ /** ID of dataset */
19522
+ dataset_id: string;
19523
+ /** ID of dataseteditorconfiguration */
19524
+ dataseteditorconfiguration_id: string;
19525
+ };
19526
+ };
17981
19527
  responses: {
17982
19528
  /** successful operation */
17983
19529
  200: {
17984
19530
  content: {
17985
- "application/json": components["schemas"]["CreateSavedFilterOutput"];
19531
+ "application/json": components["schemas"]["DeleteDatasetEditorConfigurationOutput"];
17986
19532
  };
17987
19533
  };
17988
19534
  };
17989
19535
  requestBody: {
17990
19536
  content: {
17991
- "application/json": components["schemas"]["CreateSavedFilterInput"];
19537
+ "application/json": components["schemas"]["DeleteDatasetEditorConfigurationInput"];
17992
19538
  };
17993
19539
  };
17994
19540
  };
@@ -17996,24 +19542,48 @@ export interface operations {
17996
19542
  * ### Required permissions
17997
19543
  * > []
17998
19544
  */
17999
- DeleteComponent: {
19545
+ GetDatasetEditorConfiguration: {
18000
19546
  parameters: {
18001
19547
  path: {
18002
- /** ID of component */
18003
- component_id: string;
19548
+ /** ID of dataset */
19549
+ dataset_id: string;
19550
+ /** ID of dataseteditorconfiguration */
19551
+ dataseteditorconfiguration_id: string;
18004
19552
  };
18005
19553
  };
18006
19554
  responses: {
18007
19555
  /** successful operation */
18008
19556
  200: {
18009
19557
  content: {
18010
- "application/json": components["schemas"]["DeleteComponentOutput"];
19558
+ "application/json": components["schemas"]["GetDatasetEditorConfigurationOutput"];
19559
+ };
19560
+ };
19561
+ };
19562
+ };
19563
+ /**
19564
+ * ### Required permissions
19565
+ * > []
19566
+ */
19567
+ ListKeyphrases: {
19568
+ parameters: {
19569
+ path: {
19570
+ /** ID of dataset */
19571
+ dataset_id: string;
19572
+ /** ID of field */
19573
+ field: string;
19574
+ };
19575
+ };
19576
+ responses: {
19577
+ /** successful operation */
19578
+ 200: {
19579
+ content: {
19580
+ "application/json": components["schemas"]["ListKeyphrasesOutput"];
18011
19581
  };
18012
19582
  };
18013
19583
  };
18014
19584
  requestBody: {
18015
19585
  content: {
18016
- "application/json": components["schemas"]["DeleteComponentInput"];
19586
+ "application/json": components["schemas"]["ListKeyphrasesInput"];
18017
19587
  };
18018
19588
  };
18019
19589
  };
@@ -18021,19 +19591,28 @@ export interface operations {
18021
19591
  * ### Required permissions
18022
19592
  * > []
18023
19593
  */
18024
- ListComponents: {
18025
- parameters: {};
19594
+ UpdateKeyphrase: {
19595
+ parameters: {
19596
+ path: {
19597
+ /** ID of dataset */
19598
+ dataset_id: string;
19599
+ /** ID of field */
19600
+ field: string;
19601
+ /** ID of keyphrase */
19602
+ keyphrase_id: string;
19603
+ };
19604
+ };
18026
19605
  responses: {
18027
19606
  /** successful operation */
18028
19607
  200: {
18029
19608
  content: {
18030
- "application/json": components["schemas"]["ListComponentsOutput"];
19609
+ "application/json": components["schemas"]["UpdateKeyphraseOutput"];
18031
19610
  };
18032
19611
  };
18033
19612
  };
18034
19613
  requestBody: {
18035
19614
  content: {
18036
- "application/json": components["schemas"]["ListComponentsInput"];
19615
+ "application/json": components["schemas"]["UpdateKeyphraseInput"];
18037
19616
  };
18038
19617
  };
18039
19618
  };
@@ -18041,24 +19620,28 @@ export interface operations {
18041
19620
  * ### Required permissions
18042
19621
  * > []
18043
19622
  */
18044
- UpdateComponent: {
19623
+ DeleteKeyphrase: {
18045
19624
  parameters: {
18046
19625
  path: {
18047
- /** ID of component */
18048
- component_id: string;
19626
+ /** ID of dataset */
19627
+ dataset_id: string;
19628
+ /** ID of field */
19629
+ field: string;
19630
+ /** ID of keyphrase */
19631
+ keyphrase_id: string;
18049
19632
  };
18050
19633
  };
18051
19634
  responses: {
18052
19635
  /** successful operation */
18053
19636
  200: {
18054
19637
  content: {
18055
- "application/json": components["schemas"]["UpdateComponentOutput"];
19638
+ "application/json": components["schemas"]["DeleteKeyphraseOutput"];
18056
19639
  };
18057
19640
  };
18058
19641
  };
18059
19642
  requestBody: {
18060
19643
  content: {
18061
- "application/json": components["schemas"]["UpdateComponentInput"];
19644
+ "application/json": components["schemas"]["DeleteKeyphraseInput"];
18062
19645
  };
18063
19646
  };
18064
19647
  };
@@ -18066,18 +19649,22 @@ export interface operations {
18066
19649
  * ### Required permissions
18067
19650
  * > []
18068
19651
  */
18069
- GetComponent: {
19652
+ GetKeyphrase: {
18070
19653
  parameters: {
18071
19654
  path: {
18072
- /** ID of component */
18073
- component_id: string;
19655
+ /** ID of dataset */
19656
+ dataset_id: string;
19657
+ /** ID of field */
19658
+ field: string;
19659
+ /** ID of keyphrase */
19660
+ keyphrase_id: string;
18074
19661
  };
18075
19662
  };
18076
19663
  responses: {
18077
19664
  /** successful operation */
18078
19665
  200: {
18079
19666
  content: {
18080
- "application/json": components["schemas"]["GetComponentOutput"];
19667
+ "application/json": components["schemas"]["GetKeyphraseOutput"];
18081
19668
  };
18082
19669
  };
18083
19670
  };
@@ -18086,19 +19673,26 @@ export interface operations {
18086
19673
  * ### Required permissions
18087
19674
  * > []
18088
19675
  */
18089
- CreateComponent: {
18090
- parameters: {};
19676
+ BulkUpdateKeyphrases: {
19677
+ parameters: {
19678
+ path: {
19679
+ /** ID of dataset */
19680
+ dataset_id: string;
19681
+ /** ID of field */
19682
+ field: string;
19683
+ };
19684
+ };
18091
19685
  responses: {
18092
19686
  /** successful operation */
18093
19687
  200: {
18094
19688
  content: {
18095
- "application/json": components["schemas"]["CreateComponentOutput"];
19689
+ "application/json": components["schemas"]["BulkUpdateKeyphrasesOutput"];
18096
19690
  };
18097
19691
  };
18098
19692
  };
18099
19693
  requestBody: {
18100
19694
  content: {
18101
- "application/json": components["schemas"]["CreateComponentInput"];
19695
+ "application/json": components["schemas"]["BulkUpdateKeyphrasesInput"];
18102
19696
  };
18103
19697
  };
18104
19698
  };