fix: remove deprecated method from documentation

[ArslanSaleem]

• Closes Features of Agent is outdated for document in pandasai3.0 #1841 (Replace xxxx with the GitHub issue number).

---

Important

Update documentation to remove deprecated methods and guide users on migrating to PandasAI v3 with new features like follow_up().

• Documentation Updates:
  • Remove deprecated methods clarification_questions(), explain(), and rephrase_query() from docs/v3/agent.mdx.
  • Introduce follow_up() method in docs/v3/agent.mdx for maintaining conversation context.
  • Update docs/v3/migration-backwards-compatibility.mdx to reflect changes in agent methods and recommend using pai.DataFrame() and pai.chat().
• Migration Guide:
  • Update docs/v3/migration-guide.mdx to guide users on migrating from v2 to v3, emphasizing global configuration and new method usage.
  • Highlight removal of certain configuration options and methods.
• Troubleshooting:
  • Add common issues and solutions in docs/v3/migration-troubleshooting.mdx, focusing on method removals and configuration changes.

^{This description was created by for 8493a35. You can customize this summary. It will automatically update as commits are pushed.}

[ellipsis-dev]

Important

Looks good to me! 👍

Reviewed everything up to 26e8e3a in 1 minute and 17 seconds. Click for details.

• Reviewed 74 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 4 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. docs/v3/agent.mdx:37

• Draft comment:
  Updated header from 'Clarification questions' to 'Follow-up Questions' to reflect the removal of deprecated functions in pandasai3.0.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply states what was changed without offering any insight or guidance.

2. docs/v3/agent.mdx:39

• Draft comment:
  Removed deprecated code examples (clarification_questions, explain, rephrase_query) to align documentation with pandasai3.0. The new follow_up example correctly demonstrates maintaining conversation context.
• Reason this comment was not posted:
  Comment looked like it was already resolved.

3. docs/v3/agent.mdx:107

• Draft comment:
  Minor text reflow in the Enterprise license note. Ensure the note remains accurate regarding the local vector store training requirements.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% The comment is asking the author to ensure the note remains accurate, which violates the rule against asking the author to ensure behavior is intended. It doesn't provide a specific suggestion or point out a specific issue.

4. docs/v3/agent.mdx:55

• Draft comment:
  Line 55: The placeholder "" appears to be incomplete or not formatted as standard Markdown. Consider revising it to a proper note formatting or removing it if not needed.
• Reason this comment was not posted:
  Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_nDf25dRw4TZnXT0F

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.32%. Comparing base (aca26cd) to head (8493a35).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1842   +/-   ##
=======================================
  Coverage   91.32%   91.32%           
=======================================
  Files          72       72           
  Lines        2813     2813           
=======================================
  Hits         2569     2569           
  Misses        244      244           

Flag	Coverage Δ
unittests	91.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ellipsis-dev]

Important

Looks good to me! 👍

Reviewed 8493a35 in 1 minute and 40 seconds. Click for details.

• Reviewed 857 lines of code in 4 files
• Skipped 0 files when reviewing.
• Skipped posting 4 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. docs/v3/migration-backwards-compatibility.mdx:128

• Draft comment:
  Good update: The Agent section now clarifies that some methods (clarification_questions, rephrase_query, explain) are removed and introduces the new follow_up() method. This clearly addresses issue #1841.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is purely informative, providing details about changes made in the code. It does not suggest any improvements, ask for clarifications, or point out potential issues. According to the rules, purely informative comments should be removed.

2. docs/v3/migration-guide.mdx:200

• Draft comment:
  Agent section now properly removes deprecated methods and demonstrates the new usage with chat() and follow_up(). This update effectively resolves the outdated documentation for Agent.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is purely informative, praising the update for resolving outdated documentation. It doesn't provide any actionable feedback or suggestions for improvement.

3. docs/v3/migration-troubleshooting.mdx:59

• Draft comment:
  The troubleshooting section now correctly instructs users to use chat() and follow_up() instead of the removed Agent methods. This clear guidance will help mitigate the AttributeError issue.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is purely informative, praising the change made in the PR. It does not provide any actionable feedback or suggestions for improvement. According to the rules, purely informative comments should be removed.

4. docs/v3/migration-v2-to-v3.mdx:1

• Draft comment:
  The entire migration-v2-to-v3.mdx file has been removed. Ensure that all essential migration instructions from this file are consolidated within the remaining migration documents so users are not missing critical migration information.
• Reason this comment was not posted:
  Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_gOxgzY9pOTIBetXl

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}