@tstdl/base 0.93.125 → 0.93.126

package/document-management/server/services/document-management-ai-provider.service.d.ts

@@ -0,0 +1,66 @@
+import type { DocumentCategoryView } from '../../../document-management/service-models/categories-and-types.view-model.js';
+import type { DocumentPropertyValueView } from '../../../document-management/service-models/document-management.view-model.js';
+import type { AiConfiguration, Document, DocumentManagementAiConfiguration, DocumentProperty, DocumentType, DocumentWorkflowStep } from '../../models/index.js';
+import type { DocumentValidationExecutorContext } from '../validators/validator.js';
+export type AiConfigurationResolveDataMap = {
+    [DocumentWorkflowStep.ContentExtraction]: {
+        document: Document;
+    };
+    [DocumentWorkflowStep.Classification]: {
+        document: Document;
+        categories: DocumentCategoryView[];
+    };
+    [DocumentWorkflowStep.DataExtraction]: {
+        document: Document;
+        type: DocumentType;
+        properties: DocumentProperty[] | undefined;
+    };
+    [DocumentWorkflowStep.Assignment]: {
+        document: Document;
+        properties: DocumentPropertyValueView[] | undefined;
+        collectionIds: string[];
+    };
+    [DocumentWorkflowStep.Validation]: DocumentValidationExecutorContext;
+};
+export declare abstract class DocumentManagementAiProviderService {
+    /**
+     * Resolves the global AI configuration (e.g. language, global defaults).
+     * @param tenantId The tenant ID.
+     * @returns The resolved global AI configuration, or undefined if no configuration is found.
+     */
+    abstract getGlobalConfiguration(tenantId: string): DocumentManagementAiConfiguration | undefined | Promise<DocumentManagementAiConfiguration | undefined>;
+    /**
+     * Resolves the AI configuration for the content extraction step.
+     * @param tenantId The tenant ID.
+     * @param data The content extraction data.
+     * @returns The resolved AI configuration, or undefined if no specific configuration is found.
+     */
+    abstract getContentExtractionConfiguration(tenantId: string, data: AiConfigurationResolveDataMap[typeof DocumentWorkflowStep.ContentExtraction]): AiConfiguration | undefined | Promise<AiConfiguration | undefined>;
+    /**
+     * Resolves the AI configuration for the classification step.
+     * @param tenantId The tenant ID.
+     * @returns The resolved AI configuration, or undefined if no specific configuration is found.
+     */
+    abstract getClassificationConfiguration(tenantId: string, data: AiConfigurationResolveDataMap[typeof DocumentWorkflowStep.Classification]): AiConfiguration | undefined | Promise<AiConfiguration | undefined>;
+    /**
+     * Resolves the AI configuration for the data extraction step.
+     * @param tenantId The tenant ID.
+     * @param data The data extraction data.
+     * @returns The resolved AI configuration, or undefined if no specific configuration is found.
+     */
+    abstract getDataExtractionConfiguration(tenantId: string, data: AiConfigurationResolveDataMap[typeof DocumentWorkflowStep.DataExtraction]): AiConfiguration | undefined | Promise<AiConfiguration | undefined>;
+    /**
+     * Resolves the AI configuration for the assignment step.
+     * @param tenantId The tenant ID.
+     * @param data The assignment data.
+     * @returns The resolved AI configuration, or undefined if no specific configuration is found.
+     */
+    abstract getAssignmentConfiguration(tenantId: string, data: AiConfigurationResolveDataMap[typeof DocumentWorkflowStep.Assignment]): AiConfiguration | undefined | Promise<AiConfiguration | undefined>;
+    /**
+     * Resolves the AI configuration for a specific validation.
+     * @param tenantId The tenant ID.
+     * @param data The validation data.
+     * @returns The resolved AI configuration, or undefined if no specific configuration is found.
+     */
+    abstract getValidationConfiguration(tenantId: string, data: AiConfigurationResolveDataMap[typeof DocumentWorkflowStep.Validation]): AiConfiguration | undefined | Promise<AiConfiguration | undefined>;
+}

package/document-management/server/services/document-management-ai-provider.service.js

@@ -0,0 +1,2 @@
+export class DocumentManagementAiProviderService {
+}

package/document-management/server/services/document-management-ai.service.d.ts

@@ -1,24 +1,61 @@
-import type { DocumentPropertyDataType } from '../../models/index.js';
-import { Document } from '../../models/index.js';
-type DocumentInformationExtractionPropertyResult = {
+import { type TstdlGenkitGenerationOptions } from '../../../ai/genkit/index.js';
+import { type Instructions } from '../../../ai/prompts/index.js';
+import { type SchemaTestable } from '../../../schema/index.js';
+import type { ObjectLiteral } from '../../../types/types.js';
+import type { ModelReference } from 'genkit';
+import type { AiConfiguration, DocumentPropertyDataType, InstructionOverride } from '../../models/index.js';
+import { Document, DocumentWorkflowStep } from '../../models/index.js';
+import { type AiConfigurationResolveDataMap } from './document-management-ai-provider.service.js';
+type DocumentDataExtractionPropertyResult = {
     propertyId: string;
     dataType: DocumentPropertyDataType;
     value: string | number | boolean;
 };
-export type DocumentInformationExtractionResult = {
+export type DocumentDataExtractionResult = {
     title: string;
     subtitle: string | null;
     date: number | null;
     summary: string;
     tags: string[];
-    properties: DocumentInformationExtractionPropertyResult[];
+    properties: DocumentDataExtractionPropertyResult[];
+};
+declare const dataExtractionInstructionsRaw: {
+    'JSON Output': import("../../../ai/prompts/index.js").InstructionsList;
+    Role: string;
+    Task: string;
+    'Field Specific Instructions': {
+        Title: string;
+        Subtitle: string;
+        Summary: string;
+        Tags: string;
+        Date: string;
+    };
+    'Property Extraction': string[];
 };
 export declare class DocumentManagementAiService {
     #private;
-    extractDocumentContent(tenantId: string, documentId: string): Promise<string>;
+    extractContent(tenantId: string, documentId: string): Promise<string>;
     classifyDocumentType(tenantId: string, documentId: string): Promise<string>;
-    extractDocumentInformation(tenantId: string, documentId: string): Promise<DocumentInformationExtractionResult>;
+    extractData(tenantId: string, documentId: string): Promise<DocumentDataExtractionResult>;
     findSuitableCollectionsForDocument(document: Document, collectionIds: string[]): Promise<string[]>;
     findSuitableRequestForDocument(document: Document, collectionIds: string[]): Promise<string | null>;
+    protected runAi<T, Step extends DocumentWorkflowStep>(tenantId: string, step: Step, stepData: AiConfigurationResolveDataMap[Step], options: {
+        targetId?: string;
+        defaultModel: ModelReference<any>;
+        system: Instructions;
+        user: Instructions;
+        data?: ObjectLiteral;
+        schema: SchemaTestable<T>;
+        document?: Document;
+        config?: TstdlGenkitGenerationOptions<T, any>['config'];
+        aiConfig?: AiConfiguration;
+    }): Promise<T>;
+    private resolveAiConfiguration;
+    private mergeExtractionConfigs;
+    private resolveContextKeys;
 }
+export declare function mergeFieldInstructions(instructionsKey: keyof typeof dataExtractionInstructionsRaw['Field Specific Instructions'], field: keyof NonNullable<AiConfiguration['extraction']>, aiConfig: AiConfiguration): string;
+export declare function mergeInstructions(base: string, overrides: (InstructionOverride | undefined)[], options?: {
+    formatTemplate?: (format: string) => string;
+}): string;
 export {};