@lichen-ai/lichen-sdk 0.1.0

package/dist/schema.d.ts

@@ -0,0 +1,661 @@
+import type { JSONSchema7 } from 'json-schema';
+type Optional<T> = T | null | undefined;
+export type RunStatus = 'pending' | 'running' | 'error' | 'success' | 'timeout' | 'interrupted';
+export type ThreadStatus = 'idle' | 'busy' | 'interrupted' | 'error';
+type MultitaskStrategy = 'reject' | 'interrupt' | 'rollback' | 'enqueue';
+export type CancelAction = 'interrupt' | 'rollback';
+export type Config = {
+    /**
+     * Tags for this call and any sub-calls (eg. a Chain calling an LLM).
+     * You can use these to filter calls.
+     */
+    tags?: string[];
+    /**
+     * Maximum number of times a call can recurse.
+     * If not provided, defaults to 25.
+     */
+    recursion_limit?: number;
+    /**
+     * Runtime values for attributes previously made configurable on this Runnable.
+     */
+    configurable?: {
+        /**
+         * ID of the thread
+         */
+        thread_id?: Optional<string>;
+        /**
+         * Timestamp of the state checkpoint
+         */
+        checkpoint_id?: Optional<string>;
+        [key: string]: unknown;
+    };
+};
+export interface GraphSchema {
+    /**
+     * The ID of the graph.
+     */
+    graph_id: string;
+    /**
+     * The schema for the input state.
+     * Missing if unable to generate JSON schema from graph.
+     */
+    input_schema?: JSONSchema7 | null | undefined;
+    /**
+     * The schema for the output state.
+     * Missing if unable to generate JSON schema from graph.
+     */
+    output_schema?: JSONSchema7 | null | undefined;
+    /**
+     * The schema for the graph state.
+     * Missing if unable to generate JSON schema from graph.
+     */
+    state_schema?: JSONSchema7 | null | undefined;
+    /**
+     * The schema for the graph config.
+     * Missing if unable to generate JSON schema from graph.
+     */
+    config_schema?: JSONSchema7 | null | undefined;
+    /**
+     * The schema for the graph context.
+     * Missing if unable to generate JSON schema from graph.
+     */
+    context_schema?: JSONSchema7 | null | undefined;
+}
+export type Subgraphs = Record<string, GraphSchema>;
+export type Metadata = Optional<{
+    source?: 'input' | 'loop' | 'update' | (string & {});
+    step?: number;
+    writes?: Record<string, unknown> | null;
+    parents?: Record<string, string>;
+    [key: string]: unknown;
+}>;
+export interface AssistantBase {
+    /** The ID of the assistant. */
+    assistant_id: string;
+    /** The ID of the graph. */
+    graph_id: string;
+    /** The assistant config. */
+    config: Config;
+    /** The assistant context. */
+    context: unknown;
+    /** The time the assistant was created. */
+    created_at: string;
+    /** The assistant metadata. */
+    metadata: Metadata;
+    /** The version of the assistant. */
+    version: number;
+    /** The name of the assistant */
+    name: string;
+    /** The description of the assistant */
+    description?: string;
+}
+export interface AssistantVersion extends AssistantBase {
+}
+export interface Assistant extends AssistantBase {
+    /** The last time the assistant was updated. */
+    updated_at: string;
+}
+export interface AssistantGraph {
+    nodes: Array<{
+        id: string | number;
+        name?: string;
+        data?: Record<string, unknown> | string;
+        metadata?: unknown;
+    }>;
+    edges: Array<{
+        source: string;
+        target: string;
+        data?: string;
+        conditional?: boolean;
+    }>;
+}
+/**
+ * An interrupt thrown inside a thread.
+ */
+export interface Interrupt<TValue = unknown> {
+    /**
+     * The ID of the interrupt.
+     */
+    id?: string;
+    /**
+     * The value of the interrupt.
+     */
+    value?: TValue;
+    /**
+     * Will be deprecated in the future.
+     * @deprecated Will be removed in the future.
+     */
+    when?: 'during' | (string & {});
+    /**
+     * Whether the interrupt can be resumed.
+     * @deprecated Will be removed in the future.
+     */
+    resumable?: boolean;
+    /**
+     * The namespace of the interrupt.
+     * @deprecated Replaced by `interrupt_id`
+     */
+    ns?: string[];
+}
+export interface Thread<ValuesType = DefaultValues> {
+    /** The ID of the thread. */
+    thread_id: string;
+    /** The time the thread was created. */
+    created_at: string;
+    /** The last time the thread was updated. */
+    updated_at: string;
+    /** The thread metadata. */
+    metadata: Metadata;
+    /** The status of the thread */
+    status: ThreadStatus;
+    /** The current state of the thread. */
+    values: ValuesType;
+    /** Interrupts which were thrown in this thread */
+    interrupts: Record<string, Array<Interrupt>>;
+}
+export interface ThreadContextUsage {
+    thread_id: string;
+    agent_key: string | null;
+    run_id: string | null;
+    updated_at: string | null;
+    usage: {
+        context_tokens: number;
+        input_tokens: number;
+        output_tokens: number;
+        total_tokens: number;
+        embed_tokens: number;
+        total_price: number;
+        currency: string | null;
+    };
+}
+export interface Cron {
+    /** The ID of the cron */
+    cron_id: string;
+    /** The ID of the assistant */
+    assistant_id: string;
+    /** The ID of the thread */
+    thread_id: Optional<string>;
+    /** The end date to stop running the cron. */
+    end_time: Optional<string>;
+    /** The schedule to run, cron format. */
+    schedule: string;
+    /** The time the cron was created. */
+    created_at: string;
+    /** The last time the cron was updated. */
+    updated_at: string;
+    /** The run payload to use for creating new run. */
+    payload: Record<string, unknown>;
+    /** The user ID of the cron */
+    user_id: Optional<string>;
+    /** The next run date of the cron */
+    next_run_date: Optional<string>;
+    /** The metadata of the cron */
+    metadata: Record<string, unknown>;
+}
+export type DefaultValues = Record<string, unknown>[] | Record<string, unknown>;
+export interface ThreadState<ValuesType = DefaultValues> {
+    /** The state values */
+    values: ValuesType;
+    /** The next nodes to execute. If empty, the thread is done until new input is received */
+    next: string[];
+    /** Checkpoint of the thread state */
+    checkpoint: Checkpoint;
+    /** Metadata for this state */
+    metadata: Metadata;
+    /** Time of state creation  */
+    created_at: Optional<string>;
+    /** The parent checkpoint. If missing, this is the root checkpoint */
+    parent_checkpoint: Optional<Checkpoint>;
+    /** Tasks to execute in this step. If already attempted, may contain an error */
+    tasks: Array<ThreadTask>;
+}
+export interface ThreadTask {
+    id: string;
+    name: string;
+    result?: unknown;
+    error: Optional<string>;
+    interrupts: Array<Interrupt>;
+    checkpoint: Optional<Checkpoint>;
+    state: Optional<ThreadState>;
+}
+export interface Run {
+    /** The ID of the run */
+    run_id: string;
+    /** The ID of the thread */
+    thread_id: string;
+    /** The assistant that wwas used for this run */
+    assistant_id: string;
+    /** The time the run was created */
+    created_at: string;
+    /** The last time the run was updated */
+    updated_at: string;
+    /** The status of the run. */
+    status: RunStatus;
+    /** Run metadata */
+    metadata: Metadata;
+    /** Strategy to handle concurrent runs on the same thread */
+    multitask_strategy: Optional<MultitaskStrategy>;
+}
+export type Checkpoint = {
+    thread_id: string;
+    checkpoint_ns: string;
+    checkpoint_id: Optional<string>;
+    checkpoint_map: Optional<Record<string, unknown>>;
+};
+export interface ListNamespaceResponse {
+    namespaces: string[][];
+}
+export interface Item {
+    namespace: string[];
+    key: string;
+    value: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SearchItem extends Item {
+    score?: number;
+}
+export interface SearchItemsResponse {
+    items: SearchItem[];
+}
+export interface CronCreateResponse {
+    cron_id: string;
+    assistant_id: string;
+    thread_id: string | undefined;
+    user_id: string;
+    payload: Record<string, unknown>;
+    schedule: string;
+    next_run_date: string;
+    end_time: string | undefined;
+    created_at: string;
+    updated_at: string;
+    metadata: Metadata;
+}
+export interface CronCreateForThreadResponse extends Omit<CronCreateResponse, 'thread_id'> {
+    thread_id: string;
+}
+export type AssistantSortBy = 'assistant_id' | 'graph_id' | 'name' | 'created_at' | 'updated_at';
+export type ThreadSortBy = 'thread_id' | 'status' | 'created_at' | 'updated_at';
+export type CronSortBy = 'cron_id' | 'assistant_id' | 'thread_id' | 'created_at' | 'updated_at' | 'next_run_date';
+export type SortOrder = 'asc' | 'desc';
+export type AssistantSelectField = 'assistant_id' | 'graph_id' | 'name' | 'description' | 'config' | 'context' | 'created_at' | 'updated_at' | 'metadata' | 'version';
+export type ThreadSelectField = 'thread_id' | 'created_at' | 'updated_at' | 'metadata' | 'config' | 'context' | 'status' | 'values' | 'interrupts';
+export type RunSelectField = 'run_id' | 'thread_id' | 'assistant_id' | 'created_at' | 'updated_at' | 'status' | 'metadata' | 'kwargs' | 'multitask_strategy';
+export type CronSelectField = 'cron_id' | 'assistant_id' | 'thread_id' | 'end_time' | 'schedule' | 'created_at' | 'updated_at' | 'user_id' | 'payload' | 'next_run_date' | 'metadata' | 'now';
+export interface Knowledgebase {
+    workspaceId: string;
+    id: string;
+    name: string;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    permission?: KnowledgebasePermission;
+    recall?: TKBRecallParams;
+    copilotModel?: TCopilotModel;
+}
+/**
+ * Knowledgebase permission levels
+ */
+export declare enum KnowledgebasePermission {
+    /**
+     * Only visible to you
+     * @default
+     */
+    Private = "private",
+    /**
+     * Visible to all members in the organization
+     */
+    Organization = "organization",
+    /**
+     * Visible to all members in the tenant
+     */
+    Public = "public"
+}
+/**
+ * Recall parameters
+ */
+export type TKBRecallParams = {
+    /**
+     * Top K of result chunks
+     */
+    topK?: number;
+    /**
+     * At least the similarity threshold
+     */
+    score?: number;
+    /**
+     * Weight in EnsembleRetriever
+     */
+    weight?: number;
+};
+export type TCopilotModel = {
+    copilotId?: string;
+    modelType?: AiModelTypeEnum;
+    model?: string;
+    /**
+     * Details config for ai model
+     */
+    options?: TCopilotModelOptions;
+};
+export declare enum AiModelTypeEnum {
+    LLM = "llm",
+    TEXT_EMBEDDING = "text-embedding",
+    RERANK = "rerank",
+    SPEECH2TEXT = "speech2text",
+    MODERATION = "moderation",
+    TTS = "tts",
+    TEXT2IMG = "text2img"
+}
+export type TCopilotModelOptions = {
+    [key: string]: any;
+};
+export type RuntimeCapabilitySkill = {
+    id: string;
+    workspaceId: string;
+    label: string;
+    description?: string;
+    repositoryName?: string;
+    provider?: string;
+    meta?: RuntimeCapabilitySkillMeta;
+    default?: boolean;
+};
+export type IconDefinition = {
+    type: 'image' | 'svg' | 'font' | 'emoji' | 'lottie';
+    value: string;
+    color?: string;
+    size?: number;
+    alt?: string;
+    style?: Record<string, string>;
+};
+export type RuntimeCapabilityIcon = IconDefinition;
+export type RuntimeCapabilitySkillMeta = {
+    icon?: IconDefinition;
+    [key: string]: unknown;
+};
+export type RuntimeCapabilityPluginMeta = {
+    icon?: IconDefinition;
+    [key: string]: unknown;
+};
+export type RuntimeCapabilityPlugin = {
+    nodeKey: string;
+    provider: string;
+    label: string;
+    description?: string;
+    meta?: RuntimeCapabilityPluginMeta;
+    toolNames?: string[];
+};
+export type RuntimeCapabilitySubAgent = {
+    nodeKey: string;
+    type: 'agent' | 'xpert';
+    label: string;
+    name?: string;
+    description?: string;
+    avatar?: Record<string, unknown> | string;
+    agentKey?: string;
+    xpertId?: string;
+    parameters?: unknown[];
+    toolNames?: string[];
+    toolsetNames?: string[];
+    knowledgebaseNames?: string[];
+};
+export type RuntimeCapabilitiesResponse = {
+    skills: RuntimeCapabilitySkill[];
+    plugins: RuntimeCapabilityPlugin[];
+    subAgents?: RuntimeCapabilitySubAgent[];
+};
+export type RuntimeCapabilitiesSelection = {
+    mode: 'allowlist';
+    skills: {
+        workspaceId?: string;
+        ids: string[];
+    };
+    plugins: {
+        nodeKeys: string[];
+    };
+    subAgents?: {
+        nodeKeys: string[];
+    };
+};
+/**
+ * Human input payload for a chat request.
+ */
+export interface ChatRequestHuman {
+    input?: string;
+    files?: Partial<{
+        id: string;
+        name: string;
+        url: string;
+        size: number;
+        type: string;
+    }>[];
+    runtimeCapabilities?: RuntimeCapabilitiesSelection;
+    [key: string]: unknown;
+}
+/**
+ * State passed alongside a chat request.
+ */
+export type ChatState = {
+    human?: ChatRequestHuman;
+} & Record<string, unknown>;
+/**
+ * Target reference for resume/retry actions.
+ */
+export interface ChatTarget {
+    aiMessageId?: string;
+    executionId?: string;
+}
+/**
+ * Decision payload for resuming an interrupted chat.
+ */
+export interface ChatResumeDecision {
+    type: 'confirm' | 'reject';
+    payload?: unknown;
+}
+/**
+ * Patch payload for modifying an interrupted chat.
+ */
+export interface ChatInterruptPatch {
+    agentKey?: string;
+    toolCalls?: unknown[];
+    update?: unknown;
+}
+export type ChatFollowUpMode = 'queue' | 'steer';
+/**
+ * Send a new message in a chat run.
+ */
+export interface ChatSendRequest {
+    action: 'send';
+    conversationId?: string;
+    projectId?: string;
+    environmentId?: string;
+    sandboxEnvironmentId?: string;
+    message: {
+        clientMessageId?: string;
+        input: ChatRequestHuman;
+    };
+    state?: ChatState;
+}
+/**
+ * Resume an interrupted chat run.
+ */
+export interface ChatResumeRequest {
+    action: 'resume';
+    conversationId: string;
+    target: ChatTarget;
+    decision: ChatResumeDecision;
+    patch?: ChatInterruptPatch;
+    state?: ChatState;
+}
+/**
+ * Retry a failed chat run.
+ */
+export interface ChatRetryRequest {
+    action: 'retry';
+    conversationId: string;
+    source: ChatTarget;
+    environmentId?: string;
+    sandboxEnvironmentId?: string;
+    checkpointId?: string;
+}
+/**
+ * Follow up while another chat run is active.
+ */
+export interface ChatFollowUpRequest {
+    action: 'follow_up';
+    conversationId: string;
+    mode: ChatFollowUpMode;
+    message: {
+        clientMessageId?: string;
+        input: ChatRequestHuman;
+    };
+    target?: ChatTarget;
+    state?: ChatState;
+}
+/**
+ * Discriminated union of all chat request actions.
+ * Maps to the server-side `TChatRequest` (v2) validated by `RunCreateStreamHandler`.
+ */
+export type ChatRequest = ChatSendRequest | ChatResumeRequest | ChatRetryRequest | ChatFollowUpRequest;
+/**
+ * Legacy chat request format (v1).
+ * The server normalizes this into a v2 {@link ChatRequest} automatically.
+ * Prefer the v2 format for new code.
+ */
+export interface LegacyChatRequest {
+    input: ChatRequestHuman;
+    state?: ChatState;
+    agentKey?: string;
+    projectId?: string;
+    conversationId?: string;
+    environmentId?: string;
+    id?: string;
+    executionId?: string;
+    confirm?: boolean;
+    command?: {
+        resume?: unknown;
+        update?: unknown;
+        toolCalls?: unknown[];
+        agentKey?: string;
+    };
+    retry?: boolean;
+    sandboxEnvironmentId?: string;
+}
+/**
+ * All accepted run input formats.
+ * The server accepts both v2 {@link ChatRequest} and {@link LegacyChatRequest}.
+ */
+export type RunInput = ChatRequest | LegacyChatRequest;
+export type SandboxManagedServiceStatus = 'starting' | 'running' | 'stopping' | 'stopped' | 'failed' | 'lost';
+export type SandboxManagedServiceTransportMode = 'none' | 'http';
+export type SandboxManagedServiceEnvEntry = {
+    name: string;
+    value: string;
+};
+export type SandboxManagedServiceStartInput = {
+    name: string;
+    command: string;
+    cwd?: string | null;
+    port?: number | null;
+    previewPath?: string | null;
+    readyPattern?: string | null;
+    env?: SandboxManagedServiceEnvEntry[];
+    replaceExisting?: boolean;
+};
+export type SandboxManagedServiceLogs = {
+    stderr: string;
+    stdout: string;
+};
+export type SandboxManagedServicePreviewSession = {
+    expiresAt: string;
+    previewUrl: string;
+};
+export interface SandboxManagedService {
+    id?: string;
+    conversationId: string;
+    provider: string;
+    name: string;
+    command: string;
+    workingDirectory: string;
+    requestedPort?: number | null;
+    actualPort?: number | null;
+    previewPath?: string | null;
+    status: SandboxManagedServiceStatus;
+    runtimeRef?: unknown;
+    transportMode?: SandboxManagedServiceTransportMode | null;
+    ownerExecutionId?: string | null;
+    ownerAgentKey?: string | null;
+    startedAt?: string | null;
+    stoppedAt?: string | null;
+    exitCode?: number | null;
+    signal?: string | null;
+    metadata?: unknown;
+    previewUrl?: string | null;
+}
+export type Pagination<T> = {
+    items: T[];
+    total: number;
+};
+export type ChatConversationStatus = 'idle' | 'busy' | 'interrupted' | 'error';
+export type ChatConversationFrom = 'platform' | 'webapp' | 'debugger' | 'knowledge' | 'job' | 'api' | 'feishu' | 'lark' | 'dingtalk' | 'wecom';
+export interface ChatConversation {
+    id: string;
+    threadId: string;
+    title?: string;
+    status?: ChatConversationStatus;
+    from?: ChatConversationFrom;
+    fromEndUserId?: string;
+    options?: Record<string, unknown>;
+    error?: string;
+    operation?: Record<string, unknown>;
+    xpertId?: string;
+    projectId?: string;
+    taskId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ChatMessage {
+    id: string;
+    conversationId?: string;
+    role?: string;
+    content?: unknown;
+    reasoning?: unknown;
+    status?: string;
+    error?: string;
+    executionId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type ChatMessageFeedbackRating = 'like' | 'dislike';
+export interface ChatMessageFeedback {
+    id: string;
+    conversationId?: string;
+    messageId?: string;
+    rating?: ChatMessageFeedbackRating;
+    content?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * Represents a file stored on the server.
+ * Returned by the file upload API.
+ */
+export interface StorageFile {
+    id: string;
+    /** File storage path/key */
+    file: string;
+    /** File access URL */
+    url?: string;
+    /** Original filename */
+    originalName?: string;
+    /** File encoding */
+    encoding?: string;
+    /** File size in bytes */
+    size?: number;
+    /** MIME type */
+    mimetype?: string;
+    /** File storage provider (LOCAL, S3, OSS, etc.) */
+    storageProvider?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export {};

package/dist/schema.js

@@ -0,0 +1,30 @@
+/**
+ * Knowledgebase permission levels
+ */
+export var KnowledgebasePermission;
+(function (KnowledgebasePermission) {
+    /**
+     * Only visible to you
+     * @default
+     */
+    KnowledgebasePermission["Private"] = "private";
+    /**
+     * Visible to all members in the organization
+     */
+    KnowledgebasePermission["Organization"] = "organization";
+    /**
+     * Visible to all members in the tenant
+     */
+    KnowledgebasePermission["Public"] = "public";
+})(KnowledgebasePermission || (KnowledgebasePermission = {}));
+export var AiModelTypeEnum;
+(function (AiModelTypeEnum) {
+    AiModelTypeEnum["LLM"] = "llm";
+    AiModelTypeEnum["TEXT_EMBEDDING"] = "text-embedding";
+    AiModelTypeEnum["RERANK"] = "rerank";
+    AiModelTypeEnum["SPEECH2TEXT"] = "speech2text";
+    AiModelTypeEnum["MODERATION"] = "moderation";
+    AiModelTypeEnum["TTS"] = "tts";
+    AiModelTypeEnum["TEXT2IMG"] = "text2img";
+})(AiModelTypeEnum || (AiModelTypeEnum = {}));
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AA+aA;;GAEG;AACH,MAAM,CAAN,IAAY,uBAcX;AAdD,WAAY,uBAAuB;IACjC;;;OAGG;IACH,8CAAmB,CAAA;IACnB;;OAEG;IACH,wDAA6B,CAAA;IAC7B;;OAEG;IACH,4CAAiB,CAAA;AACnB,CAAC,EAdW,uBAAuB,KAAvB,uBAAuB,QAclC;AA+BD,MAAM,CAAN,IAAY,eAQX;AARD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,oDAAiC,CAAA;IACjC,oCAAiB,CAAA;IACjB,8CAA2B,CAAA;IAC3B,4CAAyB,CAAA;IACzB,8BAAW,CAAA;IACX,wCAAqB,CAAA;AACvB,CAAC,EARW,eAAe,KAAf,eAAe,QAQ1B"}