You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/docs/pages/guides/agents/quick-start.mdx
+16-9Lines changed: 16 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -88,21 +88,28 @@ _--------- End Context ---------_
88
88
</AccordionGroup>
89
89
90
90
5.**Data**
91
-
The data you provide will be the source of truth for your agent. Your agent will rely on this data (along with the prompt and Q&A pairs) to answer user queries. There are two types of data you can specify here:
91
+
The data you provide will be the source of truth for your agent. Your agent will rely on this data (along with the prompt and Q&A pairs) to answer user queries. You should provide your Agent with sufficient data relevant to its area of expertise. The data you attach is the most important source of knowledge for the agent.
92
+
93
+
There are two ways you can provide data to the agent:
92
94
93
-
-**Searchable Sources**
94
-
You should provide your Agent with sufficient data relevant to its area of expertise. It will search these sources for information relevant to user questions, and pass just the most relevant information to the AI model. Use the toggle to enable searchable sources and use the search bar to add sources.
95
+
-**Attach Data**
96
+
This allows you as the agent builder to specify which data sources your agent should consider. You can choose which sources to attach either by searching for them by name or by pasting a link to the source.
95
97
96
-
<Framecaption="We provided our infosec agent with all of Credal's information security documentation.">
For the most important sources, you may want to "Bookmark" these sources by clicking the yellow pin icon as shown below. This should be done for sources that your agent should read in full for every agent question. Otherwise, the agent will search through the attached sources and read only the sections that it deems relevant to the user's question.
99
99
100
-
-**Pinned Data**
101
-
By pinning data sources, you instruct your agent to pass the full contents of the document to the AI for every user question. You should use this for documents where the entire document is relevant to most questions you expect your agent to address.
102
100
<Framecaption="Here, we pinned our infosec FAQs when setting up Credal's Infosec agent.">
Alternatively, you may want to allow the user to attach one or more source documents at the time of their question. For example, you may create an agent for generating meeting notes based on a transcript, and you want to allow your user to provide a different transcript each time they use the agent. This can be accomplished by creating a user input.
106
+
107
+
-**Advanced Settings**
108
+
There are some advanced setting you can use to control how your agent searches through the attached data. For most use cases, you should leave the default settings.
109
+
110
+
For advanced use cases, you can specify how many of the most relevent chunks (a chunk is roughly 2-3 sentences) the agent should read. You can also set a relevancy score cutoff.
111
+
112
+
106
113
### Deploy Your Agent to Slack
107
114
108
115
Once you have a agent set up, you can use it directly in Credal, or deploy it to Slack or other tools through the API. You can set up a deployment in the “Deploy” tab. For this short guide, we'll cover Slack only; please refer to the detailed guide for the other options.
0 commit comments