@petercatai/whisker-client 0.1.202505300705 → 0.1.202506111244-dev

package/dist/api.d.ts

@@ -21,20 +21,81 @@ export declare enum IResource {
     Rule = "rule",
     Public = "public"
 }
+/**
+ * Language
+ * Enum of the programming languages.
+ */
+export declare enum ILanguage {
+    Cpp = "cpp",
+    Go = "go",
+    Java = "java",
+    Kotlin = "kotlin",
+    Js = "js",
+    Ts = "ts",
+    Php = "php",
+    Proto = "proto",
+    Python = "python",
+    Rst = "rst",
+    Ruby = "ruby",
+    Rust = "rust",
+    Scala = "scala",
+    Swift = "swift",
+    Markdown = "markdown",
+    Latex = "latex",
+    Html = "html",
+    Sol = "sol",
+    Csharp = "csharp",
+    Cobol = "cobol",
+    C = "c",
+    Lua = "lua",
+    Perl = "perl",
+    Haskell = "haskell",
+    Elixir = "elixir",
+    Powershell = "powershell"
+}
 /**
  * KnowledgeTypeEnum
- * mime type of the knowledge. If multiple files are included and require a decomposer, please set the type to 'folder'
+ * mime type of the knowledge. The type is used to determine how to process the knowledge and
+ * is also used to determine the type of the knowledge resource.
+ * different types of knowledge will be processed differently and have different load、split configurations.
+ * For example, text will be processed by splitter, while code will be processed by language parser.
  */
 export declare enum IKnowledgeTypeEnum {
     Text = "text",
     Image = "image",
     Markdown = "markdown",
+    Latex = "latex",
     Json = "json",
     Docx = "docx",
     Pdf = "pdf",
     Qa = "qa",
     Yuquedoc = "yuquedoc",
-    Folder = "folder"
+    YuqueBook = "yuque_book",
+    GithubRepo = "github_repo",
+    Cpp = "cpp",
+    Go = "go",
+    Java = "java",
+    Kotlin = "kotlin",
+    Js = "js",
+    Ts = "ts",
+    Php = "php",
+    Proto = "proto",
+    Python = "python",
+    Rst = "rst",
+    Ruby = "ruby",
+    Rust = "rust",
+    Scala = "scala",
+    Swift = "swift",
+    Html = "html",
+    Sol = "sol",
+    Csharp = "csharp",
+    Cobol = "cobol",
+    C = "c",
+    Lua = "lua",
+    Perl = "perl",
+    Haskell = "haskell",
+    Elixir = "elixir",
+    Powershell = "powershell"
 }
 /**
  * KnowledgeSourceEnum
@@ -213,6 +274,33 @@ export interface IBaseCharSplitConfig {
      */
     split_regex?: string | null;
 }
+/**
+ * BaseCodeSplitConfig
+ * Code document split configuration
+ */
+export interface IBaseCodeSplitConfig {
+    /**
+     * Type
+     * @default "base_code"
+     */
+    type?: "base_code";
+    /** The programming language of the code. */
+    language: ILanguage;
+    /**
+     * Chunk Size
+     * chunk max size for code
+     * @min 1
+     * @default 1500
+     */
+    chunk_size?: number;
+    /**
+     * Chunk Overlap
+     * chunk overlap size for code, must be less than chunk_size
+     * @min 0
+     * @default 150
+     */
+    chunk_overlap?: number;
+}
 /** Chunk */
 export interface IChunk {
     /**
@@ -261,6 +349,36 @@ export interface IChunk {
      * Arbitrary metadata associated with the content.
      */
     metadata?: Record<string, any> | null;
+    /**
+     * Tags
+     * Tags from knowledge.metadata._tags
+     */
+    tags?: string[] | null;
+    /**
+     * F1
+     * Field 1 from knowledge.metadata._f1
+     */
+    f1?: string | null;
+    /**
+     * F2
+     * Field 2 from knowledge.metadata._f2
+     */
+    f2?: string | null;
+    /**
+     * F3
+     * Field 3 from knowledge.metadata._f3
+     */
+    f3?: string | null;
+    /**
+     * F4
+     * Field 4 from knowledge.metadata._f4
+     */
+    f4?: string | null;
+    /**
+     * F5
+     * Field 5 from knowledge.metadata._f5
+     */
+    f5?: string | null;
     /**
      * Gmt Create
      * creation time
@@ -327,6 +445,12 @@ export interface IGithubFileSourceConfig {
      * github repo url
      */
     repo_name: string;
+    /**
+     * Url
+     * remote origin of the repo, must start with http:// or https://
+     * @default "https://github.com"
+     */
+    url?: string;
     /**
      * Branch
      * branch name of the repo
@@ -358,9 +482,9 @@ export interface IGithubRepoCreate {
     /**
      * Knowledge Type
      * type of knowledge resource
-     * @default "folder"
+     * @default "github_repo"
      */
-    knowledge_type?: "folder";
+    knowledge_type?: "github_repo";
     /**
      * Knowledge Name
      * name of the knowledge resource
@@ -394,7 +518,51 @@ export interface IGithubRepoCreate {
     /** source config of the knowledge */
     source_config: IGithubRepoSourceConfig;
     /** split config of the knowledge */
-    split_config: IBaseCharSplitConfig;
+    split_config: IGithubRepoParseConfig;
+}
+/** GithubRepoParseConfig */
+export interface IGithubRepoParseConfig {
+    /**
+     * Chunk Size
+     * chunk max size
+     * @min 1
+     * @default 1500
+     */
+    chunk_size?: number;
+    /**
+     * Chunk Overlap
+     * chunk overlap size, must be less than chunk_size
+     * @min 0
+     * @default 150
+     */
+    chunk_overlap?: number;
+    /**
+     * Type
+     * @default "github_repo"
+     */
+    type?: "github_repo";
+    /**
+     * Include Patterns
+     * List of include patterns (comma-separated) to filter files in the repo.Only files matching these patterns will be included, unless excluded by ignore_patterns or .gitignore. Lower priority than ignore_patterns and .gitignore.
+     */
+    include_patterns?: string[] | null;
+    /**
+     * Ignore Patterns
+     * Additional ignore patterns (comma-separated) to exclude files in the repo. Highest priority, overrides include_patterns and .gitignore.
+     */
+    ignore_patterns?: string[] | null;
+    /**
+     * Use Gitignore
+     * Whether to respect .gitignore rules when filtering files. Priority is lower than ignore_patterns, higher than include_patterns.
+     * @default true
+     */
+    use_gitignore?: boolean | null;
+    /**
+     * Use Default Ignore
+     * Whether to use default ignore patterns (e.g. .git/*, *.pyc, etc). Lowest priority.
+     * @default true
+     */
+    use_default_ignore?: boolean | null;
 }
 /** GithubRepoSourceConfig */
 export interface IGithubRepoSourceConfig {
@@ -403,6 +571,12 @@ export interface IGithubRepoSourceConfig {
      * github repo url
      */
     repo_name: string;
+    /**
+     * Url
+     * remote origin of the repo, must start with http:// or https://
+     * @default "https://github.com"
+     */
+    url?: string;
     /**
      * Branch
      * branch name of the repo
@@ -620,7 +794,7 @@ export interface IKnowledgeInput {
      * Split Config
      * configuration for splitting the knowledge
      */
-    split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig;
+    split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig;
     /**
      * File Sha
      * SHA of the file
@@ -706,7 +880,7 @@ export interface IKnowledgeOutput {
      * Split Config
      * configuration for splitting the knowledge
      */
-    split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig;
+    split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig;
     /**
      * File Sha
      * SHA of the file
@@ -721,7 +895,7 @@ export interface IKnowledgeOutput {
      * Metadata
      * additional metadata, user can update it
      */
-    metadata?: Record<string, any> | null;
+    metadata?: Record<string, any>;
     /**
      * Retrieval Count
      * count of the retrieval
@@ -1538,6 +1712,36 @@ export interface IRetrievalChunk {
      * Arbitrary metadata associated with the content.
      */
     metadata?: Record<string, any> | null;
+    /**
+     * Tags
+     * Tags from knowledge.metadata._tags
+     */
+    tags?: string[] | null;
+    /**
+     * F1
+     * Field 1 from knowledge.metadata._f1
+     */
+    f1?: string | null;
+    /**
+     * F2
+     * Field 2 from knowledge.metadata._f2
+     */
+    f2?: string | null;
+    /**
+     * F3
+     * Field 3 from knowledge.metadata._f3
+     */
+    f3?: string | null;
+    /**
+     * F4
+     * Field 4 from knowledge.metadata._f4
+     */
+    f4?: string | null;
+    /**
+     * F5
+     * Field 5 from knowledge.metadata._f5
+     */
+    f5?: string | null;
     /**
      * Gmt Create
      * creation time
@@ -1999,7 +2203,7 @@ export interface IYuqueCreate {
      * type of knowledge resource
      * @default "yuquedoc"
      */
-    knowledge_type?: "yuquedoc" | "folder";
+    knowledge_type?: "yuquedoc" | "github_repo";
     /**
      * Knowledge Name
      * name of the knowledge resource
@@ -2137,6 +2341,7 @@ export interface HttpResponse<D extends unknown, E extends unknown = unknown> ex
 type CancelToken = Symbol | string | number;
 export declare enum ContentType {
     Json = "application/json",
+    JsonApi = "application/vnd.api+json",
     FormData = "multipart/form-data",
     UrlEncoded = "application/x-www-form-urlencoded",
     Text = "text/plain"
@@ -2163,7 +2368,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title whisker rag server
- * @version 1.0.5
+ * @version 1.0.6
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
     /**

package/dist/api.js

@@ -22,7 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Api = exports.HttpClient = exports.ContentType = exports.IAction = exports.IEmbeddingModelEnum = exports.IKnowledgeSourceEnum = exports.IKnowledgeTypeEnum = exports.IResource = exports.ITaskStatus = void 0;
+exports.Api = exports.HttpClient = exports.ContentType = exports.IAction = exports.IEmbeddingModelEnum = exports.IKnowledgeSourceEnum = exports.IKnowledgeTypeEnum = exports.ILanguage = exports.IResource = exports.ITaskStatus = void 0;
 /** TaskStatus */
 var ITaskStatus;
 (function (ITaskStatus) {
@@ -48,21 +48,83 @@ var IResource;
     IResource["Rule"] = "rule";
     IResource["Public"] = "public";
 })(IResource || (exports.IResource = IResource = {}));
+/**
+ * Language
+ * Enum of the programming languages.
+ */
+var ILanguage;
+(function (ILanguage) {
+    ILanguage["Cpp"] = "cpp";
+    ILanguage["Go"] = "go";
+    ILanguage["Java"] = "java";
+    ILanguage["Kotlin"] = "kotlin";
+    ILanguage["Js"] = "js";
+    ILanguage["Ts"] = "ts";
+    ILanguage["Php"] = "php";
+    ILanguage["Proto"] = "proto";
+    ILanguage["Python"] = "python";
+    ILanguage["Rst"] = "rst";
+    ILanguage["Ruby"] = "ruby";
+    ILanguage["Rust"] = "rust";
+    ILanguage["Scala"] = "scala";
+    ILanguage["Swift"] = "swift";
+    ILanguage["Markdown"] = "markdown";
+    ILanguage["Latex"] = "latex";
+    ILanguage["Html"] = "html";
+    ILanguage["Sol"] = "sol";
+    ILanguage["Csharp"] = "csharp";
+    ILanguage["Cobol"] = "cobol";
+    ILanguage["C"] = "c";
+    ILanguage["Lua"] = "lua";
+    ILanguage["Perl"] = "perl";
+    ILanguage["Haskell"] = "haskell";
+    ILanguage["Elixir"] = "elixir";
+    ILanguage["Powershell"] = "powershell";
+})(ILanguage || (exports.ILanguage = ILanguage = {}));
 /**
  * KnowledgeTypeEnum
- * mime type of the knowledge. If multiple files are included and require a decomposer, please set the type to 'folder'
+ * mime type of the knowledge. The type is used to determine how to process the knowledge and
+ * is also used to determine the type of the knowledge resource.
+ * different types of knowledge will be processed differently and have different load、split configurations.
+ * For example, text will be processed by splitter, while code will be processed by language parser.
  */
 var IKnowledgeTypeEnum;
 (function (IKnowledgeTypeEnum) {
     IKnowledgeTypeEnum["Text"] = "text";
     IKnowledgeTypeEnum["Image"] = "image";
     IKnowledgeTypeEnum["Markdown"] = "markdown";
+    IKnowledgeTypeEnum["Latex"] = "latex";
     IKnowledgeTypeEnum["Json"] = "json";
     IKnowledgeTypeEnum["Docx"] = "docx";
     IKnowledgeTypeEnum["Pdf"] = "pdf";
     IKnowledgeTypeEnum["Qa"] = "qa";
     IKnowledgeTypeEnum["Yuquedoc"] = "yuquedoc";
-    IKnowledgeTypeEnum["Folder"] = "folder";
+    IKnowledgeTypeEnum["YuqueBook"] = "yuque_book";
+    IKnowledgeTypeEnum["GithubRepo"] = "github_repo";
+    IKnowledgeTypeEnum["Cpp"] = "cpp";
+    IKnowledgeTypeEnum["Go"] = "go";
+    IKnowledgeTypeEnum["Java"] = "java";
+    IKnowledgeTypeEnum["Kotlin"] = "kotlin";
+    IKnowledgeTypeEnum["Js"] = "js";
+    IKnowledgeTypeEnum["Ts"] = "ts";
+    IKnowledgeTypeEnum["Php"] = "php";
+    IKnowledgeTypeEnum["Proto"] = "proto";
+    IKnowledgeTypeEnum["Python"] = "python";
+    IKnowledgeTypeEnum["Rst"] = "rst";
+    IKnowledgeTypeEnum["Ruby"] = "ruby";
+    IKnowledgeTypeEnum["Rust"] = "rust";
+    IKnowledgeTypeEnum["Scala"] = "scala";
+    IKnowledgeTypeEnum["Swift"] = "swift";
+    IKnowledgeTypeEnum["Html"] = "html";
+    IKnowledgeTypeEnum["Sol"] = "sol";
+    IKnowledgeTypeEnum["Csharp"] = "csharp";
+    IKnowledgeTypeEnum["Cobol"] = "cobol";
+    IKnowledgeTypeEnum["C"] = "c";
+    IKnowledgeTypeEnum["Lua"] = "lua";
+    IKnowledgeTypeEnum["Perl"] = "perl";
+    IKnowledgeTypeEnum["Haskell"] = "haskell";
+    IKnowledgeTypeEnum["Elixir"] = "elixir";
+    IKnowledgeTypeEnum["Powershell"] = "powershell";
 })(IKnowledgeTypeEnum || (exports.IKnowledgeTypeEnum = IKnowledgeTypeEnum = {}));
 /**
  * KnowledgeSourceEnum
@@ -98,6 +160,7 @@ var IAction;
 var ContentType;
 (function (ContentType) {
     ContentType["Json"] = "application/json";
+    ContentType["JsonApi"] = "application/vnd.api+json";
     ContentType["FormData"] = "multipart/form-data";
     ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
     ContentType["Text"] = "text/plain";
@@ -121,6 +184,9 @@ class HttpClient {
             [ContentType.Json]: (input) => input !== null && (typeof input === "object" || typeof input === "string")
                 ? JSON.stringify(input)
                 : input,
+            [ContentType.JsonApi]: (input) => input !== null && (typeof input === "object" || typeof input === "string")
+                ? JSON.stringify(input)
+                : input,
             [ContentType.Text]: (input) => input !== null && typeof input !== "string"
                 ? JSON.stringify(input)
                 : input,
@@ -231,7 +297,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title whisker rag server
- * @version 1.0.5
+ * @version 1.0.6
  */
 class Api extends HttpClient {
     constructor() {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@petercatai/whisker-client",
-    "version": "0.1.202505300705",
-    "description": "Generated API client (Production)",
+    "version": "0.1.202506111244-dev",
+    "description": "Generated API client (preview)",
     "main": "dist/api.js",
     "types": "dist/api.d.ts",
     "files": [
@@ -13,10 +13,10 @@
     },
     "publishConfig": {
         "access": "public",
-        "tag": "latest"
+        "tag": "dev"
     },
     "devDependencies": {
-        "@types/node": "^22.15.27",
+        "@types/node": "^24.0.0",
         "axios": "^1.9.0",
         "typescript": "^5.8.3"
     }