Package com.embabel.agent.rag.tools
Class RagReference
-
- All Implemented Interfaces:
-
com.embabel.agent.api.common.LlmReference,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 RagReference implements LlmReference
Expose a RagService as an LlmReference with tools.
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringnameprivate final Stringdescriptionprivate final RagOptionsoptionsprivate final PromptContributionLocationpromptContributionLocationprivate final Stringrole
-
Constructor Summary
Constructors Constructor Description RagReference(String name, String description, RagOptions options, PromptRunner summarizerPromptRunner)
-
Method Summary
Modifier and Type Method Description StringgetName()StringgetDescription()final RagOptionsgetOptions()ObjecttoolInstance()Return the instance of the tool object. Stringnotes()Notes about this reference, such as usage guidance. -
Methods inherited from class com.embabel.common.ai.prompt.PromptElement
getPromptContributionLocation, getRole -
Methods inherited from class com.embabel.agent.api.common.LlmReference
contribution, toolObject, toolPrefix -
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
-
-
Constructor Detail
-
RagReference
RagReference(String name, String description, RagOptions options, PromptRunner summarizerPromptRunner)
-
-
Method Detail
-
getDescription
String getDescription()
-
getOptions
final RagOptions getOptions()
-
toolInstance
Object toolInstance()
Return the instance of the tool object. Defaults to this
-
-
-
-