ART Framework API Docs
    Preparing search index...

      ART Framework API Docs

      ART (Agentic Reasoning & Tool-use) Framework - Main Entry Point

      Welcome to the ART framework! This file is the primary public API surface for the library. It's structured to provide a clear and intuitive experience for developers, whether you're just getting started or building advanced, custom agentic systems.

      --- Quick Start --- For most use cases, you'll only need createArtInstance and the associated types.

      Example:

      import { createArtInstance } from 'art-framework';
      import type { ArtInstanceConfig } from 'art-framework';

      const config: ArtInstanceConfig = {
      storage: { type: 'memory' },
      providers: {
      openai: { adapter: 'openai', apiKey: '...' }
      },
      tools: [new CalculatorTool()],
      persona: {
      name: 'MyAgent',
      prompts: {
      synthesis: 'You are MyAgent. Always answer in rhyme.'
      }
      }
      };

      const art = await createArtInstance(config);
      const response = await art.process({ query: "Hello, world!" });

      --- API Structure ---

      1. Core Factory: The main function to create an ART instance.
      2. Primary Interfaces & Types: Essential types for configuration and interaction.
      3. Built-in Components: Concrete implementations of adapters, tools, and agents.
      4. Advanced Systems & Managers: Lower-level components for building custom logic.
      5. Utilities: Helper functions and classes.

      Enumerations

      A2ATaskPriority
      A2ATaskStatus
      ErrorCode
      LogLevel
      MessageRole
      ModelCapability
      ObservationType
      TodoItemStatus

      Classes

      A2ATaskSocket
      AdapterInstantiationError
      AgentDiscoveryService
      AgentFactory
      AnthropicAdapter
      ApiKeyStrategy
      ApiQueueTimeoutError
      ARTError
      AuthManager
      CalculatorTool
      ConversationSocket
      DeepSeekAdapter
      GeminiAdapter
      GenericOAuthStrategy
      GroqAdapter
      IndexedDBStorageAdapter
      InMemoryStorageAdapter
      LLMStreamSocket
      LocalInstanceBusyError
      LocalProviderConflictError
      Logger
      McpClientController
      McpManager
      McpProxyTool
      ObservationSocket
      OllamaAdapter
      OpenAIAdapter
      OpenRouterAdapter
      OutputParser
      PESAgent
      PKCEOAuthStrategy
      ProviderManagerImpl
      ReasoningEngine
      StateManager
      SupabaseStorageAdapter
      SystemPromptResolver
      TaskDelegationService
      ToolRegistry
      TypedSocket
      UISystem
      UnknownProviderError
      ZyntopiaOAuthStrategy

      Interfaces

      A2AAgentInfo
      A2ATask
      A2ATaskEvent
      A2ATaskFilter
      A2ATaskMetadata
      A2ATaskResult
      AgentDiscoveryConfig
      AgentFinalResponse
      AgentOptions
      AgentPersona
      AgentProps
      AgentState
      AnthropicAdapterOptions
      ArtInstance
      ArtInstanceConfig
      ArtStandardMessage
      AvailableProviderEntry
      BlockingToolCompletedResult
      BlockingToolConfig
      BlockingToolSuspendedResult
      CallOptions
      ConversationManager
      ConversationMessage
      CreateA2ATaskRequest
      DeepSeekAdapterOptions
      DisplayToolConfig
      ExecutionConfig
      ExecutionContext
      ExecutionMetadata
      ExecutionOutput
      FilterOptions
      GeminiAdapterOptions
      GroqAdapterOptions
      HITLContext
      HITLFeedback
      HITLFeedbackSchema
      HITLInputValidation
      HITLSelectOption
      IA2ATaskRepository
      IAgentCore
      IAuthStrategy
      IConversationRepository
      IObservationRepository
      IProviderManager
      IStateRepository
      IToolExecutor
      ITypedSocket
      JsonObjectSchema
      LLMMetadata
      LoggerConfig
      ManagedAdapterAccessor
      McpManagerConfig
      McpResource
      McpResourceTemplate
      McpServerStatus
      McpToolDefinition
      MessageOptions
      OAuthConfig
      Observation
      ObservationFilter
      ObservationManager
      OllamaAdapterOptions
      OpenAIAdapterOptions
      OpenRouterAdapterOptions
      ParsedToolCall
      PESAgentStateData
      PKCEOAuthConfig
      PromptBlueprint
      PromptContext
      ProviderAdapter
      ProviderManagerConfig
      RuntimeProviderConfig
      StageSpecificPrompts
      StepOutputEntry
      StorageAdapter
      StreamEvent
      SystemPromptOverride
      SystemPromptSpec
      SystemPromptsRegistry
      TaskDelegationConfig
      TaskStatusResponse
      ThreadConfig
      ThreadContext
      TodoItem
      ToolResult
      ToolSchema
      ToolSystem
      UpdateA2ATaskRequest
      ZyntopiaOAuthConfig

      Type Aliases

      ArtStandardMessageRole
      ArtStandardPrompt
      FormattedPrompt
      HITLInputType
      JsonSchema
      McpServerConfig
      StateSavingStrategy
      StreamEventTypeFilter
      SystemPromptMergeStrategy
      ToolExecutionMode
      UnsubscribeFunction

      Variables

      ArtStandardMessageSchema
      ArtStandardPromptSchema
      VERSION

      Functions

      createArtInstance
      createHITLSuccessResult
      generateUUID
      isBlockingSuspendedResult
      isFeedbackApproved