@breadstone/archipel-mcp 0.0.51 → 0.0.53

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md

@@ -0,0 +1,135 @@
+---
+title: 'Interface: IIntelligenceRealtimeSessionConfiguration'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRealtimeSessionConfiguration
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:18
+
+Provider-neutral configuration for a realtime AI session.
+
+This contract intentionally mirrors the stable Archipel surface instead of
+exposing the AI SDK's experimental realtime types to applications.
+
+## Properties
+
+### inputAudioFormat?
+
+```ts
+readonly optional inputAudioFormat?: IIntelligenceRealtimeAudioFormat;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:31
+
+Input audio format.
+
+***
+
+### inputAudioTranscription?
+
+```ts
+readonly optional inputAudioTranscription?: IIntelligenceRealtimeTranscriptionConfiguration;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:34
+
+Optional input transcription settings.
+
+***
+
+### instructions?
+
+```ts
+readonly optional instructions?: string;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:22
+
+System instructions for the model.
+
+***
+
+### outputAudioFormat?
+
+```ts
+readonly optional outputAudioFormat?: IIntelligenceRealtimeAudioFormat;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:40
+
+Output audio format.
+
+***
+
+### outputAudioTranscription?
+
+```ts
+readonly optional outputAudioTranscription?: IIntelligenceRealtimeTranscriptionConfiguration;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:37
+
+Optional spoken-output transcription settings.
+
+***
+
+### outputModalities?
+
+```ts
+readonly optional outputModalities?: readonly ("text" | "audio")[];
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:28
+
+Modalities the model may produce.
+
+***
+
+### providerOptions?
+
+```ts
+readonly optional providerOptions?: Readonly<Record<string, unknown>>;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:49
+
+Provider-specific escape hatch retained inside the Archipel boundary.
+
+***
+
+### tools?
+
+```ts
+readonly optional tools?: readonly IIntelligenceRealtimeToolDefinition[];
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:46
+
+Explicit tool definitions. Registered Archipel tools are used when omitted.
+
+***
+
+### turnDetection?
+
+```ts
+readonly optional turnDetection?: 
+  | IIntelligenceRealtimeTurnDetectionConfiguration
+  | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:43
+
+Voice activity detection settings, or `null` for push-to-talk.
+
+***
+
+### voice?
+
+```ts
+readonly optional voice?: string;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:25
+
+Provider voice identifier for spoken model output.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md

@@ -0,0 +1,148 @@
+---
+title: 'Interface: IIntelligenceRealtimeSessionOptions'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRealtimeSessionOptions
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:16
+
+Options used to create one server-owned realtime model connection.
+
+## Properties
+
+### activeToolNames?
+
+```ts
+readonly optional activeToolNames?: readonly string[];
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:32
+
+Optional allow-list of registered Archipel tools exposed to this session.
+
+***
+
+### metadata?
+
+```ts
+readonly optional metadata?: Readonly<Record<string, IntelligenceRealtimeMetadataValue>>;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:35
+
+Bounded, non-sensitive correlation metadata copied to metering events.
+
+***
+
+### model
+
+```ts
+readonly model: string;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:23
+
+Realtime model identifier such as `gpt-realtime`.
+
+***
+
+### onClose?
+
+```ts
+readonly optional onClose?: (event) => void | Promise<void>;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:44
+
+Receives the terminal upstream connection state.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | [`IIntelligenceRealtimeCloseEvent`](Interface.IIntelligenceRealtimeCloseEvent) |
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### onError?
+
+```ts
+readonly optional onError?: (error) => void | Promise<void>;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:41
+
+Receives transport, provider, parsing, and metering adapter failures.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `error` | `Error` |
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### onEvent?
+
+```ts
+readonly optional onEvent?: (event) => void | Promise<void>;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:38
+
+Receives normalized provider events in wire order.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | [`IntelligenceRealtimeServerEvent`](TypeAlias.IntelligenceRealtimeServerEvent) |
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### provider?
+
+```ts
+readonly optional provider?: IntelligenceProviderName;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:26
+
+Optional provider override. Defaults to the configured intelligence provider.
+
+***
+
+### sessionConfiguration?
+
+```ts
+readonly optional sessionConfiguration?: IIntelligenceRealtimeSessionConfiguration;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:29
+
+Provider-neutral realtime session configuration.
+
+***
+
+### sessionId
+
+```ts
+readonly sessionId: string;
+```
+
+Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:20
+
+Application-owned identifier used for persistence, billing, and audit correlation.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IIntelligenceRealtimeToolDefinition'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRealtimeToolDefinition
+
+Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:6
+
+Provider-neutral function definition exposed to a realtime model.
+
+## Properties
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:16
+
+Optional model-facing description.
+
+***
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:13
+
+Unique tool name within the session.
+
+***
+
+### parameters
+
+```ts
+readonly parameters: Record<string, unknown>;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:19
+
+JSON Schema describing the function parameters.
+
+***
+
+### type
+
+```ts
+readonly type: "function";
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:10
+
+Tool kind.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md

@@ -0,0 +1,46 @@
+---
+title: 'Interface: IIntelligenceRealtimeTranscriptionConfiguration'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRealtimeTranscriptionConfiguration
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:6
+
+Provider-neutral transcription configuration.
+
+## Properties
+
+### language?
+
+```ts
+readonly optional language?: string;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:13
+
+Optional BCP 47 language hint.
+
+***
+
+### model?
+
+```ts
+readonly optional model?: string;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:10
+
+Provider-specific transcription model.
+
+***
+
+### prompt?
+
+```ts
+readonly optional prompt?: string;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:16
+
+Optional prompt used to guide the transcription.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IIntelligenceRealtimeTurnDetectionConfiguration'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRealtimeTurnDetectionConfiguration
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:6
+
+Provider-neutral voice activity detection configuration.
+
+## Properties
+
+### prefixPaddingMs?
+
+```ts
+readonly optional prefixPaddingMs?: number;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:19
+
+Audio retained before detected speech starts.
+
+***
+
+### silenceDurationMs?
+
+```ts
+readonly optional silenceDurationMs?: number;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:16
+
+Silence duration that closes a turn.
+
+***
+
+### threshold?
+
+```ts
+readonly optional threshold?: number;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:13
+
+Activation threshold between zero and one.
+
+***
+
+### type
+
+```ts
+readonly type: "server-vad" | "semantic-vad" | "disabled";
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:10
+
+Voice activity detection strategy.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md

@@ -0,0 +1,103 @@
+---
+title: 'Interface: IIntelligenceRealtimeUsage'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceRealtimeUsage
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:9
+
+Normalized token usage reported by a realtime provider.
+
+Null values mean the provider did not expose that dimension. Applications
+can therefore distinguish missing data from an actual zero-token count.
+
+## Properties
+
+### cachedInputTokens
+
+```ts
+readonly cachedInputTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:15
+
+***
+
+### inputAudioTokens
+
+```ts
+readonly inputAudioTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:17
+
+***
+
+### inputTextTokens
+
+```ts
+readonly inputTextTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:16
+
+***
+
+### inputTokens
+
+```ts
+readonly inputTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:12
+
+***
+
+### outputAudioTokens
+
+```ts
+readonly outputAudioTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:19
+
+***
+
+### outputTextTokens
+
+```ts
+readonly outputTextTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:18
+
+***
+
+### outputTokens
+
+```ts
+readonly outputTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:13
+
+***
+
+### rawUsage
+
+```ts
+readonly rawUsage: unknown;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:20
+
+***
+
+### totalTokens
+
+```ts
+readonly totalTokens: number | null;
+```
+
+Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:14

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md

@@ -6,7 +6,7 @@ editUrl: false
 # Type Alias: IntelligenceLanguageModelLoader
 
 ```ts
-type IntelligenceLanguageModelLoader = (configuration) => LanguageModelV4;
+type IntelligenceLanguageModelLoader = (configuration) => Promise<LanguageModelV4>;
 ```
 
 Defined in: [providers/IntelligenceLanguageModelLoader.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoader.ts#L13)
@@ -21,4 +21,4 @@ Represents a factory responsible for creating a configured language model instan
 
 ## Returns
 
-`LanguageModelV4`
+`Promise`\<`LanguageModelV4`\>

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md

@@ -0,0 +1,64 @@
+---
+title: 'Type Alias: IntelligenceRealtimeClientEvent'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeClientEvent
+
+```ts
+type IntelligenceRealtimeClientEvent = 
+  | {
+  config: IIntelligenceRealtimeSessionConfiguration;
+  type: "session-update";
+}
+  | {
+  audio: string;
+  type: "input-audio-append";
+}
+  | {
+  type: "input-audio-commit";
+}
+  | {
+  type: "input-audio-clear";
+}
+  | {
+  item:   | {
+     role: "user";
+     text: string;
+     type: "text-message";
+   }
+     | {
+     audio: string;
+     role: "user";
+     type: "audio-message";
+   }
+     | {
+     callId: string;
+     name?: string;
+     output: string;
+     type: "function-call-output";
+   };
+  type: "conversation-item-create";
+}
+  | {
+  audioEndMs: number;
+  contentIndex: number;
+  itemId: string;
+  type: "conversation-item-truncate";
+}
+  | {
+  options?: {
+     instructions?: string;
+     metadata?: Readonly<Record<string, unknown>>;
+     modalities?: ReadonlyArray<string>;
+  };
+  type: "response-create";
+}
+  | {
+  type: "response-cancel";
+};
+```
+
+Defined in: realtime/contracts/IntelligenceRealtimeClientEvent.ts:12
+
+Provider-neutral event sent from an application to a realtime model.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligenceRealtimeMetadataValue'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeMetadataValue
+
+```ts
+type IntelligenceRealtimeMetadataValue = string | number | boolean | null;
+```
+
+Defined in: realtime/contracts/IntelligenceRealtimeMetadataValue.ts:6
+
+Serializable metadata copied into realtime metering events.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md

@@ -0,0 +1,44 @@
+---
+title: 'Type Alias: IntelligenceRealtimeMeteringEvent'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeMeteringEvent
+
+```ts
+type IntelligenceRealtimeMeteringEvent = 
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  startedAt: string;
+  type: "session-started";
+}
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  durationMs: number;
+  final: boolean;
+  periodEndedAt: string;
+  periodStartedAt: string;
+  sequence: number;
+  type: "billing-interval";
+}
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  responseId: string | null;
+  type: "provider-usage";
+  usage: IIntelligenceRealtimeUsage;
+}
+  | IIntelligenceRealtimeMeteringEnvelope & {
+  closeCode: number;
+  closeReason: string;
+  durationMs: number;
+  endedAt: string;
+  startedAt: string;
+  type: "session-ended";
+};
+```
+
+Defined in: realtime/contracts/IntelligenceRealtimeMeteringEvent.ts:44
+
+Durable metering event emitted by an Archipel realtime session.
+
+`billing-interval` events provide a provider-independent 30-second billing
+basis by default. `provider-usage` carries exact token dimensions whenever
+the upstream provider exposes them. Consumers can persist both in one audit
+transaction and choose their commercial charging strategy independently.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md

@@ -0,0 +1,25 @@
+---
+title: 'Type Alias: IntelligenceRealtimeModelLoader'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeModelLoader
+
+```ts
+type IntelligenceRealtimeModelLoader = (configuration, options) => Promise<RealtimeModelV4>;
+```
+
+Defined in: providers/IntelligenceRealtimeModelLoader.ts:14
+
+Creates a configured Vercel AI SDK realtime model behind the Archipel facade.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
+| `options` | `IIntelligenceRealtimeModelLoaderOptions` |
+
+## Returns
+
+`Promise`\<`RealtimeModelV4`\>