-
Notifications
You must be signed in to change notification settings - Fork 892
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3470cbd
commit 0764f3b
Showing
18 changed files
with
809 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,5 +4,85 @@ description: 'Learn how to use the Email integration with Julep' | |
| icon: 'envelope' | ||
| --- | ||
|
|
||
| Welcome to the Email integration guide for Julep! This integration allows you to send emails using SMTP, enabling you to build workflows that require email communication capabilities. Whether you're sending notifications or managing email campaigns, this guide will walk you through the setup and usage. | ||
|
|
||
| Coming soon... | ||
| ## Prerequisites | ||
|
|
||
| <Info type="info" title="SMTP Server Credentials Required"> | ||
| To use the Email integration, you need SMTP server credentials, including the host, port, username, and password. Ensure you have access to an SMTP server before proceeding. | ||
| </Info> | ||
|
|
||
| ## How to Use the Integration | ||
|
|
||
| To get started with the Email integration, follow these steps to configure and create a task: | ||
|
|
||
| <Steps> | ||
| <Step title="Configure Your SMTP Server"> | ||
| Add your SMTP server credentials to the Julep dashboard under the integrations section. This will allow Julep to authenticate requests to your email server on your behalf. | ||
| </Step> | ||
| <Step title="Create Task Definition"> | ||
| Use the following YAML configuration to define your email sending task: | ||
|
|
||
| ```yaml Email Example | ||
| name: Email Task | ||
| tools: | ||
| - name: email_tool | ||
| type: integration | ||
| integration: | ||
| provider: email | ||
| setup: | ||
| host: "smtp.example.com" | ||
| port: 587 | ||
| user: "your_username" | ||
| password: "your_password" | ||
| main: | ||
| - tool: email_tool | ||
| arguments: | ||
| to: "[email protected]" | ||
| from: "[email protected]" | ||
| subject: "Hello from Julep" | ||
| body: "This is a test email sent using Julep's Email integration." | ||
| ``` | ||
| </Step> | ||
| </Steps> | ||
| ### YAML Explanation | ||
| <AccordionGroup> | ||
| <Accordion title="Basic Configuration"> | ||
| - **_name_**: A descriptive name for the task, in this case, "Email Task". | ||
| - **_tools_**: This section lists the tools or integrations being used. Here, `email_tool` is defined as an integration tool. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Tool Configuration"> | ||
| - **_type_**: Specifies the type of tool, which is `integration` in this context. | ||
| - **_integration_**: Details the provider and setup for the integration. | ||
| - **_provider_**: Indicates the service provider, which is `email` for Email integration. | ||
| - **_setup_**: Contains configuration details, such as the SMTP server credentials. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Workflow Configuration"> | ||
| - **_main_**: Defines the main execution steps. | ||
| - **_tool_**: Refers to the tool defined earlier (`email_tool`). | ||
| - **_arguments_**: Specifies the input parameters for the tool: | ||
| - **_to_**: The email address to send the email to. | ||
| - **_from_**: The email address to send the email from. | ||
| - **_subject_**: The subject of the email. | ||
| - **_body_**: The body of the email. | ||
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| <Note> | ||
| Remember to replace the SMTP server credentials and email addresses with your actual information. Ensure your SMTP server allows sending emails from the specified addresses. | ||
| </Note> | ||
|
|
||
| ## Conclusion | ||
|
|
||
| With the Email integration, you can efficiently send emails using SMTP. | ||
| This integration provides a robust solution for email communication, enhancing your workflow's capabilities and user experience. | ||
|
|
||
| For further assistance, feel free to reach out to our support team or consult the [SMTP documentation](https://docs.python.org/3/library/smtplib.html). | ||
|
|
||
| <Callout type="success" title="Need Help?"> | ||
| If you encounter any issues or have questions, our support team is here to help. Don't hesitate to reach out! | ||
| </Callout> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 95 additions & 2 deletions
97
documentation/docs/integrations/document-processing/llama-parse.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,100 @@ | ||
| --- | ||
| title: 'Llama Parse' | ||
| description: 'Learn how to use the Llama Parse integration with Julep' | ||
| icon: 'file' | ||
| icon: 'file-pdf' | ||
| --- | ||
|
|
||
| Coming soon... | ||
| Welcome to the Llama Parse integration guide for Julep! This integration allows you to parse documents efficiently, enabling you to build workflows that require document processing capabilities. Whether you're developing a document management system or need to extract information from files, this guide will walk you through the setup and usage. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| <Info type="info" title="API Key Required"> | ||
| To use the Llama Parse integration, you need an API key. You can obtain this key by signing up at [Llama Parse](https://llamaparse.com/signup). | ||
| </Info> | ||
|
|
||
| ## How to Use the Integration | ||
|
|
||
| To get started with the Llama Parse integration, follow these steps to configure and create a task: | ||
|
|
||
| <Steps> | ||
| <Step title="Configure Your API Key"> | ||
| Add your API key to the Julep dashboard under the integrations section. This will allow Julep to authenticate requests to Llama Parse on your behalf. | ||
| </Step> | ||
| <Step title="Create Task Definition"> | ||
| Use the following YAML configuration to define your document parsing task: | ||
|
|
||
| ```yaml Llama Parse Example | ||
| name: Llama Parse Task | ||
| tools: | ||
| - name: llama_parse | ||
| type: integration | ||
| integration: | ||
| provider: llama-parse | ||
| setup: | ||
| llamaparse_api_key: {llamaparse_api_key} | ||
| params: # Optional setup parameters | ||
| key1: value1 | ||
| key2: value2 | ||
| main: | ||
| - tool: llama_parse | ||
| arguments: | ||
| file: "base64_encoded_file" | ||
| filename: "document.pdf" | ||
| base64: true | ||
| params: # Optional arguments parameters | ||
| key3: value3 | ||
| key4: value4 | ||
| ``` | ||
| </Step> | ||
| <Step title="Run Task"> | ||
| Deploy your task by creating a new execution. | ||
| </Step> | ||
| </Steps> | ||
| ### YAML Explanation | ||
| <AccordionGroup> | ||
| <Accordion title="Basic Configuration"> | ||
| - **_name_**: A descriptive name for the task, in this case, "Llama Parse Task". | ||
| - **_tools_**: This section lists the tools or integrations being used. Here, `llama_parse` is defined as an integration tool. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Tool Configuration"> | ||
| - **_type_**: Specifies the type of tool, which is `integration` in this context. | ||
| - **_integration_**: Details the provider and setup for the integration. | ||
| - **_provider_**: Indicates the service provider, which is `llama-parse` for Llama Parse. | ||
| - **_setup_**: Contains configuration details, such as the API key (`llamaparse_api_key`) required for authentication. | ||
| - **_params_**: Optional setup parameters that can be used to customize the integration. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Execution Configuration"> | ||
| - **_main_**: Defines the main execution steps. | ||
| - **_tool_**: Refers to the tool defined earlier (`llama_parse`). | ||
| - **_arguments_**: Specifies the input parameters for the tool: | ||
| - **_file_**: Can be either a base64 encoded file string or an array of http/https URLs to load | ||
| - **_filename_**: (optional) The name of the file (only used with base64 encoded files). Defaults to None. | ||
| - **_base64_**: (optional) Whether the input file is base64 encoded. Defaults to false. | ||
| - **_params_**: (optional) Optional arguments parameters that can override setup parameters for specific tasks. Defaults to None. | ||
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| <Callout type="info" title="Additional Parameters"> | ||
| The different parameters available for the Llama Parse integration can be found in the [Llama Parse API documentation](https://github.com/run-llama/llama_parse/blob/main/README.md). | ||
| </Callout> | ||
|
|
||
| <Note> | ||
| Remember to replace `{llamaparse_api_key}` with your actual API key and ensure your file is base64 encoded if `base64` is set to true. Use the `params` field to pass any additional parameters required by your specific use case. | ||
| </Note> | ||
| <Note> | ||
| Llama Parse supports a wide range of different file types. For a full list of supported file types, please refer to the [Llama Parse documentation](https://github.com/run-llama/llama_parse/blob/main/llama_parse/utils.py). | ||
| </Note> | ||
| ## Conclusion | ||
|
|
||
| With the Llama Parse integration, you can efficiently process documents and extract valuable information. | ||
| This integration provides a robust solution for document processing, enhancing your workflow's capabilities and user experience. | ||
|
|
||
| For further assistance, feel free to reach out to our support team or consult the [Llama Parse API documentation](https://docs.cloud.llamaindex.ai/llamaparse/getting_started/python). | ||
|
|
||
| <Callout type="success" title="Need Help?"> | ||
| If you encounter any issues or have questions, our support team is here to help. Don't hesitate to reach out! | ||
| </Callout> |
Oops, something went wrong.