@pixel-brewery/archipel-platform-intelligence

Classes

Class	Description
AnthropicIntelligenceProviderAdapter	Anthropic adapter for language, files, and skills.
DefaultIntelligencePromptPolicyAdapter	Default prompt policy that supports native settings and automatic model selection.
GatewayIntelligenceProviderAdapter	Vercel AI Gateway adapter spanning all standardized model capabilities.
GoogleIntelligenceProviderAdapter	Google adapter for language, embeddings, images, speech, video, realtime, and files.
GrokIntelligenceProviderAdapter	xAI Grok adapter for language, image, speech, transcription, video, realtime, and files.
IntelligenceAgent	Reusable provider-neutral agent backed by the language capability.
IntelligenceAgentFactory	Creates reusable provider-neutral tool-loop agents.
IntelligenceConfigurationError	Error thrown when an intelligence provider configuration is invalid or missing.
IntelligenceEmbeddingGenerator	Provider-neutral single and batch embedding facade.
IntelligenceHealthIndicator	Health indicator for the intelligence infrastructure. Performs a bounded remote readiness probe for the default language model and reports the locally registered capability topology.
IntelligenceImageGenerator	Provider-neutral image generation facade.
IntelligenceLanguageGenerator	Provider-neutral language generation, structured output, and streaming facade.
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.
IntelligenceProviderAdapterPort	Port implemented by every intelligence provider adapter.
IntelligenceProviderAssetUploader	Uploads provider-managed files and skills behind provider-neutral contracts.
IntelligenceProviderDiagnostics	Performs bounded, provider-neutral provider availability diagnostics.
IntelligenceProviderError	Error thrown when an intelligence provider call fails.
IntelligenceProviderRegistry	Immutable registry of provider adapters and their supported capabilities.
IntelligenceRealtimeError	Error raised by a realtime session, transport, or metering adapter.
IntelligenceRealtimeMeteringPort	Application port for idempotently persisting realtime billing and audit events.
IntelligenceRealtimeSessionFactory	Creates server-owned WebSocket sessions, negotiates browser-owned WebRTC sessions, and ends browser-owned WebRTC sessions at their provider.
IntelligenceRealtimeSessionPort	Provider-neutral control surface for one realtime model connection.
IntelligenceReranker	Provider-neutral semantic reranking facade.
IntelligenceSpeechGenerator	Provider-neutral speech generation facade.
IntelligenceToolBase	Base class for class-based intelligence tools.
IntelligenceToolRegistry	Registry for class-based intelligence tools.
IntelligenceTranscriptionGenerator	Provider-neutral bounded and streaming transcription facade.
IntelligenceValidationError	Error thrown when an intelligence input validation fails.
IntelligenceVideoGenerator	Provider-neutral video generation facade.
MiMoIntelligenceProviderAdapter	Xiaomi MiMo OpenAI-compatible language adapter.
OpenAIIntelligenceProviderAdapter	OpenAI adapter for language, embeddings, images, audio, video, realtime, files, and skills.

Interfaces

Interface	Description
IIntelligenceAgentConfiguration	Reusable provider-neutral tool-loop agent configuration.
IIntelligenceDeferredToolLoadingOptions	On-demand exposure of a large composed tool catalog during one language call.
IIntelligenceDeferredToolLoadResult	Output of the built-in deferred tool loader.
IIntelligenceEmbeddingBatchOptions	Provider-neutral batch embedding options.
IIntelligenceEmbeddingBatchResult	Provider-neutral batch embedding result.
IIntelligenceEmbeddingOptions	Provider-neutral single-value embedding options.
IIntelligenceEmbeddingResult	Provider-neutral embedding result.
IIntelligenceFileUploadOptions	Provider-neutral file upload options.
IIntelligenceFileUploadResult	Normalized provider-managed file upload result.
IIntelligenceGeneratedFile	Binary content generated by an intelligence capability.
IIntelligenceGenerationStepStartEvent	Language generation step metadata.
IIntelligenceImageGenerationOptions	Provider-neutral image generation options.
IIntelligenceImageGenerationResult	Provider-neutral image generation result.
IIntelligenceLanguageCallCapacity	Immutable standardized input facts for one prepared language call.
IIntelligenceLanguageCompletion	Normalized language generation result.
IIntelligenceLanguageGenerationOptions	Provider-neutral language generation controls.
IIntelligenceLanguageStream	Provider-neutral text stream.
IIntelligenceModelReference	Selects a provider-owned model without exposing a provider SDK model object.
IIntelligenceModelRequestOptions	Shared provider/model controls for intelligence operations.
IIntelligenceModelStatus	Safe resolved model status that never includes credentials.
IIntelligenceModuleOptions	Options for configuring the intelligence module.
IIntelligenceObjectStream	Provider-neutral structured-output stream.
IIntelligencePreparedLanguageCall	Single-use language call whose local model, option, prompt, and tool preparation has already completed.
IIntelligencePrompt	Provider-neutral language-model prompt.
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.
IIntelligenceProviderCallStartEvent	Exact standardized input facts observed immediately before a provider call.
IIntelligenceProviderConfiguration	Describes the resolved configuration for the intelligence provider.
IIntelligenceProviderLoadRequest	Internal model/API load request passed to a provider adapter.
IIntelligenceProviderProbeResult	Provider-neutral result of a bounded provider availability probe.
IIntelligenceProviderWebRTCClosure	Outcome of ending a browser-owned WebRTC session through a provider's server control channel.
IIntelligenceProviderWebRTCConversationHistoryRequest	Provider request to add earlier conversation turns to the setup of one browser-owned WebRTC realtime session.
IIntelligenceProviderWebRTCTerminationRequest	Provider request to end one browser-owned WebRTC realtime session.
IIntelligenceRealtimeAudioFormat	Provider-neutral audio format configuration.
IIntelligenceRealtimeCloseEvent	Describes why an upstream realtime connection closed.
IIntelligenceRealtimeConversationTurn	One earlier turn of a conversation that a new browser-owned WebRTC session receives as quoted, untrusted context.
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 WebSocket realtime 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.
IIntelligenceRealtimeWebRTCConfiguration	Provider-neutral browser setup needed before creating a WebRTC SDP offer.
IIntelligenceRealtimeWebRTCSessionOptions	Server-side SDP exchange for a browser-owned WebRTC realtime session.
IIntelligenceRealtimeWebRTCSessionResult	SDP answer and data-channel information returned to the browser.
IIntelligenceRealtimeWebRTCTerminationOptions	Identifies one browser-owned WebRTC session that the server ends at its provider.
IIntelligenceRealtimeWebRTCTerminationResult	Result of ending a browser-owned WebRTC realtime session from the server.
IIntelligenceRequestOptions	Shared execution controls for bounded intelligence requests.
IIntelligenceRerankingOptions	Provider-neutral reranking options.
IIntelligenceRerankingResult	Provider-neutral reranking result.
IIntelligenceSkillUploadOptions	Provider-neutral skill bundle upload options.
IIntelligenceSkillUploadResult	Normalized provider-managed skill upload result.
IIntelligenceSpeechGenerationOptions	Provider-neutral speech generation options.
IIntelligenceSpeechGenerationResult	Provider-neutral speech generation result.
IIntelligenceStreamingTranscriptionOptions	Provider-neutral live transcription options.
IIntelligenceTool	Minimal shape required by the intelligence tool registry.
IIntelligenceToolCall	Tool call selected by a language model.
IIntelligenceToolDefinition	Provider-neutral application tool definition.
IIntelligenceToolExecutionEndEvent	Tool execution completion event.
IIntelligenceToolExecutionStartEvent	Tool execution start event.
IIntelligenceToolRegistry	Contract for the intelligence tool registry.
IIntelligenceTranscriptionOptions	Provider-neutral transcription options.
IIntelligenceTranscriptionResult	Provider-neutral transcription result.
IIntelligenceTranscriptionStream	Provider-neutral live transcription result.
IIntelligenceUsage	Provider-neutral usage counters.
IIntelligenceVideoGenerationOptions	Provider-neutral video generation options.
IIntelligenceVideoGenerationResult	Provider-neutral video generation result.

Type Aliases

Type Alias	Description
IIntelligenceModelMessage	Provider-neutral conversation message.
IIntelligencePromptModelRequirement	Model selection requested by a reusable intelligence prompt.
IIntelligenceSchema	Provider-neutral schema accepted by prompts, structured outputs, and tools.
IntelligenceCapability	Intelligence capability identifier.
IntelligenceDefaultModels	Capability-specific default provider and model references.
IntelligenceJsonValue	JSON-compatible value used by provider-neutral intelligence contracts.
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.
IntelligenceProviderOptions	Provider-specific request options kept behind an explicit escape hatch.
IntelligenceProviderProbeStatus	Normalized provider availability state.
IntelligenceProviderToolOptions	Opaque provider-tool configuration accepted only by provider-specific subpaths.
IntelligenceRealtimeClientEvent	Provider-neutral event sent from an application to a realtime model.
IntelligenceRealtimeConnectionMode	Connection mechanisms supported by the AI SDK realtime model contract.
IntelligenceRealtimeConversationHistoryStatus	Outcome of handing earlier conversation turns to a new browser-owned WebRTC session.
IntelligenceRealtimeMetadataValue	Serializable metadata copied into realtime metering events.
IntelligenceRealtimeMeteringEvent	Durable metering event emitted by an Archipel realtime session.
IntelligenceRealtimeServerEvent	Provider-neutral event emitted by a realtime model.
IntelligenceRealtimeStatus	Describes the lifecycle state of an upstream realtime model connection.
IntelligenceRealtimeWebRTCTerminationStatus	Outcome of ending a browser-owned WebRTC realtime session from the server.
IntelligenceRequestTimeouts	Capability-specific total request timeouts in milliseconds.
IntelligenceToolChoice	Provider-neutral tool-selection policy.
IntelligenceToolOutput	Provider-neutral tool result.
IntelligenceToolSet	Provider-neutral named tool collection.
IntelligenceTranscriptionStreamPart	Provider-neutral live transcription event.
IntelligenceValidationStage	Union type derived from IntelligenceValidationStages.

Variables

Variable	Description
AI_GATEWAY_API_KEY	Vercel AI Gateway API key.
AI_GATEWAY_BASE_URL	Vercel AI Gateway base URL.
AI_GATEWAY_CONFIG_ENTRIES	Configuration entries used by the Vercel AI Gateway provider.
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, gateway).
INTELLIGENCE_TEMPERATURE	Sampling temperature for the AI model.
INTELLIGENCE_TOP_P	Top-p (nucleus sampling) for the AI model.
IntelligenceCapabilityNames	Capability identifiers understood by the intelligence provider registry.
IntelligenceProviderNames	Enumerates the supported model providers powering the intelligence pipeline.
IntelligenceRealtimeConversationHistoryLimits	Provider-neutral bounds of the conversation history that a new browser-owned WebRTC session can receive.
IntelligenceValidationStages	Identifies which side of a provider call failed validation.
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	Provider-neutral 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.
createIntelligenceJsonSchema	Creates a provider-neutral JSON Schema wrapper.
createIntelligenceTool	Creates an Archipel intelligence tool registration.
createMimoCustomTool	Creates a provider-neutral function tool for MiMo.
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.
defineIntelligenceTool	Defines a provider-neutral intelligence tool while preserving its input and output types.
intelligencePrompt	Creates a reusable intelligence prompt definition.
provideIntelligenceTools	Creates a feature-owned Nest provider that contributes existing tool providers to the application-wide intelligence registry during module bootstrap.
validateIntelligenceSchema	Validates a value through an Archipel schema without exposing the underlying schema library.