| Name | llama-index-tools-salesforce JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | llama-index tools salesforce integration |
| upload_time | 2024-02-21 22:28:09 |
| maintainer | chrispangg |
| docs_url | None |
| author | Your Name |
| requires_python | >=3.8.1,<4.0 |
| license | MIT |
| keywords |
salesforce
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Salesforce Tool
This tool connects to a Salesforce environment and allow the Agent to perform SOQL and SOSL queries.
## Usage
This tool is a wrapper tool using the simple salesforce library. More information on this library [here](https://simple-salesforce.readthedocs.io/)
Here's an example usage of the Salesforce Tool:
```python
from llama_index.tools.salesforce import SalesforceToolSpec
# Initialize the tool with your Salesforce credentials and other relevant details
sf = SalesforceToolSpec(
username=sf_username,
password=sf_password,
consumer_key=sf_consumer_key,
consumer_secret=sf_consumer_secret,
domain="test",
)
agent = OpenAIAgent.from_tools(
sf.to_tool_list(),
llm=llm,
verbose=True,
system_prompt=system_prompt,
memory=memory,
)
agent.chat("List 3 Accounts in Salesforce")
agent.chat("Provide information on a customer account John Doe")
```
`execute_sosl` - Returns the result of a Salesforce search as a dict decoded from the Salesforce response JSON payload.
`execute_soql` - Returns the full set of results for the `query`. The returned dict is the decoded JSON payload from the final call to Salesforce, but with the `totalSize` field representing the full number of results retrieved and the `records` list representing the full list of records retrieved.
This loader is designed to be used as a way to load data as a Tool in a Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-tools-salesforce",
"maintainer": "chrispangg",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "salesforce",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/72/fc/639dc334e219fe7b3523e0417af0148e81345b061dae38f0a1ac845df5b6/llama_index_tools_salesforce-0.1.3.tar.gz",
"platform": null,
"description": "# Salesforce Tool\n\nThis tool connects to a Salesforce environment and allow the Agent to perform SOQL and SOSL queries.\n\n## Usage\n\nThis tool is a wrapper tool using the simple salesforce library. More information on this library [here](https://simple-salesforce.readthedocs.io/)\n\nHere's an example usage of the Salesforce Tool:\n\n```python\nfrom llama_index.tools.salesforce import SalesforceToolSpec\n\n# Initialize the tool with your Salesforce credentials and other relevant details\nsf = SalesforceToolSpec(\n username=sf_username,\n password=sf_password,\n consumer_key=sf_consumer_key,\n consumer_secret=sf_consumer_secret,\n domain=\"test\",\n)\n\nagent = OpenAIAgent.from_tools(\n sf.to_tool_list(),\n llm=llm,\n verbose=True,\n system_prompt=system_prompt,\n memory=memory,\n)\n\nagent.chat(\"List 3 Accounts in Salesforce\")\nagent.chat(\"Provide information on a customer account John Doe\")\n```\n\n`execute_sosl` - Returns the result of a Salesforce search as a dict decoded from the Salesforce response JSON payload.\n\n`execute_soql` - Returns the full set of results for the `query`. The returned dict is the decoded JSON payload from the final call to Salesforce, but with the `totalSize` field representing the full number of results retrieved and the `records` list representing the full list of records retrieved.\n\nThis loader is designed to be used as a way to load data as a Tool in a Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index tools salesforce integration",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"salesforce"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b41fd7edf7132be7cd467ee52bc7381e786245b3ab1b8775c462f1ac52ba5800",
"md5": "3d2d355284811340e969a124789d52ac",
"sha256": "4e99f091a210579a49ecc956a6a0de5b0b2c15d6b27f969d020fdf4bb321ca49"
},
"downloads": -1,
"filename": "llama_index_tools_salesforce-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d2d355284811340e969a124789d52ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 3030,
"upload_time": "2024-02-21T22:28:08",
"upload_time_iso_8601": "2024-02-21T22:28:08.500459Z",
"url": "https://files.pythonhosted.org/packages/b4/1f/d7edf7132be7cd467ee52bc7381e786245b3ab1b8775c462f1ac52ba5800/llama_index_tools_salesforce-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72fc639dc334e219fe7b3523e0417af0148e81345b061dae38f0a1ac845df5b6",
"md5": "4882ed7f3ead379af17c2d3a1ae2e4ab",
"sha256": "e0b73b046a47011bafdc58c032ade25bb310e69f04d984c33270eaaa475503c5"
},
"downloads": -1,
"filename": "llama_index_tools_salesforce-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "4882ed7f3ead379af17c2d3a1ae2e4ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 2648,
"upload_time": "2024-02-21T22:28:09",
"upload_time_iso_8601": "2024-02-21T22:28:09.502231Z",
"url": "https://files.pythonhosted.org/packages/72/fc/639dc334e219fe7b3523e0417af0148e81345b061dae38f0a1ac845df5b6/llama_index_tools_salesforce-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 22:28:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-tools-salesforce"
}
