-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
feat: update docs #1167
feat: update docs #1167
Changes from 4 commits
c2bbb5f
b2632bf
8d77b4b
e167030
3b5e45b
8fa5d7b
7eb76ae
e743507
ab18046
631ac2e
5398737
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,6 +13,17 @@ When executing actions without agents, you'll need to provide the input paramete | |
|
||
<Tabs> | ||
<Tab title="SDK"> | ||
Install packages: | ||
<CodeGroup> | ||
```bash Python | ||
pip install composio-openai | ||
``` | ||
```bash JavaScript | ||
npm install composio-core | ||
``` | ||
</CodeGroup> | ||
|
||
Import libraries & get action schema: | ||
<CodeGroup> | ||
```python Python | ||
from composio import ComposioToolSet, Action | ||
|
@@ -27,7 +38,7 @@ action_schema = composio_toolset.get_action_schemas(actions=[Action.GITHUB_STAR_ | |
print(json.dumps(action_schema[0].parameters.properties, indent=2)) | ||
``` | ||
|
||
```javascript Javascript | ||
```javascript JavaScript | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's an inconsistency in the capitalization of "JavaScript". In this file it's written as "Javascript" while in other documentation files it's written as "JavaScript". Please maintain consistency by using "JavaScript" throughout the documentation. |
||
import { OpenAIToolSet } from "composio-core"; | ||
|
||
const composio_toolset = new OpenAIToolSet(); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,11 @@ Composio allows you to [execute actions directly](action-guide-without-agents) u | |
|
||
<Tabs> | ||
<Tab title="Python"> | ||
Install packages: | ||
```bash | ||
pip install composio-core | ||
``` | ||
|
||
Use the `add_auth` method to add the existing authentication to the toolset for the app you want to use. `in_` is where you want to add the auth, `name` is the name of the header you want to add and `value` is the value of the header. | ||
```python {7-13} | ||
from composio import ComposioToolSet, App | ||
|
@@ -34,6 +39,10 @@ toolset.execute_action( | |
``` | ||
</Tab> | ||
<Tab title="JavaScript"> | ||
Install packages: | ||
```bash | ||
npm install composio-core | ||
``` | ||
Here you need to pass the authentication parameters inside the `authConfig`. `in_` is where you want to add the auth, `name` is the name of the header you want to add and `value` is the value of the header. | ||
Comment on lines
39
to
46
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Formatting Issue: The code block for installing the JavaScript package is not properly formatted. The closing backticks for the code block are missing, which can lead to rendering issues in the documentation. Additionally, ensure consistency in the formatting style across different sections of the document. 🔧 Suggested Code Diff: ```bash
npm install composio-core
|
||
```javascript {10-14} | ||
import { OpenAIToolSet } from "composio-core"; | ||
|
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.
Documentation Improvement: The change adds a step to install required libraries, which is a beneficial addition to the documentation. However, the step title 'Import necessary modules' was removed, which might lead to confusion if the import step is still necessary. Consider re-adding or clarifying the import step if it is required.
🔧 Suggested Code Diff:
📝 Committable Code Suggestion