@relevanceai/sdk 1.7.0 → 1.11.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.
@@ -550,6 +550,14 @@ class VectorApiClient extends BaseClient_1._GenericClient {
550
550
  options
551
551
  });
552
552
  }
553
+ async advancedclusterfacetsapiv2servicesclusterfacetspost(input, options) {
554
+ return this.SendRequest({
555
+ input,
556
+ method: 'post',
557
+ path: '/services/cluster/facets',
558
+ options
559
+ });
560
+ }
553
561
  async clusterlistservicesclusterlistget(input, options) {
554
562
  return this.SendRequest({
555
563
  input,
@@ -882,6 +882,18 @@ var VectorApiClient = /** @class */ (function (_super) {
882
882
  });
883
883
  });
884
884
  };
885
+ VectorApiClient.prototype.advancedclusterfacetsapiv2servicesclusterfacetspost = function (input, options) {
886
+ return __awaiter(this, void 0, void 0, function () {
887
+ return __generator(this, function (_a) {
888
+ return [2 /*return*/, this.SendRequest({
889
+ input: input,
890
+ method: 'post',
891
+ path: '/services/cluster/facets',
892
+ options: options
893
+ })];
894
+ });
895
+ });
896
+ };
885
897
  VectorApiClient.prototype.clusterlistservicesclusterlistget = function (input, options) {
886
898
  return __awaiter(this, void 0, void 0, function () {
887
899
  return __generator(this, function (_a) {
@@ -136,6 +136,8 @@ export declare type clusteraggregateapiv2servicesclusteraggregatepostInput = ope
136
136
  export declare type clusteraggregateapiv2servicesclusteraggregatepostOutput = operations['cluster_aggregate_api_v2_services_cluster_aggregate_post']['responses']['200']['content']['application/json'];
137
137
  export declare type advancedclusterfacetsapiservicesclusterfacetsgetInput = {};
138
138
  export declare type advancedclusterfacetsapiservicesclusterfacetsgetOutput = operations['advanced_cluster_facets_api_services_cluster_facets_get']['responses']['200']['content']['application/json'];
139
+ export declare type advancedclusterfacetsapiv2servicesclusterfacetspostInput = operations['advanced_cluster_facets_api_v2_services_cluster_facets_post']['requestBody']['content']['application/json'];
140
+ export declare type advancedclusterfacetsapiv2servicesclusterfacetspostOutput = operations['advanced_cluster_facets_api_v2_services_cluster_facets_post']['responses']['200']['content']['application/json'];
139
141
  export declare type clusterlistservicesclusterlistgetInput = {};
140
142
  export declare type clusterlistservicesclusterlistgetOutput = operations['cluster_list_services_cluster_list_get']['responses']['200']['content']['application/json'];
141
143
  export declare type clusterlistmultiservicesclusterlistpostInput = {};
@@ -256,6 +258,7 @@ export declare class VectorApiClient extends _GenericClient {
256
258
  centroidslistfurthestfromcenterv2servicesclustercentroidslistfurthestfromcenterpost(input: CommandInput<centroidslistfurthestfromcenterv2servicesclustercentroidslistfurthestfromcenterpostInput>, options?: _GenericMethodOptions): Promise<CommandOutput<centroidslistfurthestfromcenterv2servicesclustercentroidslistfurthestfromcenterpostOutput>>;
257
259
  clusteraggregateapiv2servicesclusteraggregatepost(input: CommandInput<clusteraggregateapiv2servicesclusteraggregatepostInput>, options?: _GenericMethodOptions): Promise<CommandOutput<clusteraggregateapiv2servicesclusteraggregatepostOutput>>;
258
260
  advancedclusterfacetsapiservicesclusterfacetsget(input: CommandInput<advancedclusterfacetsapiservicesclusterfacetsgetInput>, options?: _GenericMethodOptions): Promise<CommandOutput<advancedclusterfacetsapiservicesclusterfacetsgetOutput>>;
261
+ advancedclusterfacetsapiv2servicesclusterfacetspost(input: CommandInput<advancedclusterfacetsapiv2servicesclusterfacetspostInput>, options?: _GenericMethodOptions): Promise<CommandOutput<advancedclusterfacetsapiv2servicesclusterfacetspostOutput>>;
259
262
  clusterlistservicesclusterlistget(input: CommandInput<clusterlistservicesclusterlistgetInput>, options?: _GenericMethodOptions): Promise<CommandOutput<clusterlistservicesclusterlistgetOutput>>;
260
263
  clusterlistmultiservicesclusterlistpost(input: CommandInput<clusterlistmultiservicesclusterlistpostInput>, options?: _GenericMethodOptions): Promise<CommandOutput<clusterlistmultiservicesclusterlistpostOutput>>;
261
264
  tagapiservicestaggertagpost(input: CommandInput<tagapiservicestaggertagpostInput>, options?: _GenericMethodOptions): Promise<CommandOutput<tagapiservicestaggertagpostOutput>>;
@@ -727,11 +727,17 @@ export interface paths {
727
727
  * Only can be used after a vector field has been clustered with /cluster.
728
728
  */
729
729
  get: operations["advanced_cluster_facets_api_services_cluster_facets_get"];
730
+ /**
731
+ * Takes a high level aggregation of every field and every cluster in a collection. This helps you interpret each cluster and what is in them.
732
+ *
733
+ * Only can be used after a vector field has been clustered with /cluster.
734
+ */
735
+ post: operations["advanced_cluster_facets_api_v2_services_cluster_facets_post"];
730
736
  };
731
737
  "/services/cluster/list": {
732
738
  /** Get a list of cluster IDs based on the relevant information */
733
739
  get: operations["cluster_list_services_cluster_list_get"];
734
- /** Get a list of cluster IDs */
740
+ /** Get a list of cluster IDs based on the relevant information */
735
741
  post: operations["cluster_list_multi_services_cluster_list_post"];
736
742
  };
737
743
  "/services/tagger/tag": {
@@ -1958,6 +1964,25 @@ export interface components {
1958
1964
  /** Whether to sort results by ascending or descending order */
1959
1965
  asc?: boolean;
1960
1966
  };
1967
+ /** Base class for all abstractmodels */
1968
+ FacetsModel: {
1969
+ /** Unique name of dataset */
1970
+ dataset_id: string;
1971
+ /** The vector field to search in. It can either be an array of strings (automatically equally weighted) (e.g. ['check_vector_', 'yellow_vector_']) or it is a dictionary mapping field to float where the weighting is explicitly specified (e.g. {'check_vector_': 0.2, 'yellow_vector_': 0.5}) */
1972
+ vector_fields?: unknown[];
1973
+ /** WARNING: DEPRECATED. Vector field with None */
1974
+ vector_field?: string;
1975
+ /** Fields to include in the facets, if [] then all */
1976
+ facets_fields?: string[];
1977
+ /** Size of facet page */
1978
+ page_size?: number;
1979
+ /** Page of the results */
1980
+ page?: number;
1981
+ /** Whether to sort results by ascending or descending order */
1982
+ asc?: boolean;
1983
+ /** Interval for date facets */
1984
+ date_interval?: string;
1985
+ };
1961
1986
  /** Base class for each response model */
1962
1987
  GetDeployableResponse: {
1963
1988
  project_id?: string;
@@ -4954,6 +4979,38 @@ export interface operations {
4954
4979
  };
4955
4980
  };
4956
4981
  };
4982
+ /**
4983
+ * Takes a high level aggregation of every field and every cluster in a collection. This helps you interpret each cluster and what is in them.
4984
+ *
4985
+ * Only can be used after a vector field has been clustered with /cluster.
4986
+ */
4987
+ advanced_cluster_facets_api_v2_services_cluster_facets_post: {
4988
+ parameters: {
4989
+ header: {
4990
+ /** Authorization credentials. Header authorization should be in the form of **"project:api_key"** */
4991
+ Authorization: string;
4992
+ };
4993
+ };
4994
+ responses: {
4995
+ /** Successful Response */
4996
+ 200: {
4997
+ content: {
4998
+ "application/json": unknown;
4999
+ };
5000
+ };
5001
+ /** Validation Error */
5002
+ 422: {
5003
+ content: {
5004
+ "application/json": components["schemas"]["HTTPValidationError"];
5005
+ };
5006
+ };
5007
+ };
5008
+ requestBody: {
5009
+ content: {
5010
+ "application/json": components["schemas"]["FacetsModel"];
5011
+ };
5012
+ };
5013
+ };
4957
5014
  /** Get a list of cluster IDs based on the relevant information */
4958
5015
  cluster_list_services_cluster_list_get: {
4959
5016
  parameters: {
@@ -4985,7 +5042,7 @@ export interface operations {
4985
5042
  };
4986
5043
  };
4987
5044
  };
4988
- /** Get a list of cluster IDs */
5045
+ /** Get a list of cluster IDs based on the relevant information */
4989
5046
  cluster_list_multi_services_cluster_list_post: {
4990
5047
  parameters: {
4991
5048
  query: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@relevanceai/sdk",
3
- "version": "1.7.0",
3
+ "version": "1.11.0",
4
4
  "description": "Javascript client for RelevanceAI APIs. Browser, Node.js and typescript support.",
5
5
  "main": "./dist-cjs/index.js",
6
6
  "types": "./dist-types/index.d.ts",