Skip to content

Bauriemma/docs bash 7 14 25 #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified fern/docs/assets/.DS_Store
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 16 additions & 9 deletions fern/docs/pages/guides/agents/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,21 +88,28 @@ _--------- End Context ---------_
</AccordionGroup>

5. **Data**
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:
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.

There are two ways you can provide data to the agent:

- **Searchable Sources**
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.
- **Attach Data**
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.

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

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

- **User Inputs**
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.

- **Advanced Settings**
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: 'advanced setting' should be 'advanced settings' and 'relevent' should be 'relevant'.


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.


### Deploy Your Agent to Slack

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.
Expand Down
130 changes: 0 additions & 130 deletions fern/docs/pages/guides/bulk-analysis-in-depth-guide.mdx

This file was deleted.

Loading