@petercatai/whisker-client 0.1.202505160555 → 0.1.202505190451-dev

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.
Files changed (2) hide show
  1. package/dist/api.d.ts +29 -138
  2. package/package.json +4 -4
package/dist/api.d.ts CHANGED
@@ -799,8 +799,8 @@ export interface IPDFSplitConfig {
799
799
  */
800
800
  table_extract_mode?: string;
801
801
  }
802
- /** PageParams[Chunk] */
803
- export interface IPageParamsChunk {
802
+ /** PageQueryParams[Chunk] */
803
+ export interface IPageQueryParamsChunk {
804
804
  /**
805
805
  * Order By
806
806
  * order by field
@@ -833,8 +833,8 @@ export interface IPageParamsChunk {
833
833
  */
834
834
  page_size?: number;
835
835
  }
836
- /** PageParams[Knowledge] */
837
- export interface IPageParamsKnowledge {
836
+ /** PageQueryParams[Knowledge] */
837
+ export interface IPageQueryParamsKnowledge {
838
838
  /**
839
839
  * Order By
840
840
  * order by field
@@ -867,8 +867,8 @@ export interface IPageParamsKnowledge {
867
867
  */
868
868
  page_size?: number;
869
869
  }
870
- /** PageParams[Space] */
871
- export interface IPageParamsSpace {
870
+ /** PageQueryParams[Space] */
871
+ export interface IPageQueryParamsSpace {
872
872
  /**
873
873
  * Order By
874
874
  * order by field
@@ -901,8 +901,8 @@ export interface IPageParamsSpace {
901
901
  */
902
902
  page_size?: number;
903
903
  }
904
- /** PageParams[Task] */
905
- export interface IPageParamsTask {
904
+ /** PageQueryParams[Task] */
905
+ export interface IPageQueryParamsTask {
906
906
  /**
907
907
  * Order By
908
908
  * order by field
@@ -1049,126 +1049,6 @@ export interface IQACreate {
1049
1049
  /** source config of the knowledge */
1050
1050
  source_config?: ITextSourceConfig | null;
1051
1051
  }
1052
- /** QueryByDeepRetrieval */
1053
- export interface IQueryByDeepRetrieval {
1054
- /**
1055
- * Embedding Model Name
1056
- * The name of the embedding model
1057
- */
1058
- embedding_model_name: IEmbeddingModelEnum | string;
1059
- /**
1060
- * Similarity Threshold
1061
- * The similarity threshold, ranging from 0.0 to 1.0.
1062
- * @min 0
1063
- * @max 1
1064
- * @default 0.5
1065
- */
1066
- similarity_threshold?: number;
1067
- /**
1068
- * Top
1069
- * The maximum number of results to return.
1070
- * @min 1
1071
- * @default 1024
1072
- */
1073
- top?: number;
1074
- /**
1075
- * Metadata Filter
1076
- * metadata filter
1077
- * @default {}
1078
- */
1079
- metadata_filter?: Record<string, any>;
1080
- /**
1081
- * Type
1082
- * The type of the request, should be 'deep_retrieval'.
1083
- * @default "deep_retrieval"
1084
- */
1085
- type?: string;
1086
- /**
1087
- * Space Name List
1088
- * space name list
1089
- */
1090
- space_name_list: string[];
1091
- }
1092
- /** QueryByKnowledgeConfig */
1093
- export interface IQueryByKnowledgeConfig {
1094
- /**
1095
- * Embedding Model Name
1096
- * The name of the embedding model
1097
- */
1098
- embedding_model_name: string;
1099
- /**
1100
- * Similarity Threshold
1101
- * The similarity threshold, ranging from 0.0 to 1.0.
1102
- * @min 0
1103
- * @max 1
1104
- * @default 0.5
1105
- */
1106
- similarity_threshold?: number;
1107
- /**
1108
- * Top
1109
- * The maximum number of results to return.
1110
- * @min 1
1111
- * @default 1024
1112
- */
1113
- top?: number;
1114
- /**
1115
- * Metadata Filter
1116
- * metadata filter
1117
- * @default {}
1118
- */
1119
- metadata_filter?: Record<string, any>;
1120
- /**
1121
- * Type
1122
- * The type of the request, should be 'query_in_knowledge_list'.
1123
- * @default "query_in_knowledge_list"
1124
- */
1125
- type?: string;
1126
- /**
1127
- * Space Id List
1128
- * knowledge id list
1129
- */
1130
- space_id_list: string[];
1131
- }
1132
- /** QueryBySpaceConfig */
1133
- export interface IQueryBySpaceConfig {
1134
- /**
1135
- * Embedding Model Name
1136
- * The name of the embedding model
1137
- */
1138
- embedding_model_name: IEmbeddingModelEnum | string;
1139
- /**
1140
- * Similarity Threshold
1141
- * The similarity threshold, ranging from 0.0 to 1.0.
1142
- * @min 0
1143
- * @max 1
1144
- * @default 0.5
1145
- */
1146
- similarity_threshold?: number;
1147
- /**
1148
- * Top
1149
- * The maximum number of results to return.
1150
- * @min 1
1151
- * @default 1024
1152
- */
1153
- top?: number;
1154
- /**
1155
- * Metadata Filter
1156
- * metadata filter
1157
- * @default {}
1158
- */
1159
- metadata_filter?: Record<string, any>;
1160
- /**
1161
- * Type
1162
- * The type of the request, should be 'query_in_space_list'.
1163
- * @default "query_in_space_list"
1164
- */
1165
- type?: string;
1166
- /**
1167
- * Space Id List
1168
- * space id list
1169
- */
1170
- space_id_list: string[];
1171
- }
1172
1052
  /** ResponseModel */
1173
1053
  export interface IResponseModel {
1174
1054
  /** Success */
@@ -1445,18 +1325,29 @@ export interface IRetrievalChunk {
1445
1325
  */
1446
1326
  similarity: number;
1447
1327
  }
1328
+ /** RetrievalConfig */
1329
+ export interface IRetrievalConfig {
1330
+ /**
1331
+ * Type
1332
+ * The retrieval type. Each retrieval type corresponds to a specific retriever.
1333
+ */
1334
+ type: string;
1335
+ [key: string]: any;
1336
+ }
1448
1337
  /** RetrievalRequest */
1449
1338
  export interface IRetrievalRequest {
1450
1339
  /**
1451
- * Question
1452
- * The query question
1340
+ * Content
1341
+ * The content to be searched, such as a question, text, or any other query string.
1453
1342
  */
1454
- question: string;
1343
+ content: string;
1455
1344
  /**
1456
- * Config
1457
- * The configuration for the retrieval request
1345
+ * Image Url
1346
+ * image
1458
1347
  */
1459
- config: IQueryBySpaceConfig | IQueryByKnowledgeConfig | IQueryByDeepRetrieval | Record<string, any>;
1348
+ image_url?: string | null;
1349
+ /** The configuration for the retrieval request. Must inherit from RetrievalConfig and have a 'type' attribute. */
1350
+ config: IRetrievalConfig;
1460
1351
  }
1461
1352
  /** S3SourceConfig */
1462
1353
  export interface IS3SourceConfig {
@@ -2085,7 +1976,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2085
1976
  * @summary Get Knowledge List
2086
1977
  * @request POST:/api/knowledge/list
2087
1978
  */
2088
- getKnowledgeList: (data: IPageParamsKnowledge, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseKnowledge, void | IHTTPValidationError>>;
1979
+ getKnowledgeList: (data: IPageQueryParamsKnowledge, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseKnowledge, void | IHTTPValidationError>>;
2089
1980
  /**
2090
1981
  * No description
2091
1982
  *
@@ -2176,7 +2067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2176
2067
  * @summary Get Task List
2177
2068
  * @request POST:/api/task/list
2178
2069
  */
2179
- getTaskList: (data: IPageParamsTask, params?: RequestParams) => Promise<HttpResponse<IResponseModelStatusStatisticsPageResponseTask, void | IHTTPValidationError>>;
2070
+ getTaskList: (data: IPageQueryParamsTask, params?: RequestParams) => Promise<HttpResponse<IResponseModelStatusStatisticsPageResponseTask, void | IHTTPValidationError>>;
2180
2071
  /**
2181
2072
  * No description
2182
2073
  *
@@ -2211,7 +2102,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2211
2102
  * @summary Get Chunk List
2212
2103
  * @request POST:/api/chunk/list
2213
2104
  */
2214
- getChunkList: (data: IPageParamsChunk, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseChunk, void | IHTTPValidationError>>;
2105
+ getChunkList: (data: IPageQueryParamsChunk, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseChunk, void | IHTTPValidationError>>;
2215
2106
  /**
2216
2107
  * No description
2217
2108
  *
@@ -2325,7 +2216,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2325
2216
  * @summary Get Space List
2326
2217
  * @request POST:/api/space/list
2327
2218
  */
2328
- getSpaceList: (data: IPageParamsSpace, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseSpaceResponse, void | IHTTPValidationError>>;
2219
+ getSpaceList: (data: IPageQueryParamsSpace, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseSpaceResponse, void | IHTTPValidationError>>;
2329
2220
  /**
2330
2221
  * No description
2331
2222
  *
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@petercatai/whisker-client",
3
- "version": "0.1.202505160555",
4
- "description": "Generated API client (Production)",
3
+ "version": "0.1.202505190451-dev",
4
+ "description": "Generated API client (preview)",
5
5
  "main": "dist/api.js",
6
6
  "types": "dist/api.d.ts",
7
7
  "files": [
@@ -13,10 +13,10 @@
13
13
  },
14
14
  "publishConfig": {
15
15
  "access": "public",
16
- "tag": "latest"
16
+ "tag": "dev"
17
17
  },
18
18
  "devDependencies": {
19
- "@types/node": "^22.15.18",
19
+ "@types/node": "^22.15.19",
20
20
  "axios": "^1.9.0",
21
21
  "typescript": "^5.8.3"
22
22
  }