@petercatai/whisker-client 0.1.202504281028 → 0.1.202504301149

package/dist/api.d.ts

@@ -32,7 +32,10 @@ export declare enum IKnowledgeSourceEnum {
     GithubRepo = "github_repo",
     GithubFile = "github_file",
     UserInputText = "user_input_text",
-    UserUploadFile = "user_upload_file"
+    UserUploadFile = "user_upload_file",
+    Yuque = "yuque",
+    Youtube = "youtube",
+    Database = "database"
 }
 /** EmbeddingModelEnum */
 export declare enum IEmbeddingModelEnum {
@@ -1101,6 +1104,126 @@ export interface IQACreate {
     /** source config of the knowledge */
     source_config?: ITextSourceConfig | null;
 }
+/** QueryByDeepSearch */
+export interface IQueryByDeepSearch {
+    /**
+     * Embedding Model Name
+     * The name of the embedding model
+     */
+    embedding_model_name: IEmbeddingModelEnum | string;
+    /**
+     * Similarity Threshold
+     * The similarity threshold, ranging from 0.0 to 1.0.
+     * @min 0
+     * @max 1
+     * @default 0.5
+     */
+    similarity_threshold?: number;
+    /**
+     * Top
+     * The maximum number of results to return.
+     * @min 1
+     * @default 1024
+     */
+    top?: number;
+    /**
+     * Metadata Filter
+     * metadata filter
+     * @default {}
+     */
+    metadata_filter?: Record<string, any>;
+    /**
+     * Type
+     * The type of the request, should be 'deep_search'.
+     * @default "deep_search"
+     */
+    type?: string;
+    /**
+     * Space Name List
+     * space name list
+     */
+    space_name_list: string[];
+}
+/** QueryByKnowledgeConfig */
+export interface IQueryByKnowledgeConfig {
+    /**
+     * Embedding Model Name
+     * The name of the embedding model
+     */
+    embedding_model_name: string;
+    /**
+     * Similarity Threshold
+     * The similarity threshold, ranging from 0.0 to 1.0.
+     * @min 0
+     * @max 1
+     * @default 0.5
+     */
+    similarity_threshold?: number;
+    /**
+     * Top
+     * The maximum number of results to return.
+     * @min 1
+     * @default 1024
+     */
+    top?: number;
+    /**
+     * Metadata Filter
+     * metadata filter
+     * @default {}
+     */
+    metadata_filter?: Record<string, any>;
+    /**
+     * Type
+     * The type of the request, should be 'query_in_knowledge_list'.
+     * @default "query_in_knowledge_list"
+     */
+    type?: string;
+    /**
+     * Space Id List
+     * knowledge id list
+     */
+    space_id_list: string[];
+}
+/** QueryBySpaceConfig */
+export interface IQueryBySpaceConfig {
+    /**
+     * Embedding Model Name
+     * The name of the embedding model
+     */
+    embedding_model_name: IEmbeddingModelEnum | string;
+    /**
+     * Similarity Threshold
+     * The similarity threshold, ranging from 0.0 to 1.0.
+     * @min 0
+     * @max 1
+     * @default 0.5
+     */
+    similarity_threshold?: number;
+    /**
+     * Top
+     * The maximum number of results to return.
+     * @min 1
+     * @default 1024
+     */
+    top?: number;
+    /**
+     * Metadata Filter
+     * metadata filter
+     * @default {}
+     */
+    metadata_filter?: Record<string, any>;
+    /**
+     * Type
+     * The type of the request, should be 'query_in_space_list'.
+     * @default "query_in_space_list"
+     */
+    type?: string;
+    /**
+     * Space Id List
+     * space id list
+     */
+    space_id_list: string[];
+}
 /** ResponseModel */
 export interface IResponseModel {
     /** Success */
@@ -1238,12 +1361,10 @@ export interface IResponseModelObject {
 /** RetrievalByKnowledgeRequest */
 export interface IRetrievalByKnowledgeRequest {
     /**
-     * Question
-     * The query question
+     * Embedding Model Name
+     * The name of the embedding model
      */
-    question: string;
-    /** The name of the embedding model */
-    embedding_model_name: IEmbeddingModelEnum;
+    embedding_model_name: IEmbeddingModelEnum | string;
     /**
      * Similarity Threshold
      * The similarity threshold, ranging from 0.0 to 1.0.
@@ -1265,6 +1386,11 @@ export interface IRetrievalByKnowledgeRequest {
      * @default {}
      */
     metadata_filter?: Record<string, any>;
+    /**
+     * Question
+     * The query question
+     */
+    question: string;
     /**
      * Knowledge Id List
      * knowledge id list
@@ -1274,12 +1400,10 @@ export interface IRetrievalByKnowledgeRequest {
 /** RetrievalBySpaceRequest */
 export interface IRetrievalBySpaceRequest {
     /**
-     * Question
-     * The query question
+     * Embedding Model Name
+     * The name of the embedding model
      */
-    question: string;
-    /** The name of the embedding model */
-    embedding_model_name: IEmbeddingModelEnum;
+    embedding_model_name: IEmbeddingModelEnum | string;
     /**
      * Similarity Threshold
      * The similarity threshold, ranging from 0.0 to 1.0.
@@ -1301,6 +1425,11 @@ export interface IRetrievalBySpaceRequest {
      * @default {}
      */
     metadata_filter?: Record<string, any>;
+    /**
+     * Question
+     * The query question
+     */
+    question: string;
     /**
      * Space Id List
      * space id list
@@ -1361,10 +1490,23 @@ export interface IRetrievalChunk {
     gmt_modified?: string;
     /**
      * Similarity
-     * The similarity of the chunk
+     * The similarity of the chunk, ranging from 0.0 to 1.0.
      */
     similarity: number;
 }
+/** RetrievalRequest */
+export interface IRetrievalRequest {
+    /**
+     * Question
+     * The query question
+     */
+    question: string;
+    /**
+     * Config
+     * The configuration for the retrieval request
+     */
+    config: IQueryBySpaceConfig | IQueryByKnowledgeConfig | IQueryByDeepSearch | Record<string, any>;
+}
 /** S3SourceConfig */
 export interface IS3SourceConfig {
     /**
@@ -1398,10 +1540,10 @@ export interface IS3SourceConfig {
      */
     secret_key?: string | null;
     /**
-     * Session Token
+     * Auth Info
      * s3 session token
      */
-    session_token?: string | null;
+    auth_info?: string | null;
 }
 /**
  * SpaceCreate
@@ -1409,6 +1551,8 @@ export interface IS3SourceConfig {
  * Attributes:
  *     space_name (str): Space name, example: petercat bot group.
  *     description (str): descrition of the space resource.
+ *     metadata (Dict[str, Any]): metadata of the space resource.such as embedding model name
+ *         and other parameters.
  */
 export interface ISpaceCreate {
     /**
@@ -1423,6 +1567,12 @@ export interface ISpaceCreate {
      * @maxLength 255
      */
     description: string;
+    /**
+     * Metadata
+     * metadata of the space resource
+     * @default {}
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * SpaceResponse
@@ -1445,6 +1595,12 @@ export interface ISpaceResponse {
      * @maxLength 255
      */
     description: string;
+    /**
+     * Metadata
+     * metadata of the space resource
+     * @default {}
+     */
+    metadata?: Record<string, any>;
     /**
      * Space Id
      * space id
@@ -1495,6 +1651,16 @@ export interface IStatusStatisticsPageResponseTask {
      * @default 0
      */
     success?: number;
+    /**
+     * Failed
+     * @default 0
+     */
+    failed?: number;
+    /**
+     * Cancelled
+     * @default 0
+     */
+    cancelled?: number;
 }
 /** Task */
 export interface ITask {
@@ -1894,6 +2060,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/retrieval/space
          */
         retrieveSpaceContent: (data: IRetrievalBySpaceRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListRetrievalChunk, void | IHTTPValidationError>>;
+        /**
+         * @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id.
+         *
+         * @tags retrieval
+         * @name Retrieve
+         * @summary Retrieve
+         * @request POST:/api/retrieval/
+         */
+        retrieve: (data: IRetrievalRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListRetrievalChunk, void | IHTTPValidationError>>;
     };
     task: {
         /**

package/dist/api.js

@@ -61,6 +61,9 @@ var IKnowledgeSourceEnum;
     IKnowledgeSourceEnum["GithubFile"] = "github_file";
     IKnowledgeSourceEnum["UserInputText"] = "user_input_text";
     IKnowledgeSourceEnum["UserUploadFile"] = "user_upload_file";
+    IKnowledgeSourceEnum["Yuque"] = "yuque";
+    IKnowledgeSourceEnum["Youtube"] = "youtube";
+    IKnowledgeSourceEnum["Database"] = "database";
 })(IKnowledgeSourceEnum || (exports.IKnowledgeSourceEnum = IKnowledgeSourceEnum = {}));
 /** EmbeddingModelEnum */
 var IEmbeddingModelEnum;
@@ -295,6 +298,15 @@ class Api extends HttpClient {
              * @request POST:/api/retrieval/space
              */
             retrieveSpaceContent: (data, params = {}) => this.request(Object.assign({ path: `/api/retrieval/space`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id.
+             *
+             * @tags retrieval
+             * @name Retrieve
+             * @summary Retrieve
+             * @request POST:/api/retrieval/
+             */
+            retrieve: (data, params = {}) => this.request(Object.assign({ path: `/api/retrieval/`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
         };
         this.task = {
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@petercatai/whisker-client",
-    "version": "0.1.202504281028",
+    "version": "0.1.202504301149",
     "description": "Generated API client (Production)",
     "main": "dist/api.js",
     "types": "dist/api.d.ts",
@@ -16,7 +16,7 @@
         "tag": "latest"
     },
     "devDependencies": {
-        "@types/node": "^22.15.2",
+        "@types/node": "^22.15.3",
         "axios": "^1.9.0",
         "typescript": "^5.8.3"
     }