Skip to content

Commit 25f33c0

Browse files
benauriemmarb0000ellipsis-dev[bot]
authored
Bauriemma/docs bash 7 14 25 (#214)
* quick start text for attaching data * advanced settings * screenshot * BA refresh * Update fern/docs/pages/guides/agents/quick-start.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * Update fern/docs/pages/guides/bulk-analysis.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> --------- Co-authored-by: Ria Balli <35355202+rb0000@users.noreply.github.com> Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
1 parent 6da61d7 commit 25f33c0

File tree

5 files changed

+35
-156
lines changed

5 files changed

+35
-156
lines changed

fern/docs/assets/.DS_Store

0 Bytes
Binary file not shown.
Loading

fern/docs/pages/guides/agents/quick-start.mdx

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,21 +88,28 @@ _--------- End Context ---------_
8888
</AccordionGroup>
8989

9090
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:
9294

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.
9597

96-
<Frame caption="We provided our infosec agent with all of Credal's information security documentation.">
97-
<img src="/docs/assets/copilots/copilot-searchable-data.png" />
98-
</Frame>
98+
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.
9999

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.
102100
<Frame caption="Here, we pinned our infosec FAQs when setting up Credal's Infosec agent.">
103-
<img src="/docs/assets/copilots/copilot-pinned-data.png" />
101+
<img src="/docs/assets/copilots/copilot-attached-data.png" />
104102
</Frame>
105103

104+
- **User Inputs**
105+
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+
106113
### Deploy Your Agent to Slack
107114

108115
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.

fern/docs/pages/guides/bulk-analysis-in-depth-guide.mdx

Lines changed: 0 additions & 130 deletions
This file was deleted.

0 commit comments

Comments
 (0)