@petercatai/whisker-client 0.1.202505131519 → 0.1.202505141300

package/dist/api.d.ts

@@ -10,7 +10,7 @@ export declare enum ITaskStatus {
 }
 /**
  * KnowledgeTypeEnum
- * mime type of the knowledge
+ * mime type of the knowledge. If multiple files are included and require a decomposer, please set the type to 'folder'
  */
 export declare enum IKnowledgeTypeEnum {
     Text = "text",
@@ -31,10 +31,9 @@ export declare enum IKnowledgeSourceEnum {
     GithubRepo = "github_repo",
     GithubFile = "github_file",
     UserInputText = "user_input_text",
-    UserUploadFile = "user_upload_file",
-    Yuque = "yuque",
-    Youtube = "youtube",
-    Database = "database"
+    CloudStorageText = "cloud_storage_text",
+    CloudStorageImage = "cloud_storage_image",
+    Yuque = "yuque"
 }
 /** EmbeddingModelEnum */
 export declare enum IEmbeddingModelEnum {
@@ -46,7 +45,7 @@ export declare enum IEmbeddingModelEnum {
 }
 /**
  * BaseCharSplitConfig
- * Base split configuration class
+ * Base char split configuration class
  */
 export interface IBaseCharSplitConfig {
     /**
@@ -297,8 +296,12 @@ export interface IImageCreate {
      * @default {}
      */
     metadata?: Record<string, any>;
-    /** source type */
-    source_type: IKnowledgeSourceEnum;
+    /**
+     * Source Type
+     * source type
+     * @default "cloud_storage_image"
+     */
+    source_type?: "cloud_storage_image";
     /**
      * Embedding Model Name
      * name of the embedding model. you can set any other model if target embedding service registered
@@ -320,6 +323,15 @@ export interface IImageCreate {
      * source config of the knowledge
      */
     source_config: IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
+    split_config: IImageSplitConfig;
+}
+/** ImageSplitConfig */
+export interface IImageSplitConfig {
+    /**
+     * Type
+     * @default "image"
+     */
+    type?: "image";
 }
 /** JSONCreate */
 export interface IJSONCreate {
@@ -575,87 +587,6 @@ export interface IKnowledgeOutput {
      */
     gmt_modified?: string;
 }
-/**
- * KnowledgeCreate
- * KnowledgeCreate model for creating knowledge resources.
- * Attributes:
- *     knowledge_type (ResourceType): Type of knowledge resource.
- *     space_id (str): Space ID, example: petercat bot ID.
- *     knowledge_name (str): Name of the knowledge resource.
- *     file_sha (Optional[str]): SHA of the file.
- *     file_size (Optional[int]): Size of the file.
- *     split_config (Optional[dict]): Configuration for splitting the knowledge.
- *     source_data (Optional[str]): Source data of the knowledge.
- *     auth_info (Optional[str]): Authentication information.
- *     embedding_model_name (Optional[str]): Name of the embedding model.
- *     metadata (Optional[dict]): Additional metadata.
- */
-export interface IKnowledgeCreate {
-    /**
-     * Space Id
-     * the space of knowledge, example: petercat bot id, github repo name
-     */
-    space_id: string;
-    /**
-     * type of knowledge resource
-     * @default "text"
-     */
-    knowledge_type?: IKnowledgeTypeEnum;
-    /**
-     * Knowledge Name
-     * name of the knowledge resource
-     * @maxLength 255
-     */
-    knowledge_name: string;
-    /**
-     * source type
-     * @default "user_input_text"
-     */
-    source_type?: IKnowledgeSourceEnum;
-    /**
-     * Source Config
-     * source config of the knowledge
-     */
-    source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig | IYuqueSourceConfig;
-    /**
-     * Embedding Model Name
-     * name of the embedding model. you can set any other model if target embedding service registered
-     * @default "openai"
-     */
-    embedding_model_name?: IEmbeddingModelEnum | string;
-    /**
-     * Split Config
-     * configuration for splitting the knowledge
-     */
-    split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig;
-    /**
-     * File Sha
-     * SHA of the file
-     */
-    file_sha?: string | null;
-    /**
-     * File Size
-     * size of the file
-     */
-    file_size?: number | null;
-    /**
-     * Metadata
-     * additional metadata, user can update it
-     * @default {}
-     */
-    metadata?: Record<string, any>;
-    /**
-     * Parent Id
-     * parent knowledge id
-     */
-    parent_id?: string | null;
-    /**
-     * Enabled
-     * is knowledge enabled
-     * @default true
-     */
-    enabled?: boolean;
-}
 /** MarkdownCreate */
 export interface IMarkdownCreate {
     /**
@@ -723,21 +654,33 @@ export interface IMarkdownSplitConfig {
      * @default 150
      */
     chunk_overlap?: number;
+    /**
+     * Type
+     * @default "markdown"
+     */
+    type?: "markdown";
     /**
      * Separators
-     * separator list, if None, use default separators
+     * List of separators to split the text. If None, uses default separators
      */
-    separators?: string[] | null;
+    separators: string[];
     /**
-     * Split Regex
-     * split_regex,if set, use it instead of separators
+     * Is Separator Regex
+     * If true, the separators should be in regular expression format.
      */
-    split_regex?: string | null;
+    is_separator_regex: boolean;
     /**
-     * Type
-     * @default "markdown"
+     * Keep Separator
+     * Whether to keep the separator and where to place it in each corresponding chunk (True='start')
+     * @default false
      */
-    type?: "markdown";
+    keep_separator?: boolean | "start" | "end" | null;
+    /**
+     * Extract Header First
+     * If true, will split markdown by header first
+     * @default false
+     */
+    extract_header_first?: boolean | null;
 }
 /** OpenIdSourceConfig */
 export interface IOpenIdSourceConfig {
@@ -825,33 +768,11 @@ export interface IPDFSplitConfig {
      * @default 150
      */
     chunk_overlap?: number;
-    /**
-     * Separators
-     * separator list, if None, use default separators
-     */
-    separators?: string[] | null;
-    /**
-     * Split Regex
-     * split_regex,if set, use it instead of separators
-     */
-    split_regex?: string | null;
     /**
      * Type
      * @default "pdf"
      */
     type?: "pdf";
-    /**
-     * Split By Page
-     * Whether to split by pages
-     * @default false
-     */
-    split_by_page?: boolean;
-    /**
-     * Keep Layout
-     * Whether to preserve the original layout
-     * @default true
-     */
-    keep_layout?: boolean;
     /**
      * Extract Images
      * Whether to extract images
@@ -1078,8 +999,12 @@ export interface IQACreate {
      * @default {}
      */
     metadata?: Record<string, any>;
-    /** source type */
-    source_type: IKnowledgeSourceEnum;
+    /**
+     * Source Type
+     * source type
+     * @default "user_input_text"
+     */
+    source_type?: "user_input_text";
     /**
      * Embedding Model Name
      * name of the embedding model. you can set any other model if target embedding service registered
@@ -1880,9 +1805,8 @@ export interface ITextSplitConfig {
     /**
      * Separators
      * List of separators to split the text. If None, uses default separators
-     * @default ["\n","\n\n","\r"]
      */
-    separators?: string[];
+    separators: string[];
     /**
      * Split Regex
      * split_regex,if set, use it instead of separators
@@ -1893,18 +1817,17 @@ export interface ITextSplitConfig {
      * @default "text"
      */
     type?: "text";
+    /**
+     * Is Separator Regex
+     * If true, the separators should be in regular expression format.
+     */
+    is_separator_regex: boolean;
     /**
      * Keep Separator
      * Whether to keep the separator and where to place it in each corresponding chunk (True='start')
      * @default false
      */
     keep_separator?: boolean | "start" | "end" | null;
-    /**
-     * Strip Whitespace
-     * If `True`, strips whitespace from the start and end of every document
-     * @default false
-     */
-    strip_whitespace?: boolean | null;
 }
 /** ValidationError */
 export interface IValidationError {
@@ -1915,6 +1838,61 @@ export interface IValidationError {
     /** Error Type */
     type: string;
 }
+/** YuqueCreate */
+export interface IYuqueCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "yuquedoc"
+     */
+    knowledge_type?: "yuquedoc" | "folder";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Source Type
+     * source type
+     * @default "yuque"
+     */
+    source_type?: "yuque";
+    /**
+     * Embedding Model Name
+     * name of the embedding model. you can set any other model if target embedding service registered
+     * @default "openai"
+     */
+    embedding_model_name?: IEmbeddingModelEnum | string;
+    /**
+     * File Sha
+     * SHA of the file
+     */
+    file_sha?: string | null;
+    /**
+     * File Size
+     * size of the file
+     */
+    file_size?: number | null;
+    /** source config of the knowledge */
+    source_config: IYuqueSourceConfig;
+    /**
+     * Split Config
+     * split config of the knowledge
+     */
+    split_config: IGeaGraphSplitConfig | IBaseCharSplitConfig;
+}
 /** YuqueSourceConfig */
 export interface IYuqueSourceConfig {
     /**
@@ -1924,20 +1902,20 @@ export interface IYuqueSourceConfig {
      */
     api_url?: string;
     /**
-     * Group Id
+     * Group Login
      * the yuque group id
      */
-    group_id: number;
+    group_login: string;
     /**
-     * Book Id
+     * Book Slug
      * the yuque book id, if not set, will use the group all book
      */
-    book_id?: number | null;
+    book_slug?: string | null;
     /**
      * Document Id
-     * the yuque document id in book, if not set, will use the book id as document id
+     * the yuque document id in book, if not set, will use the book all doc
      */
-    document_id?: number | null;
+    document_id?: string | number | null;
     /**
      * Auth Info
      * authentication information
@@ -2024,7 +2002,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @summary Add Knowledge
          * @request POST:/api/knowledge/add
          */
-        addKnowledge: (data: (IKnowledgeCreate | ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
+        addKnowledge: (data: (ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate | IYuqueCreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
         /**
          * No description
          *

package/dist/api.js

@@ -36,7 +36,7 @@ var ITaskStatus;
 })(ITaskStatus || (exports.ITaskStatus = ITaskStatus = {}));
 /**
  * KnowledgeTypeEnum
- * mime type of the knowledge
+ * mime type of the knowledge. If multiple files are included and require a decomposer, please set the type to 'folder'
  */
 var IKnowledgeTypeEnum;
 (function (IKnowledgeTypeEnum) {
@@ -59,10 +59,9 @@ var IKnowledgeSourceEnum;
     IKnowledgeSourceEnum["GithubRepo"] = "github_repo";
     IKnowledgeSourceEnum["GithubFile"] = "github_file";
     IKnowledgeSourceEnum["UserInputText"] = "user_input_text";
-    IKnowledgeSourceEnum["UserUploadFile"] = "user_upload_file";
+    IKnowledgeSourceEnum["CloudStorageText"] = "cloud_storage_text";
+    IKnowledgeSourceEnum["CloudStorageImage"] = "cloud_storage_image";
     IKnowledgeSourceEnum["Yuque"] = "yuque";
-    IKnowledgeSourceEnum["Youtube"] = "youtube";
-    IKnowledgeSourceEnum["Database"] = "database";
 })(IKnowledgeSourceEnum || (exports.IKnowledgeSourceEnum = IKnowledgeSourceEnum = {}));
 /** EmbeddingModelEnum */
 var IEmbeddingModelEnum;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@petercatai/whisker-client",
-    "version": "0.1.202505131519",
+    "version": "0.1.202505141300",
     "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.17",
+        "@types/node": "^22.15.18",
         "axios": "^1.9.0",
         "typescript": "^5.8.3"
     }