[AUTOCUT] Update opensearch-js to reflect the latest OpenSearch API s…

…pec (2025-01-05) (#950) Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: nhtruong <[email protected]>
opensearch-project · Jan 6, 2025 · f4c5f26 · f4c5f26
1 parent 8703a6c
commit f4c5f26
Show file tree

Hide file tree

Showing 64 changed files with 1,853 additions and 866 deletions.
diff --git a/api/OpenSearchApi.d.ts b/api/OpenSearchApi.d.ts
@@ -693,6 +693,18 @@ export default class OpenSearchAPI {
   };
 
   ml: {
+    predict (params: API.Ml_Predict_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_Predict_Response>;
+    predict (params: API.Ml_Predict_Request, callback: callbackFn<API.Ml_Predict_Response>): TransportRequestCallback;
+    predict (params: API.Ml_Predict_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_Predict_Response>): TransportRequestCallback;
+
+    trainPredict (params: API.Ml_TrainPredict_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_TrainPredict_Response>;
+    trainPredict (params: API.Ml_TrainPredict_Request, callback: callbackFn<API.Ml_TrainPredict_Response>): TransportRequestCallback;
+    trainPredict (params: API.Ml_TrainPredict_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_TrainPredict_Response>): TransportRequestCallback;
+
+    train (params: API.Ml_Train_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_Train_Response>;
+    train (params: API.Ml_Train_Request, callback: callbackFn<API.Ml_Train_Response>): TransportRequestCallback;
+    train (params: API.Ml_Train_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_Train_Response>): TransportRequestCallback;
+
     registerAgents (params?: API.Ml_RegisterAgents_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_RegisterAgents_Response>;
     registerAgents (callback: callbackFn<API.Ml_RegisterAgents_Response>): TransportRequestCallback;
     registerAgents (params: API.Ml_RegisterAgents_Request, callback: callbackFn<API.Ml_RegisterAgents_Response>): TransportRequestCallback;
@@ -707,15 +719,33 @@ export default class OpenSearchAPI {
     createConnector (params: API.Ml_CreateConnector_Request, callback: callbackFn<API.Ml_CreateConnector_Response>): TransportRequestCallback;
     createConnector (params: API.Ml_CreateConnector_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_CreateConnector_Response>): TransportRequestCallback;
 
+    searchConnectors (params?: API.Ml_SearchConnectors_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_SearchConnectors_Response>;
+    searchConnectors (callback: callbackFn<API.Ml_SearchConnectors_Response>): TransportRequestCallback;
+    searchConnectors (params: API.Ml_SearchConnectors_Request, callback: callbackFn<API.Ml_SearchConnectors_Response>): TransportRequestCallback;
+    searchConnectors (params: API.Ml_SearchConnectors_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_SearchConnectors_Response>): TransportRequestCallback;
+
     deleteConnector (params: API.Ml_DeleteConnector_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_DeleteConnector_Response>;
     deleteConnector (params: API.Ml_DeleteConnector_Request, callback: callbackFn<API.Ml_DeleteConnector_Response>): TransportRequestCallback;
     deleteConnector (params: API.Ml_DeleteConnector_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_DeleteConnector_Response>): TransportRequestCallback;
 
+    getConnector (params: API.Ml_GetConnector_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_GetConnector_Response>;
+    getConnector (params: API.Ml_GetConnector_Request, callback: callbackFn<API.Ml_GetConnector_Response>): TransportRequestCallback;
+    getConnector (params: API.Ml_GetConnector_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_GetConnector_Response>): TransportRequestCallback;
+
+    updateConnector (params: API.Ml_UpdateConnector_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_UpdateConnector_Response>;
+    updateConnector (params: API.Ml_UpdateConnector_Request, callback: callbackFn<API.Ml_UpdateConnector_Response>): TransportRequestCallback;
+    updateConnector (params: API.Ml_UpdateConnector_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_UpdateConnector_Response>): TransportRequestCallback;
+
     registerModelGroup (params?: API.Ml_RegisterModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_RegisterModelGroup_Response>;
     registerModelGroup (callback: callbackFn<API.Ml_RegisterModelGroup_Response>): TransportRequestCallback;
     registerModelGroup (params: API.Ml_RegisterModelGroup_Request, callback: callbackFn<API.Ml_RegisterModelGroup_Response>): TransportRequestCallback;
     registerModelGroup (params: API.Ml_RegisterModelGroup_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_RegisterModelGroup_Response>): TransportRequestCallback;
 
+    searchModelGroup (params?: API.Ml_SearchModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_SearchModelGroup_Response>;
+    searchModelGroup (callback: callbackFn<API.Ml_SearchModelGroup_Response>): TransportRequestCallback;
+    searchModelGroup (params: API.Ml_SearchModelGroup_Request, callback: callbackFn<API.Ml_SearchModelGroup_Response>): TransportRequestCallback;
+    searchModelGroup (params: API.Ml_SearchModelGroup_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_SearchModelGroup_Response>): TransportRequestCallback;
+
     deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_DeleteModelGroup_Response>;
     deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, callback: callbackFn<API.Ml_DeleteModelGroup_Response>): TransportRequestCallback;
     deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_DeleteModelGroup_Response>): TransportRequestCallback;
@@ -724,6 +754,10 @@ export default class OpenSearchAPI {
     getModelGroup (params: API.Ml_GetModelGroup_Request, callback: callbackFn<API.Ml_GetModelGroup_Response>): TransportRequestCallback;
     getModelGroup (params: API.Ml_GetModelGroup_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_GetModelGroup_Response>): TransportRequestCallback;
 
+    updateModelGroup (params: API.Ml_UpdateModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_UpdateModelGroup_Response>;
+    updateModelGroup (params: API.Ml_UpdateModelGroup_Request, callback: callbackFn<API.Ml_UpdateModelGroup_Response>): TransportRequestCallback;
+    updateModelGroup (params: API.Ml_UpdateModelGroup_Request, options: TransportRequestOptions, callback: callbackFn<API.Ml_UpdateModelGroup_Response>): TransportRequestCallback;
+
     registerModel (params?: API.Ml_RegisterModel_Request, options?: TransportRequestOptions): TransportRequestPromise<API.Ml_RegisterModel_Response>;
     registerModel (callback: callbackFn<API.Ml_RegisterModel_Response>): TransportRequestCallback;
     registerModel (params: API.Ml_RegisterModel_Request, callback: callbackFn<API.Ml_RegisterModel_Response>): TransportRequestCallback;

diff --git a/api/_core/search.d.ts b/api/_core/search.d.ts
@@ -57,7 +57,7 @@ export interface Search_Request extends Global.Params {
   search_type?: Common.SearchType;
   seq_no_primary_term?: boolean;
   size?: number;
-  sort?: string | string[];
+  sort?: Common.StringOrStringArray;
   stats?: string[];
   stored_fields?: Common.Fields;
   suggest_field?: Common.Field;

diff --git a/api/_types/_common.analysis.d.ts b/api/_types/_common.analysis.d.ts
@@ -556,7 +556,7 @@ export type StopTokenFilter = TokenFilterBase & {
   type: 'stop';
 }
 
-export type StopWords = string | string[]
+export type StopWords = Common.StringOrStringArray
 
 export type SynonymFormat = 'solr' | 'wordnet'
 

diff --git a/api/_types/_common.d.ts b/api/_types/_common.d.ts
@@ -153,6 +153,8 @@ export type Duration = string
 
 export type DurationLarge = string
 
+export type DurationValueUnitMicros = UnitMicros
+
 export type DurationValueUnitMillis = UnitMillis
 
 export type DurationValueUnitNanos = UnitNanos
@@ -283,7 +285,7 @@ export type HourAndMinute = {
   minute: number[];
 }
 
-export type HttpHeaders = Record<string, string | string[]>
+export type HttpHeaders = Record<string, StringOrStringArray>
 
 export type HumanReadableByteCount = string
 
@@ -624,7 +626,7 @@ export type Retries = {
 
 export type Routing = string
 
-export type RoutingInQueryString = string | string[]
+export type RoutingInQueryString = StringOrStringArray
 
 export type RrfRank = RankBase & {
   rank_constant?: number;
@@ -825,6 +827,8 @@ export type StringifiedLong = number | string
 
 export type StringifiedVersionNumber = VersionNumber | string
 
+export type StringOrStringArray = string | string[]
+
 export type SuggestMode = 'always' | 'missing' | 'popular'
 
 export type TaskFailure = {
@@ -878,6 +882,8 @@ export type uint = number
 
 export type ulong = number
 
+export type UnitMicros = number
+
 export type UnitMillis = number
 
 export type UnitNanos = number

diff --git a/api/_types/_global.d.ts b/api/_types/_global.d.ts
@@ -14,10 +14,11 @@
  * modify the API generator.
  */
 
+import * as Common from './_common'
 
 export type Params = {
   error_trace?: boolean;
-  filter_path?: string | string[];
+  filter_path?: Common.StringOrStringArray;
   human?: boolean;
   pretty?: boolean;
   source?: string;

diff --git a/api/_types/indices._common.d.ts b/api/_types/indices._common.d.ts
@@ -230,7 +230,7 @@ export type IndexSettings = {
   refresh_interval?: Common.Duration;
   routing?: IndexRouting;
   routing_partition_size?: Common.StringifiedInteger;
-  routing_path?: string | string[];
+  routing_path?: Common.StringOrStringArray;
   search?: IndexSettingsSearch;
   'search.idle.after'?: Common.Duration;
   settings?: IndexSettings;

diff --git a/api/_types/indices.analyze.d.ts b/api/_types/indices.analyze.d.ts
@@ -14,6 +14,7 @@
  * modify the API generator.
  */
 
+import * as Common from './_common'
 
 export type AnalyzeDetail = {
   analyzer?: AnalyzerDetail;
@@ -54,7 +55,7 @@ export type ExplainAnalyzeToken = {
   type: string;
 }
 
-export type TextToAnalyze = string | string[]
+export type TextToAnalyze = Common.StringOrStringArray
 
 export type TokenDetail = {
   name: string;

diff --git a/api/_types/indices.stats.d.ts b/api/_types/indices.stats.d.ts
@@ -21,7 +21,9 @@ export type AllIndicesStats = {
   total: IndexStats;
 }
 
-export type IndexShardStats = IndexStatsBase & {
+export type IndexShardStats = IndexShardStatsBase & Record<string, any>
+
+export type IndexShardStatsBase = IndexStatsBase & {
   commit?: ShardCommit;
   retention_leases?: ShardRetentionLeases;
   routing?: ShardRouting;