@breadstone/archipel-mcp 0.0.52 → 0.0.54

package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md

@@ -0,0 +1,110 @@
+---
+title: 'Class: IntelligenceRealtimeError'
+generated: true
+editUrl: false
+---
+# Class: IntelligenceRealtimeError
+
+Defined in: [errors/IntelligenceRealtimeError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L12)
+
+Error raised by a realtime session, transport, or metering adapter.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceRealtimeError(
+   message, 
+   phase, 
+   provider, 
+   model, 
+   sessionId, 
+   isRetryable, 
+   cause?): IntelligenceRealtimeError;
+```
+
+Defined in: [errors/IntelligenceRealtimeError.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L25)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `phase` | \| `"configuration"` \| `"token"` \| `"connect"` \| `"send"` \| `"receive"` \| `"metering"` \| `"close"` |
+| `provider` | [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName) |
+| `model` | `string` |
+| `sessionId` | `string` |
+| `isRetryable` | `boolean` |
+| `cause?` | `Error` |
+
+#### Returns
+
+`IntelligenceRealtimeError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### isRetryable
+
+```ts
+readonly isRetryable: boolean;
+```
+
+Defined in: [errors/IntelligenceRealtimeError.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L19)
+
+***
+
+### model
+
+```ts
+readonly model: string;
+```
+
+Defined in: [errors/IntelligenceRealtimeError.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L17)
+
+***
+
+### phase
+
+```ts
+readonly phase: 
+  | "configuration"
+  | "token"
+  | "connect"
+  | "send"
+  | "receive"
+  | "metering"
+  | "close";
+```
+
+Defined in: [errors/IntelligenceRealtimeError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L15)
+
+***
+
+### provider
+
+```ts
+readonly provider: IntelligenceProviderName;
+```
+
+Defined in: [errors/IntelligenceRealtimeError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L16)
+
+***
+
+### sessionId
+
+```ts
+readonly sessionId: string;
+```
+
+Defined in: [errors/IntelligenceRealtimeError.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L18)

package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md

@@ -0,0 +1,47 @@
+---
+title: 'Abstract Class: IntelligenceRealtimeMeteringPort'
+generated: true
+editUrl: false
+---
+# Abstract Class: IntelligenceRealtimeMeteringPort
+
+Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L15)
+
+Application port for idempotently persisting realtime billing and audit events.
+
+Implementations should treat `eventId` as an idempotency key and persist the
+commercial debit and AI audit record in one application transaction.
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceRealtimeMeteringPort(): IntelligenceRealtimeMeteringPort;
+```
+
+#### Returns
+
+`IntelligenceRealtimeMeteringPort`
+
+## Methods
+
+### report()
+
+```ts
+abstract report(event): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L23)
+
+Persists one metering event.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `event` | [`IntelligenceRealtimeMeteringEvent`](TypeAlias.IntelligenceRealtimeMeteringEvent) | Normalized, idempotently identifiable metering event. |
+
+#### Returns
+
+`Promise`\<`void`\>

package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md

@@ -0,0 +1,129 @@
+---
+title: 'Class: IntelligenceRealtimeSessionFactory'
+generated: true
+editUrl: false
+---
+# Class: IntelligenceRealtimeSessionFactory
+
+Defined in: [IntelligenceRealtimeSessionFactory.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L35)
+
+Creates and owns server-side, provider-neutral realtime AI sessions.
+
+Applications forward normalized events and audio chunks through their own
+authenticated WebSocket gateway. Provider credentials, provider event
+mappings, token creation, and upstream sockets remain inside Archipel.
+
+## Implements
+
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceRealtimeSessionFactory(
+   configService, 
+   toolRegistry, 
+   metering, 
+   providerLoaders, 
+   runtime): IntelligenceRealtimeSessionFactory;
+```
+
+Defined in: [IntelligenceRealtimeSessionFactory.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L55)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+| `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) |
+| `metering` | [`IntelligenceRealtimeMeteringPort`](Class.IntelligenceRealtimeMeteringPort) |
+| `providerLoaders` | [`IntelligenceRealtimeModelLoaders`](TypeAlias.IntelligenceRealtimeModelLoaders) |
+| `runtime` | `IIntelligenceRealtimeRuntimeOptions` |
+
+#### Returns
+
+`IntelligenceRealtimeSessionFactory`
+
+## Accessors
+
+### activeSessionCount
+
+#### Get Signature
+
+```ts
+get activeSessionCount(): number;
+```
+
+Defined in: [IntelligenceRealtimeSessionFactory.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L74)
+
+Number of sessions currently owned by this module instance.
+
+##### Returns
+
+`number`
+
+***
+
+### registeredProviders
+
+#### Get Signature
+
+```ts
+get registeredProviders(): readonly IntelligenceProviderName[];
+```
+
+Defined in: [IntelligenceRealtimeSessionFactory.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L79)
+
+Providers currently registered for server-owned realtime sessions.
+
+##### Returns
+
+readonly [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)[]
+
+## Methods
+
+### createSession()
+
+```ts
+createSession(options): Promise<IntelligenceRealtimeSessionPort>;
+```
+
+Defined in: [IntelligenceRealtimeSessionFactory.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L93)
+
+Creates an isolated realtime session without opening the upstream socket.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IIntelligenceRealtimeSessionOptions`](Interface.IIntelligenceRealtimeSessionOptions) | Logical session, provider, model, tools, and event callbacks. |
+
+#### Returns
+
+`Promise`\<[`IntelligenceRealtimeSessionPort`](Class.IntelligenceRealtimeSessionPort)\>
+
+A provider-neutral session. Call `connect()` to start streaming.
+
+***
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [IntelligenceRealtimeSessionFactory.ts:132](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L132)
+
+Closes all owned upstream sessions during Nest application shutdown.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy
+```

package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md

@@ -0,0 +1,308 @@
+---
+title: 'Abstract Class: IntelligenceRealtimeSessionPort'
+generated: true
+editUrl: false
+---
+# Abstract Class: IntelligenceRealtimeSessionPort
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L14)
+
+Provider-neutral control surface for one realtime model connection.
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceRealtimeSessionPort(): IntelligenceRealtimeSessionPort;
+```
+
+#### Returns
+
+`IntelligenceRealtimeSessionPort`
+
+## Accessors
+
+### connectionId
+
+#### Get Signature
+
+```ts
+get abstract connectionId(): string;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L18)
+
+##### Returns
+
+`string`
+
+***
+
+### model
+
+#### Get Signature
+
+```ts
+get abstract model(): string;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L20)
+
+##### Returns
+
+`string`
+
+***
+
+### provider
+
+#### Get Signature
+
+```ts
+get abstract provider(): IntelligenceProviderName;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L19)
+
+##### Returns
+
+[`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)
+
+***
+
+### sessionId
+
+#### Get Signature
+
+```ts
+get abstract sessionId(): string;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L17)
+
+##### Returns
+
+`string`
+
+***
+
+### status
+
+#### Get Signature
+
+```ts
+get abstract status(): IntelligenceRealtimeStatus;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L21)
+
+##### Returns
+
+[`IntelligenceRealtimeStatus`](TypeAlias.IntelligenceRealtimeStatus)
+
+## Methods
+
+### addToolOutput()
+
+```ts
+abstract addToolOutput(
+   callId, 
+   output, 
+name?): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L56)
+
+Returns a completed function result to the model.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callId` | `string` |
+| `output` | `unknown` |
+| `name?` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### appendAudio()
+
+```ts
+abstract appendAudio(audio): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L34)
+
+Appends a base64-encoded audio fragment to the upstream input buffer.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `audio` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### cancelResponse()
+
+```ts
+abstract cancelResponse(): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L53)
+
+Cancels the active model response.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### clearAudio()
+
+```ts
+abstract clearAudio(): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L40)
+
+Clears the provider input audio buffer.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### close()
+
+```ts
+abstract close(code?, reason?): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L59)
+
+Gracefully closes the upstream connection and flushes metering events.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `code?` | `number` |
+| `reason?` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### commitAudio()
+
+```ts
+abstract commitAudio(): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L37)
+
+Commits the provider input audio buffer.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### connect()
+
+```ts
+abstract connect(): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L28)
+
+Opens the upstream provider WebSocket and applies the session configuration.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### requestResponse()
+
+```ts
+abstract requestResponse(options?): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L46)
+
+Requests a new model response.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | \{ `instructions?`: `string`; `metadata?`: `Readonly`\<`Record`\<`string`, `unknown`\>\>; `modalities?`: readonly `string`[]; \} |
+| `options.instructions?` | `string` |
+| `options.metadata?` | `Readonly`\<`Record`\<`string`, `unknown`\>\> |
+| `options.modalities?` | readonly `string`[] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### send()
+
+```ts
+abstract send(event): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L31)
+
+Sends any provider-neutral client event.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | [`IntelligenceRealtimeClientEvent`](TypeAlias.IntelligenceRealtimeClientEvent) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### sendText()
+
+```ts
+abstract sendText(text, requestResponse?): Promise<void>;
+```
+
+Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L43)
+
+Sends a text turn and optionally asks the model to respond.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `text` | `string` |
+| `requestResponse?` | `boolean` |
+
+#### Returns
+
+`Promise`\<`void`\>

package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: IntelligenceTextGenerator
 
-Defined in: [IntelligenceTextGenerator.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L57)
+Defined in: [IntelligenceTextGenerator.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L34)
 
 Executes text completions using the configured intelligence provider.
 
@@ -26,7 +26,7 @@ new IntelligenceTextGenerator(
    validateOnModuleInit?): IntelligenceTextGenerator;
 ```
 
-Defined in: [IntelligenceTextGenerator.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L72)
+Defined in: [IntelligenceTextGenerator.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L49)
 
 #### Parameters
 
@@ -49,7 +49,7 @@ Defined in: [IntelligenceTextGenerator.ts:72](https://github.com/RueDeRennes/arc
 generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
 ```
 
-Defined in: [IntelligenceTextGenerator.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L113)
+Defined in: [IntelligenceTextGenerator.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L90)
 
 Generates a completion using the configured provider.
 
@@ -76,7 +76,7 @@ Generates a completion using the configured provider.
 getConfiguration(): IIntelligenceProviderConfiguration;
 ```
 
-Defined in: [IntelligenceTextGenerator.ts:290](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L290)
+Defined in: [IntelligenceTextGenerator.ts:270](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L270)
 
 Returns the resolved provider configuration with the API key redacted.
 
@@ -96,7 +96,7 @@ Returns the resolved provider configuration with the API key redacted.
 onModuleInit(): Promise<void>;
 ```
 
-Defined in: [IntelligenceTextGenerator.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L97)
+Defined in: [IntelligenceTextGenerator.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L74)
 
 Eagerly resolves configuration at startup to fail fast on missing keys.
 
@@ -118,7 +118,7 @@ OnModuleInit.onModuleInit
 streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Context, Output<string, string, never>>>;
 ```
 
-Defined in: [IntelligenceTextGenerator.ts:215](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L215)
+Defined in: [IntelligenceTextGenerator.ts:195](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L195)
 
 Streams a completion using the configured provider.
 

package/data/packages/platform-intelligence/api/Function.intelligencePrompt.md

@@ -0,0 +1,31 @@
+---
+title: 'Function: intelligencePrompt()'
+generated: true
+editUrl: false
+---
+# Function: intelligencePrompt()
+
+```ts
+function intelligencePrompt<TInput, TOutput>(configuration): IIntelligencePromptDefinition<TInput, TOutput, "object" | "text">;
+```
+
+Defined in: [prompts/intelligencePrompt.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/intelligencePrompt.ts#L15)
+
+Creates a reusable intelligence prompt definition.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TInput` | - |
+| `TOutput` | `string` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configuration` | [`IntelligencePromptDefinitionConfiguration`](TypeAlias.IntelligencePromptDefinitionConfiguration)\<`TInput`, `TOutput`\> |
+
+## Returns
+
+[`IIntelligencePromptDefinition`](Interface.IIntelligencePromptDefinition)\<`TInput`, `TOutput`, `"object"` \| `"text"`\>

package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md

@@ -0,0 +1,25 @@
+---
+title: 'Function: loadGoogleRealtimeModel()'
+generated: true
+editUrl: false
+---
+# Function: loadGoogleRealtimeModel()
+
+```ts
+function loadGoogleRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
+```
+
+Defined in: [providers/google/loadGoogleRealtimeModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleRealtimeModel.ts#L17)
+
+Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
+| `options` | `IIntelligenceRealtimeModelLoaderOptions` |
+
+## Returns
+
+`Promise`\<`RealtimeModelV4`\>