@petercatai/whisker-client 0.1.202504091941-dev

package/dist/api.d.ts

@@ -0,0 +1,1577 @@
+/**
+ * BaseCharSplitConfig
+ * Base split configuration class
+ */
+export interface IBaseCharSplitConfig {
+    /**
+     * Chunk Size
+     * @min 1
+     * @exclusiveMax 5000
+     * @default 1500
+     */
+    chunk_size?: number;
+    /**
+     * Chunk Overlap
+     * @min 0
+     * @default 150
+     */
+    chunk_overlap?: number;
+}
+/** Chunk */
+export interface IChunk {
+    /**
+     * Chunk Id
+     * chunk id
+     */
+    chunk_id?: string;
+    /**
+     * Space Id
+     * space id
+     */
+    space_id: string;
+    /**
+     * Tenant Id
+     * tenant id
+     */
+    tenant_id: string;
+    /**
+     * Embedding
+     * chunk embedding
+     */
+    embedding?: number[] | null;
+    /**
+     * Context
+     * chunk content
+     */
+    context: string;
+    /**
+     * Knowledge Id
+     * file source info
+     */
+    knowledge_id: string;
+    /**
+     * Embedding Model Name
+     * name of the embedding model
+     */
+    embedding_model_name?: string;
+    /**
+     * Metadata
+     * Arbitrary metadata associated with the content.
+     */
+    metadata?: object | null;
+    /**
+     * Gmt Create
+     * creation time
+     */
+    gmt_create?: string;
+    /**
+     * Gmt Modified
+     * update time
+     */
+    gmt_modified?: string;
+}
+/** EmbeddingModelEnum */
+export declare enum IEmbeddingModelEnum {
+    Openai = "openai",
+    SentenceTransformersAllMiniLML6V2 = "sentence-transformers/all-MiniLM-L6-v2",
+    SentenceTransformersAllMpnetBaseV2 = "sentence-transformers/all-mpnet-base-v2",
+    SentenceTransformersParaphraseMultilingualMiniLML12V2 = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+    Shibing624Text2VecBaseChinese = "shibing624/text2vec-base-chinese"
+}
+/** GithubFileSourceConfig */
+export interface IGithubFileSourceConfig {
+    /**
+     * Repo Name
+     * github repo url
+     */
+    repo_name: string;
+    /**
+     * Branch
+     * branch name of the repo
+     */
+    branch?: string | null;
+    /**
+     * Commit Id
+     * commit id of the repo
+     */
+    commit_id?: string | null;
+    /**
+     * Auth Info
+     * authentication information
+     */
+    auth_info?: string | null;
+    /**
+     * Path
+     * path of the file in the repo
+     */
+    path: string;
+}
+/** GithubRepoCreate */
+export interface IGithubRepoCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "folder"
+     */
+    knowledge_type?: "folder";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: object;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * 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: IGithubRepoSourceConfig;
+    /** split config of the knowledge */
+    split_config: IBaseCharSplitConfig;
+}
+/** GithubRepoSourceConfig */
+export interface IGithubRepoSourceConfig {
+    /**
+     * Repo Name
+     * github repo url
+     */
+    repo_name: string;
+    /**
+     * Branch
+     * branch name of the repo
+     */
+    branch?: string | null;
+    /**
+     * Commit Id
+     * commit id of the repo
+     */
+    commit_id?: string | null;
+    /**
+     * Auth Info
+     * authentication information
+     */
+    auth_info?: string | null;
+}
+/** HTTPValidationError */
+export interface IHTTPValidationError {
+    /** Detail */
+    detail?: IValidationError[];
+}
+/** ImageCreate */
+export interface IImageCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "image"
+     */
+    knowledge_type?: "image";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: object;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * 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;
+    /**
+     * File Size
+     * Byte size of the file
+     */
+    file_size: number;
+    /**
+     * Source Config
+     * source config of the knowledge
+     */
+    source_config: IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
+}
+/** JSONCreate */
+export interface IJSONCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "json"
+     */
+    knowledge_type?: "json";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: object;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * 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
+     * source config of the knowledge
+     */
+    source_config: ITextSourceConfig | IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
+    /** split config of the knowledge */
+    split_config: IJSONSplitConfig;
+}
+/**
+ * JSONSplitConfig
+ * JSON document split configuration
+ */
+export interface IJSONSplitConfig {
+    /**
+     * Chunk Size
+     * @min 1
+     * @exclusiveMax 5000
+     * @default 1500
+     */
+    chunk_size?: number;
+    /**
+     * Chunk Overlap
+     * @min 0
+     * @default 150
+     */
+    chunk_overlap?: number;
+    /**
+     * Split Level
+     * Depth level for JSON splitting
+     * @min 1
+     * @default 1
+     */
+    split_level?: number;
+    /**
+     * Preserve Structure
+     * Whether to preserve JSON structure
+     * @default true
+     */
+    preserve_structure?: boolean;
+    /**
+     * Array Handling
+     * Array handling mode: 'split' or 'merge'
+     * @default "split"
+     */
+    array_handling?: string;
+    /**
+     * Key Filters
+     * List of keys to process; processes all keys if None
+     */
+    key_filters?: string[] | null;
+}
+/** Knowledge */
+export interface IKnowledge {
+    /**
+     * Knowledge Id
+     * knowledge id
+     */
+    knowledge_id?: string;
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Tenant Id
+     * tenant id
+     */
+    tenant_id: string;
+    /** type of knowledge resource */
+    knowledge_type?: string;
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /** source type */
+    source_type?: string;
+    /**
+     * Source Config
+     * source config of the knowledge
+     */
+    source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig;
+    /**
+     * Embedding Model Name
+     * name of the embedding model. you can set any other model if target embedding service registered
+     */
+    embedding_model_name?: string;
+    /**
+     * Split Config
+     * configuration for splitting the knowledge
+     */
+    split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | IPDFSplitConfig | ITextSplitConfig | IJSONSplitConfig;
+    /**
+     * 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
+     */
+    metadata?: object | null;
+    /**
+     * Parent Id
+     * parent knowledge id
+     */
+    parent_id?: string | null;
+    /**
+     * Enabled
+     * is knowledge enabled
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Gmt Create
+     * creation time
+     */
+    gmt_create?: string;
+    /**
+     * Gmt Modified
+     * update time
+     */
+    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 | ITextSourceConfig;
+    /**
+     * 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 | IPDFSplitConfig | ITextSplitConfig | IJSONSplitConfig;
+    /**
+     * 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?: object;
+    /**
+     * Parent Id
+     * parent knowledge id
+     */
+    parent_id?: string | null;
+    /**
+     * Enabled
+     * is knowledge enabled
+     * @default true
+     */
+    enabled?: boolean;
+}
+/** KnowledgeSourceEnum */
+export declare enum IKnowledgeSourceEnum {
+    GithubRepo = "github_repo",
+    GithubFile = "github_file",
+    UserInputText = "user_input_text",
+    UserUploadFile = "user_upload_file"
+}
+/**
+ * KnowledgeTypeEnum
+ * mime type of the knowledge
+ */
+export declare enum IKnowledgeTypeEnum {
+    Text = "text",
+    Image = "image",
+    Markdown = "markdown",
+    Json = "json",
+    Docx = "docx",
+    Pdf = "pdf",
+    Qa = "qa",
+    Folder = "folder"
+}
+/** MarkdownCreate */
+export interface IMarkdownCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "markdown"
+     */
+    knowledge_type?: "markdown";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: object;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * 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
+     * source config of the knowledge
+     */
+    source_config: ITextSourceConfig | IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
+    /** split config of the knowledge */
+    split_config: IMarkdownSplitConfig;
+}
+/**
+ * MarkdownSplitConfig
+ * Markdown document split configuration
+ */
+export interface IMarkdownSplitConfig {
+    /**
+     * Chunk Size
+     * @min 1
+     * @exclusiveMax 5000
+     * @default 1500
+     */
+    chunk_size?: number;
+    /**
+     * Chunk Overlap
+     * @min 0
+     * @default 150
+     */
+    chunk_overlap?: number;
+    /**
+     * Separators
+     * separator list
+     */
+    separators: string[] | null;
+    /**
+     * Split Regex
+     * split_regex
+     */
+    split_regex: string | null;
+}
+/** OpenIdSourceConfig */
+export interface IOpenIdSourceConfig {
+    /**
+     * Id
+     * cloud storage file id, used for afts
+     */
+    id: string;
+}
+/** OpenUrlSourceConfig */
+export interface IOpenUrlSourceConfig {
+    /**
+     * Url
+     * cloud storage url, such as oss, cos, etc.
+     */
+    url: string;
+}
+/** PDFCreate */
+export interface IPDFCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "pdf"
+     */
+    knowledge_type?: "pdf";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: object;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * 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;
+    /**
+     * File Size
+     * Byte size of the file
+     */
+    file_size: number;
+    /**
+     * Source Config
+     * source config of the knowledge
+     */
+    source_config: IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
+    /** split config of the knowledge */
+    split_config: IPDFSplitConfig;
+}
+/**
+ * PDFSplitConfig
+ * PDF document split configuration
+ */
+export interface IPDFSplitConfig {
+    /**
+     * Chunk Size
+     * @min 1
+     * @exclusiveMax 5000
+     * @default 1500
+     */
+    chunk_size?: number;
+    /**
+     * Chunk Overlap
+     * @min 0
+     * @default 150
+     */
+    chunk_overlap?: number;
+    /**
+     * 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
+     * @default false
+     */
+    extract_images?: boolean;
+    /**
+     * Table Extract Mode
+     * Table extraction mode: 'text' or 'structure'
+     * @default "text"
+     */
+    table_extract_mode?: string;
+}
+/** PageParams[Chunk] */
+export interface IPageParamsChunk {
+    /**
+     * Page
+     * page number
+     * @min 1
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Page Size
+     * page size
+     * @min 1
+     * @max 1000
+     * @default 10
+     */
+    page_size?: number;
+    /**
+     * Order By
+     * order by field
+     */
+    order_by?: string | null;
+    /**
+     * Order Direction
+     * asc or desc
+     * @default "asc"
+     */
+    order_direction?: string | null;
+    /**
+     * Eq Conditions
+     * list of equality conditions, each as a dict with key and value
+     */
+    eq_conditions?: object | null;
+}
+/** PageParams[Knowledge] */
+export interface IPageParamsKnowledge {
+    /**
+     * Page
+     * page number
+     * @min 1
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Page Size
+     * page size
+     * @min 1
+     * @max 1000
+     * @default 10
+     */
+    page_size?: number;
+    /**
+     * Order By
+     * order by field
+     */
+    order_by?: string | null;
+    /**
+     * Order Direction
+     * asc or desc
+     * @default "asc"
+     */
+    order_direction?: string | null;
+    /**
+     * Eq Conditions
+     * list of equality conditions, each as a dict with key and value
+     */
+    eq_conditions?: object | null;
+}
+/** PageParams[Task] */
+export interface IPageParamsTask {
+    /**
+     * Page
+     * page number
+     * @min 1
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Page Size
+     * page size
+     * @min 1
+     * @max 1000
+     * @default 10
+     */
+    page_size?: number;
+    /**
+     * Order By
+     * order by field
+     */
+    order_by?: string | null;
+    /**
+     * Order Direction
+     * asc or desc
+     * @default "asc"
+     */
+    order_direction?: string | null;
+    /**
+     * Eq Conditions
+     * list of equality conditions, each as a dict with key and value
+     */
+    eq_conditions?: object | null;
+}
+/** PageResponse[Chunk] */
+export interface IPageResponseChunk {
+    /** Items */
+    items: IChunk[];
+    /** Total */
+    total: number;
+    /** Page */
+    page: number;
+    /** Page Size */
+    page_size: number;
+    /** Total Pages */
+    total_pages: number;
+}
+/** PageResponse[Knowledge] */
+export interface IPageResponseKnowledge {
+    /** Items */
+    items: IKnowledge[];
+    /** Total */
+    total: number;
+    /** Page */
+    page: number;
+    /** Page Size */
+    page_size: number;
+    /** Total Pages */
+    total_pages: number;
+}
+/** PageResponse[Task] */
+export interface IPageResponseTask {
+    /** Items */
+    items: ITask[];
+    /** Total */
+    total: number;
+    /** Page */
+    page: number;
+    /** Page Size */
+    page_size: number;
+    /** Total Pages */
+    total_pages: number;
+}
+/** QACreate */
+export interface IQACreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "qa"
+     */
+    knowledge_type?: "qa";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: object;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * 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;
+    /**
+     * Question
+     * question of the knowledge resource
+     */
+    question: string;
+    /**
+     * Answer
+     * answer of the knowledge resource
+     */
+    answer: string;
+    /** split config of the knowledge */
+    split_config: ITextSplitConfig;
+    /** source config of the knowledge */
+    source_config?: ITextSourceConfig | null;
+}
+/** ResponseModel */
+export interface IResponseModel {
+    /** Success */
+    success: boolean;
+    /** Data */
+    data?: null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[Knowledge] */
+export interface IResponseModelKnowledge {
+    /** Success */
+    success: boolean;
+    data?: IKnowledge | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[List[Knowledge]] */
+export interface IResponseModelListKnowledge {
+    /** Success */
+    success: boolean;
+    /** Data */
+    data?: IKnowledge[] | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[List[RetrievalChunk]] */
+export interface IResponseModelListRetrievalChunk {
+    /** Success */
+    success: boolean;
+    /** Data */
+    data?: IRetrievalChunk[] | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[List[Task]] */
+export interface IResponseModelListTask {
+    /** Success */
+    success: boolean;
+    /** Data */
+    data?: ITask[] | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[NoneType] */
+export interface IResponseModelNoneType {
+    /** Success */
+    success: boolean;
+    /** Data */
+    data?: null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[PageResponse[Chunk]] */
+export interface IResponseModelPageResponseChunk {
+    /** Success */
+    success: boolean;
+    data?: IPageResponseChunk | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[PageResponse[Knowledge]] */
+export interface IResponseModelPageResponseKnowledge {
+    /** Success */
+    success: boolean;
+    data?: IPageResponseKnowledge | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[PageResponse[Task]] */
+export interface IResponseModelPageResponseTask {
+    /** Success */
+    success: boolean;
+    data?: IPageResponseTask | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[Task] */
+export interface IResponseModelTask {
+    /** Success */
+    success: boolean;
+    data?: ITask | null;
+    /** Message */
+    message?: string | null;
+}
+/** ResponseModel[Tenant] */
+export interface IResponseModelTenant {
+    /** Success */
+    success: boolean;
+    data?: ITenant | null;
+    /** Message */
+    message?: string | null;
+}
+/** RetrievalByKnowledgeRequest */
+export interface IRetrievalByKnowledgeRequest {
+    /**
+     * Question
+     * The query question
+     */
+    question: string;
+    /** The name of the embedding model */
+    embedding_model_name: IEmbeddingModelEnum;
+    /**
+     * 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?: object;
+    /**
+     * Knowledge Id List
+     * knowledge id list
+     */
+    knowledge_id_list: string[];
+}
+/** RetrievalBySpaceRequest */
+export interface IRetrievalBySpaceRequest {
+    /**
+     * Question
+     * The query question
+     */
+    question: string;
+    /** The name of the embedding model */
+    embedding_model_name: IEmbeddingModelEnum;
+    /**
+     * 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?: object;
+    /**
+     * Space Id List
+     * space id list
+     */
+    space_id_list: string[];
+}
+/** RetrievalChunk */
+export interface IRetrievalChunk {
+    /**
+     * Chunk Id
+     * chunk id
+     */
+    chunk_id?: string;
+    /**
+     * Space Id
+     * space id
+     */
+    space_id: string;
+    /**
+     * Tenant Id
+     * tenant id
+     */
+    tenant_id: string;
+    /**
+     * Embedding
+     * chunk embedding
+     */
+    embedding?: number[] | null;
+    /**
+     * Context
+     * chunk content
+     */
+    context: string;
+    /**
+     * Knowledge Id
+     * file source info
+     */
+    knowledge_id: string;
+    /**
+     * Embedding Model Name
+     * name of the embedding model
+     */
+    embedding_model_name?: string;
+    /**
+     * Metadata
+     * Arbitrary metadata associated with the content.
+     */
+    metadata?: object | null;
+    /**
+     * Gmt Create
+     * creation time
+     */
+    gmt_create?: string;
+    /**
+     * Gmt Modified
+     * update time
+     */
+    gmt_modified?: string;
+    /**
+     * Similarity
+     * The similarity of the chunk
+     */
+    similarity: number;
+}
+/** S3SourceConfig */
+export interface IS3SourceConfig {
+    /**
+     * Bucket
+     * s3 bucket name
+     */
+    bucket: string;
+    /**
+     * Key
+     * s3 key
+     */
+    key: string;
+    /**
+     * Version Id
+     * s3 version id
+     */
+    version_id?: string | null;
+    /**
+     * Region
+     * s3 region
+     */
+    region?: string | null;
+    /**
+     * Access Key
+     * s3 access key
+     */
+    access_key?: string | null;
+    /**
+     * Secret Key
+     * s3 secret key
+     */
+    secret_key?: string | null;
+    /**
+     * Session Token
+     * s3 session token
+     */
+    session_token?: string | null;
+}
+/** Task */
+export interface ITask {
+    /**
+     * Task Id
+     * Unique identifier for the task
+     */
+    task_id?: string;
+    /**
+     * Current status of the task
+     * @default "pending"
+     */
+    status?: ITaskStatus;
+    /**
+     * Knowledge Id
+     * Identifier for the source file
+     */
+    knowledge_id: string;
+    /**
+     * Metadata
+     * Metadata for the task
+     */
+    metadata?: object | null;
+    /**
+     * Error Message
+     * Error message (only present if the task failed)
+     */
+    error_message?: string | null;
+    /**
+     * Space Id
+     * Identifier for the space
+     */
+    space_id: string;
+    /**
+     * User Id
+     * Identifier for the user
+     */
+    user_id?: string | null;
+    /**
+     * Tenant Id
+     * Identifier for the tenant
+     */
+    tenant_id: string;
+    /**
+     * Gmt Create
+     * Task creation time
+     */
+    gmt_create?: string;
+    /**
+     * Gmt Modified
+     * Last update time
+     */
+    gmt_modified?: string;
+}
+/** TaskRestartRequest */
+export interface ITaskRestartRequest {
+    /**
+     * Task Id List
+     * List of task IDs to restart
+     */
+    task_id_list: string[];
+}
+/** TaskStatus */
+export declare enum ITaskStatus {
+    Pending = "pending",
+    Running = "running",
+    Success = "success",
+    Failed = "failed",
+    Skipped = "skipped",
+    Canceled = "canceled",
+    PendingRetry = "pending_retry"
+}
+/** Tenant */
+export interface ITenant {
+    /**
+     * Tenant Id
+     * tenant id
+     */
+    tenant_id?: string;
+    /**
+     * Tenant Name
+     * tenant name
+     * @default ""
+     */
+    tenant_name?: string;
+    /**
+     * Email
+     * email
+     */
+    email: string;
+    /**
+     * Secret Key
+     * secret_key
+     * @default ""
+     */
+    secret_key?: string;
+    /**
+     * Is Active
+     * is active
+     * @default true
+     */
+    is_active?: boolean;
+    /**
+     * Gmt Create
+     * tenant created time
+     */
+    gmt_create?: string;
+    /**
+     * Gmt Modified
+     * tenant updated time
+     */
+    gmt_modified?: string;
+}
+/** TenantCreate */
+export interface ITenantCreate {
+    /** Tenant Name */
+    tenant_name: string;
+    /** Email */
+    email?: string | null;
+}
+/** TextCreate */
+export interface ITextCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "text"
+     */
+    knowledge_type?: "text";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: object;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * 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
+     * source config of the knowledge
+     */
+    source_config: ITextSourceConfig | IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
+    /** split config of the knowledge */
+    split_config: ITextSplitConfig;
+}
+/** TextSourceConfig */
+export interface ITextSourceConfig {
+    /**
+     * Text
+     * Text content, length range 1-100000 characters
+     * @minLength 1
+     * @maxLength 100000
+     * @default ""
+     */
+    text?: string;
+}
+/**
+ * TextSplitConfig
+ * Plain text split configuration
+ */
+export interface ITextSplitConfig {
+    /**
+     * Chunk Size
+     * @min 1
+     * @exclusiveMax 5000
+     * @default 1500
+     */
+    chunk_size?: number;
+    /**
+     * Chunk Overlap
+     * @min 0
+     * @default 150
+     */
+    chunk_overlap?: number;
+    /**
+     * Separators
+     * List of separators to split the text. If None, uses default separators
+     * @default ["\n\n"]
+     */
+    separators?: string[];
+    /**
+     * 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 {
+    /** Location */
+    loc: (string | number)[];
+    /** Message */
+    msg: string;
+    /** Error Type */
+    type: string;
+}
+import type { AxiosInstance, AxiosRequestConfig, ResponseType } from "axios";
+export type QueryParamsType = Record<string | number, any>;
+export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
+    /** set parameter to `true` for call `securityWorker` for this request */
+    secure?: boolean;
+    /** request path */
+    path: string;
+    /** content type of request body */
+    type?: ContentType;
+    /** query params */
+    query?: QueryParamsType;
+    /** format of response (i.e. response.json() -> format: "json") */
+    format?: ResponseType;
+    /** request body */
+    body?: unknown;
+}
+export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
+    secure?: boolean;
+    format?: ResponseType;
+}
+export declare enum ContentType {
+    Json = "application/json",
+    FormData = "multipart/form-data",
+    UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain"
+}
+export declare class HttpClient<SecurityDataType = unknown> {
+    instance: AxiosInstance;
+    private securityData;
+    private securityWorker?;
+    private secure?;
+    private format?;
+    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
+    setSecurityData: (data: SecurityDataType | null) => void;
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
+    protected stringifyFormItem(formItem: unknown): string;
+    protected createFormData(input: Record<string, unknown>): FormData;
+    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
+}
+/**
+ * @title whisker rag server
+ * @version 1.0.2
+ */
+export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * No description
+     *
+     * @name HomePageGet
+     * @summary Home Page
+     * @request GET:/
+     */
+    homePageGet: (params?: RequestParams) => Promise<any>;
+    knowledge: {
+        /**
+         * @description Duplicate file_sha entries are prohibited. Any modifications to split_config or embedding model_name parameters must be performed using dedicated API endpoints."
+         *
+         * @tags knowledge
+         * @name AddKnowledge
+         * @summary Add Knowledge
+         * @request POST:/api/knowledge/add
+         */
+        addKnowledge: (data: (IKnowledgeCreate | ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate)[], params?: RequestParams) => Promise<IResponseModelListKnowledge>;
+        /**
+         * No description
+         *
+         * @tags knowledge
+         * @name GetKnowledgeList
+         * @summary Get Knowledge List
+         * @request POST:/api/knowledge/list
+         */
+        getKnowledgeList: (data: IPageParamsKnowledge, params?: RequestParams) => Promise<IResponseModelPageResponseKnowledge>;
+        /**
+         * No description
+         *
+         * @tags knowledge
+         * @name GetKnowledgeById
+         * @summary Get Knowledge By Id
+         * @request GET:/api/knowledge/detail
+         */
+        getKnowledgeById: (query: {
+            /** Knowledge Id */
+            knowledge_id: string;
+        }, params?: RequestParams) => Promise<IResponseModelKnowledge>;
+        /**
+         * @description Deletes a knowledge entry by its ID.
+         *
+         * @tags knowledge
+         * @name DeleteKnowledge
+         * @summary Delete Knowledge
+         * @request DELETE:/api/knowledge/delete
+         */
+        deleteKnowledge: (query: {
+            /** Knowledge Id */
+            knowledge_id: string;
+        }, params?: RequestParams) => Promise<IResponseModelNoneType>;
+    };
+    retrieval: {
+        /**
+         * @description Retrieve certain chunks within a knowledge_id, for example, within a specific PDF file.
+         *
+         * @tags retrieval
+         * @name RetrieveKnowledgeContent
+         * @summary Retrieve Knowledge Content
+         * @request POST:/api/retrieval/knowledge
+         */
+        retrieveKnowledgeContent: (data: IRetrievalByKnowledgeRequest, params?: RequestParams) => Promise<IResponseModelListRetrievalChunk>;
+        /**
+         * @description Retrieve chunks within a space_id, for example, given a petercat bot_id, retrieve all chunks under that bot_id.
+         *
+         * @tags retrieval
+         * @name RetrieveSpaceContent
+         * @summary Retrieve Space Content
+         * @request POST:/api/retrieval/space
+         */
+        retrieveSpaceContent: (data: IRetrievalBySpaceRequest, params?: RequestParams) => Promise<IResponseModelListRetrievalChunk>;
+    };
+    task: {
+        /**
+         * No description
+         *
+         * @tags task
+         * @name RestartTask
+         * @summary Restart Task
+         * @request POST:/api/task/restart
+         */
+        restartTask: (data: ITaskRestartRequest, params?: RequestParams) => Promise<IResponseModelListTask>;
+        /**
+         * No description
+         *
+         * @tags task
+         * @name GetTaskList
+         * @summary Get Task List
+         * @request POST:/api/task/list
+         */
+        getTaskList: (data: IPageParamsTask, params?: RequestParams) => Promise<IResponseModelPageResponseTask>;
+        /**
+         * No description
+         *
+         * @tags task
+         * @name GetTaskDetail
+         * @summary Get Task Detail
+         * @request GET:/api/task/detail
+         */
+        getTaskDetail: (query: {
+            /** Task Id */
+            task_id: string;
+        }, params?: RequestParams) => Promise<IResponseModelTask>;
+    };
+    chunk: {
+        /**
+         * No description
+         *
+         * @tags chunk
+         * @name GetChunkList
+         * @summary Get Chunk List
+         * @request POST:/api/chunk/list
+         */
+        getChunkList: (data: IPageParamsChunk, params?: RequestParams) => Promise<IResponseModelPageResponseChunk>;
+    };
+    tenant: {
+        /**
+         * No description
+         *
+         * @tags tenant
+         * @name CreateTenant
+         * @summary Create Tenant
+         * @request POST:/api/tenant/create
+         */
+        createTenant: (data: ITenantCreate, params?: RequestParams) => Promise<IResponseModelTenant>;
+        /**
+         * No description
+         *
+         * @tags tenant
+         * @name GetTenant
+         * @summary Get Tenant
+         * @request GET:/api/tenant/me
+         */
+        getTenant: (params?: RequestParams) => Promise<any>;
+    };
+    healthChecker: {
+        /**
+         * No description
+         *
+         * @name HealthCheckerApiHealthCheckerGet
+         * @summary Health Checker
+         * @request GET:/api/health_checker
+         */
+        healthCheckerApiHealthCheckerGet: (params?: RequestParams) => Promise<IResponseModel>;
+    };
+}