@nestbox-ai/doc-processing-api 1.0.66 → 1.0.68

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.
@@ -1 +1 @@
1
- 7.19.0
1
+ 7.20.0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @nestbox-ai/doc-processing-api@1.0.66
1
+ ## @nestbox-ai/doc-processing-api@1.0.68
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @nestbox-ai/doc-processing-api@1.0.66 --save
39
+ npm install @nestbox-ai/doc-processing-api@1.0.68 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -124,6 +124,10 @@ export interface DocumentDto {
124
124
  * Optional processing metrics (pages, chunks, entities, etc.)
125
125
  */
126
126
  'metrics'?: { [key: string]: any; };
127
+ /**
128
+ * Tags associated with the document
129
+ */
130
+ 'tags'?: Array<string>;
127
131
  }
128
132
 
129
133
  export const DocumentDtoStatusEnum = {
@@ -570,6 +574,10 @@ export interface ProfileDto {
570
574
  * Content of the YAML file
571
575
  */
572
576
  'yamlFileContent'?: string;
577
+ /**
578
+ * Tags associated with the profile
579
+ */
580
+ 'tags'?: Array<string>;
573
581
  }
574
582
  export interface QueryCreateResponseDto {
575
583
  /**
@@ -804,10 +812,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
804
812
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
805
813
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
806
814
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
815
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
807
816
  * @param {*} [options] Override http request option.
808
817
  * @throws {RequiredError}
809
818
  */
810
- documentsControllerCreateDocument: async (profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
819
+ documentsControllerCreateDocument: async (profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
811
820
  // verify required parameter 'profileId' is not null or undefined
812
821
  assertParamExists('documentsControllerCreateDocument', 'profileId', profileId)
813
822
  // verify required parameter 'file' is not null or undefined
@@ -845,6 +854,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
845
854
  if (visualize !== undefined) {
846
855
  localVarFormParams.append('visualize', String(visualize) as any);
847
856
  }
857
+ if (tags) {
858
+ localVarFormParams.append('tags', tags.join(COLLECTION_FORMATS.csv));
859
+ }
860
+
848
861
  localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
849
862
  localVarHeaderParameter['Accept'] = 'application/json';
850
863
 
@@ -898,10 +911,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
898
911
  * @param {number} [page] 1-based page number.
899
912
  * @param {number} [limit] Page size.
900
913
  * @param {string} [profileId] Filter documents by profile/config ID.
914
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
901
915
  * @param {*} [options] Override http request option.
902
916
  * @throws {RequiredError}
903
917
  */
904
- documentsControllerListDocuments: async (page?: number, limit?: number, profileId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
918
+ documentsControllerListDocuments: async (page?: number, limit?: number, profileId?: string, tags?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
905
919
  const localVarPath = `/documents`;
906
920
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
907
921
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -926,6 +940,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
926
940
  localVarQueryParameter['profileId'] = profileId;
927
941
  }
928
942
 
943
+ if (tags) {
944
+ localVarQueryParameter['tags'] = tags;
945
+ }
946
+
929
947
  localVarHeaderParameter['Accept'] = 'application/json';
930
948
 
931
949
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -954,11 +972,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
954
972
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
955
973
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
956
974
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
975
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
957
976
  * @param {*} [options] Override http request option.
958
977
  * @throws {RequiredError}
959
978
  */
960
- async documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentCreateResponseDto>> {
961
- const localVarAxiosArgs = await localVarAxiosParamCreator.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options);
979
+ async documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentCreateResponseDto>> {
980
+ const localVarAxiosArgs = await localVarAxiosParamCreator.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options);
962
981
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
963
982
  const localVarOperationServerBasePath = operationServerMap['DocumentsApi.documentsControllerCreateDocument']?.[localVarOperationServerIndex]?.url;
964
983
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -982,11 +1001,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
982
1001
  * @param {number} [page] 1-based page number.
983
1002
  * @param {number} [limit] Page size.
984
1003
  * @param {string} [profileId] Filter documents by profile/config ID.
1004
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
985
1005
  * @param {*} [options] Override http request option.
986
1006
  * @throws {RequiredError}
987
1007
  */
988
- async documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedDocumentsDto>> {
989
- const localVarAxiosArgs = await localVarAxiosParamCreator.documentsControllerListDocuments(page, limit, profileId, options);
1008
+ async documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedDocumentsDto>> {
1009
+ const localVarAxiosArgs = await localVarAxiosParamCreator.documentsControllerListDocuments(page, limit, profileId, tags, options);
990
1010
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
991
1011
  const localVarOperationServerBasePath = operationServerMap['DocumentsApi.documentsControllerListDocuments']?.[localVarOperationServerIndex]?.url;
992
1012
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1008,11 +1028,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
1008
1028
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
1009
1029
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
1010
1030
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
1031
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
1011
1032
  * @param {*} [options] Override http request option.
1012
1033
  * @throws {RequiredError}
1013
1034
  */
1014
- documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentCreateResponseDto> {
1015
- return localVarFp.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options).then((request) => request(axios, basePath));
1035
+ documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<DocumentCreateResponseDto> {
1036
+ return localVarFp.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options).then((request) => request(axios, basePath));
1016
1037
  },
1017
1038
  /**
1018
1039
  *
@@ -1030,11 +1051,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
1030
1051
  * @param {number} [page] 1-based page number.
1031
1052
  * @param {number} [limit] Page size.
1032
1053
  * @param {string} [profileId] Filter documents by profile/config ID.
1054
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
1033
1055
  * @param {*} [options] Override http request option.
1034
1056
  * @throws {RequiredError}
1035
1057
  */
1036
- documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedDocumentsDto> {
1037
- return localVarFp.documentsControllerListDocuments(page, limit, profileId, options).then((request) => request(axios, basePath));
1058
+ documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedDocumentsDto> {
1059
+ return localVarFp.documentsControllerListDocuments(page, limit, profileId, tags, options).then((request) => request(axios, basePath));
1038
1060
  },
1039
1061
  };
1040
1062
  };
@@ -1051,11 +1073,12 @@ export class DocumentsApi extends BaseAPI {
1051
1073
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
1052
1074
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
1053
1075
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
1076
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
1054
1077
  * @param {*} [options] Override http request option.
1055
1078
  * @throws {RequiredError}
1056
1079
  */
1057
- public documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig) {
1058
- return DocumentsApiFp(this.configuration).documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options).then((request) => request(this.axios, this.basePath));
1080
+ public documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig) {
1081
+ return DocumentsApiFp(this.configuration).documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options).then((request) => request(this.axios, this.basePath));
1059
1082
  }
1060
1083
 
1061
1084
  /**
@@ -1075,11 +1098,12 @@ export class DocumentsApi extends BaseAPI {
1075
1098
  * @param {number} [page] 1-based page number.
1076
1099
  * @param {number} [limit] Page size.
1077
1100
  * @param {string} [profileId] Filter documents by profile/config ID.
1101
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
1078
1102
  * @param {*} [options] Override http request option.
1079
1103
  * @throws {RequiredError}
1080
1104
  */
1081
- public documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig) {
1082
- return DocumentsApiFp(this.configuration).documentsControllerListDocuments(page, limit, profileId, options).then((request) => request(this.axios, this.basePath));
1105
+ public documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) {
1106
+ return DocumentsApiFp(this.configuration).documentsControllerListDocuments(page, limit, profileId, tags, options).then((request) => request(this.axios, this.basePath));
1083
1107
  }
1084
1108
  }
1085
1109
 
@@ -1807,10 +1831,11 @@ export const ProfilesApiAxiosParamCreator = function (configuration?: Configurat
1807
1831
  * @summary Create profile from YAML
1808
1832
  * @param {File} yaml YAML file containing the profile/config.
1809
1833
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1834
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1810
1835
  * @param {*} [options] Override http request option.
1811
1836
  * @throws {RequiredError}
1812
1837
  */
1813
- profilesControllerCreateProfile: async (yaml: File, name?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1838
+ profilesControllerCreateProfile: async (yaml: File, name?: string, tags?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1814
1839
  // verify required parameter 'yaml' is not null or undefined
1815
1840
  assertParamExists('profilesControllerCreateProfile', 'yaml', yaml)
1816
1841
  const localVarPath = `/profiles`;
@@ -1834,6 +1859,10 @@ export const ProfilesApiAxiosParamCreator = function (configuration?: Configurat
1834
1859
  if (name !== undefined) {
1835
1860
  localVarFormParams.append('name', name as any);
1836
1861
  }
1862
+ if (tags) {
1863
+ localVarFormParams.append('tags', tags.join(COLLECTION_FORMATS.csv));
1864
+ }
1865
+
1837
1866
  localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
1838
1867
  localVarHeaderParameter['Accept'] = 'application/json';
1839
1868
 
@@ -1916,10 +1945,11 @@ export const ProfilesApiAxiosParamCreator = function (configuration?: Configurat
1916
1945
  * @summary List profiles
1917
1946
  * @param {number} [page] 1-based page number.
1918
1947
  * @param {number} [limit] Page size.
1948
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1919
1949
  * @param {*} [options] Override http request option.
1920
1950
  * @throws {RequiredError}
1921
1951
  */
1922
- profilesControllerListProfiles: async (page?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1952
+ profilesControllerListProfiles: async (page?: number, limit?: number, tags?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1923
1953
  const localVarPath = `/profiles`;
1924
1954
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1925
1955
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -1940,6 +1970,10 @@ export const ProfilesApiAxiosParamCreator = function (configuration?: Configurat
1940
1970
  localVarQueryParameter['limit'] = limit;
1941
1971
  }
1942
1972
 
1973
+ if (tags) {
1974
+ localVarQueryParameter['tags'] = tags;
1975
+ }
1976
+
1943
1977
  localVarHeaderParameter['Accept'] = 'application/json';
1944
1978
 
1945
1979
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1965,11 +1999,12 @@ export const ProfilesApiFp = function(configuration?: Configuration) {
1965
1999
  * @summary Create profile from YAML
1966
2000
  * @param {File} yaml YAML file containing the profile/config.
1967
2001
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
2002
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1968
2003
  * @param {*} [options] Override http request option.
1969
2004
  * @throws {RequiredError}
1970
2005
  */
1971
- async profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>> {
1972
- const localVarAxiosArgs = await localVarAxiosParamCreator.profilesControllerCreateProfile(yaml, name, options);
2006
+ async profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>> {
2007
+ const localVarAxiosArgs = await localVarAxiosParamCreator.profilesControllerCreateProfile(yaml, name, tags, options);
1973
2008
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1974
2009
  const localVarOperationServerBasePath = operationServerMap['ProfilesApi.profilesControllerCreateProfile']?.[localVarOperationServerIndex]?.url;
1975
2010
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2004,11 +2039,12 @@ export const ProfilesApiFp = function(configuration?: Configuration) {
2004
2039
  * @summary List profiles
2005
2040
  * @param {number} [page] 1-based page number.
2006
2041
  * @param {number} [limit] Page size.
2042
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
2007
2043
  * @param {*} [options] Override http request option.
2008
2044
  * @throws {RequiredError}
2009
2045
  */
2010
- async profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>> {
2011
- const localVarAxiosArgs = await localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, options);
2046
+ async profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>> {
2047
+ const localVarAxiosArgs = await localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, options);
2012
2048
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2013
2049
  const localVarOperationServerBasePath = operationServerMap['ProfilesApi.profilesControllerListProfiles']?.[localVarOperationServerIndex]?.url;
2014
2050
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2027,11 +2063,12 @@ export const ProfilesApiFactory = function (configuration?: Configuration, baseP
2027
2063
  * @summary Create profile from YAML
2028
2064
  * @param {File} yaml YAML file containing the profile/config.
2029
2065
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
2066
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
2030
2067
  * @param {*} [options] Override http request option.
2031
2068
  * @throws {RequiredError}
2032
2069
  */
2033
- profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto> {
2034
- return localVarFp.profilesControllerCreateProfile(yaml, name, options).then((request) => request(axios, basePath));
2070
+ profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto> {
2071
+ return localVarFp.profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(axios, basePath));
2035
2072
  },
2036
2073
  /**
2037
2074
  *
@@ -2057,11 +2094,12 @@ export const ProfilesApiFactory = function (configuration?: Configuration, baseP
2057
2094
  * @summary List profiles
2058
2095
  * @param {number} [page] 1-based page number.
2059
2096
  * @param {number} [limit] Page size.
2097
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
2060
2098
  * @param {*} [options] Override http request option.
2061
2099
  * @throws {RequiredError}
2062
2100
  */
2063
- profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto> {
2064
- return localVarFp.profilesControllerListProfiles(page, limit, options).then((request) => request(axios, basePath));
2101
+ profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto> {
2102
+ return localVarFp.profilesControllerListProfiles(page, limit, tags, options).then((request) => request(axios, basePath));
2065
2103
  },
2066
2104
  };
2067
2105
  };
@@ -2075,11 +2113,12 @@ export class ProfilesApi extends BaseAPI {
2075
2113
  * @summary Create profile from YAML
2076
2114
  * @param {File} yaml YAML file containing the profile/config.
2077
2115
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
2116
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
2078
2117
  * @param {*} [options] Override http request option.
2079
2118
  * @throws {RequiredError}
2080
2119
  */
2081
- public profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig) {
2082
- return ProfilesApiFp(this.configuration).profilesControllerCreateProfile(yaml, name, options).then((request) => request(this.axios, this.basePath));
2120
+ public profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) {
2121
+ return ProfilesApiFp(this.configuration).profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(this.axios, this.basePath));
2083
2122
  }
2084
2123
 
2085
2124
  /**
@@ -2108,11 +2147,12 @@ export class ProfilesApi extends BaseAPI {
2108
2147
  * @summary List profiles
2109
2148
  * @param {number} [page] 1-based page number.
2110
2149
  * @param {number} [limit] Page size.
2150
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
2111
2151
  * @param {*} [options] Override http request option.
2112
2152
  * @throws {RequiredError}
2113
2153
  */
2114
- public profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig) {
2115
- return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, options).then((request) => request(this.axios, this.basePath));
2154
+ public profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig) {
2155
+ return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, options).then((request) => request(this.axios, this.basePath));
2116
2156
  }
2117
2157
  }
2118
2158
 
package/common.ts CHANGED
@@ -96,7 +96,8 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
96
96
  * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
97
97
  * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
98
98
  */
99
- export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
99
+ // @ts-ignore
100
+ export const replaceWithSerializableTypeIfNeeded = function(key: string, value: any) {
100
101
  if (value instanceof Set) {
101
102
  return Array.from(value);
102
103
  } else {
package/dist/api.d.ts CHANGED
@@ -115,6 +115,10 @@ export interface DocumentDto {
115
115
  'metrics'?: {
116
116
  [key: string]: any;
117
117
  };
118
+ /**
119
+ * Tags associated with the document
120
+ */
121
+ 'tags'?: Array<string>;
118
122
  }
119
123
  export declare const DocumentDtoStatusEnum: {
120
124
  readonly Queued: "queued";
@@ -549,6 +553,10 @@ export interface ProfileDto {
549
553
  * Content of the YAML file
550
554
  */
551
555
  'yamlFileContent'?: string;
556
+ /**
557
+ * Tags associated with the profile
558
+ */
559
+ 'tags'?: Array<string>;
552
560
  }
553
561
  export interface QueryCreateResponseDto {
554
562
  /**
@@ -733,10 +741,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
733
741
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
734
742
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
735
743
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
744
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
736
745
  * @param {*} [options] Override http request option.
737
746
  * @throws {RequiredError}
738
747
  */
739
- documentsControllerCreateDocument: (profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
748
+ documentsControllerCreateDocument: (profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
740
749
  /**
741
750
  *
742
751
  * @summary Read document
@@ -751,10 +760,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
751
760
  * @param {number} [page] 1-based page number.
752
761
  * @param {number} [limit] Page size.
753
762
  * @param {string} [profileId] Filter documents by profile/config ID.
763
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
754
764
  * @param {*} [options] Override http request option.
755
765
  * @throws {RequiredError}
756
766
  */
757
- documentsControllerListDocuments: (page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
767
+ documentsControllerListDocuments: (page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
758
768
  };
759
769
  /**
760
770
  * DocumentsApi - functional programming interface
@@ -768,10 +778,11 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
768
778
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
769
779
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
770
780
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
781
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
771
782
  * @param {*} [options] Override http request option.
772
783
  * @throws {RequiredError}
773
784
  */
774
- documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentCreateResponseDto>>;
785
+ documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentCreateResponseDto>>;
775
786
  /**
776
787
  *
777
788
  * @summary Read document
@@ -786,10 +797,11 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
786
797
  * @param {number} [page] 1-based page number.
787
798
  * @param {number} [limit] Page size.
788
799
  * @param {string} [profileId] Filter documents by profile/config ID.
800
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
789
801
  * @param {*} [options] Override http request option.
790
802
  * @throws {RequiredError}
791
803
  */
792
- documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedDocumentsDto>>;
804
+ documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedDocumentsDto>>;
793
805
  };
794
806
  /**
795
807
  * DocumentsApi - factory interface
@@ -803,10 +815,11 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
803
815
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
804
816
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
805
817
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
818
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
806
819
  * @param {*} [options] Override http request option.
807
820
  * @throws {RequiredError}
808
821
  */
809
- documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentCreateResponseDto>;
822
+ documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<DocumentCreateResponseDto>;
810
823
  /**
811
824
  *
812
825
  * @summary Read document
@@ -821,10 +834,11 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
821
834
  * @param {number} [page] 1-based page number.
822
835
  * @param {number} [limit] Page size.
823
836
  * @param {string} [profileId] Filter documents by profile/config ID.
837
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
824
838
  * @param {*} [options] Override http request option.
825
839
  * @throws {RequiredError}
826
840
  */
827
- documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedDocumentsDto>;
841
+ documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedDocumentsDto>;
828
842
  };
829
843
  /**
830
844
  * DocumentsApi - object-oriented interface
@@ -838,10 +852,11 @@ export declare class DocumentsApi extends BaseAPI {
838
852
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
839
853
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
840
854
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
855
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
841
856
  * @param {*} [options] Override http request option.
842
857
  * @throws {RequiredError}
843
858
  */
844
- documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentCreateResponseDto, any, {}>>;
859
+ documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentCreateResponseDto, any, {}>>;
845
860
  /**
846
861
  *
847
862
  * @summary Read document
@@ -856,10 +871,11 @@ export declare class DocumentsApi extends BaseAPI {
856
871
  * @param {number} [page] 1-based page number.
857
872
  * @param {number} [limit] Page size.
858
873
  * @param {string} [profileId] Filter documents by profile/config ID.
874
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
859
875
  * @param {*} [options] Override http request option.
860
876
  * @throws {RequiredError}
861
877
  */
862
- documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedDocumentsDto, any, {}>>;
878
+ documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedDocumentsDto, any, {}>>;
863
879
  }
864
880
  export declare const DocumentsControllerCreateDocumentPriorityEnum: {
865
881
  readonly Low: "low";
@@ -1216,10 +1232,11 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
1216
1232
  * @summary Create profile from YAML
1217
1233
  * @param {File} yaml YAML file containing the profile/config.
1218
1234
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1235
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1219
1236
  * @param {*} [options] Override http request option.
1220
1237
  * @throws {RequiredError}
1221
1238
  */
1222
- profilesControllerCreateProfile: (yaml: File, name?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1239
+ profilesControllerCreateProfile: (yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1223
1240
  /**
1224
1241
  *
1225
1242
  * @summary Read profile
@@ -1240,10 +1257,11 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
1240
1257
  * @summary List profiles
1241
1258
  * @param {number} [page] 1-based page number.
1242
1259
  * @param {number} [limit] Page size.
1260
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1243
1261
  * @param {*} [options] Override http request option.
1244
1262
  * @throws {RequiredError}
1245
1263
  */
1246
- profilesControllerListProfiles: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1264
+ profilesControllerListProfiles: (page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1247
1265
  };
1248
1266
  /**
1249
1267
  * ProfilesApi - functional programming interface
@@ -1254,10 +1272,11 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
1254
1272
  * @summary Create profile from YAML
1255
1273
  * @param {File} yaml YAML file containing the profile/config.
1256
1274
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1275
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1257
1276
  * @param {*} [options] Override http request option.
1258
1277
  * @throws {RequiredError}
1259
1278
  */
1260
- profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
1279
+ profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
1261
1280
  /**
1262
1281
  *
1263
1282
  * @summary Read profile
@@ -1280,10 +1299,11 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
1280
1299
  * @summary List profiles
1281
1300
  * @param {number} [page] 1-based page number.
1282
1301
  * @param {number} [limit] Page size.
1302
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1283
1303
  * @param {*} [options] Override http request option.
1284
1304
  * @throws {RequiredError}
1285
1305
  */
1286
- profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
1306
+ profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
1287
1307
  };
1288
1308
  /**
1289
1309
  * ProfilesApi - factory interface
@@ -1294,10 +1314,11 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
1294
1314
  * @summary Create profile from YAML
1295
1315
  * @param {File} yaml YAML file containing the profile/config.
1296
1316
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1317
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1297
1318
  * @param {*} [options] Override http request option.
1298
1319
  * @throws {RequiredError}
1299
1320
  */
1300
- profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
1321
+ profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
1301
1322
  /**
1302
1323
  *
1303
1324
  * @summary Read profile
@@ -1320,10 +1341,11 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
1320
1341
  * @summary List profiles
1321
1342
  * @param {number} [page] 1-based page number.
1322
1343
  * @param {number} [limit] Page size.
1344
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1323
1345
  * @param {*} [options] Override http request option.
1324
1346
  * @throws {RequiredError}
1325
1347
  */
1326
- profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
1348
+ profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
1327
1349
  };
1328
1350
  /**
1329
1351
  * ProfilesApi - object-oriented interface
@@ -1334,10 +1356,11 @@ export declare class ProfilesApi extends BaseAPI {
1334
1356
  * @summary Create profile from YAML
1335
1357
  * @param {File} yaml YAML file containing the profile/config.
1336
1358
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1359
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1337
1360
  * @param {*} [options] Override http request option.
1338
1361
  * @throws {RequiredError}
1339
1362
  */
1340
- profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
1363
+ profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
1341
1364
  /**
1342
1365
  *
1343
1366
  * @summary Read profile
@@ -1360,10 +1383,11 @@ export declare class ProfilesApi extends BaseAPI {
1360
1383
  * @summary List profiles
1361
1384
  * @param {number} [page] 1-based page number.
1362
1385
  * @param {number} [limit] Page size.
1386
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1363
1387
  * @param {*} [options] Override http request option.
1364
1388
  * @throws {RequiredError}
1365
1389
  */
1366
- profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
1390
+ profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
1367
1391
  }
1368
1392
  /**
1369
1393
  * QueriesApi - axios parameter creator