-
Notifications
You must be signed in to change notification settings - Fork 21
Update reasoning concept docs #174
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
base: main
Are you sure you want to change the base?
Conversation
concepts/reasoning/introduction.mdx
Outdated
| title: What is Reasoning? | ||
| sidebarTitle: Overview | ||
| description: Reasoning gives Agents the ability to "think" before responding and "analyze" the results of their actions (i.e. tool calls), greatly improving the Agents' ability to solve problems that require sequential tool calls. | ||
| description: Give your agents the ability to think through problems step-by-step, validate their work, and self-correct—dramatically improving accuracy on complex tasks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The self-correct-dramatically doesn't read well?
| reasoning=True, | ||
| ) | ||
|
|
||
| # Option 1: Synchronous streaming (recommended for most use cases) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd break these into 3 different tabs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
| ## Example Use Cases | ||
|
|
||
| ### Logical puzzles | ||
| <Accordion title="Logical Puzzles" icon="brain"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tabs though, they look so nice!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changed to tabs
| ) | ||
| ``` | ||
|
|
||
| ## Monitoring Your Agent's Thinking |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is repeated from other docs? I think it is a bit much, the doc gets very long
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is still here right?
| ``` | ||
|
|
||
| See the [Workflow Tools](/concepts/tools/reasoning_tools/workflow-tools) documentation for more details. | ||
| ## When to Use Reasoning Tools |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be overkill
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
| tools=[workflow_tools], | ||
| markdown=True, | ||
| model=OpenAIChat(id="gpt-4o"), | ||
| tools=[ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will add think/analyze tools multiple times. Just thought of that. Did this sample actually work for you in practice?
|
|
||
| ### Add Instructions Automatically | ||
|
|
||
| The `add_instructions` parameter automatically includes detailed reasoning guidelines in your agent's instructions: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should mention this adds "pre-made" instructions that we wrote for the tool. But not all of the tools have that.
|
|
||
| ### Add Few-Shot Examples | ||
|
|
||
| Include example reasoning workflows to guide the agent: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, for which tools does it apply
Description
Also adds a reference for reasoning related classes/functions
Type of Change
Related Issues/PRs (if applicable)
Checklist