Skip to content

Trasversale · Package · Active

@platform/contracts-ai

Shared contract package for the internal AI generation API exposed by platform-ai-service.

  • TypeScript declarations
  • Dual package exports

Spec sheet

Package name

@platform/contracts-ai

Repository path

platform-shared-packages/packages/contracts-ai

Primary consumer

platform-ai-service

Responsibilities

  • Define shared DTOs for provider listing and generation requests/responses.
  • Keep AI service consumers aligned with the service contract.

Interfaces and contract surface

  • Package root export

Consumers

Notes

  • This package is the contract anchor for future experience backends consuming shared AI.

Source references

  • platform-ai-service/README.md
  • platform-shared-packages/packages/contracts-ai/package.json

Contratti principali ​

AiProviderCapabilities espone:

  • textGeneration: generazione testuale disponibile.
  • metadata: il provider accetta metadata di correlazione.
  • customBaseUrl: il provider supporta endpoint custom.
  • structuredOutputs: il provider puo applicare uno schema JSON all'output.

AiGenerationRequest accetta providerKey?, model?, instructions?, input, metadata? e outputSchema?. outputSchema deve essere un oggetto JSON Schema alla radice; i consumer devono comunque validare il risultato sul proprio schema canonico prima di persisterlo o usarlo in workflow applicativi.

Workspace reference: /Users/jeanpaul/projects/cs-repository