@breadstone/archipel-platform-intelligence

Classes

Class	Description
DefaultIntelligencePromptPolicyAdapter	Default prompt policy that supports native settings and automatic model selection.
IntelligenceAgentFactory	Creates AI SDK 7 tool-loop agents with platform-registered tools merged in.
IntelligenceConfigurationError	Error thrown when an intelligence provider configuration is invalid or missing.
IntelligenceEmbeddingGenerator	Executes AI SDK embedding operations.
IntelligenceHealthIndicator	Health indicator for the intelligence infrastructure. Verifies that the intelligence provider configuration can be resolved.
IntelligenceMediaGenerator	Executes AI SDK media generation and understanding operations.
IntelligenceModule	Core module exposing the shared intelligence infrastructure.
IntelligencePromptExecutor	Validates and executes reusable intelligence prompt invocations.
IntelligencePromptPolicyPort	Resolves provider-neutral prompt requirements into effective generation settings.
IntelligenceProviderAssetUploader	Uploads provider-managed files and skills for reuse in AI SDK calls.
IntelligenceProviderError	Error thrown when an intelligence provider call fails.
IntelligenceRealtimeError	Error raised by a realtime session, transport, or metering adapter.
IntelligenceRealtimeMeteringPort	Application port for idempotently persisting realtime billing and audit events.
IntelligenceRealtimeSessionFactory	Creates and owns server-side, provider-neutral realtime AI sessions.
IntelligenceRealtimeSessionPort	Provider-neutral control surface for one realtime model connection.
IntelligenceStructuredGenerator	Executes AI SDK structured-output generation.
IntelligenceTelemetryRegistry	Registers AI SDK telemetry integrations for the current process.
IntelligenceTextGenerator	Executes text completions using the configured intelligence provider.
IntelligenceToolBase	Base class for class-based AI SDK tools.
IntelligenceToolRegistry	Registry for class-based intelligence tools.
IntelligenceValidationError	Error thrown when an intelligence input validation fails.

Interfaces

Interface	Description
IIntelligenceCompletionUsage	Captures usage telemetry returned by the intelligence provider.
IIntelligenceModuleOptions	Options for configuring the intelligence module.
IIntelligencePromptDefinition	Reusable, immutable definition of an intelligence prompt.
IIntelligencePromptEffectivePolicy	Effective settings resolved for one prompt execution.
IIntelligencePromptExecutionContext	Application context made available to prompt policy adapters.
IIntelligencePromptExecutionPolicy	Native settings and provider-neutral requirements declared by an intelligence prompt.
IIntelligencePromptExecutionResult	Normalized result of an intelligence prompt execution.
IIntelligencePromptInvocation	Bound prompt definition ready for execution.
IIntelligencePromptPolicyRequest	Policy resolution request for one prompt invocation.
IIntelligencePromptRenderContext	Input exposed to pure prompt rendering functions.
IIntelligenceProviderConfiguration	Describes the resolved configuration for the intelligence provider.
IIntelligenceRealtimeAudioFormat	Provider-neutral audio format configuration.
IIntelligenceRealtimeCloseEvent	Describes why an upstream realtime connection closed.
IIntelligenceRealtimeModuleOptions	Module-level resilience and resource limits for realtime intelligence.
IIntelligenceRealtimeSessionConfiguration	Provider-neutral configuration for a realtime AI session.
IIntelligenceRealtimeSessionOptions	Options used to create one server-owned realtime model connection.
IIntelligenceRealtimeToolDefinition	Provider-neutral function definition exposed to a realtime model.
IIntelligenceRealtimeTranscriptionConfiguration	Provider-neutral transcription configuration.
IIntelligenceRealtimeTurnDetectionConfiguration	Provider-neutral voice activity detection configuration.
IIntelligenceRealtimeUsage	Normalized token usage reported by a realtime provider.
IIntelligenceTextCompletion	Represents the normalized completion result produced by the intelligence provider.
IIntelligenceTextGenerationOptions	Options that can be supplied when generating text with the intelligence provider.
IIntelligenceTextGenerator	Abstraction responsible for executing text completions using the configured provider.
IIntelligenceTextStreamingOptions	Options that can be supplied when streaming text with the intelligence provider.
IIntelligenceTool	Minimal shape required by the intelligence tool registry.
IIntelligenceToolRegistry	Contract for the intelligence tool registry.

Type Aliases

Type Alias	Description
IIntelligencePromptModelRequirement	Model selection requested by a reusable intelligence prompt.
IntelligenceLanguageModelLoader	Represents a factory responsible for creating a configured language model instance.
IntelligenceLanguageModelLoaders	Maps configured intelligence providers to their tree-shakable model loader.
IntelligencePromptCapability	Provider-neutral capability required by an intelligence prompt.
IntelligencePromptDefinitionConfiguration	Configuration accepted by intelligencePrompt.
IntelligencePromptGenerationOptions	Native generation settings that can be stored on a prompt definition.
IntelligencePromptLatency	Latency profile requested by an intelligence prompt.
IntelligencePromptMode	Supported execution modes for reusable intelligence prompts.
IntelligencePromptQuality	Provider-neutral model quality requested by an intelligence prompt.
IntelligencePromptReasoning	Provider-neutral reasoning effort requested by an intelligence prompt.
IntelligenceProviderName	Represents the union of supported intelligence provider identifiers.
IntelligenceRealtimeClientEvent	Provider-neutral event sent from an application to a realtime model.
IntelligenceRealtimeMetadataValue	Serializable metadata copied into realtime metering events.
IntelligenceRealtimeMeteringEvent	Durable metering event emitted by an Archipel realtime session.
IntelligenceRealtimeModelLoader	Creates a configured Vercel AI SDK realtime model behind the Archipel facade.
IntelligenceRealtimeModelLoaders	Maps configured intelligence providers to tree-shakable realtime model loaders.
IntelligenceRealtimeServerEvent	Provider-neutral event emitted by a realtime model.
IntelligenceRealtimeStatus	Describes the lifecycle state of an upstream realtime model connection.
IntelligenceTextStream	Native AI SDK streaming result returned by the intelligence text generator.

Variables

Variable	Description
ANTHROPIC_API_KEY	Anthropic-specific API key.
ANTHROPIC_BASE_URL	Anthropic-specific base URL.
ANTHROPIC_CONFIG_ENTRIES	Configuration entries used by the Anthropic intelligence provider.
AnthropicIntelligenceToolNames	Anthropic provider-defined tool names exposed through Archipel.
GEMINI_API_KEY	Google-specific Gemini API key alias.
GOOGLE_API_KEY	Google-specific API key.
GOOGLE_BASE_URL	Google-specific base URL.
GOOGLE_CONFIG_ENTRIES	Configuration entries used by the Google intelligence provider.
GoogleIntelligenceToolNames	Google provider-defined tool names exposed through Archipel.
GROK_API_KEY	Grok-specific API key.
GROK_BASE_URL	Grok-specific base URL.
GROK_CONFIG_ENTRIES	Configuration entries used by the Grok intelligence provider.
GrokIntelligenceToolNames	Grok provider-defined tool names exposed through Archipel.
INTELLIGENCE_API_KEY	Global API key override for the intelligence provider.
INTELLIGENCE_BASE_URL	Global base URL override for the intelligence provider.
INTELLIGENCE_MAX_OUTPUT_TOKENS	Maximum number of output tokens for the AI model.
INTELLIGENCE_MODEL	AI model identifier to use for text generation.
INTELLIGENCE_PROVIDER	Intelligence provider name (e.g. openai, anthropic, google, grok, mimo).
INTELLIGENCE_TEMPERATURE	Sampling temperature for the AI model.
INTELLIGENCE_TOP_P	Top-p (nucleus sampling) for the AI model.
IntelligenceProviderNames	Enumerates the supported model providers powering the intelligence pipeline.
MIMO_API_KEY	MiMo-specific API key.
MIMO_BASE_URL	MiMo-specific base URL.
MIMO_CONFIG_ENTRIES	Configuration entries used by the MiMo intelligence provider.
OPENAI_API_KEY	OpenAI-specific API key.
OPENAI_BASE_URL	OpenAI-specific base URL.
OPENAI_CONFIG_ENTRIES	Configuration entries used by the OpenAI intelligence provider.
OpenAIIntelligenceToolNames	OpenAI provider-defined tool names exposed through Archipel.
PLATFORM_INTELLIGENCE_CONFIG_ENTRIES	All configuration entries required by platform-intelligence.
XAI_API_KEY	xAI-specific API key alias for Grok.
XAI_BASE_URL	xAI-specific base URL alias for Grok.

Functions

Function	Description
createAnthropicAdvisor20260301Tool	Creates an Anthropic advisor tool registration.
createAnthropicBash20241022Tool	Creates an Anthropic bash tool registration for the 2024-10-22 version.
createAnthropicBash20250124Tool	Creates an Anthropic bash tool registration for the 2025-01-24 version.
createAnthropicCodeExecution20250522Tool	Creates an Anthropic code-execution tool registration for the 2025-05-22 version.
createAnthropicCodeExecution20250825Tool	Creates an Anthropic code-execution tool registration for the 2025-08-25 version.
createAnthropicCodeExecution20260120Tool	Creates an Anthropic code-execution tool registration for the 2026-01-20 version.
createAnthropicComputer20241022Tool	Creates an Anthropic computer-use tool registration for the 2024-10-22 version.
createAnthropicComputer20250124Tool	Creates an Anthropic computer-use tool registration for the 2025-01-24 version.
createAnthropicComputer20251124Tool	Creates an Anthropic computer-use tool registration for the 2025-11-24 version.
createAnthropicMemory20250818Tool	Creates an Anthropic memory tool registration.
createAnthropicTextEditor20241022Tool	Creates an Anthropic text-editor tool registration for the 2024-10-22 version.
createAnthropicTextEditor20250124Tool	Creates an Anthropic text-editor tool registration for the 2025-01-24 version.
createAnthropicTextEditor20250429Tool	Creates an Anthropic text-editor tool registration for the 2025-04-29 version.
createAnthropicTextEditor20250728Tool	Creates an Anthropic text-editor tool registration for the 2025-07-28 version.
createAnthropicToolSearchBM2520251119Tool	Creates an Anthropic BM25 tool-search tool registration.
createAnthropicToolSearchRegex20251119Tool	Creates an Anthropic regex tool-search tool registration.
createAnthropicWebFetch20250910Tool	Creates an Anthropic web-fetch tool registration for the 2025-09-10 version.
createAnthropicWebFetch20260209Tool	Creates an Anthropic web-fetch tool registration for the 2026-02-09 version.
createAnthropicWebSearch20250305Tool	Creates an Anthropic web-search tool registration for the 2025-03-05 version.
createAnthropicWebSearch20260209Tool	Creates an Anthropic web-search tool registration for the 2026-02-09 version.
createGoogleCodeExecutionTool	Creates a Google code-execution tool registration.
createGoogleEnterpriseWebSearchTool	Creates a Google enterprise-web-search tool registration.
createGoogleFileSearchTool	Creates a Google file-search tool registration.
createGoogleGoogleMapsTool	Creates a Google Maps grounding tool registration.
createGoogleGoogleSearchTool	Creates a Google Search grounding tool registration.
createGoogleUrlContextTool	Creates a Google URL context tool registration.
createGoogleVertexRagStoreTool	Creates a Google Vertex RAG Store tool registration.
createGrokCodeExecutionTool	Creates a Grok code-execution tool registration.
createGrokFileSearchTool	Creates a Grok file-search tool registration.
createGrokMcpServerTool	Creates a Grok MCP server tool registration.
createGrokViewImageTool	Creates a Grok image-understanding tool registration.
createGrokViewXVideoTool	Creates a Grok X-video understanding tool registration.
createGrokWebSearchTool	Creates a Grok web-search tool registration.
createGrokXSearchTool	Creates a Grok X-search tool registration.
createIntelligenceTool	Adapts a native AI SDK tool to the Archipel intelligence tool schema.
createMimoCustomTool	Creates a MiMo function tool registration.
createOpenAIApplyPatchTool	Creates an OpenAI apply-patch tool registration.
createOpenAICodeInterpreterTool	Creates an OpenAI code-interpreter tool registration.
createOpenAICustomTool	Creates an OpenAI custom provider-defined tool registration.
createOpenAIFileSearchTool	Creates an OpenAI file-search tool registration.
createOpenAIImageGenerationTool	Creates an OpenAI image-generation tool registration.
createOpenAILocalShellTool	Creates an OpenAI local-shell tool registration.
createOpenAIMcpTool	Creates an OpenAI MCP connector tool registration.
createOpenAIShellTool	Creates an OpenAI shell tool registration.
createOpenAIToolSearchTool	Creates an OpenAI tool-search tool registration.
createOpenAIWebSearchPreviewTool	Creates an OpenAI web-search-preview tool registration.
createOpenAIWebSearchTool	Creates an OpenAI web-search tool registration.
createProviderOptions	Creates the provider options object consumed by the AI SDK model factories.
intelligencePrompt	Creates a reusable intelligence prompt definition.
loadAnthropicLanguageModel	Creates the Anthropic language model from the resolved provider configuration.
loadGoogleLanguageModel	Creates the Google Gemini language model from the resolved provider configuration.
loadGoogleRealtimeModel	Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider.
loadGrokLanguageModel	Creates the Grok language model through the native xAI provider.
loadGrokRealtimeModel	Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider.
loadMimoLanguageModel	Creates the Xiaomi MiMo language model from the resolved provider configuration.
loadOpenAILanguageModel	Creates the OpenAI language model from the resolved provider configuration.
loadOpenAIRealtimeModel	Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider.