SymbolicAI: A Neuro-Symbolic Perspective on Large Language Models (LLMs)

Contents:

• Introduction
  • Overview
  • Key Features
  • 🤷‍♂️ Why SymbolicAI?
  • Core Concepts
  • More fun facts!
  • Future Directions
• Installation
  • Core Features
    • Setting up a neurosymbolic API Key
    • Optional Features
    • Additional Requirements
  • Configuration File
• Quick Start Guide
  • Creating and Manipulating Symbols
    • Ranking Objects
    • Evaluating Expressions
      • Dynamic Casting
      • Probabilistic Programming
    • 🧠 Causal Reasoning
    • 🪜 Next Steps
• Features
  • 🧠 Causal Reasoning
  • Operations
    • Custom Operations
    • Few-Shot Operations
    • Prompt Design
  • Expressions
    • Sequence expressions
    • Stream expressions
  • Vision
  • Module Management
  • ❌ Error Handling and Debugging
    • 🕷️ Interpretability, Testing & Debugging
      • Unit Testing Models
      • 🔥Debugging
        • Example: News Summary
    • 📈 Interface for Query and Response Inspection
• Engines
  • Symbolic Engine (WolframAlpha)
  • Speech Engine (Whisper)
  • OCR Engine
  • Search Engine
  • Webcrawler Engine
  • Drawing Engine
    • DALL-E Example
    • Flux Example
    • Supported Parameters
      • DALL-E Parameters
      • Flux Parameters
  • File Engine
  • Indexing Engine
  • CLIP Engine
  • Local Neuro-Symbolic Engine
    • llama.cpp backend
    • HuggingFace backend
  • Custom Engine
• Tutorials
  • Writing a Custom Chatbot
  • Querying Data with SQL
  • Handling Files and Long Context Lengths
    • News Generator
    • Streaming over a PDF File
  • Video Tutorials
  • Example Files
• Tools
  • Shell Command Tool
    • 🖥️ Interactive Shell
      • Auto-completion
      • Query Neuro-Symbolic Model
      • Pipe with Files
      • Pipe with Commands
      • Slicing Operation on Files
      • Stateful Conversation
      • Limitations and Notes
  • Chatbot
  • Packages
    • 📦 Package Manager
    • 📦 Package Runner
      • Usage
      • Examples
      • Alias File
    • 📦 Package Initializer
      • Usage
      • Examples
• API Reference
• Expressions
  • Chat
    • ChatBot
      • ChatBot.input()
      • ChatBot.narrate()
      • ChatBot.repeat()
      • ChatBot.static_context
    • SymbiaChat
      • SymbiaChat.forward()
    • run()
  • Components
    • All
      • All.forward()
    • Analyze
      • Analyze.forward()
    • Any
      • Any.forward()
    • Choice
      • Choice.forward()
    • Clean
      • Clean.forward()
    • Cluster
      • Cluster.forward()
    • Compose
      • Compose.forward()
    • Convert
      • Convert.forward()
    • Embed
      • Embed.forward()
    • ExceptionWithUsage
    • ExcludeFilter
      • ExcludeFilter.forward()
    • Execute
      • Execute.forward()
    • ExpressionBuilder
      • ExpressionBuilder.forward()
      • ExpressionBuilder.static_context
    • Extract
      • Extract.forward()
    • FileQuery
      • FileQuery.forward()
    • FileReader
      • FileReader.exists()
      • FileReader.expand_user_path()
      • FileReader.extract_files()
      • FileReader.forward()
      • FileReader.get_files()
      • FileReader.integrity_check()
    • FileWriter
      • FileWriter.forward()
    • Function
      • Function.format()
      • Function.forward()
      • Function.prompt
    • FunctionWithUsage
      • FunctionWithUsage.add_usage()
      • FunctionWithUsage.forward()
      • FunctionWithUsage.get_usage()
      • FunctionWithUsage.print_verbose()
      • FunctionWithUsage.reset_usage()
    • GraphViz
      • GraphViz.forward()
    • InContextClassification
      • InContextClassification.forward()
    • IncludeFilter
      • IncludeFilter.forward()
    • Indexer
      • Indexer.DEFAULT
      • Indexer.exists()
      • Indexer.forward()
      • Indexer.register()
      • Indexer.replace_special_chars()
    • JsonParser
      • JsonParser.forward()
    • Lambda
      • Lambda.forward()
    • LengthConstrainedFunction
      • LengthConstrainedFunction.check_constraints()
      • LengthConstrainedFunction.forward()
      • LengthConstrainedFunction.get()
      • LengthConstrainedFunction.wrap_task()
    • LengthConstraint
      • LengthConstraint.field_name
      • LengthConstraint.max_characters
      • LengthConstraint.min_characters
    • Log
      • Log.forward()
    • Map
      • Map.forward()
    • Metric
      • Metric.forward()
    • Outline
      • Outline.forward()
    • Output
      • Output.forward()
    • Parallel
      • Parallel.forward()
    • PrepareData
      • PrepareData.PrepareDataPreProcessor
      • PrepareData.static_context
    • PrimitiveDisabler
    • Query
      • Query.forward()
    • RuntimeExpression
      • RuntimeExpression.forward()
    • SelfPrompt
      • SelfPrompt.forward()
    • Sequence
      • Sequence.forward()
    • SimilarityClassification
      • SimilarityClassification.forward()
    • Stream
      • Stream.forward()
    • Style
      • Style.forward()
    • Template
      • Template.forward()
    • Trace
      • Trace.forward()
    • TrackerTraceable
    • Translate
      • Translate.forward()
    • Try
      • Try.forward()
    • ValidatedFunction
      • ValidatedFunction.forward()
      • ValidatedFunction.prepare_seeds()
  • Core
    • Argument
      • Argument.value
    • analyze()
    • caption()
    • case()
    • clean()
    • cluster()
    • code()
    • combine()
    • command()
    • compare()
    • compose()
    • contains()
    • convert()
    • correct()
    • delitem()
    • dictionary()
    • draw()
    • embed()
    • equals()
    • execute()
    • expand()
    • expression()
    • extract()
    • fetch()
    • few_shot()
    • filtering()
    • foreach()
    • getitem()
    • include()
    • index()
    • interpret()
    • invert()
    • isinstanceof()
    • listing()
    • logic()
    • modify()
    • negate()
    • notify()
    • ocr()
    • opening()
    • outline()
    • output()
    • prompt()
    • query()
    • rank()
    • register()
    • replace()
    • search()
    • setitem()
    • simulate()
    • speech_to_text()
    • style()
    • sufficient()
    • summarize()
    • text_to_speech()
    • text_vision()
    • transcribe()
    • translate()
    • tune()
    • unique()
    • userinput()
    • zero_shot()
  • Functional
    • ConstraintViolationException
    • EngineRepository
      • EngineRepository.bind_property()
      • EngineRepository.command()
      • EngineRepository.get()
      • EngineRepository.list()
      • EngineRepository.query()
      • EngineRepository.register()
      • EngineRepository.register_from_package()
      • EngineRepository.register_from_plugin()
    • ProbabilisticBooleanMode
      • ProbabilisticBooleanMode.MEDIUM
      • ProbabilisticBooleanMode.STRICT
      • ProbabilisticBooleanMode.TOLERANT
  • Memory
    • Memory
      • Memory.forget()
      • Memory.forward()
      • Memory.recall()
      • Memory.store()
    • SlidingWindowListMemory
      • SlidingWindowListMemory.forget()
      • SlidingWindowListMemory.recall()
      • SlidingWindowListMemory.store()
    • SlidingWindowStringConcatMemory
      • SlidingWindowStringConcatMemory.drop()
      • SlidingWindowStringConcatMemory.forget()
      • SlidingWindowStringConcatMemory.history()
      • SlidingWindowStringConcatMemory.max_tokens()
      • SlidingWindowStringConcatMemory.recall()
      • SlidingWindowStringConcatMemory.store()
    • VectorDatabaseMemory
      • VectorDatabaseMemory.recall()
      • VectorDatabaseMemory.store()
  • Post Processors
    • ASTPostProcessor
    • CaseInsensitivePostProcessor
    • ClusterPostProcessor
    • CodeExtractPostProcessor
    • ConfirmToBoolPostProcessor
    • ConsolePostProcessor
    • ExpandFunctionPostProcessor
    • JsonTruncateMarkdownPostProcessor
    • JsonTruncatePostProcessor
    • NotifySubscriberPostProcessor
    • PostProcessor
    • SplitNewLinePostProcessor
    • SplitPipePostProcessor
    • StripPostProcessor
    • TakeLastPostProcessor
    • TemplatePostProcessor
    • WolframAlphaPostProcessor
  • Pre Processors
    • ArgsPreProcessor
    • ArgsToInputPreProcessor
    • ArrowMessagePreProcessor
    • CleanTextMessagePreProcessor
    • ClusterPreProcessor
    • CombinePreProcessor
    • ComparePreProcessor
    • ConsoleInputPreProcessor
    • ConsolePreProcessor
    • ContainsPreProcessor
    • CorrectionPreProcessor
    • CrawlPatternPreProcessor
    • DataTemplatePreProcessor
    • DeleteIndexPreProcessor
    • EnumPreProcessor
    • EqualsPreProcessor
    • ExceptionPreProcessor
    • ExpandFunctionPreProcessor
    • ExtractPatternPreProcessor
    • FilterPreProcessor
    • ForEachPreProcessor
    • FormatPreProcessor
    • GenerateCodePreProcessor
    • GenerateTextPreProcessor
    • IncludePreProcessor
    • IndexPreProcessor
    • InterpretExpressionPreProcessor
    • IsInstanceOfPreProcessor
    • JsonPreProcessor
    • LanguagePreProcessor
    • ListPreProcessor
    • LogicExpressionPreProcessor
    • MapPreProcessor
    • ModifyPreProcessor
    • NegatePreProcessor
    • PreProcessor
    • PredictionMessagePreProcessor
    • PromptPreProcessor
    • QueryPreProcessor
    • RankPreProcessor
    • RawInputPreProcessor
    • ReplacePreProcessor
    • SelfToInputPreProcessor
    • SemanticMappingPreProcessor
    • SetIndexPreProcessor
    • SimpleSymbolicExpressionPreProcessor
    • SimulateCodePreProcessor
    • StylePreProcessor
    • SufficientInformationPreProcessor
    • SummaryPreProcessing
    • TemplatePreProcessor
    • TextFormatPreProcessor
    • TextMessagePreProcessor
    • TextToOutlinePreProcessor
    • TranscriptionPreProcessor
    • UniquePreProcessor
    • UnwrapListSymbolsPreProcessor
    • ValuePreProcessor
  • Prompts
    • CleanText
    • CombineText
    • CompareValues
    • ContainsValue
    • ExceptionMapping
    • ExecutionCorrection
    • ExpandFunction
    • ExtractPattern
    • FewShotPattern
    • Filter
    • ForEach
    • Format
    • FuzzyEquals
    • GenerateCode
    • GenerateText
    • IncludeText
    • Index
    • InvertExpression
    • IsInstanceOf
    • JsonPromptTemplate
    • ListObjects
    • LogicExpression
    • MapContent
    • MemoryCapabilities
    • ModelName
      • ModelName.ALL
    • Modify
    • NegateStatement
    • Prompt
      • Prompt.append()
      • Prompt.clear()
      • Prompt.remove()
      • Prompt.stop_token
      • Prompt.value
    • PromptLanguage
      • PromptLanguage.ENGLISH
      • PromptLanguage.GERMAN
      • PromptLanguage.SPANISH
    • PromptRegistry
      • PromptRegistry.default_language
      • PromptRegistry.default_model
      • PromptRegistry.has_instruction()
      • PromptRegistry.has_tag()
      • PromptRegistry.has_value()
      • PromptRegistry.instruction()
      • PromptRegistry.model_fallback
      • PromptRegistry.register_instruction()
      • PromptRegistry.register_tag()
      • PromptRegistry.register_value()
      • PromptRegistry.tag()
      • PromptRegistry.value()
    • RankList
    • RemoveIndex
    • ReplaceText
    • SemanticMapping
    • SetIndex
    • SimpleSymbolicExpression
    • SimulateCode
    • SufficientInformation
    • SymbiaCapabilities
    • TextToOutline
    • Transcription
    • UniqueKey
  • Symbol
    • Call
    • Expression
      • Expression.command()
      • Expression.copy()
      • Expression.forward()
      • Expression.prompt()
      • Expression.register()
      • Expression.serialize()
      • Expression.sym_return_type
    • ExpressionEncoder
      • ExpressionEncoder.default()
    • GlobalSymbolPrimitive
    • Linker
      • Linker.find()
      • Linker.keys()
      • Linker.values()
    • Metadata
      • Metadata.keys
    • PropertyReservedError
    • Result
      • Result.value
    • Symbol
      • Symbol.adapt()
      • Symbol.children
      • Symbol.clear()
      • Symbol.dynamic_context
      • Symbol.edges
      • Symbol.global_context
      • Symbol.graph
      • Symbol.json()
      • Symbol.linker
      • Symbol.metadata
      • Symbol.nodes
      • Symbol.parent
      • Symbol.primitive()
      • Symbol.root
      • Symbol.serialize()
      • Symbol.shape
      • Symbol.static_context
      • Symbol.symbols()
      • Symbol.value
    • SymbolEncoder
      • SymbolEncoder.default()
    • SymbolMeta
• Backend
  • Base
    • BatchEngine
      • BatchEngine.forward()
    • Engine
      • Engine.command()
      • Engine.forward()
      • Engine.id()
      • Engine.prepare()
      • Engine.preview()
  • Engines
    • CLIP Engine
      • CLIPEngine
        • CLIPEngine.command()
        • CLIPEngine.forward()
        • CLIPEngine.id()
        • CLIPEngine.load_images()
        • CLIPEngine.prepare()
    • Selenium Engine
      • SeleniumEngine
        • SeleniumEngine.forward()
        • SeleniumEngine.get_page_source()
        • SeleniumEngine.id()
        • SeleniumEngine.prepare()
      • SeleniumResult
        • SeleniumResult.extract()
    • Embedding Engine
      • EmbeddingEngine
        • EmbeddingEngine.command()
        • EmbeddingEngine.forward()
        • EmbeddingEngine.id()
        • EmbeddingEngine.prepare()
    • File Engine
      • FileEngine
        • FileEngine.fix_pdf()
        • FileEngine.forward()
        • FileEngine.id()
        • FileEngine.prepare()
        • FileEngine.read_text()
        • FileEngine.reset_eof_of_pdf_return_stream()
      • TextContainer
        • TextContainer.id
        • TextContainer.page
        • TextContainer.text
    • Search Engine
      • SearchResult
      • SerpApiEngine
        • SerpApiEngine.command()
        • SerpApiEngine.forward()
        • SerpApiEngine.id()
        • SerpApiEngine.prepare()
    • GPT-X Chat Engine
      • GPTXChatEngine
        • GPTXChatEngine.command()
        • GPTXChatEngine.compute_remaining_tokens()
        • GPTXChatEngine.compute_required_tokens()
        • GPTXChatEngine.forward()
        • GPTXChatEngine.id()
        • GPTXChatEngine.prepare()
        • GPTXChatEngine.truncate()
      • InvalidRequestErrorRemedyChatStrategy
      • TokenTruncator
        • TokenTruncator.truncate()
    • GPT-X Completion Engine
      • GPTXCompletionEngine
        • GPTXCompletionEngine.command()
        • GPTXCompletionEngine.compute_remaining_tokens()
        • GPTXCompletionEngine.compute_required_tokens()
        • GPTXCompletionEngine.forward()
        • GPTXCompletionEngine.id()
        • GPTXCompletionEngine.prepare()
      • InvalidRequestErrorRemedyCompletionStrategy
    • Image Rendering Engine
      • DalleResult
        • DalleResult.download_images()
      • DrawingEngine
        • DrawingEngine.command()
        • DrawingEngine.forward()
        • DrawingEngine.id()
        • DrawingEngine.prepare()
    • Pinecone Engine
      • PineconeIndexEngine
        • PineconeIndexEngine.command()
        • PineconeIndexEngine.forward()
        • PineconeIndexEngine.id()
        • PineconeIndexEngine.prepare()
      • PineconeResult
      • chunks()
    • NeSy Client Engine
      • LLaMACppClientEngine
        • LLaMACppClientEngine.forward()
        • LLaMACppClientEngine.id()
        • LLaMACppClientEngine.max_tokens
        • LLaMACppClientEngine.prepare()
      • LLaMAResult
      • image_to_byte_array()
    • OCR Engine
      • ApiLayerResult
      • OCREngine
        • OCREngine.command()
        • OCREngine.forward()
        • OCREngine.id()
        • OCREngine.prepare()
    • Output Engine
      • OutputEngine
        • OutputEngine.forward()
        • OutputEngine.id()
        • OutputEngine.prepare()
    • Python Engine
      • PythonEngine
        • PythonEngine.forward()
        • PythonEngine.id()
        • PythonEngine.prepare()
      • full_stack()
    • Speech-to-Text Engine
      • WhisperEngine
        • WhisperEngine.command()
        • WhisperEngine.forward()
        • WhisperEngine.id()
        • WhisperEngine.prepare()
      • WhisperResult
      • WhisperTimestampsFormatter
        • WhisperTimestampsFormatter.forward()
    • Text-to-Speech Engine
      • TTSEngine
        • TTSEngine.command()
        • TTSEngine.forward()
        • TTSEngine.id()
        • TTSEngine.prepare()
    • User Input Engine
      • UserInputEngine
        • UserInputEngine.forward()
        • UserInputEngine.id()
        • UserInputEngine.prepare()
    • WolframAlpha Engine
      • WolframAlphaEngine
        • WolframAlphaEngine.command()
        • WolframAlphaEngine.forward()
        • WolframAlphaEngine.id()
        • WolframAlphaEngine.prepare()
      • WolframResult
• How to contribute
  • Submitting changes
  • Coding conventions
  • Community Demos
• License