@amaster.ai/client 1.1.52 → 1.1.54-beta.0

package/dist/index.d.cts

@@ -6,6 +6,8 @@ import { BpmClient } from '@amaster.ai/bpm-client';
 export { ActivityInstanceTree, CamundaVariable, HistoryActivityInstance, HistoryProcessInstance, HistoryTask, ProcessInstance, ProcessVariable, Task, TaskFormSchema, TaskQueryParams, UserOperationLog } from '@amaster.ai/bpm-client';
 import { WorkflowClient } from '@amaster.ai/workflow-client';
 export { WorkflowAsyncRunDetailResponse, WorkflowAsyncRunResponse, WorkflowAsyncRunStatus, WorkflowCallbackConfig, WorkflowFile, WorkflowInputValue, WorkflowNodeUsage, WorkflowRunDetailOptions, WorkflowRunRequest, WorkflowRunResponse, WorkflowRunUsage, WorkflowUsageSummary } from '@amaster.ai/workflow-client';
+import { ClientResult, MiniProgramRuntime, HttpClient } from '@amaster.ai/http-client';
+export { ClientError, ClientResult, HttpClient, RequestConfig } from '@amaster.ai/http-client';
 import { ASRClientConfig, ASRClient, ASRHttpClientConfig, ASRHttpClient } from '@amaster.ai/asr-client';
 export { ASRClient, ASRClientConfig, ASRHttpClient, ASRHttpClientConfig, ASRLanguage } from '@amaster.ai/asr-client';
 import { CopilotClient } from '@amaster.ai/copilot-client';
@@ -16,8 +18,195 @@ import { TTSClientConfig, TTSClient } from '@amaster.ai/tts-client';
 export { TTSClient, TTSClientConfig, TTSRuntime, TTSSnapshot, TTSSpeakController, TTSSpeakControllerOptions, TTSSpeakOptions, TTSStorageAdapter, createTTSSpeakController, preprocessTTSContent, splitTextIntoFragments } from '@amaster.ai/tts-client';
 import { S3Client } from '@amaster.ai/s3-client';
 export { S3Client, S3Metadata, S3UploadOptions, S3UploadProgress, S3UploadProgressPhase, UploadRes } from '@amaster.ai/s3-client';
-import { MiniProgramRuntime, HttpClient } from '@amaster.ai/http-client';
-export { ClientError, ClientResult, HttpClient, RequestConfig } from '@amaster.ai/http-client';
+
+type KnowledgeDocumentStatus = "completed" | "indexing" | "error" | "paused";
+type KnowledgeDocumentListStatus = KnowledgeDocumentStatus | "all";
+type KnowledgeRoles = string | string[];
+type KnowledgeDatasetIdResponse = {
+    dataset_id: string;
+    tenant_id?: string;
+    workspace_id?: string;
+};
+type KnowledgeDocument = {
+    id: string;
+    name: string;
+    data_source_type?: string;
+    doc_type?: string | null;
+    doc_form?: string | null;
+    indexing_status?: string;
+    display_status?: string;
+    enabled?: boolean;
+    archived?: boolean;
+    word_count?: number;
+    hit_count?: number;
+    position?: number;
+    created_at?: number;
+    updated_at?: number;
+    completed_segments?: number;
+    total_segments?: number;
+    [key: string]: unknown;
+};
+type KnowledgeDocumentListResponse = {
+    data: KnowledgeDocument[];
+    total: number;
+    page: number;
+    limit: number;
+    has_more: boolean;
+};
+type KnowledgeChildChunk = {
+    id: string;
+    segment_id: string;
+    content: string;
+    position: number;
+    word_count?: number;
+    type?: string;
+    created_at?: number;
+    updated_at?: number;
+};
+type KnowledgeSegmentAttachment = {
+    id: string;
+    name: string;
+    size?: number;
+    extension?: string;
+    mime_type?: string;
+    source_url?: string;
+};
+type KnowledgeSegment = {
+    id: string;
+    position: number;
+    document_id: string;
+    content: string;
+    answer?: string | null;
+    word_count?: number;
+    tokens?: number;
+    keywords?: string[];
+    hit_count?: number;
+    enabled?: boolean;
+    status?: string;
+    created_at?: number;
+    updated_at?: number;
+    indexing_at?: number | null;
+    completed_at?: number | null;
+    error?: string | null;
+    child_chunks?: KnowledgeChildChunk[];
+    attachments?: KnowledgeSegmentAttachment[];
+};
+type KnowledgeSegmentListResponse = {
+    data: KnowledgeSegment[];
+    total: number;
+    total_pages: number;
+    page: number;
+    limit: number;
+    has_more: boolean;
+};
+type KnowledgeIndexingStatus = {
+    id: string;
+    name?: string;
+    indexing_status?: string;
+    processing_started_at?: number | null;
+    parsing_completed_at?: number | null;
+    cleaning_completed_at?: number | null;
+    splitting_completed_at?: number | null;
+    completed_at?: number | null;
+    paused_at?: number | null;
+    stopped_at?: number | null;
+    completed_segments?: number;
+    total_segments?: number;
+    error?: string | null;
+    [key: string]: unknown;
+};
+type KnowledgeIndexingStatusResponse = {
+    data: KnowledgeIndexingStatus[];
+};
+type KnowledgeUploadResponse = {
+    document: KnowledgeDocument;
+    batch: string;
+};
+type KnowledgeMetadataField = {
+    id: string;
+    name: string;
+    type?: "string" | "number" | "time" | string;
+    value: unknown;
+};
+type KnowledgeMetadataOperation = {
+    document_id: string;
+    metadata_list: KnowledgeMetadataField[];
+    partial_update?: boolean;
+};
+type KnowledgeMetadataUpdateRequest = {
+    operation_data: KnowledgeMetadataOperation[];
+};
+type KnowledgeResolveOptions = {
+    datasetId: string;
+    orgCode?: string;
+    refresh?: boolean;
+    workspaceId?: string;
+    tenantId?: string;
+} | {
+    datasetId?: string;
+    orgCode: string;
+    refresh?: boolean;
+    workspaceId?: string;
+    tenantId?: string;
+};
+type KnowledgeGetDatasetIdOptions = {
+    orgCode: string;
+    refresh?: boolean;
+};
+type KnowledgeListDocumentsOptions = KnowledgeResolveOptions & {
+    page?: number;
+    limit?: number;
+    keyword?: string;
+    status?: KnowledgeDocumentListStatus;
+    sort?: string;
+    fetch?: boolean | string;
+    appCode?: string;
+    roles?: KnowledgeRoles;
+};
+type KnowledgeGetDocumentOptions = KnowledgeResolveOptions & {
+    documentId: string;
+    appCode?: string;
+    roles?: KnowledgeRoles;
+};
+type KnowledgeListSegmentsOptions = KnowledgeGetDocumentOptions & {
+    page?: number;
+    limit?: number;
+    keyword?: string;
+    enabled?: boolean | "all";
+    status?: string;
+    hitCountGte?: number;
+};
+type KnowledgeUploadDocumentOptions = KnowledgeResolveOptions & {
+    file: File | Blob;
+    fileName?: string;
+    appCode?: string;
+    config?: Record<string, unknown>;
+};
+type KnowledgeIndexingStatusOptions = KnowledgeResolveOptions & {
+    batch: string;
+};
+type KnowledgeWaitForIndexingOptions = KnowledgeIndexingStatusOptions & {
+    intervalMs?: number;
+    timeoutMs?: number;
+};
+type KnowledgeDeleteDocumentOptions = KnowledgeResolveOptions & {
+    documentId: string;
+    appCode?: string;
+};
+type KnowledgeUpdateDocumentsMetadataOptions = KnowledgeResolveOptions & KnowledgeMetadataUpdateRequest;
+type KnowledgeClient = {
+    getDatasetId(options: KnowledgeGetDatasetIdOptions): Promise<ClientResult<KnowledgeDatasetIdResponse>>;
+    listDocuments(options: KnowledgeListDocumentsOptions): Promise<ClientResult<KnowledgeDocumentListResponse>>;
+    getDocument(options: KnowledgeGetDocumentOptions): Promise<ClientResult<KnowledgeDocument>>;
+    listSegments(options: KnowledgeListSegmentsOptions): Promise<ClientResult<KnowledgeSegmentListResponse>>;
+    uploadDocument(options: KnowledgeUploadDocumentOptions): Promise<ClientResult<KnowledgeUploadResponse>>;
+    getIndexingStatus(options: KnowledgeIndexingStatusOptions): Promise<ClientResult<KnowledgeIndexingStatusResponse>>;
+    waitForIndexing(options: KnowledgeWaitForIndexingOptions): Promise<ClientResult<KnowledgeIndexingStatusResponse>>;
+    deleteDocument(options: KnowledgeDeleteDocumentOptions): Promise<ClientResult<null>>;
+    updateDocumentsMetadata(options: KnowledgeUpdateDocumentsMetadataOptions): Promise<ClientResult<{
+        result: string;
+    }>>;
+};
 
 /**
  * Amaster Client Configuration Options
@@ -173,6 +362,16 @@ interface AmasterClient {
      * ```
      */
     workflow: WorkflowClient;
+    /**
+     * Knowledge base document management module
+     *
+     * @example
+     * ```typescript
+     * await client.knowledge.listDocuments({ orgCode: 'org-123', appCode: 'demo-app' });
+     * await client.knowledge.uploadDocument({ orgCode: 'org-123', appCode: 'demo-app', file });
+     * ```
+     */
+    knowledge: KnowledgeClient;
     /**
      * ASR (Automatic Speech Recognition) module - WebSocket-based real-time speech recognition
      *
@@ -437,4 +636,4 @@ interface AmasterClient {
  */
 declare function createClient(options?: AmasterClientOptions): AmasterClient;
 
-export { type AmasterClient, type AmasterClientOptions, createClient };
+export { type AmasterClient, type AmasterClientOptions, type KnowledgeChildChunk, type KnowledgeClient, type KnowledgeDatasetIdResponse, type KnowledgeDeleteDocumentOptions, type KnowledgeDocument, type KnowledgeDocumentListResponse, type KnowledgeDocumentListStatus, type KnowledgeDocumentStatus, type KnowledgeGetDatasetIdOptions, type KnowledgeGetDocumentOptions, type KnowledgeIndexingStatus, type KnowledgeIndexingStatusOptions, type KnowledgeIndexingStatusResponse, type KnowledgeListDocumentsOptions, type KnowledgeListSegmentsOptions, type KnowledgeMetadataField, type KnowledgeMetadataOperation, type KnowledgeMetadataUpdateRequest, type KnowledgeResolveOptions, type KnowledgeRoles, type KnowledgeSegment, type KnowledgeSegmentAttachment, type KnowledgeSegmentListResponse, type KnowledgeUpdateDocumentsMetadataOptions, type KnowledgeUploadDocumentOptions, type KnowledgeUploadResponse, type KnowledgeWaitForIndexingOptions, createClient };

package/dist/index.d.ts

@@ -6,6 +6,8 @@ import { BpmClient } from '@amaster.ai/bpm-client';
 export { ActivityInstanceTree, CamundaVariable, HistoryActivityInstance, HistoryProcessInstance, HistoryTask, ProcessInstance, ProcessVariable, Task, TaskFormSchema, TaskQueryParams, UserOperationLog } from '@amaster.ai/bpm-client';
 import { WorkflowClient } from '@amaster.ai/workflow-client';
 export { WorkflowAsyncRunDetailResponse, WorkflowAsyncRunResponse, WorkflowAsyncRunStatus, WorkflowCallbackConfig, WorkflowFile, WorkflowInputValue, WorkflowNodeUsage, WorkflowRunDetailOptions, WorkflowRunRequest, WorkflowRunResponse, WorkflowRunUsage, WorkflowUsageSummary } from '@amaster.ai/workflow-client';
+import { ClientResult, MiniProgramRuntime, HttpClient } from '@amaster.ai/http-client';
+export { ClientError, ClientResult, HttpClient, RequestConfig } from '@amaster.ai/http-client';
 import { ASRClientConfig, ASRClient, ASRHttpClientConfig, ASRHttpClient } from '@amaster.ai/asr-client';
 export { ASRClient, ASRClientConfig, ASRHttpClient, ASRHttpClientConfig, ASRLanguage } from '@amaster.ai/asr-client';
 import { CopilotClient } from '@amaster.ai/copilot-client';
@@ -16,8 +18,195 @@ import { TTSClientConfig, TTSClient } from '@amaster.ai/tts-client';
 export { TTSClient, TTSClientConfig, TTSRuntime, TTSSnapshot, TTSSpeakController, TTSSpeakControllerOptions, TTSSpeakOptions, TTSStorageAdapter, createTTSSpeakController, preprocessTTSContent, splitTextIntoFragments } from '@amaster.ai/tts-client';
 import { S3Client } from '@amaster.ai/s3-client';
 export { S3Client, S3Metadata, S3UploadOptions, S3UploadProgress, S3UploadProgressPhase, UploadRes } from '@amaster.ai/s3-client';
-import { MiniProgramRuntime, HttpClient } from '@amaster.ai/http-client';
-export { ClientError, ClientResult, HttpClient, RequestConfig } from '@amaster.ai/http-client';
+
+type KnowledgeDocumentStatus = "completed" | "indexing" | "error" | "paused";
+type KnowledgeDocumentListStatus = KnowledgeDocumentStatus | "all";
+type KnowledgeRoles = string | string[];
+type KnowledgeDatasetIdResponse = {
+    dataset_id: string;
+    tenant_id?: string;
+    workspace_id?: string;
+};
+type KnowledgeDocument = {
+    id: string;
+    name: string;
+    data_source_type?: string;
+    doc_type?: string | null;
+    doc_form?: string | null;
+    indexing_status?: string;
+    display_status?: string;
+    enabled?: boolean;
+    archived?: boolean;
+    word_count?: number;
+    hit_count?: number;
+    position?: number;
+    created_at?: number;
+    updated_at?: number;
+    completed_segments?: number;
+    total_segments?: number;
+    [key: string]: unknown;
+};
+type KnowledgeDocumentListResponse = {
+    data: KnowledgeDocument[];
+    total: number;
+    page: number;
+    limit: number;
+    has_more: boolean;
+};
+type KnowledgeChildChunk = {
+    id: string;
+    segment_id: string;
+    content: string;
+    position: number;
+    word_count?: number;
+    type?: string;
+    created_at?: number;
+    updated_at?: number;
+};
+type KnowledgeSegmentAttachment = {
+    id: string;
+    name: string;
+    size?: number;
+    extension?: string;
+    mime_type?: string;
+    source_url?: string;
+};
+type KnowledgeSegment = {
+    id: string;
+    position: number;
+    document_id: string;
+    content: string;
+    answer?: string | null;
+    word_count?: number;
+    tokens?: number;
+    keywords?: string[];
+    hit_count?: number;
+    enabled?: boolean;
+    status?: string;
+    created_at?: number;
+    updated_at?: number;
+    indexing_at?: number | null;
+    completed_at?: number | null;
+    error?: string | null;
+    child_chunks?: KnowledgeChildChunk[];
+    attachments?: KnowledgeSegmentAttachment[];
+};
+type KnowledgeSegmentListResponse = {
+    data: KnowledgeSegment[];
+    total: number;
+    total_pages: number;
+    page: number;
+    limit: number;
+    has_more: boolean;
+};
+type KnowledgeIndexingStatus = {
+    id: string;
+    name?: string;
+    indexing_status?: string;
+    processing_started_at?: number | null;
+    parsing_completed_at?: number | null;
+    cleaning_completed_at?: number | null;
+    splitting_completed_at?: number | null;
+    completed_at?: number | null;
+    paused_at?: number | null;
+    stopped_at?: number | null;
+    completed_segments?: number;
+    total_segments?: number;
+    error?: string | null;
+    [key: string]: unknown;
+};
+type KnowledgeIndexingStatusResponse = {
+    data: KnowledgeIndexingStatus[];
+};
+type KnowledgeUploadResponse = {
+    document: KnowledgeDocument;
+    batch: string;
+};
+type KnowledgeMetadataField = {
+    id: string;
+    name: string;
+    type?: "string" | "number" | "time" | string;
+    value: unknown;
+};
+type KnowledgeMetadataOperation = {
+    document_id: string;
+    metadata_list: KnowledgeMetadataField[];
+    partial_update?: boolean;
+};
+type KnowledgeMetadataUpdateRequest = {
+    operation_data: KnowledgeMetadataOperation[];
+};
+type KnowledgeResolveOptions = {
+    datasetId: string;
+    orgCode?: string;
+    refresh?: boolean;
+    workspaceId?: string;
+    tenantId?: string;
+} | {
+    datasetId?: string;
+    orgCode: string;
+    refresh?: boolean;
+    workspaceId?: string;
+    tenantId?: string;
+};
+type KnowledgeGetDatasetIdOptions = {
+    orgCode: string;
+    refresh?: boolean;
+};
+type KnowledgeListDocumentsOptions = KnowledgeResolveOptions & {
+    page?: number;
+    limit?: number;
+    keyword?: string;
+    status?: KnowledgeDocumentListStatus;
+    sort?: string;
+    fetch?: boolean | string;
+    appCode?: string;
+    roles?: KnowledgeRoles;
+};
+type KnowledgeGetDocumentOptions = KnowledgeResolveOptions & {
+    documentId: string;
+    appCode?: string;
+    roles?: KnowledgeRoles;
+};
+type KnowledgeListSegmentsOptions = KnowledgeGetDocumentOptions & {
+    page?: number;
+    limit?: number;
+    keyword?: string;
+    enabled?: boolean | "all";
+    status?: string;
+    hitCountGte?: number;
+};
+type KnowledgeUploadDocumentOptions = KnowledgeResolveOptions & {
+    file: File | Blob;
+    fileName?: string;
+    appCode?: string;
+    config?: Record<string, unknown>;
+};
+type KnowledgeIndexingStatusOptions = KnowledgeResolveOptions & {
+    batch: string;
+};
+type KnowledgeWaitForIndexingOptions = KnowledgeIndexingStatusOptions & {
+    intervalMs?: number;
+    timeoutMs?: number;
+};
+type KnowledgeDeleteDocumentOptions = KnowledgeResolveOptions & {
+    documentId: string;
+    appCode?: string;
+};
+type KnowledgeUpdateDocumentsMetadataOptions = KnowledgeResolveOptions & KnowledgeMetadataUpdateRequest;
+type KnowledgeClient = {
+    getDatasetId(options: KnowledgeGetDatasetIdOptions): Promise<ClientResult<KnowledgeDatasetIdResponse>>;
+    listDocuments(options: KnowledgeListDocumentsOptions): Promise<ClientResult<KnowledgeDocumentListResponse>>;
+    getDocument(options: KnowledgeGetDocumentOptions): Promise<ClientResult<KnowledgeDocument>>;
+    listSegments(options: KnowledgeListSegmentsOptions): Promise<ClientResult<KnowledgeSegmentListResponse>>;
+    uploadDocument(options: KnowledgeUploadDocumentOptions): Promise<ClientResult<KnowledgeUploadResponse>>;
+    getIndexingStatus(options: KnowledgeIndexingStatusOptions): Promise<ClientResult<KnowledgeIndexingStatusResponse>>;
+    waitForIndexing(options: KnowledgeWaitForIndexingOptions): Promise<ClientResult<KnowledgeIndexingStatusResponse>>;
+    deleteDocument(options: KnowledgeDeleteDocumentOptions): Promise<ClientResult<null>>;
+    updateDocumentsMetadata(options: KnowledgeUpdateDocumentsMetadataOptions): Promise<ClientResult<{
+        result: string;
+    }>>;
+};
 
 /**
  * Amaster Client Configuration Options
@@ -173,6 +362,16 @@ interface AmasterClient {
      * ```
      */
     workflow: WorkflowClient;
+    /**
+     * Knowledge base document management module
+     *
+     * @example
+     * ```typescript
+     * await client.knowledge.listDocuments({ orgCode: 'org-123', appCode: 'demo-app' });
+     * await client.knowledge.uploadDocument({ orgCode: 'org-123', appCode: 'demo-app', file });
+     * ```
+     */
+    knowledge: KnowledgeClient;
     /**
      * ASR (Automatic Speech Recognition) module - WebSocket-based real-time speech recognition
      *
@@ -437,4 +636,4 @@ interface AmasterClient {
  */
 declare function createClient(options?: AmasterClientOptions): AmasterClient;
 
-export { type AmasterClient, type AmasterClientOptions, createClient };
+export { type AmasterClient, type AmasterClientOptions, type KnowledgeChildChunk, type KnowledgeClient, type KnowledgeDatasetIdResponse, type KnowledgeDeleteDocumentOptions, type KnowledgeDocument, type KnowledgeDocumentListResponse, type KnowledgeDocumentListStatus, type KnowledgeDocumentStatus, type KnowledgeGetDatasetIdOptions, type KnowledgeGetDocumentOptions, type KnowledgeIndexingStatus, type KnowledgeIndexingStatusOptions, type KnowledgeIndexingStatusResponse, type KnowledgeListDocumentsOptions, type KnowledgeListSegmentsOptions, type KnowledgeMetadataField, type KnowledgeMetadataOperation, type KnowledgeMetadataUpdateRequest, type KnowledgeResolveOptions, type KnowledgeRoles, type KnowledgeSegment, type KnowledgeSegmentAttachment, type KnowledgeSegmentListResponse, type KnowledgeUpdateDocumentsMetadataOptions, type KnowledgeUploadDocumentOptions, type KnowledgeUploadResponse, type KnowledgeWaitForIndexingOptions, createClient };