Class LocalDirectoryReference

  • All Implemented Interfaces:
    com.embabel.agent.api.reference.LlmReference , com.embabel.agent.api.reference.LlmReferenceProvider , com.embabel.common.ai.prompt.PromptContributor , com.embabel.common.ai.prompt.PromptElement , com.embabel.common.core.types.Described , com.embabel.common.core.types.Named , com.embabel.common.core.types.NamedAndDescribed

    
    public final class LocalDirectoryReference
     implements LlmReferenceProvider, LlmReference
                        

    Reference for a local directory on the filesystem. Provides readonly access via file read tools.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final String getRoot()
      String getDescription()
      final String getNotes()
      String getName()
      LlmReference reference() Create an LLM reference
      String notes() Notes about this reference, such as usage guidance.
      • Methods inherited from class com.embabel.agent.api.reference.LlmReference

        asMatryoshka, contribution, getNamingStrategy, toolInstances, toolObject, toolPrefix, tools, withUnfolding
      • Methods inherited from class com.embabel.common.ai.prompt.PromptElement

        getPromptContributionLocation, getRole
      • Methods inherited from class com.embabel.common.ai.prompt.PromptContributor

        promptContribution
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait