mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-02-07 05:15:09 -05:00
docs(blocks): complete block documentation migration cleanup
Move remaining block docs to block-integrations/ subdirectory: - Delete old docs from docs/integrations/ root - Add new docs under docs/integrations/block-integrations/ - Add guides/ directory with LLM and voice provider docs - Update SUMMARY.md with correct navigation structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Nicholas Tindle
@@ -2,39 +2,132 @@
|
||||
|
||||
* [AutoGPT Blocks Overview](README.md)
|
||||
|
||||
## Guides
|
||||
|
||||
* [LLM Providers](guides/llm-providers.md)
|
||||
* [Voice Providers](guides/voice-providers.md)
|
||||
|
||||
## Block Integrations
|
||||
|
||||
* [Basic Operations Blocks](block-integrations/basic.md)
|
||||
* [Read CSV](block-integrations/csv.md)
|
||||
* [Data Sampling](block-integrations/sampling.md)
|
||||
* [Text](block-integrations/text.md)
|
||||
* [Text Decoder](block-integrations/text-decoder.md)
|
||||
* [AI and Large Language Models](block-integrations/ai-and-llm.md)
|
||||
* [Send Web Request](block-integrations/send-web-request.md)
|
||||
* [Read RSS Feed](block-integrations/rss.md)
|
||||
* [Airtable Bases](block-integrations/airtable/bases.md)
|
||||
* [Airtable Records](block-integrations/airtable/records.md)
|
||||
* [Airtable Schema](block-integrations/airtable/schema.md)
|
||||
* [Airtable Triggers](block-integrations/airtable/triggers.md)
|
||||
* [Apollo Organization](block-integrations/apollo/organization.md)
|
||||
* [Apollo People](block-integrations/apollo/people.md)
|
||||
* [Apollo Person](block-integrations/apollo/person.md)
|
||||
* [Ayrshare Post To Bluesky](block-integrations/ayrshare/post_to_bluesky.md)
|
||||
* [Ayrshare Post To Facebook](block-integrations/ayrshare/post_to_facebook.md)
|
||||
* [Ayrshare Post To GMB](block-integrations/ayrshare/post_to_gmb.md)
|
||||
* [Ayrshare Post To Instagram](block-integrations/ayrshare/post_to_instagram.md)
|
||||
* [Ayrshare Post To LinkedIn](block-integrations/ayrshare/post_to_linkedin.md)
|
||||
* [Ayrshare Post To Pinterest](block-integrations/ayrshare/post_to_pinterest.md)
|
||||
* [Ayrshare Post To Reddit](block-integrations/ayrshare/post_to_reddit.md)
|
||||
* [Ayrshare Post To Snapchat](block-integrations/ayrshare/post_to_snapchat.md)
|
||||
* [Ayrshare Post To Telegram](block-integrations/ayrshare/post_to_telegram.md)
|
||||
* [Ayrshare Post To Threads](block-integrations/ayrshare/post_to_threads.md)
|
||||
* [Ayrshare Post To TikTok](block-integrations/ayrshare/post_to_tiktok.md)
|
||||
* [Ayrshare Post To X](block-integrations/ayrshare/post_to_x.md)
|
||||
* [Ayrshare Post To YouTube](block-integrations/ayrshare/post_to_youtube.md)
|
||||
* [Baas Bots](block-integrations/baas/bots.md)
|
||||
* [Bannerbear Text Overlay](block-integrations/bannerbear/text_overlay.md)
|
||||
* [Basic](block-integrations/basic.md)
|
||||
* [Compass Triggers](block-integrations/compass/triggers.md)
|
||||
* [Data](block-integrations/data.md)
|
||||
* [Dataforseo Keyword Suggestions](block-integrations/dataforseo/keyword_suggestions.md)
|
||||
* [Dataforseo Related Keywords](block-integrations/dataforseo/related_keywords.md)
|
||||
* [Discord Bot Blocks](block-integrations/discord/bot_blocks.md)
|
||||
* [Discord OAuth Blocks](block-integrations/discord/oauth_blocks.md)
|
||||
* [Enrichlayer LinkedIn](block-integrations/enrichlayer/linkedin.md)
|
||||
* [Exa Answers](block-integrations/exa/answers.md)
|
||||
* [Exa Code Context](block-integrations/exa/code_context.md)
|
||||
* [Exa Contents](block-integrations/exa/contents.md)
|
||||
* [Exa Research](block-integrations/exa/research.md)
|
||||
* [Exa Search](block-integrations/exa/search.md)
|
||||
* [Exa Similar](block-integrations/exa/similar.md)
|
||||
* [Exa Webhook Blocks](block-integrations/exa/webhook_blocks.md)
|
||||
* [Exa Websets](block-integrations/exa/websets.md)
|
||||
* [Exa Websets Enrichment](block-integrations/exa/websets_enrichment.md)
|
||||
* [Exa Websets Import Export](block-integrations/exa/websets_import_export.md)
|
||||
* [Exa Websets Items](block-integrations/exa/websets_items.md)
|
||||
* [Exa Websets Monitor](block-integrations/exa/websets_monitor.md)
|
||||
* [Exa Websets Polling](block-integrations/exa/websets_polling.md)
|
||||
* [Exa Websets Search](block-integrations/exa/websets_search.md)
|
||||
* [Fal AI Video Generator](block-integrations/fal/ai_video_generator.md)
|
||||
* [Firecrawl Crawl](block-integrations/firecrawl/crawl.md)
|
||||
* [Firecrawl Extract](block-integrations/firecrawl/extract.md)
|
||||
* [Firecrawl Map](block-integrations/firecrawl/map.md)
|
||||
* [Firecrawl Scrape](block-integrations/firecrawl/scrape.md)
|
||||
* [Firecrawl Search](block-integrations/firecrawl/search.md)
|
||||
* [Generic Webhook Triggers](block-integrations/generic_webhook/triggers.md)
|
||||
* [GitHub Checks](block-integrations/github/checks.md)
|
||||
* [GitHub CI](block-integrations/github/ci.md)
|
||||
* [GitHub Issues](block-integrations/github/issues.md)
|
||||
* [GitHub Pull Requests](block-integrations/github/pull_requests.md)
|
||||
* [GitHub Repo](block-integrations/github/repo.md)
|
||||
* [GitHub Reviews](block-integrations/github/reviews.md)
|
||||
* [GitHub Statuses](block-integrations/github/statuses.md)
|
||||
* [GitHub Triggers](block-integrations/github/triggers.md)
|
||||
* [Google Calendar](block-integrations/google/calendar.md)
|
||||
* [Google Docs](block-integrations/google/docs.md)
|
||||
* [Google Gmail](block-integrations/google/gmail.md)
|
||||
* [Google Sheets](block-integrations/google/sheets.md)
|
||||
* [HubSpot Company](block-integrations/hubspot/company.md)
|
||||
* [HubSpot Contact](block-integrations/hubspot/contact.md)
|
||||
* [HubSpot Engagement](block-integrations/hubspot/engagement.md)
|
||||
* [Jina Chunking](block-integrations/jina/chunking.md)
|
||||
* [Jina Embeddings](block-integrations/jina/embeddings.md)
|
||||
* [Jina Fact Checker](block-integrations/jina/fact_checker.md)
|
||||
* [Jina Search](block-integrations/jina/search.md)
|
||||
* [Linear Comment](block-integrations/linear/comment.md)
|
||||
* [Linear Issues](block-integrations/linear/issues.md)
|
||||
* [Linear Projects](block-integrations/linear/projects.md)
|
||||
* [LLM](block-integrations/llm.md)
|
||||
* [Logic](block-integrations/logic.md)
|
||||
* [Misc](block-integrations/misc.md)
|
||||
* [Multimedia](block-integrations/multimedia.md)
|
||||
* [Notion Create Page](block-integrations/notion/create_page.md)
|
||||
* [Notion Read Database](block-integrations/notion/read_database.md)
|
||||
* [Notion Read Page](block-integrations/notion/read_page.md)
|
||||
* [Notion Read Page Markdown](block-integrations/notion/read_page_markdown.md)
|
||||
* [Notion Search](block-integrations/notion/search.md)
|
||||
* [Nvidia Deepfake](block-integrations/nvidia/deepfake.md)
|
||||
* [Replicate Flux Advanced](block-integrations/replicate/flux_advanced.md)
|
||||
* [Replicate Replicate Block](block-integrations/replicate/replicate_block.md)
|
||||
* [Search](block-integrations/search.md)
|
||||
* [Google Maps Search](block-integrations/google-maps.md)
|
||||
* [Reddit Interaction Blocks](block-integrations/reddit.md)
|
||||
* [Publish to Medium](block-integrations/medium.md)
|
||||
* [Discord](block-integrations/discord.md)
|
||||
* [Time and Date](block-integrations/time-and-date.md)
|
||||
* [Mathematical Operations](block-integrations/maths.md)
|
||||
* [Ideogram Model](block-integrations/ideogram.md)
|
||||
* [Create Talking Avatar Video](block-integrations/talking-head.md)
|
||||
* [Unreal Text to Speech](block-integrations/text-to-speech.md)
|
||||
* [AI Shortform Video Creator](block-integrations/ai-shortform-video.md)
|
||||
* [Replicate Flux Advanced Model](block-integrations/replicate-flux-advanced.md)
|
||||
* [Flux Kontext](block-integrations/flux-kontext.md)
|
||||
* [Using D-ID](block-integrations/d-id.md)
|
||||
* [Transcribe YouTube Video](block-integrations/youtube.md)
|
||||
* [Send Email](block-integrations/email.md)
|
||||
* [Condition Block](block-integrations/branching.md)
|
||||
* [Step Through Items](block-integrations/iteration.md)
|
||||
* [AI Condition Block](block-integrations/ai-condition.md)
|
||||
* [Gmail](block-integrations/gmail.md)
|
||||
* [Google Sheets](block-integrations/sheet.md)
|
||||
* [GitHub Issues](block-integrations/github-issues.md)
|
||||
* [GitHub Pull Requests](block-integrations/github-pull-requests.md)
|
||||
* [GitHub Repository](block-integrations/github-repo.md)
|
||||
* [Twitter](block-integrations/twitter.md)
|
||||
* [Todoist](block-integrations/todoist.md)
|
||||
* [Slant3D Filament](block-integrations/slant3d/filament.md)
|
||||
* [Slant3D Order](block-integrations/slant3d/order.md)
|
||||
* [Slant3D Slicing](block-integrations/slant3d/slicing.md)
|
||||
* [Slant3D Webhook](block-integrations/slant3d/webhook.md)
|
||||
* [Smartlead Campaign](block-integrations/smartlead/campaign.md)
|
||||
* [Stagehand Blocks](block-integrations/stagehand/blocks.md)
|
||||
* [System Library Operations](block-integrations/system/library_operations.md)
|
||||
* [System Store Operations](block-integrations/system/store_operations.md)
|
||||
* [Text](block-integrations/text.md)
|
||||
* [Todoist Comments](block-integrations/todoist/comments.md)
|
||||
* [Todoist Labels](block-integrations/todoist/labels.md)
|
||||
* [Todoist Projects](block-integrations/todoist/projects.md)
|
||||
* [Todoist Sections](block-integrations/todoist/sections.md)
|
||||
* [Todoist Tasks](block-integrations/todoist/tasks.md)
|
||||
* [Twitter Blocks](block-integrations/twitter/blocks.md)
|
||||
* [Twitter Bookmark](block-integrations/twitter/bookmark.md)
|
||||
* [Twitter Follows](block-integrations/twitter/follows.md)
|
||||
* [Twitter Hide](block-integrations/twitter/hide.md)
|
||||
* [Twitter Like](block-integrations/twitter/like.md)
|
||||
* [Twitter List Follows](block-integrations/twitter/list_follows.md)
|
||||
* [Twitter List Lookup](block-integrations/twitter/list_lookup.md)
|
||||
* [Twitter List Members](block-integrations/twitter/list_members.md)
|
||||
* [Twitter List Tweets Lookup](block-integrations/twitter/list_tweets_lookup.md)
|
||||
* [Twitter Manage](block-integrations/twitter/manage.md)
|
||||
* [Twitter Manage Lists](block-integrations/twitter/manage_lists.md)
|
||||
* [Twitter Mutes](block-integrations/twitter/mutes.md)
|
||||
* [Twitter Pinned Lists](block-integrations/twitter/pinned_lists.md)
|
||||
* [Twitter Quote](block-integrations/twitter/quote.md)
|
||||
* [Twitter Retweet](block-integrations/twitter/retweet.md)
|
||||
* [Twitter Search Spaces](block-integrations/twitter/search_spaces.md)
|
||||
* [Twitter Spaces Lookup](block-integrations/twitter/spaces_lookup.md)
|
||||
* [Twitter Timeline](block-integrations/twitter/timeline.md)
|
||||
* [Twitter Tweet Lookup](block-integrations/twitter/tweet_lookup.md)
|
||||
* [Twitter User Lookup](block-integrations/twitter/user_lookup.md)
|
||||
* [Wolfram LLM API](block-integrations/wolfram/llm_api.md)
|
||||
* [Zerobounce Validate Emails](block-integrations/zerobounce/validate_emails.md)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,208 +0,0 @@
|
||||
# AI and Large Language Models
|
||||
|
||||
## Large Language Model (LLM) Blocks
|
||||
|
||||
### AI Structured Response Generator
|
||||
|
||||
#### What it is
|
||||
|
||||
A block that generates structured responses using a Large Language Model (LLM).
|
||||
|
||||
#### What it does
|
||||
|
||||
It takes a prompt and other parameters, sends them to an LLM, and returns a structured response in a specified format.
|
||||
|
||||
#### How it works
|
||||
|
||||
The block sends the input prompt to a chosen LLM, along with any system prompts and expected response format. It then processes the LLM's response, ensuring it matches the expected format, and returns the structured data.
|
||||
|
||||
#### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| --------------- | ------------------------------------------------------------- |
|
||||
| Prompt | The main text prompt to send to the LLM |
|
||||
| Expected Format | A dictionary specifying the structure of the desired response |
|
||||
| Model | The specific LLM to use (e.g., GPT-4 Turbo, Claude 3) |
|
||||
| API Key | The secret key for accessing the LLM service |
|
||||
| System Prompt | An optional prompt to guide the LLM's behavior |
|
||||
| Retry | Number of attempts to generate a valid response |
|
||||
| Prompt Values | Dictionary of values to fill in the prompt template |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| -------- | -------------------------------------- |
|
||||
| Response | The structured response from the LLM |
|
||||
| Error | Any error message if the process fails |
|
||||
|
||||
#### Possible use case
|
||||
|
||||
Extracting specific information from unstructured text, such as generating a product description with predefined fields (name, features, price) from a lengthy product review.
|
||||
|
||||
***
|
||||
|
||||
### AI Text Generator
|
||||
|
||||
#### What it is
|
||||
|
||||
A block that generates text responses using a Large Language Model (LLM).
|
||||
|
||||
#### What it does
|
||||
|
||||
It takes a prompt and other parameters, sends them to an LLM, and returns a text response.
|
||||
|
||||
#### How it works
|
||||
|
||||
The block sends the input prompt to a chosen LLM, processes the response, and returns the generated text.
|
||||
|
||||
#### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ------------- | ----------------------------------------------------- |
|
||||
| Prompt | The main text prompt to send to the LLM |
|
||||
| Model | The specific LLM to use (e.g., GPT-4 Turbo, Claude 3) |
|
||||
| API Key | The secret key for accessing the LLM service |
|
||||
| System Prompt | An optional prompt to guide the LLM's behavior |
|
||||
| Retry | Number of attempts to generate a valid response |
|
||||
| Prompt Values | Dictionary of values to fill in the prompt template |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| -------- | -------------------------------------- |
|
||||
| Response | The text response from the LLM |
|
||||
| Error | Any error message if the process fails |
|
||||
|
||||
#### Possible use case
|
||||
|
||||
Generating creative writing, such as short stories or poetry, based on a given theme or starting sentence.
|
||||
|
||||
***
|
||||
|
||||
### AI Text Summarizer
|
||||
|
||||
#### What it is
|
||||
|
||||
A block that summarizes long texts using a Large Language Model (LLM).
|
||||
|
||||
#### What it does
|
||||
|
||||
It takes a long text, breaks it into manageable chunks, summarizes each chunk, and then combines these summaries into a final summary.
|
||||
|
||||
#### How it works
|
||||
|
||||
The block splits the input text into smaller chunks, sends each chunk to an LLM for summarization, and then combines these summaries. If the combined summary is still too long, it repeats the process until a concise summary is achieved.
|
||||
|
||||
#### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ------------- | ------------------------------------------------------------------------- |
|
||||
| Text | The long text to be summarized |
|
||||
| Model | The specific LLM to use for summarization |
|
||||
| Focus | The main topic or aspect to focus on in the summary |
|
||||
| Style | The desired style of the summary (e.g., concise, detailed, bullet points) |
|
||||
| API Key | The secret key for accessing the LLM service |
|
||||
| Max Tokens | The maximum number of tokens for each chunk |
|
||||
| Chunk Overlap | The number of overlapping tokens between chunks |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------- | -------------------------------------- |
|
||||
| Summary | The final summarized text |
|
||||
| Error | Any error message if the process fails |
|
||||
|
||||
#### Possible use case
|
||||
|
||||
Summarizing lengthy research papers or articles to quickly grasp the main points and key findings.
|
||||
|
||||
***
|
||||
|
||||
### AI Conversation
|
||||
|
||||
#### What it is
|
||||
|
||||
A block that facilitates multi-turn conversations using a Large Language Model (LLM).
|
||||
|
||||
#### What it does
|
||||
|
||||
It takes a list of conversation messages, sends them to an LLM, and returns the model's response to continue the conversation.
|
||||
|
||||
#### How it works
|
||||
|
||||
The block sends the entire conversation history to the chosen LLM, including system messages, user inputs, and previous responses. It then returns the LLM's response as the next part of the conversation.
|
||||
|
||||
#### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ---------- | -------------------------------------------------------- |
|
||||
| Messages | A list of previous messages in the conversation |
|
||||
| Model | The specific LLM to use for the conversation |
|
||||
| API Key | The secret key for accessing the LLM service |
|
||||
| Max Tokens | The maximum number of tokens to generate in the response |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| -------- | ----------------------------------------------- |
|
||||
| Response | The LLM's response to continue the conversation |
|
||||
| Error | Any error message if the process fails |
|
||||
|
||||
#### Possible use case
|
||||
|
||||
Creating an interactive chatbot that can maintain context over multiple exchanges, such as a customer service assistant or a language learning companion.
|
||||
|
||||
***
|
||||
|
||||
### AI List Generator
|
||||
|
||||
#### What it is
|
||||
|
||||
A block that generates lists based on given prompts or source data using a Large Language Model (LLM).
|
||||
|
||||
#### What it does
|
||||
|
||||
It takes a focus or source data, sends it to an LLM, and returns a generated list based on the input.
|
||||
|
||||
#### How it works
|
||||
|
||||
The block formulates a prompt based on the given focus or source data, sends it to the chosen LLM, and then processes the response to ensure it's a valid Python list. It can retry multiple times if the initial attempts fail.
|
||||
|
||||
#### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ------------------------------------------------------- |
|
||||
| Focus | The main topic or theme for the list to be generated |
|
||||
| Source Data | Optional data to use as a basis for list generation |
|
||||
| Model | The specific LLM to use for list generation |
|
||||
| API Key | The secret key for accessing the LLM service |
|
||||
| Max Retries | The maximum number of attempts to generate a valid list |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| -------------- | ------------------------------------------ |
|
||||
| Generated List | The full list generated by the LLM |
|
||||
| List Item | Each individual item in the generated list |
|
||||
| Error | Any error message if the process fails |
|
||||
|
||||
#### Possible use case
|
||||
|
||||
Automatically generating a list of key points or action items from a long meeting transcript or summarizing the main topics discussed in a series of documents.
|
||||
|
||||
## Providers
|
||||
|
||||
There are severals providers that AutoGPT users can use for running inference with LLM models.
|
||||
|
||||
### Llama API
|
||||
|
||||
Llama API is a Meta-hosted API service that helps you integrate Llama models quickly and efficiently. Using OpenAI comptability endpoints, you can easily access the power of Llama models without the need for complex setup or configuration!
|
||||
|
||||
Join the [waitlist](https://llama.developer.meta.com/?utm_source=partner-autogpt\&utm_medium=readme) to get access!
|
||||
|
||||
Try the Llama API provider by selecting any of the following LLM Model names from the AI blocks mentioned above:
|
||||
|
||||
* Llama-4-Scout-17B-16E-Instruct-FP8
|
||||
* Llama-4-Maverick-17B-128E-Instruct-FP8
|
||||
* Llama-3.3-8B-Instruct
|
||||
* Llama-3-70B-Instruct
|
||||
@@ -1,87 +0,0 @@
|
||||
# AI Condition Block
|
||||
|
||||
## What it is
|
||||
|
||||
The AI Condition Block is a logical component that uses artificial intelligence to evaluate natural language conditions and produces outputs based on the result. This block allows you to define conditions in plain English rather than using traditional comparison operators.
|
||||
|
||||
## What it does
|
||||
|
||||
This block takes an input value and a natural language condition, then uses AI to determine whether the input satisfies the condition. Based on the result, it provides conditional outputs similar to a traditional if/else statement but with the flexibility of natural language evaluation.
|
||||
|
||||
## How it works
|
||||
|
||||
The block uses a Large Language Model (LLM) to evaluate the condition by: 1. Converting the input value to a string representation 2. Sending a carefully crafted prompt to the AI asking it to evaluate whether the input meets the specified condition 3. Parsing the AI's response to determine a true/false result 4. Outputting the appropriate value based on the result.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | --------------------------------------------------------------------------------------------------- |
|
||||
| Input Value | The value to be evaluated (can be text, number, or any data type) |
|
||||
| Condition | A plaintext English description of the condition to evaluate |
|
||||
| Yes Value | (Optional) The value to output if the condition is true. If not provided, Input Value will be used |
|
||||
| No Value | (Optional) The value to output if the condition is false. If not provided, Input Value will be used |
|
||||
| Model | The LLM model to use for evaluation (defaults to GPT-4o) |
|
||||
| Credentials | API credentials for the LLM provider |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| Result | A boolean value (true or false) indicating whether the condition was met |
|
||||
| Yes Output | The output value if the condition is true. This will be the Yes Value if provided, or Input Value if not |
|
||||
| No Output | The output value if the condition is false. This will be the No Value if provided, or Input Value if not |
|
||||
| Error Message | Error message if the AI evaluation is uncertain or fails (empty string if successful) |
|
||||
|
||||
## Examples <a href="#examples" id="examples"></a>
|
||||
|
||||
### Email Address Validation <a href="#email-address-validation" id="email-address-validation"></a>
|
||||
|
||||
* **Input Value**: `"john@example.com"`
|
||||
* **Condition**: `"the input is an email address"`
|
||||
* **Result**: `true`
|
||||
* **Yes Output**: `"john@example.com"` (or custom Yes Value)
|
||||
|
||||
### Geographic Location Check <a href="#geographic-location-check" id="geographic-location-check"></a>
|
||||
|
||||
* **Input Value**: `"San Francisco"`
|
||||
* **Condition**: `"the input is a city in the USA"`
|
||||
* **Result**: `true`
|
||||
* **Yes Output**: `"San Francisco"` (or custom Yes Value)
|
||||
|
||||
### Error Detection <a href="#error-detection" id="error-detection"></a>
|
||||
|
||||
* **Input Value**: `"Error: Connection timeout"`
|
||||
* **Condition**: `"the input is an error message or refusal"`
|
||||
* **Result**: `true`
|
||||
* **Yes Output**: `"Error: Connection timeout"` (or custom Yes Value)
|
||||
|
||||
### Content Classification <a href="#content-classification" id="content-classification"></a>
|
||||
|
||||
* **Input Value**: `"This is a detailed explanation of how machine learning works..."`
|
||||
* **Condition**: `"the input is the body of an email"`
|
||||
* **Result**: `false` (it's more like article content)
|
||||
* **No Output**: Custom No Value or the input value
|
||||
|
||||
## Possible Use Cases <a href="#possible-use-cases" id="possible-use-cases"></a>
|
||||
|
||||
* **Content Classification**: Automatically classify text content (emails, articles, comments, etc.)
|
||||
* **Data Validation**: Validate input data using natural language rules
|
||||
* **Smart Routing**: Route data through different paths based on AI-evaluated conditions
|
||||
* **Quality Control**: Check if content meets certain quality or format standards
|
||||
* **Language Detection**: Determine if text is in a specific language or style
|
||||
* **Sentiment Analysis**: Evaluate if content has positive, negative, or neutral sentiment
|
||||
* **Error Handling**: Detect and route error messages or problematic inputs
|
||||
|
||||
## Advantages over Traditional Condition Blocks <a href="#advantages-over-traditional-condition-blocks" id="advantages-over-traditional-condition-blocks"></a>
|
||||
|
||||
* **Flexibility**: Can handle complex, nuanced conditions that would be difficult to express with simple comparisons
|
||||
* **Natural Language**: Uses everyday language instead of programming logic
|
||||
* **Context Awareness**: AI can understand context and meaning, not just exact matches
|
||||
* **Adaptability**: Can handle variations in input format and wording
|
||||
|
||||
## Considerations <a href="#considerations" id="considerations"></a>
|
||||
|
||||
* **Performance**: Requires an API call to an LLM, which adds latency compared to traditional conditions
|
||||
* **Cost**: Each evaluation consumes LLM tokens, which has associated costs
|
||||
* **Reliability**: AI responses may occasionally be inconsistent, so critical logic should include fallback handling
|
||||
* **Network Dependency**: Requires internet connectivity to access the LLM API
|
||||
@@ -1,38 +0,0 @@
|
||||
# AI Shortform Video Creator
|
||||
|
||||
## What it is
|
||||
|
||||
The AI Shortform Video Creator is a tool that generates short-form videos using artificial intelligence and various customization options.
|
||||
|
||||
## What it does
|
||||
|
||||
This block creates short videos by combining AI-generated visuals, narration, and background music based on user input. It can produce different styles of videos, including stock videos, moving AI images, or AI-generated videos.
|
||||
|
||||
## How it works
|
||||
|
||||
The block takes user input for script, visual style, audio, and other parameters. It then sends this information to the revid.ai API, which processes the request and generates the video. The block monitors the video creation process and provides the final video URL once it's ready.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------------- | -------------------------------------------------------------------------------- |
|
||||
| API Key | Your revid.ai API key for authentication |
|
||||
| Script | The text content for the video, including spoken narration and visual directions |
|
||||
| Ratio | The aspect ratio of the video (e.g., "9 / 16" for vertical videos) |
|
||||
| Resolution | The video resolution (e.g., "720p") |
|
||||
| Frame Rate | The number of frames per second in the video |
|
||||
| Generation Preset | The visual style for AI-generated content (e.g., "Default", "Anime", "Realist") |
|
||||
| Background Music | The choice of background music track |
|
||||
| Voice | The AI voice to use for narration |
|
||||
| Video Style | The type of visual media to use (stock videos, moving AI images, or AI video) |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| --------- | ----------------------------------------------------------------------------------- |
|
||||
| Video URL | The web address where the created video can be accessed |
|
||||
| Error | A message explaining any issues that occurred during video creation (if applicable) |
|
||||
|
||||
## Possible use case
|
||||
|
||||
A social media marketer could use this block to quickly create engaging short-form videos for platforms like TikTok or Instagram Reels. They could input a script about a new product, choose a suitable visual style and background music, and get a professional-looking video without needing advanced video editing skills.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,35 +1,29 @@
|
||||
# Condition Block
|
||||
|
||||
## What it is
|
||||
|
||||
The Condition Block is a logical component that evaluates comparisons between two values and produces outputs based on the result.
|
||||
|
||||
## What it does
|
||||
|
||||
This block compares two input values using a specified comparison operator and determines whether the condition is true or false. It then outputs the result of the comparison and provides corresponding output values for both true and false cases.
|
||||
|
||||
## How it works
|
||||
|
||||
The block takes two values and a comparison operator as inputs. It then performs the comparison using the specified operator. Based on the result of the comparison, it outputs a boolean value (true or false) and the corresponding output value for the true or false case.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description |
|
||||
| --------- | ----------------------------------------------------------------------------------------------- |
|
||||
| Value 1 | The first value to be compared. This can be any type of value (number, text, or boolean) |
|
||||
| Operator | The comparison operator to use (e.g., equal to, not equal to, greater than, less than) |
|
||||
| Value 2 | The second value to be compared. This can be any type of value (number, text, or boolean) |
|
||||
| Yes Value | (Optional) The value to output if the condition is true. If not provided, Value 1 will be used |
|
||||
| No Value | (Optional) The value to output if the condition is false. If not provided, Value 1 will be used |
|
||||
| Input | Description |
|
||||
|-------|-------------|
|
||||
| Value 1 | The first value to be compared. This can be any type of value (number, text, or boolean) |
|
||||
| Operator | The comparison operator to use (e.g., equal to, not equal to, greater than, less than) |
|
||||
| Value 2 | The second value to be compared. This can be any type of value (number, text, or boolean) |
|
||||
| Yes Value | (Optional) The value to output if the condition is true. If not provided, Value 1 will be used |
|
||||
| No Value | (Optional) The value to output if the condition is false. If not provided, Value 1 will be used |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ---------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| Result | A boolean value (true or false) indicating whether the condition was met |
|
||||
| Output | Description |
|
||||
|--------|-------------|
|
||||
| Result | A boolean value (true or false) indicating whether the condition was met |
|
||||
| Yes Output | The output value if the condition is true. This will be the Yes Value if provided, or Value 1 if not |
|
||||
| No Output | The output value if the condition is false. This will be the No Value if provided, or Value 1 if not |
|
||||
| No Output | The output value if the condition is false. This will be the No Value if provided, or Value 1 if not |
|
||||
|
||||
## Possible use case
|
||||
|
||||
This block could be used in a customer loyalty program to determine if a customer qualifies for a discount. For example, you could compare the customer's total purchases (Value 1) with a threshold amount (Value 2) using the "greater than or equal to" operator. The Yes Value could be "Qualified for discount" and the No Value could be "Not qualified". The block would then output whether the customer qualifies and the appropriate message.
|
||||
This block could be used in a customer loyalty program to determine if a customer qualifies for a discount. For example, you could compare the customer's total purchases (Value 1) with a threshold amount (Value 2) using the "greater than or equal to" operator. The Yes Value could be "Qualified for discount" and the No Value could be "Not qualified". The block would then output whether the customer qualifies and the appropriate message.
|
||||
@@ -1,37 +1,31 @@
|
||||
# Read CSV
|
||||
|
||||
## What It Is <a href="#what-it-is" id="what-it-is"></a>
|
||||
|
||||
## What it is
|
||||
A block that reads and processes CSV (Comma-Separated Values) files.
|
||||
|
||||
## What It Does <a href="#what-it-does" id="what-it-does"></a>
|
||||
|
||||
## What it does
|
||||
This block takes CSV content as input, processes it, and outputs the data as individual rows and a complete dataset.
|
||||
|
||||
## How It Works <a href="#how-it-works" id="how-it-works"></a>
|
||||
|
||||
## How it works
|
||||
The Read CSV block takes the contents of a CSV file and splits it into rows and columns. It can handle different formatting options, such as custom delimiters and quote characters. The block processes the CSV data and outputs each row individually, as well as the complete dataset.
|
||||
|
||||
## Inputs <a href="#inputs" id="inputs"></a>
|
||||
## Inputs
|
||||
| Input | Description |
|
||||
|-------|-------------|
|
||||
| Contents | The CSV data as a string |
|
||||
| Delimiter | The character used to separate values in the CSV (default is comma ",") |
|
||||
| Quotechar | The character used to enclose fields containing special characters (default is double quote '"') |
|
||||
| Escapechar | The character used to escape special characters (default is backslash "\") |
|
||||
| Has_header | Indicates whether the CSV has a header row (default is true) |
|
||||
| Skip_rows | The number of rows to skip at the beginning of the CSV (default is 0) |
|
||||
| Strip | Whether to remove leading and trailing whitespace from values (default is true) |
|
||||
| Skip_columns | A list of column names to exclude from the output (default is an empty list) |
|
||||
|
||||
| Input | Description |
|
||||
| ------------- | ------------------------------------------------------------------------------------------------ |
|
||||
| Contents | The CSV data as a string |
|
||||
| Delimiter | The character used to separate values in the CSV (default is comma ",") |
|
||||
| Quotechar | The character used to enclose fields containing special characters (default is double quote '"') |
|
||||
| Escapechar | The character used to escape special characters (default is backslash "") |
|
||||
| Has\_header | Indicates whether the CSV has a header row (default is true) |
|
||||
| Skip\_rows | The number of rows to skip at the beginning of the CSV (default is 0) |
|
||||
| Strip | Whether to remove leading and trailing whitespace from values (default is true) |
|
||||
| Skip\_columns | A list of column names to exclude from the output (default is an empty list) |
|
||||
## Outputs
|
||||
| Output | Description |
|
||||
|--------|-------------|
|
||||
| Row | A dictionary representing a single row of the CSV, with column names as keys and cell values as values |
|
||||
| All_data | A list of dictionaries containing all rows from the CSV |
|
||||
|
||||
## Outputs <a href="#outputs" id="outputs"></a>
|
||||
|
||||
| Output | Description |
|
||||
| --------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| Row | A dictionary representing a single row of the CSV, with column names as keys and cell values as values |
|
||||
| All\_data | A list of dictionaries containing all rows from the CSV |
|
||||
|
||||
## Possible Use Case <a href="#possible-use-case" id="possible-use-case"></a>
|
||||
|
||||
This block could be used in a data analysis pipeline to import and process customer information from a CSV file. The individual rows could be used for real-time processing, while the complete dataset could be used for batch analysis or reporting.
|
||||
## Possible use case
|
||||
This block could be used in a data analysis pipeline to import and process customer information from a CSV file. The individual rows could be used for real-time processing, while the complete dataset could be used for batch analysis or reporting.
|
||||
@@ -1,20 +0,0 @@
|
||||
# Using D-ID
|
||||
|
||||
## **ElevenLabs**
|
||||
|
||||
1. Select any voice from the voice list: [https://api.elevenlabs.io/v1/voices](https://api.elevenlabs.io/v1/voices)
|
||||
2. Copy the voice\_id
|
||||
3. Use it as a string in the voice\_id field in the CreateTalkingAvatarClip Block
|
||||
|
||||
## **Microsoft Azure Voices**
|
||||
|
||||
1. Select any voice from the voice gallery: [https://speech.microsoft.com/portal/voicegallery](https://speech.microsoft.com/portal/voicegallery)
|
||||
2. Click on the "Sample code" tab on the right
|
||||
3. Copy the voice name, for example: config.SpeechSynthesisVoiceName ="en-GB-AbbiNeural"
|
||||
4. Use this string en-GB-AbbiNeural in the voice\_id field in the CreateTalkingAvatarClip Block
|
||||
|
||||
## **Amazon Polly Voices**
|
||||
|
||||
1. Select any voice from the voice list: [https://docs.aws.amazon.com/polly/latest/dg/available-voices.html](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
|
||||
2. Copy the voice name / ID
|
||||
3. Use it as string in the voice\_id field in the CreateTalkingAvatarClip Block
|
||||
@@ -1,68 +1,54 @@
|
||||
# Discord
|
||||
|
||||
### Read Discord Messages
|
||||
|
||||
#### What it is
|
||||
## Read Discord Messages
|
||||
|
||||
### What it is
|
||||
A block that reads messages from a Discord channel using a bot token.
|
||||
|
||||
#### What it does
|
||||
|
||||
### What it does
|
||||
This block connects to Discord using a bot token and retrieves messages from a specified channel. It can operate continuously or retrieve a single message.
|
||||
|
||||
#### How it works
|
||||
|
||||
### How it works
|
||||
The block uses a Discord bot to log into a server and listen for new messages. When a message is received, it extracts the content, channel name, and username of the sender. If the message contains a text file attachment, the block also retrieves and includes the file's content.
|
||||
|
||||
#### Inputs
|
||||
### Inputs
|
||||
| Input | Description |
|
||||
|-------|-------------|
|
||||
| Discord Bot Token | A secret token used to authenticate the bot with Discord |
|
||||
| Continuous Read | A boolean flag indicating whether to continuously read messages or stop after one message |
|
||||
|
||||
| Input | Description |
|
||||
| ----------------- | ----------------------------------------------------------------------------------------- |
|
||||
| Discord Bot Token | A secret token used to authenticate the bot with Discord |
|
||||
| Continuous Read | A boolean flag indicating whether to continuously read messages or stop after one message |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| --------------- | ----------------------------------------------------------------------------- |
|
||||
### Outputs
|
||||
| Output | Description |
|
||||
|--------|-------------|
|
||||
| Message Content | The text content of the received message, including any attached file content |
|
||||
| Channel Name | The name of the Discord channel where the message was received |
|
||||
| Username | The name of the user who sent the message |
|
||||
|
||||
#### Possible use case
|
||||
| Channel Name | The name of the Discord channel where the message was received |
|
||||
| Username | The name of the user who sent the message |
|
||||
|
||||
### Possible use case
|
||||
This block could be used to monitor a Discord channel for support requests. When a user posts a message, the block captures it, allowing another part of the system to process and respond to the request.
|
||||
|
||||
***
|
||||
---
|
||||
|
||||
### Send Discord Message
|
||||
|
||||
#### What it is
|
||||
## Send Discord Message
|
||||
|
||||
### What it is
|
||||
A block that sends messages to a Discord channel using a bot token.
|
||||
|
||||
#### What it does
|
||||
|
||||
### What it does
|
||||
This block connects to Discord using a bot token and sends a specified message to a designated channel.
|
||||
|
||||
#### How it works
|
||||
|
||||
### How it works
|
||||
The block uses a Discord bot to log into a server, locate the specified channel, and send the provided message. If the message is longer than Discord's character limit, it automatically splits the message into smaller chunks and sends them sequentially.
|
||||
|
||||
#### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------------- | -------------------------------------------------------- |
|
||||
### Inputs
|
||||
| Input | Description |
|
||||
|-------|-------------|
|
||||
| Discord Bot Token | A secret token used to authenticate the bot with Discord |
|
||||
| Message Content | The text content of the message to be sent |
|
||||
| Channel Name | Channel ID or channel name to send the message to |
|
||||
| Message Content | The text content of the message to be sent |
|
||||
| Channel Name | Channel ID or channel name to send the message to |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | --------------------------------------------------------------------------------------------- |
|
||||
### Outputs
|
||||
| Output | Description |
|
||||
|--------|-------------|
|
||||
| Status | A string indicating the result of the operation (e.g., "Message sent" or "Channel not found") |
|
||||
|
||||
#### Possible use case
|
||||
|
||||
This block could be used as part of an automated notification system. For example, it could send alerts to a Discord channel when certain events occur in another system, such as when a new user signs up or when a critical error is detected.
|
||||
### Possible use case
|
||||
This block could be used as part of an automated notification system. For example, it could send alerts to a Discord channel when certain events occur in another system, such as when a new user signs up or when a critical error is detected.
|
||||
@@ -1,42 +0,0 @@
|
||||
# Send Email
|
||||
|
||||
## What it is
|
||||
|
||||
The Send Email block is a tool for sending emails using SMTP (Simple Mail Transfer Protocol) credentials.
|
||||
|
||||
## What it does
|
||||
|
||||
This block allows users to send an email to a specified recipient with a custom subject and body. It uses provided SMTP credentials to connect to an email server and send the message.
|
||||
|
||||
## How it works
|
||||
|
||||
The block takes the recipient's email address, subject, and body of the email as inputs. It also requires SMTP credentials, including the server address, port, username, and password. The block then connects to the specified SMTP server, authenticates using the provided credentials, and sends the email. After attempting to send the email, it reports back whether the operation was successful or if an error occurred.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ---------------- | ------------------------------------------------------- |
|
||||
| To Email | The email address of the recipient |
|
||||
| Subject | The subject line of the email |
|
||||
| Body | The main content of the email message |
|
||||
| SMTP Credentials | Server, port, username, and password for authentication |
|
||||
|
||||
### SMTP Credentials Details
|
||||
|
||||
| Credential | Description | Default |
|
||||
| ------------- | ---------------------------------------------------- | -------------- |
|
||||
| SMTP Server | The address of the SMTP server | smtp.gmail.com |
|
||||
| SMTP Port | The port number for the SMTP server | 25 |
|
||||
| SMTP Username | The username for authenticating with the SMTP server | - |
|
||||
| SMTP Password | The password for authenticating with the SMTP server | - |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | -------------------------------------------------------------------------------------- |
|
||||
| Status | A message indicating whether the email was sent successfully |
|
||||
| Error | If the email sending fails, this output provides details about the error that occurred |
|
||||
|
||||
## Possible use case
|
||||
|
||||
This block could be used in an automated customer support system. When a customer submits a support ticket through a website, the Send Email block could automatically send a confirmation email to the customer, acknowledging receipt of their request and providing them with a ticket number for future reference.
|
||||
@@ -1,37 +0,0 @@
|
||||
# Flux Kontext
|
||||
|
||||
## What it is
|
||||
|
||||
An internal block that performs text-based image editing using BlackForest Labs' Flux Kontext models.
|
||||
|
||||
## What it does
|
||||
|
||||
Takes a prompt describing the desired transformation and optionally a reference image, then returns a new image URL.
|
||||
|
||||
## How it works
|
||||
|
||||
The block sends your prompt, image, and settings to the selected Flux Kontext model on Replicate. The service processes the request and returns a link to the edited image.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ------------ | ------------------------------------------------------------------------------- |
|
||||
| Credentials | Replicate API key with permissions for Flux Kontext models |
|
||||
| Prompt | Text instruction describing the desired edit |
|
||||
| Input Image | (Optional) Reference image URI (jpeg, png, gif, webp) |
|
||||
| Aspect Ratio | Aspect ratio of the generated image (e.g. match\_input\_image, 1:1, 16:9, etc.) |
|
||||
| Seed | (Optional, advanced) Random seed for reproducible generation |
|
||||
| Model | Model variant to use: Flux Kontext Pro or Flux Kontext Max |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ---------- | ---------------------------------- |
|
||||
| image\_url | URL of the transformed image |
|
||||
| error | Error message if generation failed |
|
||||
|
||||
## Use Cases
|
||||
|
||||
* Enhance a marketing image by requesting "add soft lighting and a subtle vignette" while providing the original asset as the reference image.
|
||||
* Generate social media assets with specific aspect ratios and style prompts.
|
||||
* Apply creative edits to product photos using text instructions.
|
||||
@@ -1,284 +0,0 @@
|
||||
# GitHub Issues
|
||||
|
||||
## Github Comment
|
||||
|
||||
### What it is
|
||||
|
||||
A block that posts comments on GitHub issues or pull requests.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to add comments to existing GitHub issues or pull requests using the GitHub API.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials, the URL of the issue or pull request, and the comment text as inputs. It then sends a request to the GitHub API to post the comment on the specified issue or pull request.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ---------------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Issue URL | The URL of the GitHub issue or pull request where the comment will be posted |
|
||||
| Comment | The text content of the comment to be posted |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------- |
|
||||
| ID | The unique identifier of the created comment |
|
||||
| URL | The direct link to the posted comment on GitHub |
|
||||
| Error | Any error message if the comment posting fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automating responses to issues in a GitHub repository, such as thanking contributors for their submissions or providing status updates on reported bugs.
|
||||
|
||||
***
|
||||
|
||||
## Github Make Issue
|
||||
|
||||
### What it is
|
||||
|
||||
A block that creates new issues on GitHub repositories.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to create new issues in a specified GitHub repository with a title and body content.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials, repository URL, issue title, and issue body as inputs. It then sends a request to the GitHub API to create a new issue with the provided information.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ---------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Repo URL | The URL of the GitHub repository where the issue will be created |
|
||||
| Title | The title of the new issue |
|
||||
| Body | The main content or description of the new issue |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ---------------------------------------------------- |
|
||||
| Number | The issue number assigned by GitHub |
|
||||
| URL | The direct link to the newly created issue on GitHub |
|
||||
| Error | Any error message if the issue creation fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically creating issues for bug reports or feature requests submitted through an external system or form.
|
||||
|
||||
***
|
||||
|
||||
## Github Read Issue
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves information about a specific GitHub issue.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches the details of a given GitHub issue, including its title, body content, and the user who created it.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials and the issue URL as inputs. It then sends a request to the GitHub API to fetch the issue's details and returns the relevant information.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Issue URL | The URL of the GitHub issue to be read |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ------------------------------------------------ |
|
||||
| Title | The title of the issue |
|
||||
| Body | The main content or description of the issue |
|
||||
| User | The username of the person who created the issue |
|
||||
| Error | Any error message if reading the issue fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Gathering information about reported issues for analysis or to display on a dashboard.
|
||||
|
||||
***
|
||||
|
||||
## Github List Issues
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves a list of issues from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches all open issues from a specified GitHub repository and provides their titles and URLs.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials and repository URL as inputs. It then sends a request to the GitHub API to fetch the list of issues and returns their details.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ---------------------------------------------------- |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Repo URL | The URL of the GitHub repository to list issues from |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------- | --------------------------------------------- |
|
||||
| Issue | A list of issues, each containing: |
|
||||
| - Title | The title of the issue |
|
||||
| - URL | The direct link to the issue on GitHub |
|
||||
| Error | Any error message if listing the issues fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Creating a summary of open issues for a project status report or displaying them on a project management dashboard.
|
||||
|
||||
***
|
||||
|
||||
## Github Add Label
|
||||
|
||||
### What it is
|
||||
|
||||
A block that adds a label to a GitHub issue or pull request.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to add a specified label to an existing GitHub issue or pull request.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials, the URL of the issue or pull request, and the label to be added as inputs. It then sends a request to the GitHub API to add the label to the specified issue or pull request.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | --------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Issue URL | The URL of the GitHub issue or pull request to add the label to |
|
||||
| Label | The name of the label to be added |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ------------------------------------------------------------- |
|
||||
| Status | A message indicating whether the label was successfully added |
|
||||
| Error | Any error message if adding the label fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically categorizing issues based on their content or assigning priority labels to newly created issues.
|
||||
|
||||
***
|
||||
|
||||
## Github Remove Label
|
||||
|
||||
### What it is
|
||||
|
||||
A block that removes a label from a GitHub issue or pull request.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to remove a specified label from an existing GitHub issue or pull request.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials, the URL of the issue or pull request, and the label to be removed as inputs. It then sends a request to the GitHub API to remove the label from the specified issue or pull request.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | -------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Issue URL | The URL of the GitHub issue or pull request to remove the label from |
|
||||
| Label | The name of the label to be removed |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | --------------------------------------------------------------- |
|
||||
| Status | A message indicating whether the label was successfully removed |
|
||||
| Error | Any error message if removing the label fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Updating the status of issues as they progress through a workflow, such as removing a "In Progress" label when an issue is completed.
|
||||
|
||||
***
|
||||
|
||||
## Github Assign Issue
|
||||
|
||||
### What it is
|
||||
|
||||
A block that assigns a user to a GitHub issue.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to assign a specific GitHub user to an existing issue.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials, the URL of the issue, and the username of the person to be assigned as inputs. It then sends a request to the GitHub API to assign the specified user to the issue.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ------------------------------------------------------ |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Issue URL | The URL of the GitHub issue to assign |
|
||||
| Assignee | The username of the person to be assigned to the issue |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ---------------------------------------------------------------- |
|
||||
| Status | A message indicating whether the issue was successfully assigned |
|
||||
| Error | Any error message if assigning the issue fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically assigning new issues to team members based on their expertise or workload.
|
||||
|
||||
***
|
||||
|
||||
## Github Unassign Issue
|
||||
|
||||
### What it is
|
||||
|
||||
A block that unassigns a user from a GitHub issue.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to remove a specific GitHub user's assignment from an existing issue.
|
||||
|
||||
### How it works
|
||||
|
||||
The block takes the GitHub credentials, the URL of the issue, and the username of the person to be unassigned as inputs. It then sends a request to the GitHub API to remove the specified user's assignment from the issue.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ---------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication information |
|
||||
| Issue URL | The URL of the GitHub issue to unassign |
|
||||
| Assignee | The username of the person to be unassigned from the issue |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ------------------------------------------------------------------ |
|
||||
| Status | A message indicating whether the issue was successfully unassigned |
|
||||
| Error | Any error message if unassigning the issue fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically unassigning issues that have been inactive for a certain period or when reassigning workload among team members.
|
||||
@@ -1,218 +0,0 @@
|
||||
# GitHub Pull Requests
|
||||
|
||||
## GitHub List Pull Requests
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves a list of pull requests from a specified GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches all open pull requests for a given GitHub repository and provides their titles and URLs.
|
||||
|
||||
### How it works
|
||||
|
||||
It connects to the GitHub API using the provided credentials and repository URL, then retrieves the list of pull requests and formats the information for easy viewing.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ------------------------------------------------------------ |
|
||||
| Credentials | GitHub authentication details to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository to fetch pull requests from |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------------ | ----------------------------------------- |
|
||||
| Pull Request | A list of pull requests, each containing: |
|
||||
| - Title | The title of the pull request |
|
||||
| - URL | The web address of the pull request |
|
||||
| Error | An error message if the operation fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A development team leader wants to quickly review all open pull requests in their project repository to prioritize code reviews.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Make Pull Request
|
||||
|
||||
### What it is
|
||||
|
||||
A block that creates a new pull request in a specified GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to create a new pull request by providing details such as title, body, and branch information.
|
||||
|
||||
### How it works
|
||||
|
||||
It uses the GitHub API to create a new pull request with the given information, including the source and target branches for the changes.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ----------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication details to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository where the pull request will be created |
|
||||
| Title | The title of the new pull request |
|
||||
| Body | The description or content of the pull request |
|
||||
| Head | The name of the branch containing the changes |
|
||||
| Base | The name of the branch you want to merge the changes into |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | --------------------------------------------------- |
|
||||
| Number | The unique identifier of the created pull request |
|
||||
| URL | The web address of the newly created pull request |
|
||||
| Error | An error message if the pull request creation fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A developer has finished working on a new feature in a separate branch and wants to create a pull request to merge their changes into the main branch for review.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Read Pull Request
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves detailed information about a specific GitHub pull request.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches and provides comprehensive information about a given pull request, including its title, body, author, and optionally, the changes made.
|
||||
|
||||
### How it works
|
||||
|
||||
It connects to the GitHub API using the provided credentials and pull request URL, then retrieves and formats the requested information.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ------------------ | ---------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication details to access the repository |
|
||||
| Pull Request URL | The URL of the specific GitHub pull request to read |
|
||||
| Include PR Changes | An option to include the actual changes made in the pull request |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------- | --------------------------------------------------------- |
|
||||
| Title | The title of the pull request |
|
||||
| Body | The description or content of the pull request |
|
||||
| Author | The username of the person who created the pull request |
|
||||
| Changes | A list of changes made in the pull request (if requested) |
|
||||
| Error | An error message if reading the pull request fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A code reviewer wants to get a comprehensive overview of a pull request, including its description and changes, before starting the review process.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Assign PR Reviewer
|
||||
|
||||
### What it is
|
||||
|
||||
A block that assigns a reviewer to a specific GitHub pull request.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to assign a designated reviewer to a given pull request in a GitHub repository.
|
||||
|
||||
### How it works
|
||||
|
||||
It uses the GitHub API to add the specified user as a reviewer for the given pull request.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ---------------- | ------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication details to access the repository |
|
||||
| Pull Request URL | The URL of the specific GitHub pull request to assign a reviewer to |
|
||||
| Reviewer | The username of the GitHub user to be assigned as a reviewer |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ------------------------------------------------------------------- |
|
||||
| Status | A message indicating whether the reviewer was successfully assigned |
|
||||
| Error | An error message if the reviewer assignment fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A project manager wants to assign a specific team member to review a newly created pull request for a critical feature.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Unassign PR Reviewer
|
||||
|
||||
### What it is
|
||||
|
||||
A block that removes an assigned reviewer from a specific GitHub pull request.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to unassign a previously designated reviewer from a given pull request in a GitHub repository.
|
||||
|
||||
### How it works
|
||||
|
||||
It uses the GitHub API to remove the specified user from the list of reviewers for the given pull request.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ---------------- | ----------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication details to access the repository |
|
||||
| Pull Request URL | The URL of the specific GitHub pull request to unassign a reviewer from |
|
||||
| Reviewer | The username of the GitHub user to be unassigned as a reviewer |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | --------------------------------------------------------------------- |
|
||||
| Status | A message indicating whether the reviewer was successfully unassigned |
|
||||
| Error | An error message if the reviewer unassignment fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A team lead realizes that an assigned reviewer is unavailable and wants to remove them from a pull request to reassign it to another team member.
|
||||
|
||||
***
|
||||
|
||||
## GitHub List PR Reviewers
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves a list of all assigned reviewers for a specific GitHub pull request.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches and provides information about all the reviewers currently assigned to a given pull request in a GitHub repository.
|
||||
|
||||
### How it works
|
||||
|
||||
It connects to the GitHub API using the provided credentials and pull request URL, then retrieves and formats the list of assigned reviewers.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ---------------- | ----------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication details to access the repository |
|
||||
| Pull Request URL | The URL of the specific GitHub pull request to list reviewers for |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ---------- | ----------------------------------------------- |
|
||||
| Reviewer | A list of assigned reviewers, each containing: |
|
||||
| - Username | The GitHub username of the reviewer |
|
||||
| - URL | The profile URL of the reviewer |
|
||||
| Error | An error message if listing the reviewers fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A project coordinator wants to check who is currently assigned to review a specific pull request to ensure all necessary team members are involved in the code review process.
|
||||
@@ -1,282 +0,0 @@
|
||||
# GitHub Repository
|
||||
|
||||
## GitHub List Tags
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves and lists all tags for a specified GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches all tags associated with a given GitHub repository and provides their names and URLs.
|
||||
|
||||
### How it works
|
||||
|
||||
The block connects to the GitHub API using provided credentials, sends a request to retrieve tag information for the specified repository, and then processes the response to extract tag names and URLs.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository to fetch tags from |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ------------------------------------------------------ |
|
||||
| Tag | Information about each tag, including its name and URL |
|
||||
| Error | Any error message if the tag listing process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A developer wants to quickly view all release tags for a project to identify the latest version or track the project's release history.
|
||||
|
||||
***
|
||||
|
||||
## GitHub List Branches
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves and lists all branches for a specified GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches all branches associated with a given GitHub repository and provides their names and URLs.
|
||||
|
||||
### How it works
|
||||
|
||||
The block authenticates with the GitHub API, sends a request to get branch information for the specified repository, and then processes the response to extract branch names and URLs.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository to fetch branches from |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | --------------------------------------------------------- |
|
||||
| Branch | Information about each branch, including its name and URL |
|
||||
| Error | Any error message if the branch listing process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A project manager wants to review all active branches in a repository to track ongoing development efforts and feature implementations.
|
||||
|
||||
***
|
||||
|
||||
## GitHub List Discussions
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves and lists recent discussions for a specified GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches a specified number of recent discussions from a given GitHub repository and provides their titles and URLs.
|
||||
|
||||
### How it works
|
||||
|
||||
The block uses the GitHub GraphQL API to request discussion data for the specified repository, processes the response, and extracts discussion titles and URLs.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| --------------------- | ------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository to fetch discussions from |
|
||||
| Number of Discussions | The number of recent discussions to retrieve (default is 5) |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ---------- | -------------------------------------------------------------- |
|
||||
| Discussion | Information about each discussion, including its title and URL |
|
||||
| Error | Any error message if the discussion listing process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A community manager wants to monitor recent discussions in a project's repository to identify trending topics or issues that need attention.
|
||||
|
||||
***
|
||||
|
||||
## GitHub List Releases
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves and lists all releases for a specified GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches all releases associated with a given GitHub repository and provides their names and URLs.
|
||||
|
||||
### How it works
|
||||
|
||||
The block connects to the GitHub API, sends a request to get release information for the specified repository, and then processes the response to extract release names and URLs.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository to fetch releases from |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------- | ---------------------------------------------------------- |
|
||||
| Release | Information about each release, including its name and URL |
|
||||
| Error | Any error message if the release listing process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A user wants to view all official releases of a software project to choose the appropriate version for installation or to track the project's release history.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Read File
|
||||
|
||||
### What it is
|
||||
|
||||
A block that reads the content of a specified file from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block retrieves the content of a specified file from a given GitHub repository, providing both the raw and decoded text content along with the file size.
|
||||
|
||||
### How it works
|
||||
|
||||
The block authenticates with the GitHub API, sends a request to fetch the specified file's content, and then processes the response to provide the file's raw content, decoded text content, and size.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository containing the file |
|
||||
| File Path | The path to the file within the repository |
|
||||
| Branch | The branch name to read from (defaults to "master") |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------------ | --------------------------------------------------- |
|
||||
| Text Content | The content of the file decoded as UTF-8 text |
|
||||
| Raw Content | The raw base64-encoded content of the file |
|
||||
| Size | The size of the file in bytes |
|
||||
| Error | Any error message if the file reading process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A developer wants to quickly view the contents of a configuration file or source code file in a GitHub repository without having to clone the entire repository.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Read Folder
|
||||
|
||||
### What it is
|
||||
|
||||
A block that reads the content of a specified folder from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block retrieves the list of files and directories within a specified folder from a given GitHub repository.
|
||||
|
||||
### How it works
|
||||
|
||||
The block connects to the GitHub API, sends a request to fetch the contents of the specified folder, and then processes the response to provide information about files and directories within that folder.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository containing the folder |
|
||||
| Folder Path | The path to the folder within the repository |
|
||||
| Branch | The branch name to read from (defaults to "master") |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| --------- | ----------------------------------------------------------------------------- |
|
||||
| File | Information about each file in the folder, including its name, path, and size |
|
||||
| Directory | Information about each directory in the folder, including its name and path |
|
||||
| Error | Any error message if the folder reading process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A project manager wants to explore the structure of a repository or specific folder to understand the organization of files and directories without cloning the entire repository.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Make Branch
|
||||
|
||||
### What it is
|
||||
|
||||
A block that creates a new branch in a GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block creates a new branch in a specified GitHub repository, based on an existing source branch.
|
||||
|
||||
### How it works
|
||||
|
||||
The block authenticates with the GitHub API, retrieves the latest commit SHA of the source branch, and then creates a new branch pointing to that commit.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | ------------------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository where the new branch will be created |
|
||||
| New Branch | The name of the new branch to create |
|
||||
| Source Branch | The name of the existing branch to use as the starting point for the new branch |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------------------------- |
|
||||
| Status | A message indicating the success of the branch creation operation |
|
||||
| Error | Any error message if the branch creation process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
A developer wants to start working on a new feature and needs to create a new branch based on the current state of the main development branch.
|
||||
|
||||
***
|
||||
|
||||
## GitHub Delete Branch
|
||||
|
||||
### What it is
|
||||
|
||||
A block that deletes a specified branch from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
|
||||
This block removes a specified branch from a given GitHub repository.
|
||||
|
||||
### How it works
|
||||
|
||||
The block authenticates with the GitHub API and sends a delete request for the specified branch.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| -------------- | -------------------------------------------------------------------- |
|
||||
| Credentials | GitHub authentication credentials required to access the repository |
|
||||
| Repository URL | The URL of the GitHub repository containing the branch to be deleted |
|
||||
| Branch | The name of the branch to delete |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------------------------- |
|
||||
| Status | A message indicating the success of the branch deletion operation |
|
||||
| Error | Any error message if the branch deletion process fails |
|
||||
|
||||
### Possible use case
|
||||
|
||||
After merging a feature branch into the main development branch, a developer wants to clean up the repository by removing the now-obsolete feature branch.
|
||||
@@ -1,243 +0,0 @@
|
||||
# Gmail
|
||||
|
||||
## Gmail Read
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves and reads emails from a Gmail account.
|
||||
|
||||
### What it does
|
||||
|
||||
This block searches for and retrieves emails from a specified Gmail account based on given search criteria. It can fetch multiple emails and provide detailed information about each email, including subject, sender, recipient, date, body content, and attachments.
|
||||
|
||||
### How it works
|
||||
|
||||
The block connects to the user's Gmail account using their credentials, performs a search based on the provided query, and retrieves the specified number of email messages. It then processes each email to extract relevant information and returns the results.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| Credentials | The user's Gmail account credentials for authentication |
|
||||
| Query | A search query to filter emails (e.g., "is:unread" for unread emails). Ignored if using only the `gmail.metadata` scope. |
|
||||
| Max Results | The maximum number of emails to retrieve |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ------------------------------------------------------------------- |
|
||||
| Email | Detailed information about a single email (now includes `threadId`) |
|
||||
| Emails | A list of email data for multiple emails |
|
||||
| Error | An error message if something goes wrong during the process |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically checking for new customer inquiries in a support email inbox and organizing them for quick response.
|
||||
|
||||
***
|
||||
|
||||
## Gmail Send
|
||||
|
||||
### What it is
|
||||
|
||||
A block that sends emails using a Gmail account.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to compose and send emails through their Gmail account. It handles the creation of the email message and sends it to the specified recipient.
|
||||
|
||||
### How it works
|
||||
|
||||
The block authenticates with the user's Gmail account, creates an email message with the provided details (recipient, subject, and body), and then sends the email using Gmail's API.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ------------------------------------------------------- |
|
||||
| Credentials | The user's Gmail account credentials for authentication |
|
||||
| To | The recipient's email address |
|
||||
| Subject | The subject line of the email |
|
||||
| Body | The main content of the email |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------------------- |
|
||||
| Result | Confirmation of the sent email, including a message ID |
|
||||
| Error | An error message if something goes wrong during the process |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically sending confirmation emails to customers after they make a purchase on an e-commerce website.
|
||||
|
||||
***
|
||||
|
||||
## Gmail List Labels
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves all labels (categories) from a Gmail account.
|
||||
|
||||
### What it does
|
||||
|
||||
This block fetches and lists all the labels or categories that are set up in the user's Gmail account. These labels are used to organize and categorize emails.
|
||||
|
||||
### How it works
|
||||
|
||||
The block connects to the user's Gmail account and requests a list of all labels. It then processes this information and returns a simplified list of label names and their corresponding IDs.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ------------------------------------------------------- |
|
||||
| Credentials | The user's Gmail account credentials for authentication |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------------------- |
|
||||
| Result | A list of labels, including their names and IDs |
|
||||
| Error | An error message if something goes wrong during the process |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Creating a dashboard that shows an overview of how many emails are in each category or label in a business email account.
|
||||
|
||||
***
|
||||
|
||||
## Gmail Add Label
|
||||
|
||||
### What it is
|
||||
|
||||
A block that adds a label to a specific email in a Gmail account.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to add a label (category) to a particular email message in their Gmail account. If the label doesn't exist, it creates a new one.
|
||||
|
||||
### How it works
|
||||
|
||||
The block first checks if the specified label exists in the user's Gmail account. If it doesn't, it creates the label. Then, it adds the label to the specified email message using the message ID.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | -------------------------------------------------------- |
|
||||
| Credentials | The user's Gmail account credentials for authentication |
|
||||
| Message ID | The unique identifier of the email message to be labeled |
|
||||
| Label Name | The name of the label to add to the email |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------------------- |
|
||||
| Result | Confirmation of the label addition, including the label ID |
|
||||
| Error | An error message if something goes wrong during the process |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically categorizing incoming customer emails based on their content, adding labels like "Urgent," "Feedback," or "Invoice" for easier processing.
|
||||
|
||||
***
|
||||
|
||||
## Gmail Remove Label
|
||||
|
||||
### What it is
|
||||
|
||||
A block that removes a label from a specific email in a Gmail account.
|
||||
|
||||
### What it does
|
||||
|
||||
This block allows users to remove a label (category) from a particular email message in their Gmail account.
|
||||
|
||||
### How it works
|
||||
|
||||
The block first finds the ID of the specified label in the user's Gmail account. If the label exists, it removes it from the specified email message using the message ID.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ------------------------------------------------------------------- |
|
||||
| Credentials | The user's Gmail account credentials for authentication |
|
||||
| Message ID | The unique identifier of the email message to remove the label from |
|
||||
| Label Name | The name of the label to remove from the email |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------------------- |
|
||||
| Result | Confirmation of the label removal, including the label ID |
|
||||
| Error | An error message if something goes wrong during the process |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically removing the "Unread" label from emails after they have been processed by a customer service representative.
|
||||
|
||||
***
|
||||
|
||||
## Gmail Get Thread
|
||||
|
||||
### What it is
|
||||
|
||||
A block that retrieves an entire Gmail thread.
|
||||
|
||||
### What it does
|
||||
|
||||
Given a `threadId`, this block fetches all messages in that thread and decodes the text bodies.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ------------------------------------------------------- |
|
||||
| Credentials | The user's Gmail account credentials for authentication |
|
||||
| threadId | The ID of the thread to fetch |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ---------------------------------------- |
|
||||
| Thread | Gmail thread with decoded messages |
|
||||
| Error | An error message if something goes wrong |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Checking if a recipient replied in an existing conversation.
|
||||
|
||||
***
|
||||
|
||||
## Gmail Reply
|
||||
|
||||
### What it is
|
||||
|
||||
A block that sends a reply within an existing Gmail thread.
|
||||
|
||||
### What it does
|
||||
|
||||
This block builds a properly formatted reply email and sends it so Gmail keeps it in the same conversation.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description |
|
||||
| --------------- | ------------------------------------------------------- |
|
||||
| Credentials | The user's Gmail account credentials for authentication |
|
||||
| threadId | The thread to reply in |
|
||||
| parentMessageId | The ID of the message you are replying to |
|
||||
| To | List of recipients |
|
||||
| Cc | List of CC recipients |
|
||||
| Bcc | List of BCC recipients |
|
||||
| Subject | Optional subject (defaults to `Re:` prefix) |
|
||||
| Body | The email body |
|
||||
| Attachments | Optional files to include |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| --------- | ------------------------------------- |
|
||||
| MessageId | The ID of the sent message |
|
||||
| ThreadId | The thread the reply belongs to |
|
||||
| Message | Full Gmail message object |
|
||||
| Error | Error message if something goes wrong |
|
||||
|
||||
### Possible use case
|
||||
|
||||
Automatically respond "Thanks, see you then" to a scheduling email while keeping the conversation tidy.
|
||||
@@ -1,39 +0,0 @@
|
||||
# Google Maps Search
|
||||
|
||||
## What it is
|
||||
|
||||
A block that searches for local businesses using the Google Maps API.
|
||||
|
||||
## What it does
|
||||
|
||||
This block allows users to search for places of interest, such as restaurants, shops, or attractions, within a specified area using Google Maps data.
|
||||
|
||||
## How it works
|
||||
|
||||
The block takes a search query, location details, and API credentials as input. It then communicates with the Google Maps API to fetch information about relevant places. The results are processed and returned as structured data containing details about each place found.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ----------- | ---------------------------------------------------------------------------------- |
|
||||
| API Key | A secret key required to authenticate and use the Google Maps API |
|
||||
| Query | The search term for finding local businesses (e.g., "restaurants in New York") |
|
||||
| Radius | The search area radius in meters, with a maximum of 50,000 meters (about 31 miles) |
|
||||
| Max Results | The maximum number of places to return, up to 60 results |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| --------- | ----------------------------------------------------------------------- |
|
||||
| Place | Information about a found place, including: |
|
||||
| - Name | The name of the business or location |
|
||||
| - Address | The full address of the place |
|
||||
| - Phone | The contact phone number |
|
||||
| - Rating | The average rating (out of 5) given by users |
|
||||
| - Reviews | The total number of user reviews |
|
||||
| - Website | The official website of the place, if available |
|
||||
| Error | A message describing any issues that occurred during the search process |
|
||||
|
||||
## Possible use case
|
||||
|
||||
A travel planning application could use this block to help users discover popular restaurants, attractions, or accommodations in their destination city. By inputting a search query like "family-friendly restaurants in Paris" and specifying a search radius around their hotel, travelers could quickly get a list of suitable dining options with ratings, contact information, and websites for making reservations.
|
||||
@@ -1,39 +1,33 @@
|
||||
# Ideogram Model
|
||||
|
||||
## What it is
|
||||
|
||||
The Ideogram Model block is an AI-powered image generation tool that creates custom images based on text prompts and various settings.
|
||||
|
||||
## What it does
|
||||
|
||||
This block generates images using the Ideogram AI model, allowing users to create unique visuals by describing what they want in text. It offers various customization options, including different model versions, aspect ratios, and style preferences.
|
||||
|
||||
## How it works
|
||||
|
||||
The block takes a text prompt and several optional parameters as input. It then sends this information to the Ideogram API, which processes the request and generates an image. The resulting image URL is returned as output. If requested, the block can also upscale the generated image for higher quality.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description |
|
||||
| ---------------------- | ------------------------------------------------------ |
|
||||
| API Key | Your personal Ideogram API key for authentication |
|
||||
| Prompt | The text description of the image you want to generate |
|
||||
| Image Generation Model | Choose from different versions of the Ideogram model |
|
||||
| Aspect Ratio | Select the desired dimensions for your image |
|
||||
| Upscale Image | Option to enhance the image quality after generation |
|
||||
| Magic Prompt Option | Enables automatic enhancement of your text prompt |
|
||||
| Seed | An optional number for reproducible image generation |
|
||||
| Style Type | Choose a specific artistic style for your image |
|
||||
| Negative Prompt | Describe elements you want to exclude from the image |
|
||||
| Color Palette Preset | Select a predefined color scheme for your image |
|
||||
| Input | Description |
|
||||
|-------|-------------|
|
||||
| API Key | Your personal Ideogram API key for authentication |
|
||||
| Prompt | The text description of the image you want to generate |
|
||||
| Image Generation Model | Choose from different versions of the Ideogram model |
|
||||
| Aspect Ratio | Select the desired dimensions for your image |
|
||||
| Upscale Image | Option to enhance the image quality after generation |
|
||||
| Magic Prompt Option | Enables automatic enhancement of your text prompt |
|
||||
| Seed | An optional number for reproducible image generation |
|
||||
| Style Type | Choose a specific artistic style for your image |
|
||||
| Negative Prompt | Describe elements you want to exclude from the image |
|
||||
| Color Palette Preset | Select a predefined color scheme for your image |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ----------------------------------------------------------- |
|
||||
| Result | The URL of the generated image |
|
||||
| Error | An error message if something goes wrong during the process |
|
||||
| Output | Description |
|
||||
|--------|-------------|
|
||||
| Result | The URL of the generated image |
|
||||
| Error | An error message if something goes wrong during the process |
|
||||
|
||||
## Possible use case
|
||||
|
||||
A marketing team needs unique visuals for a new product campaign. They can use the Ideogram Model block to quickly generate custom images based on their product descriptions and brand guidelines, exploring different styles and aspect ratios without the need for a professional designer.
|
||||
A marketing team needs unique visuals for a new product campaign. They can use the Ideogram Model block to quickly generate custom images based on their product descriptions and brand guidelines, exploring different styles and aspect ratios without the need for a professional designer.
|
||||
@@ -1,30 +1,24 @@
|
||||
# Step Through Items
|
||||
|
||||
## What it is
|
||||
## Step Through Items
|
||||
|
||||
### What it is
|
||||
A block that iterates through a list or dictionary, processing each item one by one.
|
||||
|
||||
## What it does
|
||||
|
||||
### What it does
|
||||
This block takes a list or dictionary as input and goes through each item, outputting the current item and its corresponding key or index.
|
||||
|
||||
## How it works
|
||||
|
||||
### How it works
|
||||
When given a list or dictionary, the block processes each item individually. For lists, it keeps track of the item's position (index). For dictionaries, it focuses on the values, using the value as both the item and the key in the output.
|
||||
|
||||
## Inputs
|
||||
### Inputs
|
||||
| Input | Description |
|
||||
|-------|-------------|
|
||||
| Items | A list or dictionary that you want to process item by item. For example, you could input a list of numbers [1, 2, 3, 4, 5] or a dictionary of key-value pairs {'key1': 'value1', 'key2': 'value2'} |
|
||||
|
||||
| Input | Description |
|
||||
| ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Items | A list or dictionary that you want to process item by item. For example, you could input a list of numbers \[1, 2, 3, 4, 5] or a dictionary of key-value pairs {'key1': 'value1', 'key2': 'value2'} |
|
||||
### Outputs
|
||||
| Output | Description |
|
||||
|--------|-------------|
|
||||
| Item | The current item being processed from the input list or dictionary |
|
||||
| Key | For lists, this is the index (position) of the current item. For dictionaries, this is the same as the item (the dictionary's value) |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| Item | The current item being processed from the input list or dictionary |
|
||||
| Key | For lists, this is the index (position) of the current item. For dictionaries, this is the same as the item (the dictionary's value) |
|
||||
|
||||
## Possible use case
|
||||
|
||||
Imagine you have a list of customer names and you want to perform a specific action for each customer, like sending a personalized email. This block could help you go through the list one by one, allowing you to process each customer individually.
|
||||
### Possible use case
|
||||
Imagine you have a list of customer names and you want to perform a specific action for each customer, like sending a personalized email. This block could help you go through the list one by one, allowing you to process each customer individually.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user