docs: enhance Salesforce Toolkit documentation #31387
Conversation
Updated the Salesforce integration notebook to provide a more comprehensive overview of the `langchain-salesforce` package. Key changes include: - Improved description of the tool's capabilities and features. - Added detailed setup instructions for authentication using environment variables. - Updated code snippets to use consistent parameter naming and improved readability. - Included additional resources and API references for better user guidance.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dosubot
bot
added
size:L
Enhanced the Salesforce integration notebook by improving code readability and consistency. Key changes include: - Added a unique ID to the markdown cell for better tracking. - Streamlined the initialization of the Salesforce tool by consolidating parameters into a single line. - Corrected formatting in the query definition and data handling for clarity. - Removed unnecessary blank lines to improve overall presentation.
| "\n", | ||
| "## Overview\n", | ||
| "\n", | ||
| "This notebook provides examples of interacting with Salesforce using LangChain.\n" | ||
| "The `langchain-salesforce` package provides a powerful integration between LangChain and Salesforce CRM,\n", |
There was a problem hiding this comment.
The target audience is technical, so using language which is more technical and less sales/marketing oriented is more appropriate. The general guideline is to drop adjectives like "powerful".
| "\n", | ||
| "## Getting Your Security Token\n", | ||
| "If you need a security token:\n", |
There was a problem hiding this comment.
Added it back in - accidental removal when trying to re-write
| "\n", | ||
| "- [Salesforce SOQL Reference](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/)\n", | ||
| "- [Salesforce REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/)\n", | ||
| "- [LangChain Tools Documentation](https://python.langchain.com/docs/modules/tools/)" |
There was a problem hiding this comment.
I think it's better to remove the internal cross-reference to tools. Focusing on the things that are salesforce specific or integration specific is good for the additional resources.
CodSpeed Walltime Performance ReportMerging #31387 will not alter performanceComparing
|
CodSpeed Instrumentation Performance ReportMerging #31387 will not alter performanceComparing Summary
|
Refined the Salesforce integration notebook by simplifying descriptions and improving formatting. Key changes include: - Shortened the overview of the `langchain-salesforce` package. - Enhanced clarity in the key features section. - Less marketing/sales wording - Improved setup instructions and added details for obtaining a security token.
dosubot
bot
added
the
lgtm
PR Title
PR Description
Description: Enhanced the Salesforce Toolkit documentation to provide a more comprehensive overview of the
langchain-salesforcepackage. The updates include improved descriptions of the toolkit's capabilities, detailed setup instructions for authentication using environment variables, updated code snippets with consistent parameter naming and improved readability, and additional resources with API references for better user guidance.Issue: N/A (documentation improvement)
Dependencies: None
Twitter handle: @colesmcintosh
Changes Made:
Files Modified:
docs/docs/integrations/tools/salesforce.ipynb(83 insertions, 36 deletions)This is a documentation-only change that improves the user experience for developers working with the Salesforce Toolkit. The changes are backwards compatible and follow LangChain's documentation standards.