@petercatai/whisker-client 0.1.202505160550-dev → 0.1.202505171524-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 +17 -126
  2. package/package.json +1 -1
package/dist/api.d.ts CHANGED
@@ -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 {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@petercatai/whisker-client",
3
- "version": "0.1.202505160550-dev",
3
+ "version": "0.1.202505171524-dev",
4
4
  "description": "Generated API client (preview)",
5
5
  "main": "dist/api.js",
6
6
  "types": "dist/api.d.ts",