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

package/types/knowledge.d.ts

@@ -0,0 +1,235 @@
+/**
+ * Knowledge base document management types.
+ *
+ * @module knowledge
+ */
+
+import type { ClientResult } from "./common";
+
+export type KnowledgeDocumentStatus = "completed" | "indexing" | "error" | "paused";
+export type KnowledgeDocumentListStatus = KnowledgeDocumentStatus | "all";
+export type KnowledgeRoles = string | string[];
+
+export interface KnowledgeDatasetIdResponse {
+  dataset_id: string;
+  tenant_id?: string;
+  workspace_id?: string;
+}
+
+export interface 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;
+}
+
+export interface KnowledgeDocumentListResponse {
+  data: KnowledgeDocument[];
+  total: number;
+  page: number;
+  limit: number;
+  has_more: boolean;
+}
+
+export interface KnowledgeChildChunk {
+  id: string;
+  segment_id: string;
+  content: string;
+  position: number;
+  word_count?: number;
+  type?: string;
+  created_at?: number;
+  updated_at?: number;
+}
+
+export interface KnowledgeSegmentAttachment {
+  id: string;
+  name: string;
+  size?: number;
+  extension?: string;
+  mime_type?: string;
+  source_url?: string;
+}
+
+export interface 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[];
+}
+
+export interface KnowledgeSegmentListResponse {
+  data: KnowledgeSegment[];
+  total: number;
+  total_pages: number;
+  page: number;
+  limit: number;
+  has_more: boolean;
+}
+
+export interface 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;
+}
+
+export interface KnowledgeIndexingStatusResponse {
+  data: KnowledgeIndexingStatus[];
+}
+
+export interface KnowledgeUploadResponse {
+  document: KnowledgeDocument;
+  batch: string;
+}
+
+export interface KnowledgeMetadataField {
+  id: string;
+  name: string;
+  type?: "string" | "number" | "time" | string;
+  value: unknown;
+}
+
+export interface KnowledgeMetadataOperation {
+  document_id: string;
+  metadata_list: KnowledgeMetadataField[];
+  partial_update?: boolean;
+}
+
+export interface KnowledgeMetadataUpdateRequest {
+  operation_data: KnowledgeMetadataOperation[];
+}
+
+export type KnowledgeResolveOptions =
+  | {
+      datasetId: string;
+      orgCode?: string;
+      refresh?: boolean;
+      workspaceId?: string;
+      tenantId?: string;
+    }
+  | {
+      datasetId?: string;
+      orgCode: string;
+      refresh?: boolean;
+      workspaceId?: string;
+      tenantId?: string;
+    };
+
+export interface KnowledgeGetDatasetIdOptions {
+  orgCode: string;
+  refresh?: boolean;
+}
+
+export type KnowledgeListDocumentsOptions = KnowledgeResolveOptions & {
+  page?: number;
+  limit?: number;
+  keyword?: string;
+  status?: KnowledgeDocumentListStatus;
+  sort?: string;
+  fetch?: boolean | string;
+  appCode?: string;
+  roles?: KnowledgeRoles;
+};
+
+export type KnowledgeGetDocumentOptions = KnowledgeResolveOptions & {
+  documentId: string;
+  appCode?: string;
+  roles?: KnowledgeRoles;
+};
+
+export type KnowledgeListSegmentsOptions = KnowledgeGetDocumentOptions & {
+  page?: number;
+  limit?: number;
+  keyword?: string;
+  enabled?: boolean | "all";
+  status?: string;
+  hitCountGte?: number;
+};
+
+export type KnowledgeUploadDocumentOptions = KnowledgeResolveOptions & {
+  file: File | Blob;
+  fileName?: string;
+  appCode?: string;
+  config?: Record<string, unknown>;
+};
+
+export type KnowledgeIndexingStatusOptions = KnowledgeResolveOptions & {
+  batch: string;
+};
+
+export type KnowledgeWaitForIndexingOptions = KnowledgeIndexingStatusOptions & {
+  intervalMs?: number;
+  timeoutMs?: number;
+};
+
+export type KnowledgeDeleteDocumentOptions = KnowledgeResolveOptions & {
+  documentId: string;
+  appCode?: string;
+};
+
+export type KnowledgeUpdateDocumentsMetadataOptions = KnowledgeResolveOptions &
+  KnowledgeMetadataUpdateRequest;
+
+export interface KnowledgeClientAPI {
+  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 }>>;
+}