@breadstone/archipel-mcp 0.0.52 → 0.0.53

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.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`\>

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

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligenceRealtimeModelLoaders'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeModelLoaders
+
+```ts
+type IntelligenceRealtimeModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
+```
+
+Defined in: providers/IntelligenceRealtimeModelLoaders.ts:13
+
+Maps configured intelligence providers to tree-shakable realtime model loaders.

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

@@ -0,0 +1,159 @@
+---
+title: 'Type Alias: IntelligenceRealtimeServerEvent'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeServerEvent
+
+```ts
+type IntelligenceRealtimeServerEvent = 
+  | {
+  raw: unknown;
+  sessionId?: string;
+  type: "session-created";
+}
+  | {
+  raw: unknown;
+  type: "session-updated";
+}
+  | {
+  itemId?: string;
+  raw: unknown;
+  type: "speech-started";
+}
+  | {
+  itemId?: string;
+  raw: unknown;
+  type: "speech-stopped";
+}
+  | {
+  itemId?: string;
+  previousItemId?: string;
+  raw: unknown;
+  type: "audio-committed";
+}
+  | {
+  item: unknown;
+  itemId: string;
+  raw: unknown;
+  type: "conversation-item-added";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  transcript: string;
+  type: "input-transcription-completed";
+}
+  | {
+  raw: unknown;
+  responseId: string;
+  type: "response-created";
+}
+  | {
+  raw: unknown;
+  responseId: string;
+  status: string;
+  type: "response-done";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "output-item-added";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "output-item-done";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "content-part-added";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "content-part-done";
+}
+  | {
+  delta: string;
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "audio-delta";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "audio-done";
+}
+  | {
+  delta: string;
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "audio-transcript-delta";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  transcript?: string;
+  type: "audio-transcript-done";
+}
+  | {
+  delta: string;
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "text-delta";
+}
+  | {
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  text?: string;
+  type: "text-done";
+}
+  | {
+  callId: string;
+  delta: string;
+  itemId: string;
+  raw: unknown;
+  responseId: string;
+  type: "function-call-arguments-delta";
+}
+  | {
+  arguments: string;
+  callId: string;
+  itemId: string;
+  name: string;
+  raw: unknown;
+  responseId: string;
+  type: "function-call-arguments-done";
+}
+  | {
+  code?: string;
+  message: string;
+  raw: unknown;
+  type: "error";
+}
+  | {
+  raw: unknown;
+  rawType: string;
+  type: "custom";
+};
+```
+
+Defined in: realtime/contracts/IntelligenceRealtimeServerEvent.ts:10
+
+Provider-neutral event emitted by a realtime model.
+
+The original provider event remains available through `raw` for audited
+provider-specific diagnostics without leaking provider contracts into the
+normal application flow.

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

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligenceRealtimeStatus'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceRealtimeStatus
+
+```ts
+type IntelligenceRealtimeStatus = "idle" | "connecting" | "connected" | "closing" | "closed" | "error";
+```
+
+Defined in: realtime/contracts/IntelligenceRealtimeStatus.ts:6
+
+Describes the lifecycle state of an upstream realtime model connection.

package/data/packages/platform-intelligence/api/index.md

@@ -17,6 +17,10 @@ editUrl: false
 | [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure. |
 | [IntelligenceProviderAssetUploader](Class.IntelligenceProviderAssetUploader) | Uploads provider-managed files and skills for reuse in AI SDK calls. |
 | [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
+| [IntelligenceRealtimeError](Class.IntelligenceRealtimeError) | Error raised by a realtime session, transport, or metering adapter. |
+| [IntelligenceRealtimeMeteringPort](Class.IntelligenceRealtimeMeteringPort) | Application port for idempotently persisting realtime billing and audit events. |
+| [IntelligenceRealtimeSessionFactory](Class.IntelligenceRealtimeSessionFactory) | Creates and owns server-side, provider-neutral realtime AI sessions. |
+| [IntelligenceRealtimeSessionPort](Class.IntelligenceRealtimeSessionPort) | Provider-neutral control surface for one realtime model connection. |
 | [IntelligenceStructuredGenerator](Class.IntelligenceStructuredGenerator) | Executes AI SDK structured-output generation. |
 | [IntelligenceTelemetryRegistry](Class.IntelligenceTelemetryRegistry) | Registers AI SDK telemetry integrations for the current process. |
 | [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
@@ -31,6 +35,15 @@ editUrl: false
 | [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
 | [IIntelligenceModuleOptions](Interface.IIntelligenceModuleOptions) | Options for configuring the intelligence module. |
 | [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
+| [IIntelligenceRealtimeAudioFormat](Interface.IIntelligenceRealtimeAudioFormat) | Provider-neutral audio format configuration. |
+| [IIntelligenceRealtimeCloseEvent](Interface.IIntelligenceRealtimeCloseEvent) | Describes why an upstream realtime connection closed. |
+| [IIntelligenceRealtimeModuleOptions](Interface.IIntelligenceRealtimeModuleOptions) | Module-level resilience and resource limits for realtime intelligence. |
+| [IIntelligenceRealtimeSessionConfiguration](Interface.IIntelligenceRealtimeSessionConfiguration) | Provider-neutral configuration for a realtime AI session. |
+| [IIntelligenceRealtimeSessionOptions](Interface.IIntelligenceRealtimeSessionOptions) | Options used to create one server-owned realtime model connection. |
+| [IIntelligenceRealtimeToolDefinition](Interface.IIntelligenceRealtimeToolDefinition) | Provider-neutral function definition exposed to a realtime model. |
+| [IIntelligenceRealtimeTranscriptionConfiguration](Interface.IIntelligenceRealtimeTranscriptionConfiguration) | Provider-neutral transcription configuration. |
+| [IIntelligenceRealtimeTurnDetectionConfiguration](Interface.IIntelligenceRealtimeTurnDetectionConfiguration) | Provider-neutral voice activity detection configuration. |
+| [IIntelligenceRealtimeUsage](Interface.IIntelligenceRealtimeUsage) | Normalized token usage reported by a realtime provider. |
 | [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion) | Represents the normalized completion result produced by the intelligence provider. |
 | [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions) | Options that can be supplied when generating text with the intelligence provider. |
 | [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator) | Abstraction responsible for executing text completions using the configured provider. |
@@ -45,6 +58,13 @@ editUrl: false
 | [IntelligenceLanguageModelLoader](TypeAlias.IntelligenceLanguageModelLoader) | Represents a factory responsible for creating a configured language model instance. |
 | [IntelligenceLanguageModelLoaders](TypeAlias.IntelligenceLanguageModelLoaders) | Maps configured intelligence providers to their tree-shakable model loader. |
 | [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
+| [IntelligenceRealtimeClientEvent](TypeAlias.IntelligenceRealtimeClientEvent) | Provider-neutral event sent from an application to a realtime model. |
+| [IntelligenceRealtimeMetadataValue](TypeAlias.IntelligenceRealtimeMetadataValue) | Serializable metadata copied into realtime metering events. |
+| [IntelligenceRealtimeMeteringEvent](TypeAlias.IntelligenceRealtimeMeteringEvent) | Durable metering event emitted by an Archipel realtime session. |
+| [IntelligenceRealtimeModelLoader](TypeAlias.IntelligenceRealtimeModelLoader) | Creates a configured Vercel AI SDK realtime model behind the Archipel facade. |
+| [IntelligenceRealtimeModelLoaders](TypeAlias.IntelligenceRealtimeModelLoaders) | Maps configured intelligence providers to tree-shakable realtime model loaders. |
+| [IntelligenceRealtimeServerEvent](TypeAlias.IntelligenceRealtimeServerEvent) | Provider-neutral event emitted by a realtime model. |
+| [IntelligenceRealtimeStatus](TypeAlias.IntelligenceRealtimeStatus) | Describes the lifecycle state of an upstream realtime model connection. |
 | [IntelligenceTextStream](TypeAlias.IntelligenceTextStream) | Native AI SDK streaming result returned by the intelligence text generator. |
 
 ## Variables
@@ -137,6 +157,9 @@ editUrl: false
 | [createProviderOptions](Function.createProviderOptions) | Creates the provider options object consumed by the AI SDK model factories. |
 | [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Creates the Anthropic language model from the resolved provider configuration. |
 | [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) | Creates the Google Gemini language model from the resolved provider configuration. |
+| [loadGoogleRealtimeModel](Function.loadGoogleRealtimeModel) | Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider. |
 | [loadGrokLanguageModel](Function.loadGrokLanguageModel) | Creates the Grok language model through the native xAI provider. |
+| [loadGrokRealtimeModel](Function.loadGrokRealtimeModel) | Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider. |
 | [loadMimoLanguageModel](Function.loadMimoLanguageModel) | Creates the Xiaomi MiMo language model from the resolved provider configuration. |
 | [loadOpenAILanguageModel](Function.loadOpenAILanguageModel) | Creates the OpenAI language model from the resolved provider configuration. |
+| [loadOpenAIRealtimeModel](Function.loadOpenAIRealtimeModel) | Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider. |