api.md

API Reference

Core Components

::: liteswarm.core.swarm.Swarm

::: liteswarm.core.swarm_stream.SwarmStream

::: liteswarm.types.llm.LLM

::: liteswarm.types.agent.Agent

::: liteswarm.types.tools.Tool

::: liteswarm.types.tools.ToolResult

::: liteswarm.types.tools.tool

::: liteswarm.types.tools.tool_plain

::: liteswarm.types.agent.AgentContext

::: liteswarm.types.agent.AgentSwitch

::: liteswarm.types.agent.AgentState

Chat Interface

::: liteswarm.chat.chat.SwarmChat

::: liteswarm.chat.context.ChatContext

::: liteswarm.types.chat.ChatMessage

::: liteswarm.chat.vector_index.MessageVectorIndex

::: liteswarm.types.chat.OptimizationStrategy

::: liteswarm.types.chat.WindowStrategy

::: liteswarm.types.chat.RAGStrategy

::: liteswarm.types.chat.TrimStrategy

::: liteswarm.types.chat.SummaryStrategy

Event Types

::: liteswarm.types.events.SwarmEventBase

::: liteswarm.types.events.AgentRunStartEvent

::: liteswarm.types.events.AgentRunCompleteEvent

::: liteswarm.types.events.CompletionResponseChunkEvent

::: liteswarm.types.events.AgentResponseChunkEvent

::: liteswarm.types.events.AgentResponseEvent

::: liteswarm.types.events.ToolCallResultEvent

::: liteswarm.types.events.AgentStartEvent

::: liteswarm.types.events.AgentCompleteEvent

::: liteswarm.types.events.AgentSwitchEvent

::: liteswarm.types.events.ErrorEvent

::: liteswarm.types.events.SwarmEvent

Error Types

::: liteswarm.types.exceptions.SwarmError

::: liteswarm.types.exceptions.CompletionError

::: liteswarm.types.exceptions.ContextLengthError

::: liteswarm.types.exceptions.MaxAgentSwitchesError

::: liteswarm.types.exceptions.MaxResponseContinuationsError

::: liteswarm.types.exceptions.RetryError

Collection Types

::: liteswarm.types.collections.StreamItem

::: liteswarm.types.collections.ReturnableAsyncGenerator

::: liteswarm.types.collections.AsyncStream

For more examples and detailed usage, see Examples.