API Reference

Modules

• Clients
  • AsyncFFLiteLLMClient
  • FFLiteLLMClient
  • FFMistralSmall
  • Classes
• Clients.AsyncFFLiteLLMClient
  • AsyncFFLiteLLMClient
  • Classes
• Clients.BaseLiteLLMClient
  • BaseLiteLLMClient
  • Classes
• Clients.FFLiteLLMClient
  • FFLiteLLMClient
  • Classes
• Clients.FFMistralSmall
  • FFMistralSmall
  • Classes
• Clients.model_defaults
  • get_model_defaults()
  • register_model_defaults()
  • Functions
• ConversationHistory
  • ConversationHistory
• FFAI
  • FFAI
  • extract_json_field()
  • interpolate_prompt()
  • Classes
• FFAIClientBase
  • FFAIClientBase
• OrderedPromptHistory
  • Interaction
  • OrderedPromptHistory
• agent
  • AgentLoop
  • AgentResult
  • ResponseValidator
  • ToolCallRecord
  • Classes
• agent.agent_loop
  • AgentLoop
  • Classes
• agent.agent_result
  • ToolCallRecord
  • AgentResult
  • Classes
• agent.response_validator
  • ValidationResult
  • ResponseValidator
  • Classes
• config
  • YamlConfigSource
  • LoggingRotationConfig
  • LoggingConfig
  • PathsConfig
  • RetryConfig
  • ClientTypeConfig
  • ClientsConfig
  • ModelDefaultsConfig
  • OTelConfig
  • ObservabilityConfig
  • RAGConfig
  • MemoryConfig
  • Config
  • get_config()
  • reload_config()
  • Classes
  • Functions
• core
  • AsyncFFAIClientBase
  • AsyncGraphExecutor
  • ConditionEvaluator
  • ConversationHistory
  • DependencyEdge
  • Embeddings
  • ExecutionGraph
  • ExecutionState
  • FFAIClientBase
  • GraphResult
  • HistoryExporter
  • Memory
  • OrderedPromptHistory
  • PermanentHistory
  • PromptBuilder
  • PromptNode
  • ResponseContext
  • ResponseResult
  • StructuredOutputHandler
  • StructuredResult
  • TurnHit
  • TurnVectorStore
  • build_execution_graph()
  • build_execution_graph_with_edges()
  • build_graph_history_dict()
  • check_abort_condition()
  • clean_response()
  • evaluate_condition()
  • evaluate_condition_with_trace()
  • extract_json()
  • extract_json_field()
  • get_ready_prompts()
  • interpolate_prompt()
  • is_abort_trigger()
  • resolve_graph_prompt()
  • run_sync()
  • should_skip_for_failed_deps()
  • Classes
  • Functions
• core._async
  • run_sync()
  • Functions
• core.async_client_base
  • AsyncFFAIClientBase
  • Classes
• core.async_executor
  • GraphResult
  • AsyncGraphExecutor
  • Classes
• core.client_base
  • FFAIClientBase
  • Classes
• core.condition_evaluator
  • ConditionEvaluator
  • Classes
• core.conversation_manager
  • ConversationManager
  • Classes
• core.embeddings
  • Embeddings
  • Classes
• core.execution_result
  • ExecutionResult
  • Classes
• core.execution_state
  • ExecutionState
  • Classes
• core.graph
  • DependencyEdge
  • ExecutionGraph
  • build_execution_graph()
  • build_execution_graph_with_edges()
  • get_ready_prompts()
  • evaluate_condition()
  • evaluate_condition_with_trace()
  • is_abort_trigger()
  • Classes
  • Functions
• core.graph_execution_helpers
  • build_graph_history_dict()
  • resolve_graph_prompt()
  • check_abort_condition()
  • should_skip_for_failed_deps()
  • Functions
• core.history
  • ConversationHistory
  • HistoryRecorder
  • OrderedPromptHistory
  • PermanentHistory
  • Classes
• core.history.conversation
  • ConversationHistory
  • Classes
• core.history.ordered
  • Interaction
  • OrderedPromptHistory
  • Classes
• core.history.permanent
  • PermanentHistory
  • Classes
• core.history.recorder
  • HistoryRecorder
  • Classes
• core.history_exporter
  • HistoryExporter
  • Classes
• core.memory
  • Entry
  • Memory
  • TurnHit
  • TurnVectorStore
  • cosine_similarity()
  • load_store()
  • persist_store()
  • Classes
  • Functions
• core.memory.memory
  • Memory
  • Classes
• core.memory.persist
  • persist_store()
  • load_store()
  • Functions
• core.memory.turn_store
  • cosine_similarity()
  • TurnVectorStore
  • Classes
  • Functions
• core.memory.types
  • EmbeddingBackend
  • TurnHit
  • Entry
  • Classes
• core.prompt_builder
  • PromptBuilder
  • Classes
• core.prompt_node
  • PromptNode
  • Classes
• core.prompt_utils
  • extract_json_field()
  • interpolate_prompt()
  • Functions
• core.response_context
  • ResponseContext
  • Classes
• core.response_executor
  • ResponseExecutor
  • Classes
• core.response_options
  • ResponseOptions
  • Classes
• core.response_result
  • ResponseResult
  • Classes
• core.response_utils
  • extract_json()
  • clean_response()
  • Functions
• core.structured_output
  • StructuredResult
  • StructuredOutputHandler
  • Classes
• core.types
  • Interaction
  • PromptSpec
  • Classes
• core.usage
  • TokenUsage
  • Classes
• observability
  • NoOpSpan
  • TelemetryManager
  • get_telemetry_manager()
  • Classes
  • Functions
• observability.log_context
  • set_log_context()
  • clear_log_context()
  • log_context()
  • LogContextFilter
  • ContextFormatter
  • Classes
  • Functions
• observability.telemetry
  • NoOpSpan
  • TelemetryManager
  • get_telemetry_manager()
  • reload_telemetry()
  • reset_telemetry()
  • Classes
  • Functions
• rag
  • RAG
  • BM25Index
  • CharacterChunker
  • ChunkDeduplicator
  • ChunkerBase
  • ClientAdapter
  • CodeChunker
  • ContextualEmbeddings
  • CrossEncoderReranker
  • DiversityReranker
  • Embeddings
  • GenerationResult
  • HierarchicalChunker
  • HierarchicalIndex
  • HierarchicalTextChunk
  • HybridSearch
  • MarkdownChunker
  • NoopReranker
  • QueryExpander
  • QueryResult
  • RecursiveChunker
  • RerankerBase
  • SearchHit
  • TextChunk
  • VectorStore
  • VectorStoreBase
  • chunk_text()
  • format_hits()
  • fuse_search_results()
  • get_chunker()
  • get_reranker()
  • get_store()
  • is_store_available()
  • list_available_stores()
  • list_chunkers()
  • list_stores()
  • litellm_generate_fn()
  • reciprocal_rank_fusion()
  • Classes
  • Functions
• rag.client_adapter
  • ClientAdapter
  • Classes
• rag.embed
  • Embeddings
• rag.format
  • format_hits()
  • Functions
• rag.indexing
  • Classes
• rag.indexing.bm25
  • BM25Index
  • Classes
• rag.indexing.contextual
  • ContextualEmbeddings
  • LateChunkingEmbeddings
  • Classes
• rag.indexing.deduplication
  • ChunkDeduplicator
  • Classes
• rag.indexing.hierarchical
  • HierarchicalIndex
  • Classes
• rag.prompts
• rag.rag
  • RAG
  • Classes
• rag.search
  • CrossEncoderReranker
  • DiversityReranker
  • HybridSearch
  • NoopReranker
  • QueryExpander
  • RerankerBase
  • fuse_search_results()
  • get_reranker()
  • reciprocal_rank_fusion()
  • Classes
  • Functions
• rag.search.hybrid
  • HybridSearch
  • reciprocal_rank_fusion()
  • Classes
  • Functions
• rag.search.query_expansion
  • QueryExpander
  • fuse_search_results()
  • Classes
  • Functions
• rag.search.rerankers
  • RerankerBase
  • CrossEncoderReranker
  • DiversityReranker
  • NoopReranker
  • get_reranker()
  • Classes
  • Functions
• rag.splitters
  • CharacterChunker
  • ChunkerBase
  • CodeChunker
  • HierarchicalChunker
  • HierarchicalTextChunk
  • MarkdownChunker
  • RecursiveChunker
  • TextChunk
  • chunk_text()
  • get_chunker()
  • list_chunkers()
  • Classes
  • Functions
• rag.splitters.base
  • TextChunk
  • HierarchicalTextChunk
  • ChunkerBase
  • Classes
• rag.splitters.character
  • CharacterChunker
  • Classes
• rag.splitters.code
  • CodeChunker
  • Classes
• rag.splitters.factory
  • get_chunker()
  • list_chunkers()
  • chunk_text()
  • Functions
• rag.splitters.hierarchical
  • HierarchicalChunker
  • Classes
• rag.splitters.markdown
  • MarkdownChunker
  • Classes
• rag.splitters.recursive
  • RecursiveChunker
  • Classes
• rag.store
  • VectorStore
• rag.types
  • SearchHit
  • GenerationResult
  • QueryResult
  • Classes
• retry_utils
  • RateLimitError
  • ServiceUnavailableError
  • get_retry_decorator()
  • get_configured_retry_decorator()
  • should_retry_exception()
  • extract_retry_after()
  • retry_with_backoff()
  • create_rate_limit_error()
  • Classes
  • Functions
• tools
  • ToolDefinition
  • ToolRegistry
  • Classes
• tools.tool_registry
  • ToolDefinition
  • ToolRegistry
  • Classes