@lovrabet/sdk 1.6.1-beta.4 → 1.6.1-beta.5

package/README.md

@@ -1655,3 +1655,9 @@ const client = createClient({ authMode: "openapi", token, timestamp });
 - ❌ **源代码不公开** - 本 SDK 为闭源软件
 
 如需商业授权或有疑问，请访问 [lovrabet.com](https://www.lovrabet.com)
+
+## 独立知识库服务
+
+通过 `createKnowledgeClient({ kbServiceDomain, accessKey })` 调用个人知识库的 page/getOne/create/update 和知识搜索。KB origin 必须由调用方显式配置，客户端不从 Runtime 或 Region 推导地址。每个方法只发送一次请求；文件读取、分页聚合、CAS 前读和写后核对由调用方负责。
+
+完整请求、返回类型和错误处理见 [Knowledge Service Contract](wiki/topics/knowledge-service-contract.md)。

package/dist/index.d.ts

@@ -3588,5 +3588,136 @@ declare const isTokenExpiring: typeof isTokenExpiring$1;
  */
 declare const getTokenRemainingTime: typeof getTokenRemainingTime$1;
 
-export { API_PATHS, AbstractBaseModel, ApiNamespace, AppClient, ApprovalClient, ArtifactClient, AuthManager, CONFIG_NAMES, ClientAkBffClient, ClientAkModel, ClientAkSqlClient, DEFAULTS, DatasetMetaClient, ENVIRONMENTS, ERROR_MESSAGES, FileClient, HTTP_STATUS, LovrabetError, LovrabetFlowClient, ManagementClient, ModelFactory, OCR_TYPES, OcrClient, OcrType, OpenApiModel, PermitClient, PersonalBffClient, PersonalNamespace, REGIONS, ServicesNamespace, SortOrder, TokenGenerator, WebApiModel, clearAllRegistrations, createAppClient, createClient, generateFlowOpenApiToken, generateOpenApiToken, getApiEndpoint, getAvailableEnvironments, getAvailableRegions, getRegisteredConfigNames, getRegisteredModels, getTokenRemainingTime, isTokenExpiring, registerModels, safe, sqlSafe, unregisterModels };
-export type { AggregateField, AggregateParams, AppClientConfig, AppDatasetActionRolePermitVO, AppDatasetPermitVO, AppDatasetRolePermitVO, AppEmployee, AppMenuPermitVO, AppPermitBaseVO, AppResourceMenuParam, AppRoleCreateParam, AppRolePermitQueryParam, AppRoleRequest, AppRoleUpdateParam, AppRoleUserVO, AppRoleVO, AppUserBaseVO, ApprovalFlowApproveRequest, ApprovalFlowIdentityLink, ApprovalFlowTaskDetail, ApprovalFlowTaskItem, ApprovalFlowTransferCandidate, ApprovalFlowTransferRequest, ApprovalTodoQuery, ArtifactListQuery, ArtifactUpsertRequest, AuthMode, BaseModelMethods, BaseRoleVO, ClientAkBffExecuteRequest, ClientConfig, ConditionOperator, CustomSqlQueryRequest, DataList, DatasetDrivenDataQuery, DatasetImportBatchRequest, DatasetImportBatchResult, DatasetImportContract, DatasetImportImageReadbackRequest, DatasetImportImageRequest, DatasetImportImageResult, DatasetImportReadbackRequest, DatasetImportReadbackResult, DatasetMeta, DatasetPermitListVO, DatasetRequest, DatasetRolePermitListVO, EndpointScriptSummary, Environment$1 as Environment, FieldCondition, FileQueryUrlRequest, FileService, FileUploadRequest, FileUploadResponse, FileUrlResponse, FilterParams, FlowBatchTaskActionRequest, FlowBatchTransferRequest, FlowCcQuery, FlowCcRequest, FlowCustomPageCcDetail, FlowCustomPageDefinition, FlowCustomPageStartResponse, FlowCustomPageSubmittedProcess, FlowCustomPageTaskDetail, FlowCustomPageTaskItem, FlowCustomPageTimeline, FlowDefinitionQuery, FlowPage, FlowPageQuery, FlowProcessReasonRequest, FlowRecord, FlowResubmitRequest, FlowReturnRequest, FlowReturnTarget, FlowStartRequest, FlowSubmittedQuery, FlowTaskActionRequest, FlowTransferRequest, FlowUpdateVariablesRequest, FlowVariableProjectionQuery, FlowVariableQuery, GenerateFlowTokenParams, GenerateTokenParams, HavingCondition, ListParams, ListResponse, LoginUserInfo, LovrabetClient$1 as LovrabetClient, LovrabetPersonal, LovrabetServices, MenuPermitDTO, MenuRolePermitListVO, MenuRolePermitNodeVO, ModelConfig, ModelsConfig, NotificationChannelConfig, OcrRecognizeRequest, OcrRecognizeResponse, OcrService, PageResult, Paging$1 as Paging, PersonalBffExecuteRequest, PersonalBffScript, PersonalBffService, PersonalBffUpsertRequest, PersonalRequestOptions, Region, ResourcePermitDTO, ResourcePermitParam, RoleUserUpdateParam, RuntimeArtifactDTO, RuntimeIdentityPermission, SafeResult, ScriptDefinition, ScriptLogQuery, SelectOption, SelectOptionsParams, ServiceRequestOptions, SmartApp, SortList, SqlExecuteRequest, SqlExecuteResult, SqlSafeResult, TokenResult, UserAccountBindRequest, UserAppRelation, UserAppRelationQueryParam, UserCustomSqlDTO, WhereCondition };
+/** Explicit KB origin and current user AK; no Runtime routing or credential discovery. */
+interface KnowledgeClientConfig {
+    kbServiceDomain: string;
+    accessKey: string;
+    invokeSource?: string;
+}
+interface KnowledgeRequestOptions {
+    signal?: AbortSignal;
+}
+interface KnowledgeAppRequest {
+    appCode: string;
+}
+interface PersonalKnowledgeGetRequest extends KnowledgeAppRequest {
+    id: string;
+}
+interface PersonalKnowledgeCreateRequest extends KnowledgeAppRequest {
+    title: string;
+    content: string;
+}
+interface PersonalKnowledgeUpdateRequest extends PersonalKnowledgeGetRequest {
+    title?: string;
+    /** Omitted/null preserves the body; an empty string clears it. */
+    content?: string | null;
+    expectedVersion?: number;
+}
+interface PersonalKnowledgePageRequest extends KnowledgeAppRequest {
+    currentPage?: number;
+    pageSize?: number;
+    view?: 'summary' | 'content';
+    allowContentReferences?: boolean;
+}
+interface PersonalKnowledgeRecord {
+    id: string;
+    appCode: string;
+    scope: 'personal';
+    userId: string;
+    title: string;
+    content: string | null;
+    contentDeferred?: boolean;
+    version: number;
+    ragStatus: 'READY' | 'PENDING' | 'UNKNOWN' | 'DELETING' | 'DELETED' | 'DISABLED';
+    ragErrorMessage: string | null;
+    createTime: string | null;
+    updateTime: string | null;
+}
+interface PersonalKnowledgeDocument extends PersonalKnowledgeRecord {
+    content: string;
+}
+interface PersonalKnowledgePage {
+    tableData: PersonalKnowledgeRecord[];
+    paging: {
+        currentPage: number;
+        pageSize: number;
+        totalCount: number;
+    };
+    tableColumns?: unknown[];
+    execResult?: null;
+    extend?: null;
+}
+type KnowledgeSearchScope = 'public' | 'company' | 'personal';
+interface KnowledgeSearchRequest extends KnowledgeAppRequest {
+    query: string;
+    topK?: number;
+    tags?: string[];
+    scopes?: KnowledgeSearchScope[];
+}
+interface KnowledgeSearchHit {
+    documentId: string;
+    revision: number;
+    chunkId: string;
+    scope: KnowledgeSearchScope;
+    title: string;
+    text: string;
+    tags: string[];
+    rank: number;
+    rawScore: number;
+    finalScore: number;
+    scoreKind: string;
+}
+/** Native service data. CLI presentation fields deliberately do not belong here. */
+interface KnowledgeSearchResult {
+    hits: KnowledgeSearchHit[];
+    strategyFingerprint: string;
+    timingsMs: Record<string, number>;
+}
+
+type KnowledgeErrorKind = 'validation' | 'auth' | 'http' | 'contract' | 'cancelled' | 'timeout' | 'network';
+/** Safe to serialize: never attaches credentials, knowledge content or upstream exception text. */
+declare class KnowledgeServiceError extends LovrabetError {
+    readonly kind: KnowledgeErrorKind;
+    constructor(kind: KnowledgeErrorKind, message: string, options?: {
+        status?: number;
+        code?: string;
+        writeUncertain?: boolean;
+    });
+    readonly writeUncertain: boolean;
+    toJSON(): {
+        kind: KnowledgeErrorKind;
+        writeUncertain: boolean;
+        description: ErrorDescription;
+        cause: unknown;
+        retryAfter?: string;
+        name: string;
+        message: string;
+        status: number;
+        code: string;
+        response: any;
+    };
+}
+
+declare const KNOWLEDGE_PATHS: Readonly<{
+    page: "/api/knowledge-base/personal/page";
+    getOne: "/api/knowledge-base/personal/get-one";
+    create: "/api/knowledge-base/personal/create";
+    update: "/api/knowledge-base/personal/update";
+    search: "/api/knowledge-base/search";
+}>;
+declare function normalizeKnowledgeServiceOrigin(input: string): string;
+
+/** Independent KB Service client. Each method makes exactly one request, without orchestration/retries. */
+declare function createKnowledgeClient(config: KnowledgeClientConfig): {
+    personal: {
+        page(input: PersonalKnowledgePageRequest, options?: KnowledgeRequestOptions): Promise<PersonalKnowledgePage>;
+        getOne(input: PersonalKnowledgeGetRequest, options?: KnowledgeRequestOptions): Promise<PersonalKnowledgeDocument>;
+        create(input: PersonalKnowledgeCreateRequest, options?: KnowledgeRequestOptions): Promise<PersonalKnowledgeDocument>;
+        update(input: PersonalKnowledgeUpdateRequest, options?: KnowledgeRequestOptions): Promise<PersonalKnowledgeDocument>;
+    };
+    search(input: KnowledgeSearchRequest, options?: KnowledgeRequestOptions): Promise<KnowledgeSearchResult>;
+};
+type KnowledgeClient = ReturnType<typeof createKnowledgeClient>;
+
+export { API_PATHS, AbstractBaseModel, ApiNamespace, AppClient, ApprovalClient, ArtifactClient, AuthManager, CONFIG_NAMES, ClientAkBffClient, ClientAkModel, ClientAkSqlClient, DEFAULTS, DatasetMetaClient, ENVIRONMENTS, ERROR_MESSAGES, FileClient, HTTP_STATUS, KNOWLEDGE_PATHS, KnowledgeServiceError, LovrabetError, LovrabetFlowClient, ManagementClient, ModelFactory, OCR_TYPES, OcrClient, OcrType, OpenApiModel, PermitClient, PersonalBffClient, PersonalNamespace, REGIONS, ServicesNamespace, SortOrder, TokenGenerator, WebApiModel, clearAllRegistrations, createAppClient, createClient, createKnowledgeClient, generateFlowOpenApiToken, generateOpenApiToken, getApiEndpoint, getAvailableEnvironments, getAvailableRegions, getRegisteredConfigNames, getRegisteredModels, getTokenRemainingTime, isTokenExpiring, normalizeKnowledgeServiceOrigin, registerModels, safe, sqlSafe, unregisterModels };
+export type { AggregateField, AggregateParams, AppClientConfig, AppDatasetActionRolePermitVO, AppDatasetPermitVO, AppDatasetRolePermitVO, AppEmployee, AppMenuPermitVO, AppPermitBaseVO, AppResourceMenuParam, AppRoleCreateParam, AppRolePermitQueryParam, AppRoleRequest, AppRoleUpdateParam, AppRoleUserVO, AppRoleVO, AppUserBaseVO, ApprovalFlowApproveRequest, ApprovalFlowIdentityLink, ApprovalFlowTaskDetail, ApprovalFlowTaskItem, ApprovalFlowTransferCandidate, ApprovalFlowTransferRequest, ApprovalTodoQuery, ArtifactListQuery, ArtifactUpsertRequest, AuthMode, BaseModelMethods, BaseRoleVO, ClientAkBffExecuteRequest, ClientConfig, ConditionOperator, CustomSqlQueryRequest, DataList, DatasetDrivenDataQuery, DatasetImportBatchRequest, DatasetImportBatchResult, DatasetImportContract, DatasetImportImageReadbackRequest, DatasetImportImageRequest, DatasetImportImageResult, DatasetImportReadbackRequest, DatasetImportReadbackResult, DatasetMeta, DatasetPermitListVO, DatasetRequest, DatasetRolePermitListVO, EndpointScriptSummary, Environment$1 as Environment, FieldCondition, FileQueryUrlRequest, FileService, FileUploadRequest, FileUploadResponse, FileUrlResponse, FilterParams, FlowBatchTaskActionRequest, FlowBatchTransferRequest, FlowCcQuery, FlowCcRequest, FlowCustomPageCcDetail, FlowCustomPageDefinition, FlowCustomPageStartResponse, FlowCustomPageSubmittedProcess, FlowCustomPageTaskDetail, FlowCustomPageTaskItem, FlowCustomPageTimeline, FlowDefinitionQuery, FlowPage, FlowPageQuery, FlowProcessReasonRequest, FlowRecord, FlowResubmitRequest, FlowReturnRequest, FlowReturnTarget, FlowStartRequest, FlowSubmittedQuery, FlowTaskActionRequest, FlowTransferRequest, FlowUpdateVariablesRequest, FlowVariableProjectionQuery, FlowVariableQuery, GenerateFlowTokenParams, GenerateTokenParams, HavingCondition, KnowledgeAppRequest, KnowledgeClient, KnowledgeClientConfig, KnowledgeErrorKind, KnowledgeRequestOptions, KnowledgeSearchHit, KnowledgeSearchRequest, KnowledgeSearchResult, KnowledgeSearchScope, ListParams, ListResponse, LoginUserInfo, LovrabetClient$1 as LovrabetClient, LovrabetPersonal, LovrabetServices, MenuPermitDTO, MenuRolePermitListVO, MenuRolePermitNodeVO, ModelConfig, ModelsConfig, NotificationChannelConfig, OcrRecognizeRequest, OcrRecognizeResponse, OcrService, PageResult, Paging$1 as Paging, PersonalBffExecuteRequest, PersonalBffScript, PersonalBffService, PersonalBffUpsertRequest, PersonalKnowledgeCreateRequest, PersonalKnowledgeDocument, PersonalKnowledgeGetRequest, PersonalKnowledgePage, PersonalKnowledgePageRequest, PersonalKnowledgeRecord, PersonalKnowledgeUpdateRequest, PersonalRequestOptions, Region, ResourcePermitDTO, ResourcePermitParam, RoleUserUpdateParam, RuntimeArtifactDTO, RuntimeIdentityPermission, SafeResult, ScriptDefinition, ScriptLogQuery, SelectOption, SelectOptionsParams, ServiceRequestOptions, SmartApp, SortList, SqlExecuteRequest, SqlExecuteResult, SqlSafeResult, TokenResult, UserAccountBindRequest, UserAppRelation, UserAppRelationQueryParam, UserCustomSqlDTO, WhereCondition };