Skip to content

Commit 5ce6d10

Browse files
committed
update README.md
1 parent 39ef0cc commit 5ce6d10

File tree

1 file changed

+88
-8
lines changed

1 file changed

+88
-8
lines changed

Diff for: README.md

+88-8
Original file line numberDiff line numberDiff line change
@@ -1143,8 +1143,6 @@ main:
11431143

11441144
Whenever julep encounters a _user-defined function_, it pauses, giving control back to the client and waits for the client to run the function call and give the results back to julep.
11451145

1146-
> [!TIP] > **Example cookbook**: [cookbooks/13-Error_Handling_and_Recovery.py](https://github.com/julep-ai/julep/blob/dev/cookbooks/13-Error_Handling_and_Recovery.py)
1147-
11481146
### `system` tools
11491147

11501148
Built-in tools that can be used to call the julep APIs themselves, like triggering a task execution, appending to a metadata field, etc.
@@ -1224,15 +1222,15 @@ Additional operations available for some resources:
12241222

12251223
Note: The availability of these operations may vary depending on the specific resource and implementation details.
12261224

1227-
> [!TIP] > **Example cookbook**: [cookbooks/10-Document_Management_and_Search.py](https://github.com/julep-ai/julep/blob/dev/cookbooks/10-Document_Management_and_Search.py)
1225+
> [!TIP] > **Example cookbook**: [cookbooks/06-browser-use.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/06-browser-use.ipynb)
12281226

12291227
### Built-in `integrations`
12301228

12311229
Julep comes with a number of built-in integrations (as described in the section below). `integration` tools are directly executed on the julep backend. Any additional parameters needed by them at runtime can be set in the agent/session/user's `metadata` fields.
12321230

12331231
See [Integrations](#integrations) for details on the available integrations.
12341232

1235-
> [!TIP] > **Example cookbook**: [cookbooks/01-Website_Crawler_using_Spider.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/01-Website_Crawler_using_Spider.ipynb)
1233+
> [!TIP] > **Example cookbook**: [cookbooks/01-website-crawler.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/01-website-crawler.ipynb)
12361234

12371235
### Direct `api_calls`
12381236

@@ -1290,7 +1288,7 @@ output:
12901288

12911289
<td>
12921290

1293-
**Example cookbook**: [cookbooks/03-SmartResearcher_With_WebSearch.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/03-SmartResearcher_With_WebSearch.ipynb)
1291+
**Example cookbook**: [cookbooks/02-sarcastic-news-headline-generator.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/02-sarcastic-news-headline-generator.ipynb)
12941292

12951293
</td>
12961294
</tr>
@@ -1313,6 +1311,11 @@ output:
13131311

13141312
</td>
13151313

1314+
<td>
1315+
1316+
**Example cookbook**: [cookbooks/06-browser-use.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/06-browser-use.ipynb)
1317+
1318+
</td>
13161319
</tr>
13171320
<tr>
13181321
<td> <b>Email</b> </td>
@@ -1364,7 +1367,7 @@ output:
13641367

13651368
<td>
13661369

1367-
**Example cookbook**: [cookbooks/01-Website_Crawler_using_Spider.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/01-Website_Crawler_using_Spider.ipynb)
1370+
**Example cookbook**: [cookbooks/01-website-crawler.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/01-website-crawler.ipynb)
13681371

13691372
</td>
13701373
</tr>
@@ -1387,7 +1390,7 @@ output:
13871390

13881391
<td>
13891392

1390-
**Example cookbook**: [cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb)
1393+
**Example cookbook**: [cookbooks/03-trip-planning-assistant.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/03-trip-planning-assistant.ipynb)
13911394

13921395
</td>
13931396
</tr>
@@ -1409,10 +1412,87 @@ output:
14091412

14101413
<td>
14111414

1412-
**Example cookbook**: [cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb)
1415+
**Example cookbook**: [cookbooks/03-trip-planning-assistant.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/03-trip-planning-assistant.ipynb)
1416+
1417+
</td>
1418+
</tr>
1419+
1420+
<tr>
1421+
<td> <b>FFmpeg</b> </td>
1422+
<td>
1423+
1424+
```yaml
1425+
arguments:
1426+
cmd: string # The FFmpeg command to execute
1427+
file: string # The base64 encoded file to process
1428+
1429+
output:
1430+
fileoutput: string # The output file from the FFmpeg command in base64 encoding
1431+
result: boolean # Whether the FFmpeg command was executed successfully
1432+
mime_type: string # The MIME type of the output file
1433+
```
14131434

14141435
</td>
1436+
14151437
</tr>
1438+
1439+
<tr>
1440+
<td> <b>Llama Parse</b> </td>
1441+
<td>
1442+
1443+
```yaml
1444+
setup:
1445+
llamaparse_api_key: string # The API key for Llama Parse
1446+
1447+
arguments:
1448+
file: string # The base64 encoded file to parse
1449+
filename: string # The filename of the file
1450+
1451+
output:
1452+
documents: list # The parsed data from the document
1453+
```
1454+
1455+
</td>
1456+
1457+
</tr>
1458+
1459+
<tr>
1460+
<td> <b>Cloudinary</b> </td>
1461+
<td>
1462+
1463+
```yaml
1464+
1465+
method: media_upload | media_edit # The method to use for the Cloudinary integration
1466+
1467+
setup:
1468+
cloudinary_cloud_name: string # Your Cloudinary cloud name
1469+
cloudinary_api_key: string # Your Cloudinary API key
1470+
cloudinary_api_secret: string # Your Cloudinary API secret
1471+
1472+
arguments:
1473+
file: string # The URL of the file upload. Only available for media_upload method.
1474+
upload_params: dict # Additional parameters for the upload. Only available for media_upload method.
1475+
public_id: string # The public ID for the file. For media_edit method it is MANDATORY. For media_upload method it is optional.
1476+
transformation: list[dict] # The transformations to apply to the file
1477+
return_base64: boolean # Whether to return the file in base64 encoding
1478+
1479+
output:
1480+
url: string # The URL of the uploaded file. Only available for media_upload method.
1481+
meta_data: dict # Additional metadata from the upload response. Only available for media_upload method.
1482+
public_id: string # The public ID of the uploaded file. Only available for media_upload method.
1483+
transformed_url: string # The transformed URL. Only available for media_edit method.
1484+
base64: string # The base64 encoded file. Only available for media_edit method.
1485+
```
1486+
1487+
</td>
1488+
1489+
<td>
1490+
1491+
**Example cookbook**: [cookbooks/05-video-processing-with-natural-language.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/05-video-processing-with-natural-language.ipynb)
1492+
1493+
</td>
1494+
</tr>
1495+
14161496
</table>
14171497

14181498
For more details, refer to our [Integrations Documentation](#integrations).

0 commit comments

Comments
 (0)