OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

pfo.documents.upload

Stores an object in tenant storage and schedules ingestion into the knowledge base.

  • Type: operation (command)
  • Version: 1.0.0
  • Tags: documents, ingestion
  • File: packages/examples/pocket-family-office/src/operations/index.ts
  • field.key.label
    pfo.documents.upload
    field.version.label
    1.0.0
    field.type.label
    operation (command)
    field.title.label
    pfo.documents.upload
    field.description.label

    Stores an object in tenant storage and schedules ingestion into the knowledge base.

  • Type: operation (command)
  • Version: 1.0.0
  • Tags: documents, ingestion
  • File: packages/examples/pocket-family-office/src/operations/index.ts
  • field.tags.label
    documents,ingestion
    field.owners.label
    field.stability.label

    Stores an object in tenant storage and schedules ingestion into the knowledge base.

    Goal

    Allow users to ingest financial documents for processing.

    Context

    Part of the finance domain. Documents are uploaded to object storage and then processed by the ingestion pipeline.

    Source Definition

    import { OPENBANKING_TELEMETRY_EVENTS } from '@lssm-tech/lib.contracts-integrations';
    import {
    	defineCommand,
    	defineQuery,
    	type OperationSpec,
    } from '@lssm-tech/lib.contracts-spec';
    import {
    	OwnersEnum,
    	StabilityEnum,
    	TagsEnum,
    } from '@lssm-tech/lib.contracts-spec/ownership';
    import {
    	defineEnum,
    	defineSchemaModel,
    	ScalarTypeEnum,
    	type ZodSchemaModel,
    } from '@lssm-tech/lib.schema';
    
    export const uploadDocumentContract = defineCommand({
    	meta: {
    		key: 'pfo.documents.upload',
    		version: '1.0.0',
    		description:
    			'Stores an object in tenant storage and schedules ingestion into the knowledge base.',
    		goal: 'Allow users to ingest financial documents for processing.',
    		context:
    			'Part of the finance domain. Documents are uploaded to object storage and then processed by the ingestion pipeline.',
    		owners: [OwnersEnum.PlatformFinance],
    		tags: ['documents', 'ingestion', TagsEnum.Guide],
    		stability: StabilityEnum.Experimental,
    	},
    	io: {
    		input: UploadDocumentInputModel,
    		output: UploadDocumentOutputModel,
    	},
    	policy: {
    		auth: 'user',
    		rateLimit: {
    			rpm: 30, // 30 points per 60s approx, simplified to rpm
    			key: 'user',
    		},
    	},
    	// Telemetry events removed as new spec does not support 'events' list in telemetry block
    });