mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-01-11 16:18:07 -05:00
Compare commits
197 Commits
test-speed
...
update-blo
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7cfc0a0c4f | ||
|
|
c869fd0119 | ||
|
|
097348e2ba | ||
|
|
2f97724ba5 | ||
|
|
805a988e21 | ||
|
|
6166e31942 | ||
|
|
fa56b68071 | ||
|
|
4207dc2bcf | ||
|
|
73d032a937 | ||
|
|
2011322511 | ||
|
|
09e1a4081f | ||
|
|
3831aa99e7 | ||
|
|
f15633833c | ||
|
|
2352c50433 | ||
|
|
00add5738f | ||
|
|
00b163b0a5 | ||
|
|
3c23fd5b1a | ||
|
|
7c719d6835 | ||
|
|
0b0c810861 | ||
|
|
1c1dda57e8 | ||
|
|
20e93f32ff | ||
|
|
8fc00dfe02 | ||
|
|
185d103371 | ||
|
|
dfc024acc3 | ||
|
|
791ab5d671 | ||
|
|
6dc88e3f21 | ||
|
|
d3f5718cac | ||
|
|
aef7b5db7d | ||
|
|
df071ca5a5 | ||
|
|
2b192a0d20 | ||
|
|
9572415b74 | ||
|
|
ad1bf2f27f | ||
|
|
67991f7c6d | ||
|
|
c2aad7d2d9 | ||
|
|
504a0a1250 | ||
|
|
69ae276bb8 | ||
|
|
66f2e2a77b | ||
|
|
c463d1022b | ||
|
|
88dc0bbe0b | ||
|
|
5ea176e457 | ||
|
|
134163aa88 | ||
|
|
ff494bee93 | ||
|
|
f02e2fd8bb | ||
|
|
2012213af5 | ||
|
|
94f4702f6b | ||
|
|
abf05d6407 | ||
|
|
58a8b0ddeb | ||
|
|
6a4a8f5a46 | ||
|
|
240ad756aa | ||
|
|
6c62a6a558 | ||
|
|
d36ac1471c | ||
|
|
a2b34739c9 | ||
|
|
7d4775e3b7 | ||
|
|
d133b474a8 | ||
|
|
14ef675784 | ||
|
|
2c9baa6966 | ||
|
|
43ca817a85 | ||
|
|
5cf97dd296 | ||
|
|
c577758b4a | ||
|
|
ed9d0b85b4 | ||
|
|
cfb92dd4f9 | ||
|
|
b892c2b272 | ||
|
|
d4679bbae8 | ||
|
|
34954d8df3 | ||
|
|
780c893c91 | ||
|
|
a113fdb134 | ||
|
|
b73cb9fc98 | ||
|
|
223e3de073 | ||
|
|
abfbdd0934 | ||
|
|
d8e38b505c | ||
|
|
4ebc34da62 | ||
|
|
056c539bde | ||
|
|
7e2e8843c0 | ||
|
|
a8cde7c3c5 | ||
|
|
64e59c5324 | ||
|
|
0da1461a79 | ||
|
|
192ff65bbf | ||
|
|
388003ff2d | ||
|
|
1081b15c91 | ||
|
|
0e17f5757b | ||
|
|
80de45c610 | ||
|
|
bd237c5b52 | ||
|
|
6f8f7ac716 | ||
|
|
cca71f99b9 | ||
|
|
e54a999ff4 | ||
|
|
36360b3ade | ||
|
|
a1607a3b21 | ||
|
|
8804417c72 | ||
|
|
6aeec36a3c | ||
|
|
6d09a46652 | ||
|
|
be4b2b1ba1 | ||
|
|
d2d6346f59 | ||
|
|
d83984bf38 | ||
|
|
146bf8e692 | ||
|
|
015e7d2b10 | ||
|
|
dac7e4aa57 | ||
|
|
1764cf9837 | ||
|
|
fbd1e26524 | ||
|
|
fb10bacfda | ||
|
|
f6a12828f0 | ||
|
|
fba186e5e1 | ||
|
|
91b88b840e | ||
|
|
f6b00f07ce | ||
|
|
a4bd7c9b58 | ||
|
|
bc643492e8 | ||
|
|
ba64e05803 | ||
|
|
01c0284fd2 | ||
|
|
a08a7bd1e1 | ||
|
|
25bab0eaa5 | ||
|
|
bb646e865e | ||
|
|
dc777ce89a | ||
|
|
a3955385ec | ||
|
|
88b03563f5 | ||
|
|
f57f6fc1c0 | ||
|
|
2f7ad767c2 | ||
|
|
e3e4bc8c96 | ||
|
|
d3cb3c73d1 | ||
|
|
cc75eea402 | ||
|
|
40961cb9f1 | ||
|
|
13be1a03b7 | ||
|
|
757381c889 | ||
|
|
154f0a2b83 | ||
|
|
bf91cc507f | ||
|
|
940fef027a | ||
|
|
d1b51ad09b | ||
|
|
4cb0bbe67e | ||
|
|
ebbb7b07cf | ||
|
|
db3d86bce6 | ||
|
|
f1f6f87b25 | ||
|
|
0d5ab20f14 | ||
|
|
4017c5be70 | ||
|
|
b7cc83854a | ||
|
|
0599083e0e | ||
|
|
9e36144b40 | ||
|
|
ce3c86cb1d | ||
|
|
e33263c9fc | ||
|
|
04f0f64fbb | ||
|
|
755a7b620d | ||
|
|
d54c9d4e7e | ||
|
|
852af17294 | ||
|
|
8889d029d4 | ||
|
|
e93c7dc89e | ||
|
|
7791281b90 | ||
|
|
cc9ff9e2bb | ||
|
|
6b82b9e73b | ||
|
|
61bfbeeb01 | ||
|
|
9518ff4f02 | ||
|
|
49490e899e | ||
|
|
d19866bdf5 | ||
|
|
b6c946ac4f | ||
|
|
d6f5dcd717 | ||
|
|
99779f52b2 | ||
|
|
d4e5a48163 | ||
|
|
a40bb6f6d6 | ||
|
|
a393f8bf9f | ||
|
|
d56931f4cb | ||
|
|
03691329be | ||
|
|
9813012c12 | ||
|
|
8f74e58ecc | ||
|
|
b1f5413dab | ||
|
|
cc41b2f4ab | ||
|
|
f45b4cc243 | ||
|
|
ed2e5e813d | ||
|
|
ab33d079e2 | ||
|
|
a24c869a44 | ||
|
|
d6b1cf64ed | ||
|
|
e9982ba9bd | ||
|
|
58c1e050f2 | ||
|
|
f125bb658c | ||
|
|
ba9c91d0b7 | ||
|
|
e6254f0e83 | ||
|
|
3c8cf8bd1e | ||
|
|
79f3888d61 | ||
|
|
ace5d34cc6 | ||
|
|
100ab90f44 | ||
|
|
a0ad796432 | ||
|
|
0cc625ca15 | ||
|
|
a43b329132 | ||
|
|
beeadd16f1 | ||
|
|
b2d5b9efb4 | ||
|
|
c77f32b23f | ||
|
|
b92223cf7b | ||
|
|
0d47b0ce38 | ||
|
|
c0409ba0b1 | ||
|
|
41c8504bdc | ||
|
|
c4d38e4ff3 | ||
|
|
b10a275676 | ||
|
|
8baabb0379 | ||
|
|
8bf977958a | ||
|
|
c73da1f79c | ||
|
|
3c3c1ce90a | ||
|
|
e9a198f5da | ||
|
|
706bf0578e | ||
|
|
610b613367 | ||
|
|
5f4a411b15 | ||
|
|
7b004f07e7 | ||
|
|
c16d2f94a6 |
@@ -7,14 +7,16 @@ Below is a comprehensive list of all available blocks, categorized by their prim
|
||||
## Basic Operations
|
||||
| Block Name | Description |
|
||||
|------------|-------------|
|
||||
| [Store Value](basic.md#store-value) | Stores and forwards a value |
|
||||
| [Print to Console](basic.md#print-to-console) | Outputs text to the console for debugging |
|
||||
| [Find in Dictionary](basic.md#find-in-dictionary) | Looks up a value in a dictionary or list |
|
||||
| [Agent Input](basic.md#agent-input) | Accepts user input in a workflow |
|
||||
| [Agent Output](basic.md#agent-output) | Records and formats workflow results |
|
||||
| [Add to Dictionary](basic.md#add-to-dictionary) | Adds a new key-value pair to a dictionary |
|
||||
| [Add to List](basic.md#add-to-list) | Adds a new entry to a list |
|
||||
| [Note](basic.md#note) | Displays a sticky note in the workflow |
|
||||
| [Store Value](update/basic.md#store-value) | Stores and forwards a value |
|
||||
| [Print to Console](update/basic.md#print-to-console) | Outputs text to the console for debugging |
|
||||
| [Find in Dictionary](update/basic.md#find-in-dictionary) | Looks up a value in a dictionary or list |
|
||||
| [Agent Input](update/basic.md#agent-input) | Accepts user input in a workflow |
|
||||
| [Agent Output](update/basic.md#agent-output) | Records and formats workflow results |
|
||||
| [Add to Dictionary](update/basic.md#add-to-dictionary) | Adds a new key-value pair to a dictionary |
|
||||
| [Add to List](update/basic.md#add-to-list) | Adds a new entry to a list |
|
||||
| [Note](update/basic.md#note) | Displays a sticky note in the workflow |
|
||||
| [Create Dictionary](update/basic.md#create-dictionary) | Creates a new dictionary with specified key-value pairs |
|
||||
| [Create List](update/basic.md#create-list) | Creates a new list with specified values |
|
||||
|
||||
## Data Processing
|
||||
| Block Name | Description |
|
||||
@@ -39,11 +41,13 @@ Below is a comprehensive list of all available blocks, categorized by their prim
|
||||
| [AI Text Summarizer](llm.md#ai-text-summarizer) | Summarizes long texts using LLMs |
|
||||
| [AI Conversation](llm.md#ai-conversation) | Facilitates multi-turn conversations with LLMs |
|
||||
| [AI List Generator](llm.md#ai-list-generator) | Creates lists based on prompts using LLMs |
|
||||
| [AI Music Generator](update/ai_music_generator.md#ai-music-generator) | Creates unique music using AI based on text descriptions |
|
||||
|
||||
## Web and API Interactions
|
||||
| Block Name | Description |
|
||||
|------------|-------------|
|
||||
| [Send Web Request](http.md#send-web-request) | Makes HTTP requests to specified web addresses |
|
||||
| [Send Web Request](update/http.md#web-request-sender) | Makes HTTP requests to specified web addresses |
|
||||
| [HTTP Request Handler](update/helpers/http.md#http-request-handler) | Simplifies making HTTP GET requests to web services |
|
||||
| [Read RSS Feed](rss.md#read-rss-feed) | Retrieves and processes entries from RSS feeds |
|
||||
| [Get Weather Information](search.md#get-weather-information) | Fetches current weather data for a location |
|
||||
| [Google Maps Search](google_maps.md#google-maps-search) | Searches for local businesses using Google Maps API |
|
||||
@@ -81,19 +85,37 @@ Below is a comprehensive list of all available blocks, categorized by their prim
|
||||
## Media Generation
|
||||
| Block Name | Description |
|
||||
|------------|-------------|
|
||||
| [Ideogram Model](ideogram.md#ideogram-model) | Generates images based on text prompts |
|
||||
| [Ideogram Model](update/ideogram.md#ideogram-model) | Generates images based on text prompts |
|
||||
| [Create Talking Avatar Video](talking_head.md#create-talking-avatar-video) | Creates videos with talking avatars |
|
||||
| [Unreal Text to Speech](text_to_speech_block.md#unreal-text-to-speech) | Converts text to speech using Unreal Speech API |
|
||||
| [AI Shortform Video Creator](ai_shortform_video_block.md#ai-shortform-video-creator) | Generates short-form videos using AI |
|
||||
| [Replicate Flux Advanced Model](replicate_flux_advanced.md#replicate-flux-advanced-model) | Creates images using Replicate's Flux models |
|
||||
| [AI Music Generator](update/ai_music_generator.md#ai-music-generator) | Creates unique music using AI based on text descriptions |
|
||||
|
||||
## Miscellaneous
|
||||
| Block Name | Description |
|
||||
|------------|-------------|
|
||||
| [Transcribe YouTube Video](youtube.md#transcribe-youtube-video) | Transcribes audio from YouTube videos |
|
||||
| [Send Email](email_block.md#send-email) | Sends emails using SMTP |
|
||||
| [Condition Block](branching.md#condition-block) | Evaluates conditions for workflow branching |
|
||||
| [Step Through Items](iteration.md#step-through-items) | Iterates through lists or dictionaries |
|
||||
| [Condition Block](update/branching.md#condition-block) | Evaluates conditions for workflow branching |
|
||||
| [Step Through Items](update/iteration.md#step-through-items) | Iterates through lists or dictionaries |
|
||||
|
||||
## HubSpot Integration
|
||||
| Block Name | Description |
|
||||
|------------|-------------|
|
||||
| [HubSpot Company Manager](update/hubspot/company.md#hubspot-company-manager) | Manages company records in HubSpot CRM |
|
||||
| [HubSpot Contact Manager](update/hubspot/contact.md#hubspot-contact-manager) | Manages contact information in HubSpot CRM |
|
||||
| [HubSpot Engagement Manager](update/hubspot/engagement.md#hubspot-engagement-manager) | Tracks and manages customer interactions in HubSpot |
|
||||
|
||||
## Code Management
|
||||
| Block Name | Description |
|
||||
|------------|-------------|
|
||||
| [Code Executor](update/code_executor.md#code-executor) | Executes code snippets in a secure sandbox environment |
|
||||
|
||||
## Compass Integration
|
||||
| Block Name | Description |
|
||||
|------------|-------------|
|
||||
| [Compass AI Trigger](update/compass/triggers.md#compass-ai-trigger) | Processes transcription content from Compass hardware |
|
||||
|
||||
## Google Services
|
||||
| Block Name | Description |
|
||||
|
||||
34
docs/content/platform/blocks/update/ai_music_generator.md
Normal file
34
docs/content/platform/blocks/update/ai_music_generator.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
## AI Music Generator
|
||||
|
||||
### What it is
|
||||
A powerful tool that transforms text descriptions into original music pieces using artificial intelligence technology.
|
||||
|
||||
### What it does
|
||||
Creates unique audio compositions based on your written descriptions, allowing you to specify various aspects of the music generation process, including duration, style, and output format.
|
||||
|
||||
### How it works
|
||||
The system takes your text description and other parameters, sends them to an advanced AI music model (Meta's MusicGen), and returns a link to the generated audio file. It automatically retries if there are any issues during generation and ensures the audio meets your specified requirements.
|
||||
|
||||
### Inputs
|
||||
- Text Description: Your written description of the music you want to create (e.g., "An upbeat electronic dance track with heavy bass")
|
||||
- Model Version: Choice of AI model version (Stereo Large, Melody Large, or Large) for different generation capabilities
|
||||
- Duration: Length of the generated music in seconds
|
||||
- Temperature: Controls how creative or conventional the generation should be (higher values mean more creativity)
|
||||
- Output Format: Choose between WAV or MP3 file formats
|
||||
- Normalization Strategy: How the audio volume should be balanced (Loudness, Clip, Peak, or RMS)
|
||||
- Advanced Settings:
|
||||
- Top K: Helps control variety in the generation
|
||||
- Top P: Influences probability-based generation
|
||||
- Classifier Free Guidance: Controls how closely the output follows your description
|
||||
|
||||
### Outputs
|
||||
- Audio File URL: Link to download the generated music file
|
||||
- Error Message: Information about what went wrong (if the generation fails)
|
||||
|
||||
### Possible use cases
|
||||
- Creating custom background music for videos
|
||||
- Generating mood-specific music for presentations
|
||||
- Producing unique sound effects for multimedia projects
|
||||
- Experimenting with AI-generated music compositions
|
||||
- Quick prototyping of musical ideas
|
||||
224
docs/content/platform/blocks/update/basic.md
Normal file
224
docs/content/platform/blocks/update/basic.md
Normal file
@@ -0,0 +1,224 @@
|
||||
|
||||
# Basic Blocks Documentation
|
||||
|
||||
## Store Value
|
||||
|
||||
### What it is
|
||||
A data storage and forwarding component that can hold and pass along values.
|
||||
|
||||
### What it does
|
||||
Stores a provided value and makes it available for reuse without modification.
|
||||
|
||||
### How it works
|
||||
Takes an input value and either stores it directly or uses a pre-stored value, then forwards it as output.
|
||||
|
||||
### Inputs
|
||||
- Input: The value to be stored (if no data is provided)
|
||||
- Data: A pre-stored value to use instead of the input (optional)
|
||||
|
||||
### Outputs
|
||||
- Output: The stored value
|
||||
|
||||
### Possible use case
|
||||
Storing a user's name that needs to be used multiple times throughout a workflow.
|
||||
|
||||
## Print to Console
|
||||
|
||||
### What it is
|
||||
A debugging tool that displays information during operation.
|
||||
|
||||
### What it does
|
||||
Prints text messages to the console for monitoring and debugging purposes.
|
||||
|
||||
### How it works
|
||||
Takes a text message and displays it in the console with a "Print: " prefix.
|
||||
|
||||
### Inputs
|
||||
- Text: The message to be displayed
|
||||
|
||||
### Outputs
|
||||
- Status: Confirmation that the message was printed
|
||||
|
||||
### Possible use case
|
||||
Monitoring the progress of a workflow by printing status updates.
|
||||
|
||||
## Find in Dictionary
|
||||
|
||||
### What it is
|
||||
A search tool for looking up values in data structures.
|
||||
|
||||
### What it does
|
||||
Searches for and retrieves values from dictionaries, lists, or objects using a specified key.
|
||||
|
||||
### How it works
|
||||
Takes a data structure and a key, then attempts to find and return the corresponding value.
|
||||
|
||||
### Inputs
|
||||
- Input: The data structure to search in
|
||||
- Key: The key to look up
|
||||
|
||||
### Outputs
|
||||
- Output: The found value
|
||||
- Missing: The original input when the key isn't found
|
||||
|
||||
### Possible use case
|
||||
Looking up a user's details from a database response using their ID.
|
||||
|
||||
## Agent Input
|
||||
|
||||
### What it is
|
||||
An interface for collecting input values from users.
|
||||
|
||||
### What it does
|
||||
Provides a structured way to gather and validate user input with optional constraints.
|
||||
|
||||
### How it works
|
||||
Creates an input field with customizable properties and validates the entered value.
|
||||
|
||||
### Inputs
|
||||
- Name: Identifier for the input
|
||||
- Value: The actual input value
|
||||
- Title: Display name (optional)
|
||||
- Description: Help text (optional)
|
||||
- Placeholder Values: Suggested values
|
||||
- Limit to Placeholder Values: Restrict input to suggestions only
|
||||
|
||||
### Outputs
|
||||
- Result: The collected input value
|
||||
|
||||
### Possible use case
|
||||
Creating a form field for users to enter their age with suggested ranges.
|
||||
|
||||
## Agent Output
|
||||
|
||||
### What it is
|
||||
A display component for showing results to users.
|
||||
|
||||
### What it does
|
||||
Formats and presents output values in a user-friendly way.
|
||||
|
||||
### How it works
|
||||
Takes a value and optional formatting instructions to display the result.
|
||||
|
||||
### Inputs
|
||||
- Value: The data to display
|
||||
- Name: Identifier for the output
|
||||
- Title: Display name
|
||||
- Description: Additional information
|
||||
- Format: Custom formatting instructions
|
||||
|
||||
### Outputs
|
||||
- Output: The formatted result
|
||||
|
||||
### Possible use case
|
||||
Displaying the results of a calculation with proper formatting and explanation.
|
||||
|
||||
## Add to Dictionary
|
||||
|
||||
### What it is
|
||||
A tool for adding new entries to dictionaries.
|
||||
|
||||
### What it does
|
||||
Adds one or more key-value pairs to an existing or new dictionary.
|
||||
|
||||
### How it works
|
||||
Takes a dictionary and new entries, then creates an updated dictionary with the additions.
|
||||
|
||||
### Inputs
|
||||
- Dictionary: Existing dictionary (optional)
|
||||
- Key: New entry key
|
||||
- Value: New entry value
|
||||
- Entries: Multiple entries to add
|
||||
|
||||
### Outputs
|
||||
- Updated Dictionary: The modified dictionary
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Adding a new user preference to an existing settings dictionary.
|
||||
|
||||
## Add to List
|
||||
|
||||
### What it is
|
||||
A tool for adding items to lists.
|
||||
|
||||
### What it does
|
||||
Adds one or more items to an existing or new list at specified positions.
|
||||
|
||||
### How it works
|
||||
Takes a list and new items, then creates an updated list with the additions.
|
||||
|
||||
### Inputs
|
||||
- List: Existing list (optional)
|
||||
- Entry: Single item to add
|
||||
- Entries: Multiple items to add
|
||||
- Position: Where to insert items
|
||||
|
||||
### Outputs
|
||||
- Updated List: The modified list
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Adding new tasks to a todo list at specific priorities.
|
||||
|
||||
## Note
|
||||
|
||||
### What it is
|
||||
A documentation tool for adding explanatory notes.
|
||||
|
||||
### What it does
|
||||
Displays text as a sticky note in the workflow.
|
||||
|
||||
### How it works
|
||||
Takes text input and displays it as a note for documentation purposes.
|
||||
|
||||
### Inputs
|
||||
- Text: The note content
|
||||
|
||||
### Outputs
|
||||
- Output: The displayed note text
|
||||
|
||||
### Possible use case
|
||||
Adding explanatory comments to describe complex workflow steps.
|
||||
|
||||
## Create Dictionary
|
||||
|
||||
### What it is
|
||||
A dictionary creation tool.
|
||||
|
||||
### What it does
|
||||
Creates a new dictionary with specified key-value pairs.
|
||||
|
||||
### How it works
|
||||
Takes a set of key-value pairs and combines them into a new dictionary.
|
||||
|
||||
### Inputs
|
||||
- Values: Key-value pairs for the dictionary
|
||||
|
||||
### Outputs
|
||||
- Dictionary: The created dictionary
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Creating a new user profile with multiple fields.
|
||||
|
||||
## Create List
|
||||
|
||||
### What it is
|
||||
A list creation tool.
|
||||
|
||||
### What it does
|
||||
Creates a new list with specified values.
|
||||
|
||||
### How it works
|
||||
Takes a set of values and combines them into a new list.
|
||||
|
||||
### Inputs
|
||||
- Values: Items for the list
|
||||
|
||||
### Outputs
|
||||
- List: The created list
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Creating a new shopping list with multiple items.
|
||||
33
docs/content/platform/blocks/update/branching.md
Normal file
33
docs/content/platform/blocks/update/branching.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
## Condition Block
|
||||
|
||||
### What it is
|
||||
A logical comparison tool that helps make decisions based on comparing two values.
|
||||
|
||||
### What it does
|
||||
Compares two values using standard comparison operators (equals, not equals, greater than, less than, etc.) and produces different outputs based on whether the comparison is true or false.
|
||||
|
||||
### How it works
|
||||
1. Takes two values and compares them using the selected operator
|
||||
2. Determines if the comparison is true or false
|
||||
3. Outputs the result and the appropriate value based on the comparison outcome
|
||||
4. If custom output values aren't specified, uses the input values as defaults
|
||||
|
||||
### Inputs
|
||||
- First Value: Any value you want to compare (numbers, text, or true/false values)
|
||||
- Comparison Operator: The type of comparison to perform (equals, not equals, greater than, less than, etc.)
|
||||
- Second Value: The value to compare against the first value
|
||||
- True Result Value (Optional): Custom value to output if the comparison is true
|
||||
- False Result Value (Optional): Custom value to output if the comparison is false
|
||||
|
||||
### Outputs
|
||||
- Comparison Result: Whether the comparison was true or false
|
||||
- True Output: The value produced when the comparison is true
|
||||
- False Output: The value produced when the comparison is false
|
||||
|
||||
### Possible use cases
|
||||
- Creating an age-restricted content filter: Compare user's age against a minimum required age
|
||||
- Price comparison system: Check if a product's price is below a certain threshold
|
||||
- Temperature control: Determine if current temperature is within acceptable range
|
||||
- Grade assessment: Evaluate if a student's score meets passing criteria
|
||||
- Inventory management: Check if stock levels are below reorder point
|
||||
36
docs/content/platform/blocks/update/code_executor.md
Normal file
36
docs/content/platform/blocks/update/code_executor.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
## Code Executor
|
||||
|
||||
### What it is
|
||||
A secure environment for running code snippets in various programming languages without affecting your main system.
|
||||
|
||||
### What it does
|
||||
Executes programming code in an isolated sandbox environment with internet access, allowing you to run programs safely while maintaining the ability to install and use external packages.
|
||||
|
||||
### How it works
|
||||
1. Creates a secure, isolated environment (sandbox)
|
||||
2. Sets up any required dependencies using setup commands
|
||||
3. Executes the provided code in the chosen programming language
|
||||
4. Captures and returns the results, including any output or errors
|
||||
5. Automatically closes the environment after execution
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your E2B sandbox access key for authentication
|
||||
- Setup Commands: Optional preparation steps, such as installing packages or downloading files
|
||||
- Code: The actual program or script you want to run
|
||||
- Programming Language: Your choice of Python, JavaScript, Bash, R, or Java
|
||||
- Timeout: Maximum time (in seconds) allowed for code execution
|
||||
- Template ID: Optional custom sandbox configuration for specific requirements
|
||||
|
||||
### Outputs
|
||||
- Response: The main result of your code execution
|
||||
- Standard Output: Regular program output and messages
|
||||
- Standard Error: Any error messages or warnings
|
||||
- Error: Detailed error information if the execution fails
|
||||
|
||||
### Possible use cases
|
||||
- Testing new code snippets before implementing them in a larger project
|
||||
- Running experiments with different programming languages
|
||||
- Teaching programming concepts in a safe environment
|
||||
- Testing scripts that require specific system configurations
|
||||
- Executing code that needs isolation from the main system
|
||||
30
docs/content/platform/blocks/update/compass/triggers.md
Normal file
30
docs/content/platform/blocks/update/compass/triggers.md
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
## Compass AI Trigger
|
||||
|
||||
### What it is
|
||||
A specialized component that processes and extracts transcription content from Compass hardware systems. It's designed to work with voice-to-text conversions and handle detailed transcription data.
|
||||
|
||||
### What it does
|
||||
This block receives transcription data from Compass hardware and makes the transcribed text available for further processing. It takes complex transcription data (including timing and speaker information) and simplifies it into accessible text content.
|
||||
|
||||
### How it works
|
||||
1. Receives transcription data from Compass hardware through a webhook
|
||||
2. Processes the incoming data, which includes detailed information about the transcription
|
||||
3. Extracts the main transcription text
|
||||
4. Makes the transcribed text available for other components to use
|
||||
|
||||
### Inputs
|
||||
- Payload: A structured package of data containing:
|
||||
- Date: When the transcription was created
|
||||
- Transcription: The main text content
|
||||
- Detailed transcriptions: A collection of individual transcription segments with speaker and timing information
|
||||
|
||||
### Outputs
|
||||
- Transcription: The complete text content from the transcription process, ready for further use
|
||||
|
||||
### Possible use cases
|
||||
- Converting recorded meetings into text
|
||||
- Processing customer service call recordings
|
||||
- Documenting voice notes or interviews
|
||||
- Creating text records from audio presentations
|
||||
- Real-time transcription of live speeches or presentations
|
||||
32
docs/content/platform/blocks/update/csv.md
Normal file
32
docs/content/platform/blocks/update/csv.md
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
## CSV Reader
|
||||
|
||||
### What it is
|
||||
A versatile tool that converts CSV (Comma-Separated Values) file contents into organized, structured data that's easy to work with.
|
||||
|
||||
### What it does
|
||||
Reads and processes CSV file contents, transforming them into a structured format while offering various customization options like handling headers, skipping rows, and cleaning data.
|
||||
|
||||
### How it works
|
||||
The tool takes your CSV content and breaks it down line by line, organizing each row's data into a neat, labeled structure. It can work with different types of CSV formats and gives you options to customize how the data is processed, such as removing extra spaces or skipping certain rows.
|
||||
|
||||
### Inputs
|
||||
- File Contents: The actual text content of your CSV file
|
||||
- Delimiter: The character that separates values in your file (default is comma)
|
||||
- Quote Character: The character used to wrap text that contains special characters (default is double quote)
|
||||
- Escape Character: The character used to mark special characters (default is backslash)
|
||||
- Has Header: Whether your file includes column names in the first row (default is yes)
|
||||
- Skip Rows: Number of rows to skip from the beginning of the file (default is 0)
|
||||
- Strip Whitespace: Whether to remove extra spaces from values (default is yes)
|
||||
- Skip Columns: List of columns you want to exclude from the results (default is none)
|
||||
|
||||
### Outputs
|
||||
- Individual Row: Provides each row of data as it's processed, with values organized by column names
|
||||
- Complete Dataset: Delivers all rows together as a single collection once processing is finished
|
||||
|
||||
### Possible use cases
|
||||
- Importing contact lists from spreadsheets
|
||||
- Processing financial data from exported reports
|
||||
- Converting inventory spreadsheets into structured data
|
||||
- Analyzing survey responses from CSV exports
|
||||
- Transforming exported data tables into a more usable format
|
||||
46
docs/content/platform/blocks/update/discord.md
Normal file
46
docs/content/platform/blocks/update/discord.md
Normal file
@@ -0,0 +1,46 @@
|
||||
|
||||
# Discord Integration Blocks
|
||||
|
||||
## Read Discord Messages
|
||||
|
||||
### What it is
|
||||
A component that monitors and captures messages from Discord channels.
|
||||
|
||||
### What it does
|
||||
Connects to Discord and reads incoming messages, including any text file attachments, providing the message content along with channel and sender information.
|
||||
|
||||
### How it works
|
||||
Once activated, it connects to Discord using a bot account and listens for new messages. When a message is received, it captures the content, channel name, and username of the sender. If the message includes text file attachments, it will also read and include their contents.
|
||||
|
||||
### Inputs
|
||||
- Discord Credentials: A bot token that allows the block to connect to Discord
|
||||
|
||||
### Outputs
|
||||
- Message Content: The text content of the received message, including any attached text files
|
||||
- Channel Name: The name of the Discord channel where the message was sent
|
||||
- Username: The name of the user who sent the message
|
||||
|
||||
### Possible use case
|
||||
Creating a customer support system that monitors support channels for questions and automatically logs all conversations for future reference.
|
||||
|
||||
## Send Discord Message
|
||||
|
||||
### What it is
|
||||
A component that sends messages to specified Discord channels.
|
||||
|
||||
### What it does
|
||||
Sends text messages to designated Discord channels and confirms the delivery status.
|
||||
|
||||
### How it works
|
||||
The block connects to Discord using a bot account, locates the specified channel, and sends the message. If the message is longer than Discord's character limit, it automatically splits it into smaller chunks for proper delivery.
|
||||
|
||||
### Inputs
|
||||
- Discord Credentials: A bot token that allows the block to connect to Discord
|
||||
- Message Content: The text message you want to send
|
||||
- Channel Name: The name of the channel where you want to send the message
|
||||
|
||||
### Outputs
|
||||
- Status: Confirmation of whether the message was sent successfully or if any errors occurred
|
||||
|
||||
### Possible use case
|
||||
Setting up an automated notification system that sends status updates or alerts to a Discord channel when certain events occur in your application.
|
||||
34
docs/content/platform/blocks/update/exa/contents.md
Normal file
34
docs/content/platform/blocks/update/exa/contents.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
## Exa Contents
|
||||
|
||||
### What it is
|
||||
A specialized component that retrieves and processes document contents using the Exa service platform. It's designed to fetch various types of content from documents, including full text, highlights, and summaries.
|
||||
|
||||
### What it does
|
||||
This block retrieves document contents based on provided document IDs. It can extract full text content, generate relevant highlights, and create summaries of documents. The block offers flexible configuration options to control how content is retrieved and processed.
|
||||
|
||||
### How it works
|
||||
1. Accepts document IDs and content retrieval settings
|
||||
2. Authenticates with the Exa service
|
||||
3. Sends a request to retrieve the specified content
|
||||
4. Processes the response and returns the formatted results
|
||||
5. Handles any errors that might occur during the process
|
||||
|
||||
### Inputs
|
||||
- Credentials: Authentication information required to access the Exa service
|
||||
- Document IDs: A list of unique identifiers for the documents you want to retrieve
|
||||
- Content Settings: Customizable options for content retrieval
|
||||
* Text Settings: Controls maximum character count and HTML tag handling
|
||||
* Highlight Settings: Determines number of sentences and highlights per URL
|
||||
* Summary Settings: Configures how document summaries are generated
|
||||
|
||||
### Outputs
|
||||
- Results: A list containing the retrieved document contents, which may include full text, highlights, or summaries depending on the specified settings
|
||||
- Error Message: If something goes wrong, the block provides information about what happened
|
||||
|
||||
### Possible use cases
|
||||
- Building a document management system that needs to display document previews
|
||||
- Creating a research tool that extracts relevant highlights from multiple documents
|
||||
- Developing a content aggregation platform that needs to generate summaries of articles
|
||||
- Implementing a search system that shows document snippets in search results
|
||||
- Building a content analysis tool that processes document contents for further analysis
|
||||
34
docs/content/platform/blocks/update/exa/search.md
Normal file
34
docs/content/platform/blocks/update/exa/search.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
## Exa Search
|
||||
|
||||
### What it is
|
||||
A powerful web search tool that leverages Exa's advanced search capabilities to find and filter web content based on various criteria.
|
||||
|
||||
### What it does
|
||||
Performs comprehensive web searches with fine-tuned control over the results, including filtering by dates, domains, and text patterns. It can search within specific categories, exclude unwanted sources, and deliver customized result sets.
|
||||
|
||||
### How it works
|
||||
The tool sends your search query to Exa's search engine along with any specified filters and preferences. It processes your request and returns relevant web content that matches your criteria. The search can be enhanced with automatic prompt optimization and can be configured to return exactly the number of results you need.
|
||||
|
||||
### Inputs
|
||||
- Query: Your search terms or question
|
||||
- Auto Prompt: Option to automatically enhance your search query for better results
|
||||
- Number of Results: How many search results you want to receive (default: 10)
|
||||
- Include Domains: List of websites you want to search within
|
||||
- Exclude Domains: List of websites you want to avoid
|
||||
- Crawl Date Range: Filter content based on when it was discovered by the search engine
|
||||
- Publication Date Range: Filter content based on when it was published
|
||||
- Include Text: Specific text patterns that must appear in the results
|
||||
- Exclude Text: Text patterns that should not appear in the results
|
||||
- Content Settings: Preferences for how content should be retrieved and presented
|
||||
- Type: Specific type of search to perform
|
||||
- Category: Specific category to search within
|
||||
|
||||
### Outputs
|
||||
- Results: A list of search results matching your criteria, including relevant web content and metadata
|
||||
|
||||
### Possible use cases
|
||||
- Research Project: A researcher could use this tool to find academic articles published within a specific date range, excluding certain domains and focusing on particular keywords
|
||||
- Content Monitoring: A business analyst could track mentions of their company across specific websites during a marketing campaign
|
||||
- News Gathering: A journalist could search for recent news articles about a topic while excluding unreliable sources
|
||||
- Competitive Analysis: A market researcher could gather information about competitors by searching within their domains during specific time periods
|
||||
39
docs/content/platform/blocks/update/exa/similar.md
Normal file
39
docs/content/platform/blocks/update/exa/similar.md
Normal file
@@ -0,0 +1,39 @@
|
||||
|
||||
## Exa Find Similar
|
||||
|
||||
### What it is
|
||||
A tool that finds web content similar to a specified URL using Exa's content discovery technology.
|
||||
|
||||
### What it does
|
||||
This block searches across the web to find content that is similar to a given webpage. It can filter results based on various criteria such as domains, dates, and specific text patterns, making it highly customizable for different search needs.
|
||||
|
||||
### How it works
|
||||
When you provide a URL, the block analyzes the content and searches Exa's database to find similar content across the web. It applies any specified filters (such as date ranges or domain restrictions) and returns a list of matching documents, ranked by similarity.
|
||||
|
||||
### Inputs
|
||||
- URL: The webpage address you want to find similar content for
|
||||
- Number of Results: How many similar items you want to receive (default is 10)
|
||||
- Include Domains: List of website domains to specifically search within
|
||||
- Exclude Domains: List of website domains to ignore in the search
|
||||
- Start Crawl Date: Earliest date from which to consider when content was discovered
|
||||
- End Crawl Date: Latest date from which to consider when content was discovered
|
||||
- Start Published Date: Earliest publication date to consider
|
||||
- End Published Date: Latest publication date to consider
|
||||
- Include Text: Specific text patterns to look for (limited to 5 words)
|
||||
- Exclude Text: Specific text patterns to exclude (limited to 5 words)
|
||||
- Content Settings: Advanced settings for how content should be retrieved
|
||||
|
||||
### Outputs
|
||||
- Results: A list of similar documents, each containing:
|
||||
- Title of the page
|
||||
- URL of the page
|
||||
- Publication date
|
||||
- Author information
|
||||
- Similarity score
|
||||
|
||||
### Possible use cases
|
||||
- A content creator researching similar articles in their field
|
||||
- A marketing professional tracking competitive content
|
||||
- A researcher finding related academic papers
|
||||
- A news organization identifying similar coverage of a story
|
||||
- A website owner finding potentially duplicate or plagiarized content
|
||||
@@ -0,0 +1,37 @@
|
||||
|
||||
## AI Video Generator
|
||||
|
||||
### What it is
|
||||
A powerful tool that converts text descriptions into videos using artificial intelligence models from FAL AI.
|
||||
|
||||
### What it does
|
||||
Takes a written description of a desired video and automatically generates a corresponding video clip using advanced AI technology. The system can work with different AI models to create various styles of videos.
|
||||
|
||||
### How it works
|
||||
1. Accepts your text description and chosen AI model
|
||||
2. Securely connects to the FAL AI service
|
||||
3. Submits your request for video generation
|
||||
4. Monitors the generation progress
|
||||
5. Delivers the final video URL when complete
|
||||
|
||||
### Inputs
|
||||
- Text Description: A detailed description of the video you want to create (e.g., "A dog running in a field")
|
||||
- AI Model: Choice between different video generation models (MOCHI or LUMA)
|
||||
- Credentials: Your secure access information for the FAL AI service
|
||||
|
||||
### Outputs
|
||||
- Video URL: Web link to access your generated video
|
||||
- Error Message: Clear explanation if something goes wrong during generation
|
||||
- Progress Logs: Step-by-step updates about your video's creation process
|
||||
|
||||
### Possible use cases
|
||||
- Creating quick video prototypes for marketing concepts
|
||||
- Generating video content for social media posts
|
||||
- Visualizing creative ideas without traditional video production
|
||||
- Producing animated sequences from written descriptions
|
||||
- Testing different video concepts before full production
|
||||
|
||||
### Notes
|
||||
- The generation process may take some time depending on system load
|
||||
- Video quality and style will vary based on the chosen AI model
|
||||
- Internet connection is required for video generation and retrieval
|
||||
181
docs/content/platform/blocks/update/github/issues.md
Normal file
181
docs/content/platform/blocks/update/github/issues.md
Normal file
@@ -0,0 +1,181 @@
|
||||
|
||||
# GitHub Issue Management Blocks
|
||||
|
||||
## GitHub Comment
|
||||
### What it is
|
||||
A tool for adding comments to GitHub issues or pull requests.
|
||||
|
||||
### What it does
|
||||
Posts new comments on existing GitHub issues or pull requests automatically.
|
||||
|
||||
### How it works
|
||||
Takes your comment text and adds it to the specified issue or pull request using your GitHub credentials.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Issue URL: The web address of the issue or pull request
|
||||
- Comment: The text you want to post as a comment
|
||||
|
||||
### Outputs
|
||||
- Comment ID: A unique identifier for your posted comment
|
||||
- Comment URL: Direct link to view your comment
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Automatically responding to bug reports with status updates or requesting more information from users.
|
||||
|
||||
## GitHub Make Issue
|
||||
### What it is
|
||||
A tool for creating new issues in GitHub repositories.
|
||||
|
||||
### What it does
|
||||
Creates new issues with customized titles and descriptions in any GitHub repository you have access to.
|
||||
|
||||
### How it works
|
||||
Uses your provided information to create a new issue in the specified repository with your desired title and description.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- Title: The heading for your new issue
|
||||
- Body: The main content of your issue
|
||||
|
||||
### Outputs
|
||||
- Issue Number: The unique identifier for your new issue
|
||||
- Issue URL: Direct link to view your issue
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Automatically creating standardized bug reports or feature requests based on user feedback.
|
||||
|
||||
## GitHub Read Issue
|
||||
### What it is
|
||||
A tool for retrieving information from existing GitHub issues.
|
||||
|
||||
### What it does
|
||||
Fetches and provides the contents and details of any specified GitHub issue.
|
||||
|
||||
### How it works
|
||||
Retrieves the title, description, and creator information from a given issue URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Issue URL: The web address of the issue you want to read
|
||||
|
||||
### Outputs
|
||||
- Title: The heading of the issue
|
||||
- Body: The main content of the issue
|
||||
- User: The username of who created the issue
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Monitoring specific issues for updates or collecting issue information for reporting.
|
||||
|
||||
## GitHub List Issues
|
||||
### What it is
|
||||
A tool for getting a list of all issues in a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Retrieves and lists all available issues from a specified GitHub repository.
|
||||
|
||||
### How it works
|
||||
Fetches all issues from the repository and provides their titles and URLs in a list format.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
|
||||
### Outputs
|
||||
- Issues: A list of issues with their titles and URLs
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Creating a dashboard of all open issues or generating reports about repository activity.
|
||||
|
||||
## GitHub Add Label
|
||||
### What it is
|
||||
A tool for adding labels to GitHub issues or pull requests.
|
||||
|
||||
### What it does
|
||||
Applies specified labels to any GitHub issue or pull request you have access to.
|
||||
|
||||
### How it works
|
||||
Adds the specified label to the issue or pull request identified by the URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Issue URL: The web address of the issue or pull request
|
||||
- Label: The name of the label to add
|
||||
|
||||
### Outputs
|
||||
- Status: Confirmation of the label addition
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Automatically categorizing issues based on their content or priority level.
|
||||
|
||||
## GitHub Remove Label
|
||||
### What it is
|
||||
A tool for removing labels from GitHub issues or pull requests.
|
||||
|
||||
### What it does
|
||||
Removes specified labels from any GitHub issue or pull request you have access to.
|
||||
|
||||
### How it works
|
||||
Removes the specified label from the issue or pull request identified by the URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Issue URL: The web address of the issue or pull request
|
||||
- Label: The name of the label to remove
|
||||
|
||||
### Outputs
|
||||
- Status: Confirmation of the label removal
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Updating issue categories when their status changes or correcting miscategorized issues.
|
||||
|
||||
## GitHub Assign Issue
|
||||
### What it is
|
||||
A tool for assigning GitHub issues to specific users.
|
||||
|
||||
### What it does
|
||||
Assigns a specified GitHub user to any issue you have access to.
|
||||
|
||||
### How it works
|
||||
Adds the specified user as an assignee to the issue identified by the URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Issue URL: The web address of the issue
|
||||
- Assignee: The username of the person to assign
|
||||
|
||||
### Outputs
|
||||
- Status: Confirmation of the assignment
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Automatically assigning issues to team members based on their expertise or workload.
|
||||
|
||||
## GitHub Unassign Issue
|
||||
### What it is
|
||||
A tool for removing user assignments from GitHub issues.
|
||||
|
||||
### What it does
|
||||
Removes specified users from being assigned to a GitHub issue.
|
||||
|
||||
### How it works
|
||||
Removes the specified user from the list of assignees on the given issue.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Your authentication details for GitHub
|
||||
- Issue URL: The web address of the issue
|
||||
- Assignee: The username to remove from the assignment
|
||||
|
||||
### Outputs
|
||||
- Status: Confirmation of the unassignment
|
||||
- Error Message: Information if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Redistributing workload or clearing assignments when team members are unavailable.
|
||||
145
docs/content/platform/blocks/update/github/pull_requests.md
Normal file
145
docs/content/platform/blocks/update/github/pull_requests.md
Normal file
@@ -0,0 +1,145 @@
|
||||
|
||||
# GitHub Pull Request Management Blocks
|
||||
|
||||
## List Pull Requests
|
||||
|
||||
### What it is
|
||||
A tool that retrieves a list of all pull requests from a specified GitHub repository.
|
||||
|
||||
### What it does
|
||||
Fetches and displays information about all open pull requests, including their titles and URLs.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, accesses the specified repository, and retrieves the list of pull requests.
|
||||
|
||||
### Inputs
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- GitHub Credentials: Authentication details to access the repository
|
||||
|
||||
### Outputs
|
||||
- Pull Request List: Collection of pull requests with their titles and URLs
|
||||
- Error Message: Information about any issues that occurred
|
||||
|
||||
### Possible use case
|
||||
Monitoring active development work by viewing all ongoing pull requests in a project.
|
||||
|
||||
## Make Pull Request
|
||||
|
||||
### What it is
|
||||
A tool for creating new pull requests in a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Creates a new pull request with specified details, including title, description, and branch information.
|
||||
|
||||
### How it works
|
||||
Takes your provided information and submits it to GitHub to create a new pull request.
|
||||
|
||||
### Inputs
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- Title: Name of the pull request
|
||||
- Body: Detailed description of the changes
|
||||
- Head Branch: The branch containing your changes
|
||||
- Base Branch: The branch you want to merge into
|
||||
- GitHub Credentials: Authentication details
|
||||
|
||||
### Outputs
|
||||
- Pull Request Number: Unique identifier for the created PR
|
||||
- Pull Request URL: Web address of the new PR
|
||||
- Error Message: Information about any issues
|
||||
|
||||
### Possible use case
|
||||
Automating the creation of pull requests for regular code updates or maintenance tasks.
|
||||
|
||||
## Read Pull Request
|
||||
|
||||
### What it is
|
||||
A tool that retrieves detailed information about a specific pull request.
|
||||
|
||||
### What it does
|
||||
Fetches and displays comprehensive information about a pull request, including its content and changes.
|
||||
|
||||
### How it works
|
||||
Retrieves the pull request details from GitHub and presents them in an organized format.
|
||||
|
||||
### Inputs
|
||||
- Pull Request URL: Web address of the specific pull request
|
||||
- Include Changes Flag: Option to include code changes
|
||||
- GitHub Credentials: Authentication details
|
||||
|
||||
### Outputs
|
||||
- Title: Name of the pull request
|
||||
- Body: Full description
|
||||
- Author: Creator of the pull request
|
||||
- Changes: Code modifications (if requested)
|
||||
- Error Message: Information about any issues
|
||||
|
||||
### Possible use case
|
||||
Reviewing pull request details before approving changes or providing feedback.
|
||||
|
||||
## Assign PR Reviewer
|
||||
|
||||
### What it is
|
||||
A tool for assigning reviewers to pull requests.
|
||||
|
||||
### What it does
|
||||
Adds a specified user as a reviewer to a pull request.
|
||||
|
||||
### How it works
|
||||
Updates the pull request's reviewer list with the specified username.
|
||||
|
||||
### Inputs
|
||||
- Pull Request URL: Web address of the specific pull request
|
||||
- Reviewer Username: GitHub username of the reviewer
|
||||
- GitHub Credentials: Authentication details
|
||||
|
||||
### Outputs
|
||||
- Status: Success or failure message
|
||||
- Error Message: Information about any issues
|
||||
|
||||
### Possible use case
|
||||
Automatically assigning team members to review code changes.
|
||||
|
||||
## Unassign PR Reviewer
|
||||
|
||||
### What it is
|
||||
A tool for removing reviewers from pull requests.
|
||||
|
||||
### What it does
|
||||
Removes a specified reviewer from a pull request.
|
||||
|
||||
### How it works
|
||||
Updates the pull request to remove the specified reviewer from the reviewer list.
|
||||
|
||||
### Inputs
|
||||
- Pull Request URL: Web address of the specific pull request
|
||||
- Reviewer Username: GitHub username to remove
|
||||
- GitHub Credentials: Authentication details
|
||||
|
||||
### Outputs
|
||||
- Status: Success or failure message
|
||||
- Error Message: Information about any issues
|
||||
|
||||
### Possible use case
|
||||
Reassigning reviews when a team member is unavailable or when restructuring review assignments.
|
||||
|
||||
## List PR Reviewers
|
||||
|
||||
### What it is
|
||||
A tool that shows all assigned reviewers for a pull request.
|
||||
|
||||
### What it does
|
||||
Retrieves and displays a list of all users assigned to review a specific pull request.
|
||||
|
||||
### How it works
|
||||
Fetches the reviewer information from GitHub and presents it in an organized list.
|
||||
|
||||
### Inputs
|
||||
- Pull Request URL: Web address of the specific pull request
|
||||
- GitHub Credentials: Authentication details
|
||||
|
||||
### Outputs
|
||||
- Reviewer List: Collection of reviewer usernames and profile URLs
|
||||
- Error Message: Information about any issues
|
||||
|
||||
### Possible use case
|
||||
Checking who is responsible for reviewing a particular pull request.
|
||||
297
docs/content/platform/blocks/update/github/repo.md
Normal file
297
docs/content/platform/blocks/update/github/repo.md
Normal file
@@ -0,0 +1,297 @@
|
||||
|
||||
# GitHub Repository Management Blocks
|
||||
|
||||
## GitHub List Tags
|
||||
|
||||
### What it is
|
||||
A tool that retrieves all tags from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Fetches and displays a list of all tags in a specified GitHub repository, including their names and URLs.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, retrieves tag information from the specified repository, and presents each tag with its corresponding URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
|
||||
### Outputs
|
||||
- Tag Name: The name of each tag
|
||||
- Tag URL: Direct link to browse the repository at that tag
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Monitoring version tags of a software project to track releases and updates.
|
||||
|
||||
## GitHub List Branches
|
||||
|
||||
### What it is
|
||||
A tool that retrieves all branches from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Fetches and displays a list of all branches in a specified GitHub repository, including their names and URLs.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, retrieves branch information from the specified repository, and presents each branch with its corresponding URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
|
||||
### Outputs
|
||||
- Branch Name: The name of each branch
|
||||
- Branch URL: Direct link to browse the repository at that branch
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Monitoring active development branches in a project to track different features or versions being worked on.
|
||||
|
||||
## GitHub List Discussions
|
||||
|
||||
### What it is
|
||||
A tool that retrieves recent discussions from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Fetches and displays a list of recent discussions from a specified GitHub repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, retrieves discussion information, and presents each discussion with its title and URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- Number of Discussions: How many recent discussions to retrieve (default: 5)
|
||||
|
||||
### Outputs
|
||||
- Discussion Title: The title of each discussion
|
||||
- Discussion URL: Direct link to the discussion
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Monitoring community engagement and discussions about a project.
|
||||
|
||||
## GitHub List Releases
|
||||
|
||||
### What it is
|
||||
A tool that retrieves all releases from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Fetches and displays a list of all releases in a specified GitHub repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, retrieves release information, and presents each release with its name and URL.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
|
||||
### Outputs
|
||||
- Release Name: The name of each release
|
||||
- Release URL: Direct link to the release
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Tracking official releases and their documentation for a software project.
|
||||
|
||||
## GitHub Read File
|
||||
|
||||
### What it is
|
||||
A tool that reads the content of a file from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Retrieves and displays the content of a specified file from a GitHub repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, locates the specified file, and retrieves its content in both text and raw formats.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- File Path: Location of the file within the repository
|
||||
- Branch: Which branch to read from (default: master)
|
||||
|
||||
### Outputs
|
||||
- Text Content: The file's content in readable text format
|
||||
- Raw Content: The file's content in base64 encoded format
|
||||
- File Size: Size of the file in bytes
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Retrieving configuration files or documentation from a repository.
|
||||
|
||||
## GitHub Read Folder
|
||||
|
||||
### What it is
|
||||
A tool that reads the contents of a folder from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Retrieves and displays a list of all files and folders within a specified directory.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, locates the specified folder, and lists all its contents with details.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- Folder Path: Location of the folder within the repository
|
||||
- Branch: Which branch to read from (default: master)
|
||||
|
||||
### Outputs
|
||||
- Files: List of files with names, paths, and sizes
|
||||
- Directories: List of subdirectories with names and paths
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Exploring the structure of a project or finding specific files within a repository.
|
||||
|
||||
## GitHub Make Branch
|
||||
|
||||
### What it is
|
||||
A tool that creates a new branch in a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Creates a new branch from an existing source branch in a repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, copies the specified source branch, and creates a new branch with the desired name.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- New Branch Name: Name for the branch to be created
|
||||
- Source Branch Name: Name of the branch to copy from
|
||||
|
||||
### Outputs
|
||||
- Status: Result of the branch creation operation
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Creating a new feature branch for development work.
|
||||
|
||||
## GitHub Delete Branch
|
||||
|
||||
### What it is
|
||||
A tool that deletes a branch from a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Removes a specified branch from the repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub and removes the specified branch from the repository.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- Branch Name: Name of the branch to delete
|
||||
|
||||
### Outputs
|
||||
- Status: Result of the branch deletion operation
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Cleaning up old feature branches after merging work.
|
||||
|
||||
## GitHub Create File
|
||||
|
||||
### What it is
|
||||
A tool that creates a new file in a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Creates a new file with specified content in a repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub and creates a new file at the specified location with the provided content.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- File Path: Where to create the file
|
||||
- Content: What to write in the file
|
||||
- Branch: Which branch to create the file in
|
||||
- Commit Message: Description of the change
|
||||
|
||||
### Outputs
|
||||
- File URL: Web address of the created file
|
||||
- Commit SHA: Unique identifier for the commit
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Adding new documentation or configuration files to a project.
|
||||
|
||||
## GitHub Update File
|
||||
|
||||
### What it is
|
||||
A tool that updates an existing file in a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Modifies the content of an existing file in a repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub, locates the specified file, and updates its content with the new version.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
- File Path: Location of the file to update
|
||||
- Content: New content for the file
|
||||
- Branch: Which branch contains the file
|
||||
- Commit Message: Description of the change
|
||||
|
||||
### Outputs
|
||||
- File URL: Web address of the updated file
|
||||
- Commit SHA: Unique identifier for the commit
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Updating version numbers or documentation in project files.
|
||||
|
||||
## GitHub Create Repository
|
||||
|
||||
### What it is
|
||||
A tool that creates a new GitHub repository.
|
||||
|
||||
### What it does
|
||||
Creates a new repository with specified settings and initial content.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub and creates a new repository with the provided configuration.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Name: Name for the new repository
|
||||
- Description: Description of the repository
|
||||
- Private: Whether the repository should be private
|
||||
- Auto Initialize: Whether to create an initial README file
|
||||
- GitIgnore Template: Template for ignoring files
|
||||
|
||||
### Outputs
|
||||
- Repository URL: Web address of the created repository
|
||||
- Clone URL: Address for cloning the repository
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Setting up a new project repository with proper initial configuration.
|
||||
|
||||
## GitHub List Stargazers
|
||||
|
||||
### What it is
|
||||
A tool that retrieves all users who have starred a GitHub repository.
|
||||
|
||||
### What it does
|
||||
Fetches and displays a list of users who have starred the repository.
|
||||
|
||||
### How it works
|
||||
Connects to GitHub and retrieves information about users who have starred the repository.
|
||||
|
||||
### Inputs
|
||||
- GitHub Credentials: Authentication details for accessing GitHub
|
||||
- Repository URL: The web address of the GitHub repository
|
||||
|
||||
### Outputs
|
||||
- Username: Name of each user who starred the repository
|
||||
- Profile URL: Link to each user's GitHub profile
|
||||
- Error Message: Any error that occurred during the process
|
||||
|
||||
### Possible use case
|
||||
Analyzing community interest in a project or reaching out to engaged users.
|
||||
44
docs/content/platform/blocks/update/github/triggers.md
Normal file
44
docs/content/platform/blocks/update/github/triggers.md
Normal file
@@ -0,0 +1,44 @@
|
||||
|
||||
## GitHub Pull Request Trigger
|
||||
|
||||
### What it is
|
||||
A monitoring tool that watches for and responds to GitHub pull request activities in specified repositories.
|
||||
|
||||
### What it does
|
||||
This block listens for various pull request events on a GitHub repository and provides detailed information about these events when they occur. It can track multiple types of pull request activities, such as when pull requests are opened, closed, edited, or updated.
|
||||
|
||||
### How it works
|
||||
The block sets up a webhook connection with a specified GitHub repository. When pull request activities occur in the repository, GitHub sends information to this webhook. The block then processes this information and provides structured data about the event and the pull request.
|
||||
|
||||
### Inputs
|
||||
- Repository Path: The GitHub repository to monitor (format: "owner/repository")
|
||||
- Event Selections: Choose which pull request events to monitor:
|
||||
- Pull request opened
|
||||
- Pull request closed
|
||||
- Pull request edited
|
||||
- Pull request reopened
|
||||
- Changes pushed (synchronize)
|
||||
- Assignee changes
|
||||
- Label changes
|
||||
- Draft status changes
|
||||
- Lock status changes
|
||||
- Review request changes
|
||||
- Milestone changes
|
||||
- Auto-merge setting changes
|
||||
- GitHub Credentials: Authentication details for accessing the repository
|
||||
|
||||
### Outputs
|
||||
- Event Type: The specific type of pull request event that occurred
|
||||
- Pull Request Number: The identifying number of the affected pull request
|
||||
- Pull Request Details: Complete information about the pull request
|
||||
- Pull Request URL: Direct link to the pull request on GitHub
|
||||
- Triggered User: Information about the GitHub user who caused the event
|
||||
- Complete Payload: Detailed technical information about the event
|
||||
- Error Message: Information about any problems that occurred (if applicable)
|
||||
|
||||
### Possible use cases
|
||||
1. Automatically notify team channels when new pull requests are opened
|
||||
2. Track pull request status changes for project management
|
||||
3. Generate reports on pull request activities
|
||||
4. Trigger automated code review processes
|
||||
5. Update project dashboards with real-time pull request information
|
||||
117
docs/content/platform/blocks/update/google/gmail.md
Normal file
117
docs/content/platform/blocks/update/google/gmail.md
Normal file
@@ -0,0 +1,117 @@
|
||||
|
||||
# Gmail Integration Blocks
|
||||
|
||||
## Gmail Reader
|
||||
|
||||
### What it is
|
||||
A tool that reads and retrieves emails from your Gmail account.
|
||||
|
||||
### What it does
|
||||
Fetches emails based on search criteria and provides detailed information about each email, including subject, sender, content, and attachments.
|
||||
|
||||
### How it works
|
||||
Connects to your Gmail account, searches for emails matching your criteria, and returns both the email content and metadata in an organized format.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Gmail account access permissions
|
||||
- Search Query: How to filter emails (e.g., "is:unread" for unread emails)
|
||||
- Maximum Results: How many emails to retrieve at once
|
||||
|
||||
### Outputs
|
||||
- Email: Individual email data including subject, sender, content, and attachments
|
||||
- Emails: List of multiple email data
|
||||
- Error: Any error messages if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Automatically monitoring incoming emails for important messages or creating a custom email dashboard.
|
||||
|
||||
## Gmail Sender
|
||||
|
||||
### What it is
|
||||
A tool for sending emails through your Gmail account.
|
||||
|
||||
### What it does
|
||||
Composes and sends emails to specified recipients with custom subjects and content.
|
||||
|
||||
### How it works
|
||||
Uses your Gmail account to create and send new email messages to designated recipients.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Gmail account access permissions
|
||||
- To: Recipient's email address
|
||||
- Subject: Email subject line
|
||||
- Body: Email content
|
||||
|
||||
### Outputs
|
||||
- Result: Confirmation of email sending
|
||||
- Error: Any error messages if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Sending automated notifications or responses based on specific triggers.
|
||||
|
||||
## Gmail Label Lister
|
||||
|
||||
### What it is
|
||||
A tool that shows all labels in your Gmail account.
|
||||
|
||||
### What it does
|
||||
Retrieves and displays a complete list of all labels (categories) in your Gmail account.
|
||||
|
||||
### How it works
|
||||
Connects to Gmail and fetches all existing labels, both system-created and custom.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Gmail account access permissions
|
||||
|
||||
### Outputs
|
||||
- Result: List of all Gmail labels
|
||||
- Error: Any error messages if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Reviewing available labels before setting up email organization rules.
|
||||
|
||||
## Gmail Label Adder
|
||||
|
||||
### What it is
|
||||
A tool that adds labels to specific emails in Gmail.
|
||||
|
||||
### What it does
|
||||
Applies specified labels to individual email messages for organization.
|
||||
|
||||
### How it works
|
||||
Takes an email message and a label name, then applies that label to the message.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Gmail account access permissions
|
||||
- Message ID: The specific email to label
|
||||
- Label Name: The label to apply
|
||||
|
||||
### Outputs
|
||||
- Result: Confirmation of label addition
|
||||
- Error: Any error messages if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Automatically categorizing incoming emails based on content or sender.
|
||||
|
||||
## Gmail Label Remover
|
||||
|
||||
### What it is
|
||||
A tool that removes labels from specific emails in Gmail.
|
||||
|
||||
### What it does
|
||||
Removes specified labels from individual email messages.
|
||||
|
||||
### How it works
|
||||
Takes an email message and a label name, then removes that label from the message.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Gmail account access permissions
|
||||
- Message ID: The specific email to modify
|
||||
- Label Name: The label to remove
|
||||
|
||||
### Outputs
|
||||
- Result: Confirmation of label removal
|
||||
- Error: Any error messages if something goes wrong
|
||||
|
||||
### Possible use case
|
||||
Cleaning up email categorization or updating email status after processing.
|
||||
55
docs/content/platform/blocks/update/google/sheets.md
Normal file
55
docs/content/platform/blocks/update/google/sheets.md
Normal file
@@ -0,0 +1,55 @@
|
||||
|
||||
# Google Sheets Integration Blocks
|
||||
|
||||
## Google Sheets Reader
|
||||
|
||||
### What it is
|
||||
A tool that allows you to retrieve data from Google Sheets spreadsheets.
|
||||
|
||||
### What it does
|
||||
Reads specified ranges of data from a Google Sheets spreadsheet and returns the content in an organized format.
|
||||
|
||||
### How it works
|
||||
1. Connects to Google Sheets using your provided credentials
|
||||
2. Locates the specified spreadsheet using its ID
|
||||
3. Retrieves data from the specified range of cells
|
||||
4. Returns the data as a structured list
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Google account authentication details
|
||||
- Spreadsheet ID: The unique identifier for your Google Sheet (found in the sheet's URL)
|
||||
- Range: The cell range you want to read (e.g., "Sheet1!A1:B2")
|
||||
|
||||
### Outputs
|
||||
- Result: The data retrieved from the spreadsheet, organized in rows and columns
|
||||
- Error: Any error message if the operation wasn't successful
|
||||
|
||||
### Possible use case
|
||||
Automatically collecting daily sales data from a team's shared spreadsheet for analysis or reporting.
|
||||
|
||||
## Google Sheets Writer
|
||||
|
||||
### What it is
|
||||
A tool that enables you to write data into Google Sheets spreadsheets.
|
||||
|
||||
### What it does
|
||||
Writes data into specified ranges of a Google Sheets spreadsheet, updating or replacing existing content.
|
||||
|
||||
### How it works
|
||||
1. Connects to Google Sheets using your provided credentials
|
||||
2. Locates the specified spreadsheet using its ID
|
||||
3. Updates the specified range with your provided data
|
||||
4. Returns information about the update operation
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Google account authentication details
|
||||
- Spreadsheet ID: The unique identifier for your Google Sheet (found in the sheet's URL)
|
||||
- Range: The cell range where you want to write data (e.g., "Sheet1!A1:B2")
|
||||
- Values: The data you want to write, organized in rows and columns
|
||||
|
||||
### Outputs
|
||||
- Result: Details about the write operation, including number of cells, rows, and columns updated
|
||||
- Error: Any error message if the operation wasn't successful
|
||||
|
||||
### Possible use case
|
||||
Automatically updating a project status spreadsheet with daily progress metrics collected from various sources.
|
||||
33
docs/content/platform/blocks/update/google_maps.md
Normal file
33
docs/content/platform/blocks/update/google_maps.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
## Google Maps Search
|
||||
|
||||
### What it is
|
||||
A search tool that helps you find and get detailed information about local businesses and places using Google Maps.
|
||||
|
||||
### What it does
|
||||
This tool searches for places based on your search terms and provides comprehensive details about each location found, including contact information, ratings, and website details.
|
||||
|
||||
### How it works
|
||||
When you provide a search query (like "restaurants in New York"), the tool searches within your specified radius and returns detailed information about matching places. It can gather multiple results and provides important details about each location it finds.
|
||||
|
||||
### Inputs
|
||||
- Search Query: What you're looking for and where (e.g., "coffee shops in Seattle")
|
||||
- Search Radius: How far to look from the center point, up to 50 kilometers (50,000 meters)
|
||||
- Maximum Results: How many places you want to find, up to 60 locations
|
||||
- Google Maps API Key: Authentication credentials (handled automatically by the system)
|
||||
|
||||
### Outputs
|
||||
- Business Name: The name of the found location
|
||||
- Address: The complete street address
|
||||
- Phone Number: Contact telephone number
|
||||
- Rating: Customer rating (typically out of 5 stars)
|
||||
- Review Count: Number of customer reviews
|
||||
- Website: Business website address (if available)
|
||||
|
||||
### Possible use cases
|
||||
- Finding restaurants in a new city
|
||||
- Locating nearby services like gas stations or pharmacies
|
||||
- Researching hotels in a specific area
|
||||
- Discovering highly-rated businesses in your neighborhood
|
||||
- Creating lists of local attractions for tourists
|
||||
- Finding specific types of businesses within walking distance
|
||||
33
docs/content/platform/blocks/update/helpers/http.md
Normal file
33
docs/content/platform/blocks/update/helpers/http.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
## HTTP Request Handler
|
||||
|
||||
### What it is
|
||||
A utility component that simplifies the process of making HTTP GET requests to web services and APIs.
|
||||
|
||||
### What it does
|
||||
Fetches data from specified web addresses (URLs) and returns the response in either JSON format or plain text, depending on your needs.
|
||||
|
||||
### How it works
|
||||
When given a web address, this component sends a request to that address, optionally including any specified headers. It then processes the response and returns it in your preferred format (either structured JSON data or plain text).
|
||||
|
||||
### Inputs
|
||||
- URL: The web address you want to fetch data from
|
||||
- Headers: Optional additional information to send with the request (such as authentication tokens or content preferences)
|
||||
- JSON Flag: A simple yes/no option that determines whether the response should be processed as JSON data
|
||||
|
||||
### Outputs
|
||||
- When JSON is requested: Structured data that can be easily processed
|
||||
- When JSON is not requested: Plain text content from the web address
|
||||
|
||||
### Possible use cases
|
||||
- Fetching weather data from a weather service API
|
||||
- Retrieving user profile information from a social media platform
|
||||
- Downloading content from web services
|
||||
- Checking the status of external services
|
||||
- Integrating with third-party data providers
|
||||
|
||||
### Best Practices
|
||||
- Always provide valid URLs
|
||||
- Include appropriate headers when accessing secured services
|
||||
- Use JSON output when working with API responses
|
||||
- Handle potential connection errors appropriately
|
||||
36
docs/content/platform/blocks/update/http.md
Normal file
36
docs/content/platform/blocks/update/http.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
## Web Request Sender
|
||||
|
||||
### What it is
|
||||
A communication tool that allows you to send requests to web services and APIs, handling both the sending of information and receiving of responses.
|
||||
|
||||
### What it does
|
||||
This block establishes connections with external web services, sends data in various formats, and processes the responses. It can handle different types of web requests and automatically manages how data is formatted and processed.
|
||||
|
||||
### How it works
|
||||
1. Takes your request details (URL, method, data)
|
||||
2. Formats the information appropriately (JSON or plain text)
|
||||
3. Sends the request to the specified web service
|
||||
4. Receives the response
|
||||
5. Categorizes the response based on success or type of error
|
||||
6. Returns the processed result
|
||||
|
||||
### Inputs
|
||||
- URL: The web address you want to send the request to (Example: https://api.example.com)
|
||||
- Method: The type of request to make (GET, POST, PUT, DELETE, etc.)
|
||||
- Headers: Additional information to send with your request (Optional)
|
||||
- JSON Format: Whether to treat the data as JSON or plain text (Default: Yes)
|
||||
- Body: The main content you want to send with your request (Optional)
|
||||
|
||||
### Outputs
|
||||
- Response: The information received when the request is successful
|
||||
- Client Error: Information about what went wrong if there's a problem with your request
|
||||
- Server Error: Information about what went wrong if there's a problem with the server
|
||||
|
||||
### Possible use cases
|
||||
- Fetching weather data from a weather service
|
||||
- Sending user information to a registration system
|
||||
- Retrieving product information from an e-commerce API
|
||||
- Updating customer records in a remote database
|
||||
- Checking the status of a service
|
||||
- Integrating with social media platforms
|
||||
34
docs/content/platform/blocks/update/hubspot/company.md
Normal file
34
docs/content/platform/blocks/update/hubspot/company.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
## HubSpot Company Manager
|
||||
|
||||
### What it is
|
||||
A tool that helps you manage company information in HubSpot's CRM system, allowing you to create, update, and retrieve company records.
|
||||
|
||||
### What it does
|
||||
This component handles all basic operations related to company data in HubSpot, including:
|
||||
- Creating new company profiles
|
||||
- Updating existing company information
|
||||
- Retrieving company details using domain names
|
||||
|
||||
### How it works
|
||||
The tool connects to your HubSpot account and performs the requested operation:
|
||||
1. When creating a company, it adds a new company record with your provided information
|
||||
2. When retrieving company details, it searches using the company's domain name
|
||||
3. When updating, it first finds the company by domain name, then applies your changes
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your HubSpot account authentication details
|
||||
- Operation: The action you want to perform ("create", "update", or "get")
|
||||
- Company Data: Information about the company (like name, industry, size, etc.) when creating or updating records
|
||||
- Domain: The company's website domain (e.g., "example.com") for finding specific companies
|
||||
|
||||
### Outputs
|
||||
- Company: The company information returned by HubSpot
|
||||
- Status: The result of your requested operation (e.g., "created", "updated", "retrieved", or "company_not_found")
|
||||
|
||||
### Possible use cases
|
||||
- Setting up a new customer database by creating multiple company records
|
||||
- Updating company information after receiving new details from a sales team
|
||||
- Automatically retrieving company details when a new lead comes in
|
||||
- Synchronizing company data between HubSpot and other business systems
|
||||
- Building automated workflows that need to access or modify company information
|
||||
34
docs/content/platform/blocks/update/hubspot/contact.md
Normal file
34
docs/content/platform/blocks/update/hubspot/contact.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
## HubSpot Contact Manager
|
||||
|
||||
### What it is
|
||||
A powerful tool that helps you manage contact information in your HubSpot CRM system. It serves as a bridge between your application and HubSpot's contact database.
|
||||
|
||||
### What it does
|
||||
This component allows you to perform three essential contact management operations:
|
||||
- Create new contacts in HubSpot
|
||||
- Update existing contact information
|
||||
- Retrieve contact details using email addresses
|
||||
|
||||
### How it works
|
||||
The tool connects to your HubSpot account using secure credentials and performs the requested operation:
|
||||
1. When creating contacts, it adds new contact information to your HubSpot database
|
||||
2. When updating, it first looks up the contact by email, then modifies their information
|
||||
3. When retrieving contacts, it searches using the provided email address and returns the matching contact's details
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your HubSpot account access information
|
||||
- Operation: The action you want to perform ("create", "update", or "get")
|
||||
- Contact Data: The information you want to store or update for a contact
|
||||
- Email: The contact's email address (required for updating or retrieving contacts)
|
||||
|
||||
### Outputs
|
||||
- Contact: The contact's information, including any fields stored in HubSpot
|
||||
- Status: The result of your operation (such as "created", "updated", "retrieved", or "contact_not_found")
|
||||
|
||||
### Possible use cases
|
||||
1. Customer Registration: Automatically create new HubSpot contacts when customers sign up on your website
|
||||
2. Profile Updates: Update contact information when customers modify their profiles
|
||||
3. Contact Lookup: Retrieve customer details for personalized service interactions
|
||||
4. Data Synchronization: Keep your local database in sync with HubSpot contacts
|
||||
5. Lead Management: Create and update leads in your CRM system automatically
|
||||
41
docs/content/platform/blocks/update/hubspot/engagement.md
Normal file
41
docs/content/platform/blocks/update/hubspot/engagement.md
Normal file
@@ -0,0 +1,41 @@
|
||||
|
||||
## HubSpot Engagement Manager
|
||||
|
||||
### What it is
|
||||
A tool that helps manage and track customer interactions through HubSpot's platform, focusing on email communications and engagement analysis.
|
||||
|
||||
### What it does
|
||||
- Sends emails to contacts through HubSpot
|
||||
- Tracks how contacts interact with your emails
|
||||
- Measures engagement levels over time
|
||||
- Calculates engagement scores based on customer interactions
|
||||
|
||||
### How it works
|
||||
The tool connects to your HubSpot account and can perform two main functions:
|
||||
|
||||
1. Email Sending: Creates and sends emails to your contacts through HubSpot's system
|
||||
2. Engagement Tracking: Monitors how contacts interact with your emails by collecting data about opens, clicks, and replies
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your HubSpot account authentication details
|
||||
- Operation: Choose between "send_email" or "track_engagement"
|
||||
- Email Data: Information needed for sending emails (recipient, subject, content)
|
||||
- Contact ID: The unique identifier for the contact you want to track
|
||||
- Timeframe Days: How many days back you want to analyze engagement (default is 30 days)
|
||||
|
||||
### Outputs
|
||||
- Result: Contains either email sending confirmation or detailed engagement metrics
|
||||
- Status: Indicates whether the operation was successful ("email_sent" or "engagement_tracked")
|
||||
|
||||
### Engagement Metrics Include
|
||||
- Email opens: How many times your emails were opened
|
||||
- Email clicks: How many times links in your emails were clicked
|
||||
- Email replies: How many times contacts replied to your emails
|
||||
- Last engagement: The most recent interaction time
|
||||
- Engagement score: A calculated value based on different types of interactions
|
||||
|
||||
### Possible use cases
|
||||
1. Marketing Campaign Monitoring: Track how well your email campaigns are performing by measuring customer engagement over time
|
||||
2. Automated Email Communications: Set up automated email sends to specific contacts
|
||||
3. Customer Engagement Analysis: Evaluate how actively different contacts interact with your communications
|
||||
4. ROI Measurement: Calculate the effectiveness of your email marketing efforts through engagement scoring
|
||||
38
docs/content/platform/blocks/update/ideogram.md
Normal file
38
docs/content/platform/blocks/update/ideogram.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
## Ideogram Model
|
||||
|
||||
### What it is
|
||||
A powerful AI image generation tool that creates custom images based on text descriptions using Ideogram's advanced AI models.
|
||||
|
||||
### What it does
|
||||
Transforms text descriptions into high-quality images with customizable settings for style, aspect ratio, and color schemes. It can also enhance image quality through AI upscaling.
|
||||
|
||||
### How it works
|
||||
1. Takes your text description and image preferences
|
||||
2. Sends the request to Ideogram's AI system
|
||||
3. Processes your requirements using the selected AI model
|
||||
4. Returns a URL containing your generated image
|
||||
5. Optionally upscales the image for higher quality
|
||||
|
||||
### Inputs
|
||||
- Prompt: Your text description of the desired image
|
||||
- Image Generation Model: Choice of AI model version (V1, V2, etc.)
|
||||
- Aspect Ratio: The shape and dimensions of your image
|
||||
- Upscale Image: Option to enhance image quality
|
||||
- Magic Prompt Option: Setting to automatically enhance your text prompt
|
||||
- Seed: Optional number for reproducible results
|
||||
- Style Type: Visual style preference (Realistic, Anime, 3D Render, etc.)
|
||||
- Negative Prompt: Description of elements to exclude from the image
|
||||
- Color Palette Preset: Predefined color schemes (Fresh, Jungle, Magic, etc.)
|
||||
|
||||
### Outputs
|
||||
- Result: Web link to your generated image
|
||||
- Error: Message explaining any issues that occurred
|
||||
|
||||
### Possible use cases
|
||||
- Creating unique artwork for social media posts
|
||||
- Generating product visualization concepts
|
||||
- Designing marketing materials
|
||||
- Producing story illustrations
|
||||
- Developing concept art for projects
|
||||
- Creating custom visual content for presentations
|
||||
31
docs/content/platform/blocks/update/iteration.md
Normal file
31
docs/content/platform/blocks/update/iteration.md
Normal file
@@ -0,0 +1,31 @@
|
||||
|
||||
## Step Through Items
|
||||
|
||||
### What it is
|
||||
A logical component that helps you process lists or collections of items one at a time, like going through items in a shopping list one by one.
|
||||
|
||||
### What it does
|
||||
Takes a collection of items (either as a list or a dictionary) and processes them individually, outputting each item along with its position or identifier in the sequence.
|
||||
|
||||
### How it works
|
||||
The component accepts your collection of items and then:
|
||||
1. Checks if you've provided items in any of the accepted formats
|
||||
2. Goes through each item one by one
|
||||
3. For each item, provides both the item itself and its position/identifier
|
||||
4. Continues until all items have been processed
|
||||
|
||||
### Inputs
|
||||
- Items: A list of items you want to process (like [1, 2, 3] or ["apple", "banana", "orange"])
|
||||
- Items Object: A dictionary of items with labels (like {"fruit": "apple", "vegetable": "carrot"})
|
||||
- Items String: A text version of your list or dictionary, useful when your data comes as formatted text
|
||||
|
||||
### Outputs
|
||||
- Item: The current item being processed from your collection
|
||||
- Key: The position (for lists) or label (for dictionaries) of the current item
|
||||
|
||||
### Possible use cases
|
||||
- Processing a list of customer orders one at a time
|
||||
- Going through a collection of files in a folder
|
||||
- Handling survey responses individually
|
||||
- Processing inventory items one by one
|
||||
- Working through a series of tasks in sequence
|
||||
30
docs/content/platform/blocks/update/jina/chunking.md
Normal file
30
docs/content/platform/blocks/update/jina/chunking.md
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
## Jina Text Chunking
|
||||
|
||||
### What it is
|
||||
A specialized tool that breaks down large texts into smaller, manageable pieces using Jina AI's advanced text segmentation service.
|
||||
|
||||
### What it does
|
||||
This component takes long texts and intelligently divides them into smaller chunks while maintaining context and meaning. It can also provide detailed information about how the text was divided if needed.
|
||||
|
||||
### How it works
|
||||
1. The tool connects to Jina AI's segmentation service using your security credentials
|
||||
2. It processes each text you provide, splitting it according to your specifications
|
||||
3. It returns the smaller chunks and, if requested, information about how the text was divided
|
||||
4. All chunks maintain context and are sized according to your requirements
|
||||
|
||||
### Inputs
|
||||
- Texts: A collection of text documents you want to divide into smaller pieces
|
||||
- Credentials: Your Jina AI security credentials for accessing the service
|
||||
- Maximum Chunk Length: The largest size you want for each chunk (default is 1000 characters)
|
||||
- Return Tokens: Option to receive detailed information about how the text was divided (default is No)
|
||||
|
||||
### Outputs
|
||||
- Chunks: The collection of smaller text segments created from your original texts
|
||||
- Tokens: (Optional) Detailed information about how each piece of text was divided
|
||||
|
||||
### Possible use cases
|
||||
- Breaking down large documents like research papers into more manageable sections
|
||||
- Preparing content for AI analysis systems that work better with smaller text segments
|
||||
- Creating summaries or excerpts from longer documents
|
||||
- Processing large amounts of text data for content management systems
|
||||
30
docs/content/platform/blocks/update/jina/embeddings.md
Normal file
30
docs/content/platform/blocks/update/jina/embeddings.md
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
## Jina Embedding
|
||||
|
||||
### What it is
|
||||
A specialized tool that converts text into numerical representations (embeddings) using Jina AI's technology. These numerical representations capture the meaning and context of the text in a format that computers can process effectively.
|
||||
|
||||
### What it does
|
||||
Transforms a list of text inputs into their corresponding mathematical representations, making it possible to analyze and compare texts based on their meaning rather than just their exact words.
|
||||
|
||||
### How it works
|
||||
1. Accepts a list of texts you want to process
|
||||
2. Connects securely to Jina AI's service using your credentials
|
||||
3. Sends the texts to be processed by the specified Jina model
|
||||
4. Receives and organizes the mathematical representations of your texts
|
||||
5. Returns the processed embeddings in a structured format
|
||||
|
||||
### Inputs
|
||||
- Texts: A collection of text pieces you want to convert into embeddings
|
||||
- Credentials: Your Jina AI access credentials (required for using the service)
|
||||
- Model: The specific Jina embedding model to use (automatically set to "jina-embeddings-v2-base-en" if not specified)
|
||||
|
||||
### Outputs
|
||||
- Embeddings: A list of numerical representations corresponding to your input texts
|
||||
|
||||
### Possible use cases
|
||||
- Building a smart document search system that can find relevant documents based on meaning, not just keywords
|
||||
- Creating a content recommendation system that suggests similar articles or posts
|
||||
- Developing a text classification system that can automatically categorize documents
|
||||
- Implementing a plagiarism detection system that can identify similar content
|
||||
- Creating a chatbot that can understand and respond to user queries based on semantic meaning
|
||||
25
docs/content/platform/blocks/update/jina/fact_checker.md
Normal file
25
docs/content/platform/blocks/update/jina/fact_checker.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
## Fact Checker
|
||||
|
||||
### What it is
|
||||
A tool that analyzes statements and determines their factual accuracy using Jina AI's advanced fact-checking technology.
|
||||
|
||||
### What it does
|
||||
This component examines a given statement and provides a comprehensive assessment of its truthfulness, including a numerical score, a yes/no result, and a detailed explanation of the reasoning behind the assessment.
|
||||
|
||||
### How it works
|
||||
When you provide a statement, the system sends it to Jina AI's specialized fact-checking service. The service analyzes the statement against its knowledge base and returns a detailed evaluation of the statement's factuality. The results are presented in an easy-to-understand format that includes both numerical and written assessments.
|
||||
|
||||
### Inputs
|
||||
- Statement: The text you want to verify (such as "The Earth is round" or "Paris is the capital of Italy")
|
||||
- Credentials: Your Jina AI account information (automatically handled by the system)
|
||||
|
||||
### Outputs
|
||||
- Factuality Score: A number that indicates how factual the statement is (higher numbers mean more factual)
|
||||
- Result: A simple yes/no determination of whether the statement is factual
|
||||
- Reason: A written explanation of why the statement was determined to be true or false
|
||||
- Error Message: If something goes wrong during the checking process, you'll receive an explanation of what happened
|
||||
|
||||
### Possible use cases
|
||||
A news organization could use this tool to quickly verify facts in their articles before publication. For example, if a reporter writes "Company X announced record profits in 2023," the fact checker could verify this statement against reliable sources and provide a confidence score along with supporting evidence or contradictions.
|
||||
|
||||
47
docs/content/platform/blocks/update/jina/search.md
Normal file
47
docs/content/platform/blocks/update/jina/search.md
Normal file
@@ -0,0 +1,47 @@
|
||||
|
||||
# Web Search and Content Extraction Blocks
|
||||
|
||||
## Search The Web
|
||||
|
||||
### What it is
|
||||
A tool that performs web searches using the Jina.ai search engine.
|
||||
|
||||
### What it does
|
||||
This block takes a search query and returns comprehensive results from across the internet, including content from the top 5 relevant URLs.
|
||||
|
||||
### How it works
|
||||
When you provide a search query, the block sends it to Jina.ai's search service, which scans the internet and returns the most relevant results. The process is similar to using a regular search engine, but it's designed to be integrated into automated workflows.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Jina.ai authentication details
|
||||
- Query: The text you want to search for on the internet
|
||||
|
||||
### Outputs
|
||||
- Results: A collection of search findings including content from the most relevant web pages
|
||||
- Error: Any error message if the search wasn't successful
|
||||
|
||||
### Possible use case
|
||||
A researcher could use this block to automatically gather information about a specific topic, such as "renewable energy trends," and receive comprehensive search results from multiple sources in one go.
|
||||
|
||||
## Extract Website Content
|
||||
|
||||
### What it is
|
||||
A tool that extracts readable content from any website URL.
|
||||
|
||||
### What it does
|
||||
This block visits a specified webpage and pulls out the main content, removing unnecessary elements like advertisements and navigation menus.
|
||||
|
||||
### How it works
|
||||
When given a URL, the block either performs a direct content extraction (raw mode) or uses Jina.ai's specialized reader service to intelligently extract the most relevant content from the webpage.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Jina.ai authentication details
|
||||
- URL: The web address of the page you want to extract content from
|
||||
- Raw Content: A toggle that determines whether to use basic extraction or Jina.ai's enhanced reader (advanced option)
|
||||
|
||||
### Outputs
|
||||
- Content: The extracted text from the webpage
|
||||
- Error: Any error message if the content couldn't be retrieved
|
||||
|
||||
### Possible use case
|
||||
A content curator could use this block to automatically extract articles from various news websites, getting clean, readable content without the clutter of advertisements and sidebars.
|
||||
128
docs/content/platform/blocks/update/llm.md
Normal file
128
docs/content/platform/blocks/update/llm.md
Normal file
@@ -0,0 +1,128 @@
|
||||
|
||||
# Language Model Blocks Documentation
|
||||
|
||||
## AI Structured Response Generator
|
||||
|
||||
### What it is
|
||||
A sophisticated AI component that generates structured, formatted responses using various language models.
|
||||
|
||||
### What it does
|
||||
Converts user prompts into structured data responses, ensuring the output follows a specific format defined by the user.
|
||||
|
||||
### How it works
|
||||
The component sends your prompt to an AI model, along with formatting instructions, and ensures the response matches your required structure. It will retry multiple times if the response isn't properly formatted.
|
||||
|
||||
### Inputs
|
||||
- Prompt: The main question or instruction for the AI
|
||||
- Expected Format: The structure you want the response to follow
|
||||
- Model: Choice of AI model to use
|
||||
- System Prompt: Additional context or instructions for the AI
|
||||
- Conversation History: Previous messages for context
|
||||
- Retry Count: Number of attempts to get a properly formatted response
|
||||
- Prompt Values: Variables to insert into the prompt
|
||||
|
||||
### Outputs
|
||||
- Response: The structured data response from the AI
|
||||
- Error: Any error messages if the process fails
|
||||
|
||||
### Possible use case
|
||||
Converting unstructured customer feedback into categorized data with specific fields like sentiment, main topics, and action items.
|
||||
|
||||
## AI Text Generator
|
||||
|
||||
### What it is
|
||||
A straightforward tool for generating natural language text responses.
|
||||
|
||||
### What it does
|
||||
Processes your prompt and returns a natural language response without any specific formatting requirements.
|
||||
|
||||
### How it works
|
||||
Sends your prompt to an AI model and returns the response as plain text, handling all the technical details of the AI interaction.
|
||||
|
||||
### Inputs
|
||||
- Prompt: Your question or instruction
|
||||
- Model: Choice of AI model
|
||||
- System Prompt: Additional context or instructions
|
||||
- Prompt Values: Variables to insert into the prompt
|
||||
|
||||
### Outputs
|
||||
- Response: The generated text
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Generating product descriptions, creative writing, or answering general questions.
|
||||
|
||||
## AI Text Summarizer
|
||||
|
||||
### What it is
|
||||
A tool that condenses long texts into shorter, meaningful summaries.
|
||||
|
||||
### What it does
|
||||
Processes long pieces of text and creates concise summaries while maintaining the most important information.
|
||||
|
||||
### How it works
|
||||
Breaks down long text into manageable chunks, summarizes each chunk, and then combines these summaries into a final, coherent summary.
|
||||
|
||||
### Inputs
|
||||
- Text: The long text to summarize
|
||||
- Model: Choice of AI model
|
||||
- Focus: Specific topic to focus on in the summary
|
||||
- Style: Format of the summary (concise, detailed, bullet points, or numbered list)
|
||||
- Max Tokens: Maximum length of the summary
|
||||
- Chunk Overlap: How much overlap to maintain between chunks for context
|
||||
|
||||
### Outputs
|
||||
- Summary: The final summarized text
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Summarizing long research papers, articles, or reports into brief executive summaries.
|
||||
|
||||
## AI Conversation
|
||||
|
||||
### What it is
|
||||
A tool for managing multi-turn conversations with AI models.
|
||||
|
||||
### What it does
|
||||
Maintains a conversation thread with an AI, keeping track of context and previous messages.
|
||||
|
||||
### How it works
|
||||
Sends the entire conversation history to the AI model with each new message, ensuring responses remain contextually relevant.
|
||||
|
||||
### Inputs
|
||||
- Messages: List of previous conversation messages
|
||||
- Model: Choice of AI model
|
||||
- Max Tokens: Maximum length of responses
|
||||
|
||||
### Outputs
|
||||
- Response: The AI's reply to the conversation
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Creating interactive chatbots or virtual assistants that maintain context throughout a conversation.
|
||||
|
||||
## AI List Generator
|
||||
|
||||
### What it is
|
||||
A specialized tool for creating lists from text or prompts.
|
||||
|
||||
### What it does
|
||||
Generates organized lists based on provided information or creates new lists based on specific topics.
|
||||
|
||||
### How it works
|
||||
Analyzes source data or follows prompt instructions to create structured lists, validating the format and ensuring proper list generation.
|
||||
|
||||
### Inputs
|
||||
- Focus: The main topic or purpose of the list
|
||||
- Source Data: Optional text to extract list items from
|
||||
- Model: Choice of AI model
|
||||
- Max Retries: Number of attempts to generate a valid list
|
||||
- Max Tokens: Maximum length of the generated list
|
||||
|
||||
### Outputs
|
||||
- Generated List: The complete list of items
|
||||
- List Item: Individual items from the list
|
||||
- Error: Any error messages
|
||||
|
||||
### Possible use case
|
||||
Extracting key points from meeting notes or creating organized lists of items from unstructured text data.
|
||||
45
docs/content/platform/blocks/update/maths.md
Normal file
45
docs/content/platform/blocks/update/maths.md
Normal file
@@ -0,0 +1,45 @@
|
||||
|
||||
# Mathematical Operation Blocks
|
||||
|
||||
## Calculator
|
||||
|
||||
### What it is
|
||||
A versatile mathematical calculator that performs basic arithmetic operations between two numbers.
|
||||
|
||||
### What it does
|
||||
Takes two numbers and performs one of five mathematical operations: addition, subtraction, multiplication, division, or raising to a power. It can also optionally round the result to the nearest whole number.
|
||||
|
||||
### How it works
|
||||
The calculator takes your chosen operation and two numbers, processes them according to the selected mathematical operation, and returns the result. It includes safety features like handling division by zero and provides special values for error cases.
|
||||
|
||||
### Inputs
|
||||
- Operation: Choose from Add, Subtract, Multiply, Divide, or Power
|
||||
- Number A: The first number in your calculation
|
||||
- Number B: The second number in your calculation
|
||||
- Round Result: Choose whether to round the final answer to a whole number
|
||||
|
||||
### Outputs
|
||||
- Result: The numerical outcome of your calculation
|
||||
|
||||
### Possible use case
|
||||
A teacher creating a grading system could use this to calculate final scores by adding up test results or computing weighted averages.
|
||||
|
||||
## Count Items
|
||||
|
||||
### What it is
|
||||
A counting tool that determines how many items are in any collection of data.
|
||||
|
||||
### What it does
|
||||
Counts the number of elements in various types of collections, such as lists, text strings, or sets of items.
|
||||
|
||||
### How it works
|
||||
The counter examines your provided collection and determines its size, returning the total number of items it contains. It works with different types of collections and provides error handling for invalid inputs.
|
||||
|
||||
### Inputs
|
||||
- Collection: The group of items you want to count (can be a list, text string, dictionary, or similar)
|
||||
|
||||
### Outputs
|
||||
- Count: The number of items found in the collection
|
||||
|
||||
### Possible use case
|
||||
An inventory manager could use this to quickly count the number of products in a list or the number of characters in a product description.
|
||||
36
docs/content/platform/blocks/update/medium.md
Normal file
36
docs/content/platform/blocks/update/medium.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
## Publish to Medium
|
||||
|
||||
### What it is
|
||||
A tool that enables automatic publication of content to Medium's blogging platform, allowing for various publication settings and content management options.
|
||||
|
||||
### What it does
|
||||
This block takes your content and publishes it to Medium as a new post. It can handle different types of content formats, manage publication status, and provides options for content licensing and reader notifications.
|
||||
|
||||
### How it works
|
||||
The block connects to your Medium account using your credentials, processes your content according to your specified settings, and creates a new post on Medium. It then returns the details of the published post, including its URL and publication time.
|
||||
|
||||
### Inputs
|
||||
- Author ID: Your unique Medium author identifier
|
||||
- Title: The headline for your Medium post
|
||||
- Content: The main body of your post
|
||||
- Content Format: Specify whether your content is in HTML or Markdown format
|
||||
- Tags: Up to 5 keywords to categorize your post
|
||||
- Original URL: Optional link to where the content was first published
|
||||
- Publication Status: Choose between public, draft, or unlisted
|
||||
- License Type: Specify the copyright terms for your content
|
||||
- Notify Followers: Choose whether to alert your followers about the new post
|
||||
- Credentials: Your Medium API access information
|
||||
|
||||
### Outputs
|
||||
- Post ID: A unique identifier for your published post
|
||||
- Post URL: The direct link to your post on Medium
|
||||
- Publication Time: When the post was published
|
||||
- Error Message: Information about any issues that occurred during publication
|
||||
|
||||
### Possible use cases
|
||||
- Automatically republish blog content to Medium
|
||||
- Create draft posts for team review before publication
|
||||
- Maintain a consistent content schedule across platforms
|
||||
- Cross-post content while maintaining proper attribution
|
||||
- Schedule content releases with specific visibility settings
|
||||
33
docs/content/platform/blocks/update/nvidia/deepfake.md
Normal file
33
docs/content/platform/blocks/update/nvidia/deepfake.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
## Nvidia Deepfake Detector
|
||||
|
||||
### What it is
|
||||
A specialized tool that analyzes images to determine if they have been artificially created or manipulated using deepfake technology.
|
||||
|
||||
### What it does
|
||||
This component examines uploaded images using Nvidia's advanced AI technology to detect signs of artificial manipulation or generation. It provides a confidence score indicating how likely an image is to be a deepfake, and can optionally return a marked version of the image highlighting areas of potential manipulation.
|
||||
|
||||
### How it works
|
||||
When you submit an image, the system:
|
||||
1. Securely sends your image to Nvidia's AI analysis service
|
||||
2. Processes the image using advanced detection algorithms
|
||||
3. Evaluates the likelihood of artificial manipulation
|
||||
4. Returns results including a probability score and optional marked image
|
||||
5. Provides a status update on the analysis process
|
||||
|
||||
### Inputs
|
||||
- Image: The digital image you want to analyze for potential manipulation
|
||||
- Return Image Option: Choose whether you want to receive a marked version of the analyzed image
|
||||
- Credentials: Your Nvidia API access credentials (handled automatically by the system)
|
||||
|
||||
### Outputs
|
||||
- Detection Status: Indicates if the analysis was successful, encountered an error, or was filtered for content
|
||||
- Deepfake Probability: A score between 0 and 1 indicating how likely the image is to be artificially manipulated (higher numbers indicate greater likelihood of manipulation)
|
||||
- Processed Image: If requested, a version of your image with visual indicators showing areas of potential manipulation
|
||||
|
||||
### Possible use cases
|
||||
- A news organization verifying the authenticity of submitted photographs
|
||||
- A social media platform automatically screening uploaded content for manipulated images
|
||||
- A forensics team analyzing evidence for potential digital tampering
|
||||
- A content moderation team reviewing user-submitted materials
|
||||
- A fact-checking organization verifying viral images
|
||||
81
docs/content/platform/blocks/update/pinecone.md
Normal file
81
docs/content/platform/blocks/update/pinecone.md
Normal file
@@ -0,0 +1,81 @@
|
||||
|
||||
# Pinecone Integration Blocks
|
||||
|
||||
## Pinecone Initializer
|
||||
|
||||
### What it is
|
||||
A setup tool that creates or connects to a Pinecone vector database for storing and searching through information.
|
||||
|
||||
### What it does
|
||||
Creates a new database index or connects to an existing one, setting up the necessary configuration for storing vector data.
|
||||
|
||||
### How it works
|
||||
The block checks if the specified database index exists. If it doesn't, it creates a new one with your specified settings. If it does exist, it connects to the existing index.
|
||||
|
||||
### Inputs
|
||||
- API Key: Your Pinecone authentication credentials
|
||||
- Index Name: The name you want to give to your database index
|
||||
- Dimension: The size of the vectors to be stored (default: 768)
|
||||
- Metric: The method used to measure similarity between vectors (default: cosine)
|
||||
- Cloud: The cloud provider to use (default: aws)
|
||||
- Region: The geographical location of the database (default: us-east-1)
|
||||
|
||||
### Outputs
|
||||
- Index: The name of the initialized database index
|
||||
- Message: A status message indicating whether a new index was created or an existing one was connected
|
||||
|
||||
### Possible use case
|
||||
Setting up a new semantic search system that needs a database to store and retrieve information efficiently.
|
||||
|
||||
## Pinecone Query
|
||||
|
||||
### What it is
|
||||
A search tool that finds similar items in your Pinecone database using vector similarity.
|
||||
|
||||
### What it does
|
||||
Searches through the database to find the most similar items to your query, returning both detailed results and combined text from the matches.
|
||||
|
||||
### How it works
|
||||
Takes a query vector and searches the database for the most similar items, returning the top matches based on your specifications.
|
||||
|
||||
### Inputs
|
||||
- API Key: Your Pinecone authentication credentials
|
||||
- Query Vector: The vector representation of your search query
|
||||
- Namespace: Optional organization space within the database (default: empty)
|
||||
- Top K: Number of results to return (default: 3)
|
||||
- Include Values: Whether to include vector values in results (default: false)
|
||||
- Include Metadata: Whether to include additional information in results (default: true)
|
||||
- Host: The database host address
|
||||
- Index Name: The name of the database index to search
|
||||
|
||||
### Outputs
|
||||
- Results: Detailed search results including matches and combined text
|
||||
- Combined Results: A consolidated version of the matched text
|
||||
|
||||
### Possible use case
|
||||
Implementing a semantic search feature that finds similar documents or content based on meaning rather than exact keyword matches.
|
||||
|
||||
## Pinecone Inserter
|
||||
|
||||
### What it is
|
||||
A data upload tool that adds new information to your Pinecone database.
|
||||
|
||||
### What it does
|
||||
Processes and uploads text chunks and their corresponding vector representations to the database, along with any additional metadata.
|
||||
|
||||
### How it works
|
||||
Takes your text chunks and their vector representations, combines them with metadata, and uploads them to the specified database index.
|
||||
|
||||
### Inputs
|
||||
- API Key: Your Pinecone authentication credentials
|
||||
- Index: The name of the database index
|
||||
- Chunks: List of text pieces to store
|
||||
- Embeddings: Vector representations of the text chunks
|
||||
- Namespace: Optional organization space within the database (default: empty)
|
||||
- Metadata: Additional information to store with each vector (default: empty)
|
||||
|
||||
### Outputs
|
||||
- Upsert Response: Confirmation message of successful upload
|
||||
|
||||
### Possible use case
|
||||
Building a knowledge base by uploading and organizing document collections for later retrieval and searching.
|
||||
54
docs/content/platform/blocks/update/reddit.md
Normal file
54
docs/content/platform/blocks/update/reddit.md
Normal file
@@ -0,0 +1,54 @@
|
||||
|
||||
# Reddit Interaction Blocks
|
||||
|
||||
## Get Reddit Posts
|
||||
|
||||
### What it is
|
||||
A tool that retrieves posts from a specified subreddit with customizable filtering options.
|
||||
|
||||
### What it does
|
||||
Fetches recent posts from any specified subreddit, allowing you to control how many posts to retrieve and filter them based on time or specific post IDs.
|
||||
|
||||
### How it works
|
||||
The block connects to Reddit using provided credentials, navigates to the specified subreddit, and retrieves posts based on your settings. It can limit the number of posts retrieved and filter them based on how recent they are.
|
||||
|
||||
### Inputs
|
||||
- Subreddit: The name of the subreddit to fetch posts from
|
||||
- Reddit Credentials: Authentication details needed to access Reddit
|
||||
- Last Minutes (optional): Only retrieve posts from the last X minutes
|
||||
- Last Post (optional): Stop retrieving posts when reaching a specific post ID
|
||||
- Post Limit (optional): Maximum number of posts to retrieve (defaults to 10)
|
||||
|
||||
### Outputs
|
||||
- Post: Information about each Reddit post, including:
|
||||
* Post ID
|
||||
* Subreddit name
|
||||
* Post title
|
||||
* Post content
|
||||
|
||||
### Possible use case
|
||||
Monitoring a cryptocurrency subreddit for recent discussions about market trends, retrieving the last 20 posts from the past hour to analyze community sentiment.
|
||||
|
||||
## Post Reddit Comment
|
||||
|
||||
### What it is
|
||||
A tool that posts comments on Reddit posts automatically.
|
||||
|
||||
### What it does
|
||||
Creates and posts comments on specific Reddit posts using provided credentials and comment content.
|
||||
|
||||
### How it works
|
||||
The block takes your Reddit credentials and comment information, connects to Reddit, finds the specified post, and adds your comment to that post.
|
||||
|
||||
### Inputs
|
||||
- Reddit Credentials: Authentication details needed to access Reddit
|
||||
- Comment Data: Contains:
|
||||
* Post ID to comment on
|
||||
* Comment text to post
|
||||
|
||||
### Outputs
|
||||
- Comment ID: The unique identifier of the posted comment
|
||||
|
||||
### Possible use case
|
||||
Automatically responding to customer support queries on your company's subreddit with helpful information or acknowledgments of their posts.
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
|
||||
## Replicate Flux Advanced Model
|
||||
|
||||
### What it is
|
||||
A sophisticated image generation tool that creates custom images based on text descriptions using various Flux AI models.
|
||||
|
||||
### What it does
|
||||
Transforms text descriptions into high-quality images with extensive customization options, allowing users to control various aspects of the generation process, from image dimensions to quality settings.
|
||||
|
||||
### How it works
|
||||
The system takes your text description and additional preferences, sends them to a chosen Flux AI model, and returns a generated image that matches your specifications. It uses advanced AI technology to interpret your text and create corresponding visuals.
|
||||
|
||||
### Inputs
|
||||
- Prompt: Text description of the image you want to create (e.g., "A futuristic cityscape at sunset")
|
||||
- Image Generation Model: Choice between Flux Schnell, Flux Pro, or Flux Pro 1.1
|
||||
- Seed: Optional number for reproducible results
|
||||
- Steps: Amount of processing time spent creating the image (default: 25)
|
||||
- Guidance: How closely the image should follow your text description (default: 3.0)
|
||||
- Interval: Controls variety in possible outputs (default: 2.0)
|
||||
- Aspect Ratio: Image dimensions (options: 1:1, 16:9, 2:3, 3:2, 4:5, 5:4, 9:16)
|
||||
- Output Format: Image file type (WEBP, JPG, or PNG)
|
||||
- Output Quality: Image quality setting from 0 to 100 (default: 80)
|
||||
- Safety Tolerance: Content safety level from 1 (strictest) to 5 (most permissive)
|
||||
|
||||
### Outputs
|
||||
- Result: Web link to your generated image
|
||||
- Error: Message explaining any issues if the generation fails
|
||||
|
||||
### Possible use cases
|
||||
- A marketing team needs custom images for social media campaigns
|
||||
- An artist wants to explore different visual interpretations of their ideas
|
||||
- A content creator needs unique illustrations for their blog posts
|
||||
- A designer needs quick concept visualizations for client presentations
|
||||
- A game developer wants to generate placeholder art for game assets
|
||||
37
docs/content/platform/blocks/update/rss.md
Normal file
37
docs/content/platform/blocks/update/rss.md
Normal file
@@ -0,0 +1,37 @@
|
||||
|
||||
## RSS Feed Reader
|
||||
|
||||
### What it is
|
||||
A tool that automatically reads and processes entries from RSS feeds, which are web feeds that allow users to access updates from websites in a standardized format.
|
||||
|
||||
### What it does
|
||||
Monitors specified RSS feeds for new entries within a defined time window, extracting key information such as titles, links, descriptions, and other metadata. It can either check once or continuously monitor the feed at regular intervals.
|
||||
|
||||
### How it works
|
||||
1. Connects to a specified RSS feed URL
|
||||
2. Checks for entries published within the specified time period
|
||||
3. Processes each new entry to extract relevant information
|
||||
4. If running continuously, waits for the specified polling interval before checking again
|
||||
5. Delivers structured information about each new entry as it's found
|
||||
|
||||
### Inputs
|
||||
- RSS Feed URL: The web address of the RSS feed you want to monitor
|
||||
- Time Period (minutes): How far back to look for entries, measured in minutes from the current time
|
||||
- Polling Rate (seconds): How frequently the feed should be checked when running continuously
|
||||
- Run Continuously: Whether to keep checking the feed repeatedly or just once
|
||||
|
||||
### Outputs
|
||||
- RSS Entry: A structured package of information containing:
|
||||
* Title: The headline or name of the entry
|
||||
* Link: The web address where the full content can be found
|
||||
* Description: A summary or preview of the content
|
||||
* Publication Date: When the entry was published
|
||||
* Author: Who created the content
|
||||
* Categories: Topics or tags associated with the entry
|
||||
|
||||
### Possible use cases
|
||||
- Monitoring news websites for breaking stories
|
||||
- Tracking blog updates from multiple sources
|
||||
- Creating an automated content aggregation system
|
||||
- Setting up real-time notifications for new content
|
||||
- Building a custom news dashboard
|
||||
39
docs/content/platform/blocks/update/sampling.md
Normal file
39
docs/content/platform/blocks/update/sampling.md
Normal file
@@ -0,0 +1,39 @@
|
||||
|
||||
## Data Sampling
|
||||
|
||||
### What it is
|
||||
A versatile data sampling tool that can select specific items from a dataset using various selection methods.
|
||||
|
||||
### What it does
|
||||
Takes a collection of data items and returns a smaller subset based on user-defined criteria and sampling methods. It can work with different types of data collections and offers multiple ways to choose which items to include in the sample.
|
||||
|
||||
### How it works
|
||||
The system looks at your data collection and selects items based on your chosen sampling method. It can pick items:
|
||||
- Completely randomly
|
||||
- At regular intervals
|
||||
- From specific groups proportionally
|
||||
- Based on importance weights
|
||||
- In clusters or groups
|
||||
- From the beginning or end
|
||||
- Using reservoir sampling for streaming data
|
||||
|
||||
### Inputs
|
||||
- Data: The collection of items you want to sample from
|
||||
- Sample Size: How many items you want in your final selection
|
||||
- Sampling Method: How you want to choose the items (random, systematic, top, bottom, stratified, weighted, reservoir, or cluster)
|
||||
- Accumulate: Whether to collect data over time before sampling
|
||||
- Random Seed: A number to ensure you get the same results each time (optional)
|
||||
- Stratify Key: The category to use when ensuring balanced group representation
|
||||
- Weight Key: The value to use when considering item importance
|
||||
- Cluster Key: The group identifier for cluster-based sampling
|
||||
|
||||
### Outputs
|
||||
- Sampled Data: The selected items from your dataset
|
||||
- Sample Indices: The positions of the selected items in the original dataset
|
||||
|
||||
### Possible use cases
|
||||
- Quality control in manufacturing: Randomly selecting products for inspection
|
||||
- Market research: Selecting a representative group of customers to survey
|
||||
- Data analysis: Creating balanced training datasets for machine learning
|
||||
- Scientific research: Selecting specimens for detailed analysis
|
||||
- Social studies: Choosing participants for a study while maintaining demographic balance
|
||||
48
docs/content/platform/blocks/update/search.md
Normal file
48
docs/content/platform/blocks/update/search.md
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
# Search Blocks Documentation
|
||||
|
||||
## Wikipedia Summary
|
||||
|
||||
### What it is
|
||||
A tool that retrieves concise summaries of topics from Wikipedia.
|
||||
|
||||
### What it does
|
||||
This block fetches and returns a summary of any specified topic using Wikipedia's API service.
|
||||
|
||||
### How it works
|
||||
When you provide a topic, the block connects to Wikipedia's servers, searches for the topic, and returns a condensed version of the article's main content.
|
||||
|
||||
### Inputs
|
||||
- Topic: The subject you want to learn about (e.g., "Artificial Intelligence", "Solar System")
|
||||
|
||||
### Outputs
|
||||
- Summary: A concise explanation of the requested topic
|
||||
- Error: A message explaining what went wrong if the summary couldn't be retrieved
|
||||
|
||||
### Possible use case
|
||||
A student researching various topics for a school project could quickly gather basic information about multiple subjects without having to read entire Wikipedia articles.
|
||||
|
||||
## Weather Information
|
||||
|
||||
### What it is
|
||||
A weather information retrieval system that connects to OpenWeatherMap's service.
|
||||
|
||||
### What it does
|
||||
This block fetches current weather conditions for any specified location, including temperature, humidity, and general weather conditions.
|
||||
|
||||
### How it works
|
||||
The block takes your desired location, connects to OpenWeatherMap's service using your API credentials, and returns current weather data in your preferred temperature format.
|
||||
|
||||
### Inputs
|
||||
- Location: The place you want weather information for (e.g., "New York", "London")
|
||||
- API Credentials: Your OpenWeatherMap API access information
|
||||
- Temperature Format: Choose between Celsius (default) or Fahrenheit
|
||||
|
||||
### Outputs
|
||||
- Temperature: Current temperature in the specified location
|
||||
- Humidity: Current humidity percentage
|
||||
- Condition: Description of current weather conditions (e.g., "partly cloudy", "rain")
|
||||
- Error: A message explaining what went wrong if the weather information couldn't be retrieved
|
||||
|
||||
### Possible use case
|
||||
A travel planning application could use this block to show current weather conditions for various destinations, helping users pack appropriate clothing and plan activities.
|
||||
46
docs/content/platform/blocks/update/slant3d/base.md
Normal file
46
docs/content/platform/blocks/update/slant3d/base.md
Normal file
@@ -0,0 +1,46 @@
|
||||
|
||||
## Slant3D Base Block
|
||||
|
||||
### What it is
|
||||
A foundational component that handles communications with the Slant3D manufacturing service, specifically designed to process and validate 3D printing orders.
|
||||
|
||||
### What it does
|
||||
- Manages communication with Slant3D's manufacturing API
|
||||
- Validates material and color combinations for 3D printing
|
||||
- Formats customer orders and shipping information
|
||||
- Ensures all order details are properly structured before submission
|
||||
|
||||
### How it works
|
||||
The block acts as a bridge between your application and Slant3D's manufacturing service. It takes your order information, validates all the details (like checking if a chosen color is available for a specific material), and prepares the data in the correct format for manufacturing.
|
||||
|
||||
### Inputs
|
||||
- API Key: Your unique identifier for accessing Slant3D's services
|
||||
- Customer Details:
|
||||
- Name
|
||||
- Email
|
||||
- Phone number
|
||||
- Shipping address
|
||||
- Billing address
|
||||
- Country information
|
||||
- Residential status
|
||||
- Order Information:
|
||||
- Order number
|
||||
- File URLs for 3D models
|
||||
- Material profiles (like PLA)
|
||||
- Color choices
|
||||
- Quantities
|
||||
|
||||
### Outputs
|
||||
- Validated color and material combinations
|
||||
- Properly formatted order data ready for manufacturing
|
||||
- API responses confirming order details
|
||||
- Error messages for invalid combinations or requests
|
||||
|
||||
### Possible use cases
|
||||
A custom 3D printing shop could use this block to automate their order processing. When a customer places an order for a blue PLA phone case, the block would automatically:
|
||||
1. Verify that blue is available in PLA material
|
||||
2. Format the customer's shipping details
|
||||
3. Package the order information
|
||||
4. Prepare everything for submission to Slant3D's manufacturing service
|
||||
|
||||
This streamlines the order process and ensures all submissions meet Slant3D's requirements before being sent to manufacturing.
|
||||
31
docs/content/platform/blocks/update/slant3d/filament.md
Normal file
31
docs/content/platform/blocks/update/slant3d/filament.md
Normal file
@@ -0,0 +1,31 @@
|
||||
|
||||
## Slant3D Filament Manager
|
||||
|
||||
### What it is
|
||||
A specialized tool that connects to the Slant3D service to retrieve information about available 3D printing filaments.
|
||||
|
||||
### What it does
|
||||
This component fetches a comprehensive list of available 3D printing filaments from Slant3D, including details about each filament's color, type, and profile specifications.
|
||||
|
||||
### How it works
|
||||
1. The component establishes a secure connection to Slant3D using your provided credentials
|
||||
2. It sends a request to retrieve the current filament inventory
|
||||
3. The system organizes the received information into a structured list
|
||||
4. If any issues occur during this process, it captures and reports the error
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Slant3D authentication information needed to access the service
|
||||
|
||||
### Outputs
|
||||
- Filaments: A detailed list of available filaments, including for each:
|
||||
- Filament name (e.g., "PLA BLACK")
|
||||
- Color code in hex format
|
||||
- Color category (e.g., "black", "white")
|
||||
- Material profile (e.g., "PLA")
|
||||
- Error: A message explaining what went wrong if the system encounters any issues
|
||||
|
||||
### Possible use cases
|
||||
- A 3D printing service checking available materials before accepting new orders
|
||||
- An automated system managing inventory of 3D printing supplies
|
||||
- A user interface displaying available filament options to customers
|
||||
- Planning production schedules based on material availability
|
||||
143
docs/content/platform/blocks/update/slant3d/order.md
Normal file
143
docs/content/platform/blocks/update/slant3d/order.md
Normal file
@@ -0,0 +1,143 @@
|
||||
|
||||
# Slant3D Order Management Blocks
|
||||
|
||||
## Create Order
|
||||
|
||||
### What it is
|
||||
A tool for creating new 3D printing orders in the Slant3D system.
|
||||
|
||||
### What it does
|
||||
Creates a new manufacturing order with specified items and shipping details.
|
||||
|
||||
### How it works
|
||||
Takes your order details, including customer information and items to be printed, and submits them to create a new order in the system.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Slant3D account authentication details
|
||||
- Order Number: Your custom reference number (optional)
|
||||
- Customer Details: Shipping information including name, address, and contact details
|
||||
- Items: List of items to be printed, including file locations, quantities, colors, and material types
|
||||
|
||||
### Outputs
|
||||
- Order ID: Your unique Slant3D order identifier
|
||||
- Error: Any error message if the order creation fails
|
||||
|
||||
### Possible use case
|
||||
A business owner needs to create a bulk order for custom 3D printed parts with specific shipping requirements.
|
||||
|
||||
## Order Cost Estimator
|
||||
|
||||
### What it is
|
||||
A calculator for determining the total cost of a potential order.
|
||||
|
||||
### What it does
|
||||
Provides a detailed cost breakdown including printing and shipping expenses.
|
||||
|
||||
### How it works
|
||||
Analyzes your order details and calculates various cost components before you commit to placing the order.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Slant3D account authentication details
|
||||
- Order Number: Your custom reference number (optional)
|
||||
- Customer Details: Shipping information for accurate cost calculation
|
||||
- Items: List of items to be printed
|
||||
|
||||
### Outputs
|
||||
- Total Price: Complete cost in USD
|
||||
- Shipping Cost: Estimated shipping expenses
|
||||
- Printing Cost: Cost of printing services
|
||||
- Error: Any error message if estimation fails
|
||||
|
||||
### Possible use case
|
||||
A customer wants to compare costs for different printing options before placing an order.
|
||||
|
||||
## Shipping Cost Estimator
|
||||
|
||||
### What it is
|
||||
A specialized tool for calculating shipping costs only.
|
||||
|
||||
### What it does
|
||||
Provides shipping cost estimates based on delivery location and order details.
|
||||
|
||||
### How it works
|
||||
Evaluates shipping requirements based on delivery address and order specifications to calculate shipping costs.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Slant3D account authentication details
|
||||
- Order Number: Your custom reference number (optional)
|
||||
- Customer Details: Shipping address information
|
||||
- Items: List of items for shipping calculation
|
||||
|
||||
### Outputs
|
||||
- Shipping Cost: Estimated shipping expense
|
||||
- Currency Code: Currency type (e.g., 'usd')
|
||||
- Error: Any error message if estimation fails
|
||||
|
||||
### Possible use case
|
||||
A customer needs to compare shipping costs to different delivery addresses.
|
||||
|
||||
## Order List Viewer
|
||||
|
||||
### What it is
|
||||
A tool for viewing all orders associated with your account.
|
||||
|
||||
### What it does
|
||||
Retrieves and displays a complete list of your orders.
|
||||
|
||||
### How it works
|
||||
Fetches all order information from your account history and presents it in an organized format.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Slant3D account authentication details
|
||||
|
||||
### Outputs
|
||||
- Orders: List of all orders with their details
|
||||
- Error: Any error message if retrieval fails
|
||||
|
||||
### Possible use case
|
||||
A business manager needs to review all past orders for accounting purposes.
|
||||
|
||||
## Order Tracker
|
||||
|
||||
### What it is
|
||||
A tracking system for monitoring order status and shipping progress.
|
||||
|
||||
### What it does
|
||||
Provides real-time information about order status and shipping details.
|
||||
|
||||
### How it works
|
||||
Connects to the shipping system to retrieve current status and tracking information for specific orders.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Slant3D account authentication details
|
||||
- Order ID: The specific order you want to track
|
||||
|
||||
### Outputs
|
||||
- Status: Current order status
|
||||
- Tracking Numbers: List of shipping tracking numbers
|
||||
- Error: Any error message if tracking fails
|
||||
|
||||
### Possible use case
|
||||
A customer wants to monitor the progress of their order from printing to delivery.
|
||||
|
||||
## Order Cancellation
|
||||
|
||||
### What it is
|
||||
A tool for canceling existing orders.
|
||||
|
||||
### What it does
|
||||
Allows you to cancel orders that haven't yet been processed.
|
||||
|
||||
### How it works
|
||||
Submits a cancellation request for the specified order and confirms the cancellation status.
|
||||
|
||||
### Inputs
|
||||
- Credentials: Your Slant3D account authentication details
|
||||
- Order ID: The order you want to cancel
|
||||
|
||||
### Outputs
|
||||
- Status: Confirmation of cancellation
|
||||
- Error: Any error message if cancellation fails
|
||||
|
||||
### Possible use case
|
||||
A customer needs to cancel an order due to changed requirements or specifications.
|
||||
30
docs/content/platform/blocks/update/slant3d/slicing.md
Normal file
30
docs/content/platform/blocks/update/slant3d/slicing.md
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
## Slant3D Slicer
|
||||
|
||||
### What it is
|
||||
A specialized tool that processes 3D model files (STL format) to prepare them for 3D printing and calculate associated costs.
|
||||
|
||||
### What it does
|
||||
This component takes a 3D model file, analyzes it for 3D printing, and returns both a confirmation message and the estimated price for printing the model. If any issues occur during the process, it provides detailed error information.
|
||||
|
||||
### How it works
|
||||
1. Accepts a URL pointing to a 3D model file
|
||||
2. Authenticates with the Slant3D service using provided credentials
|
||||
3. Sends the file for processing and analysis
|
||||
4. Returns the processing results and calculated printing costs
|
||||
5. Provides error information if something goes wrong
|
||||
|
||||
### Inputs
|
||||
- Credentials: Authentication information required to access the Slant3D service
|
||||
- File URL: The web address where your 3D model file (STL format) is located
|
||||
|
||||
### Outputs
|
||||
- Message: A text response indicating whether the slicing process was successful
|
||||
- Price: The calculated cost for printing the 3D model
|
||||
- Error: A detailed message explaining what went wrong (if an error occurs)
|
||||
|
||||
### Possible use cases
|
||||
- Integration with an online 3D printing service platform
|
||||
- Automated quote generation for 3D printing services
|
||||
- Quick feasibility checks for 3D printing projects
|
||||
- Batch processing of multiple 3D models for cost estimation
|
||||
38
docs/content/platform/blocks/update/talking_head.md
Normal file
38
docs/content/platform/blocks/update/talking_head.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
## Create Talking Avatar Video
|
||||
|
||||
### What it is
|
||||
A tool that creates videos featuring a digital avatar that speaks your provided text, utilizing advanced AI technology to generate realistic speaking animations.
|
||||
|
||||
### What it does
|
||||
Transforms written text into a video featuring a digital presenter who speaks your message. The system can create videos in different formats, with various speaking voices and presenter styles, and can even include features like subtitles.
|
||||
|
||||
### How it works
|
||||
1. Takes your text and chosen settings
|
||||
2. Sends the information to the D-ID service
|
||||
3. Creates a video with a digital avatar speaking your text
|
||||
4. Monitors the creation process
|
||||
5. Provides you with a URL to access the completed video
|
||||
|
||||
### Inputs
|
||||
- Text Script: The message you want the avatar to speak
|
||||
- Voice Provider: Choose from Microsoft, ElevenLabs, or Amazon for the speaking voice
|
||||
- Voice ID: The specific voice style to use
|
||||
- Presenter ID: The digital avatar that will appear in the video
|
||||
- Video Format: Choose between MP4 video, GIF animation, or WAV audio
|
||||
- Screen Format: Select wide, square, or vertical video layout
|
||||
- Subtitles: Option to display spoken text as captions
|
||||
- Speech Markup: Advanced option for controlling speech characteristics
|
||||
- Creation Settings: Control how long to wait for video completion
|
||||
|
||||
### Outputs
|
||||
- Video URL: Web address where you can access your completed video
|
||||
- Error Message: Information about what went wrong if the video creation fails
|
||||
|
||||
### Possible use cases
|
||||
- Creating a virtual spokesperson for your company
|
||||
- Producing educational videos with a consistent presenter
|
||||
- Generating multilingual presentations using different voices
|
||||
- Making product demonstrations with a professional-looking presenter
|
||||
- Creating engaging social media content with animated avatars
|
||||
- Developing interactive training materials with consistent delivery
|
||||
95
docs/content/platform/blocks/update/text.md
Normal file
95
docs/content/platform/blocks/update/text.md
Normal file
@@ -0,0 +1,95 @@
|
||||
|
||||
# Text Processing Blocks Documentation
|
||||
|
||||
## Match Text Pattern
|
||||
|
||||
### What it is
|
||||
A text matching tool that checks if a given text matches a specific pattern.
|
||||
|
||||
### What it does
|
||||
Examines input text against a specified pattern and routes the data to different outputs based on whether a match is found.
|
||||
|
||||
### How it works
|
||||
The block takes your text and pattern, compares them (considering your case sensitivity preferences), and directs the data to either a positive or negative output path.
|
||||
|
||||
### Inputs
|
||||
- Text: The text content you want to check
|
||||
- Pattern: The pattern you want to find in the text
|
||||
- Data: Information you want to pass through the block
|
||||
- Case Sensitive: Whether uppercase and lowercase letters should be treated differently
|
||||
- Dot All: Whether the dot character should match any character including newlines
|
||||
|
||||
### Outputs
|
||||
- Positive: Receives the data when a pattern match is found
|
||||
- Negative: Receives the data when no pattern match is found
|
||||
|
||||
### Possible use case
|
||||
Filtering customer feedback messages to route complaints (containing specific keywords) to the urgent response team and other messages to the general response team.
|
||||
|
||||
## Extract Text Information
|
||||
|
||||
### What it is
|
||||
A tool that pulls specific information out of text using patterns.
|
||||
|
||||
### What it does
|
||||
Searches through text to find and extract specific pieces of information based on a given pattern.
|
||||
|
||||
### How it works
|
||||
The block searches the input text for matches to your pattern and extracts either the whole match or a specific group you specify. It can find either the first match or all matches.
|
||||
|
||||
### Inputs
|
||||
- Text: The text you want to extract information from
|
||||
- Pattern: The pattern that describes what you want to extract
|
||||
- Group: Which part of the match to extract
|
||||
- Case Sensitive: Whether uppercase and lowercase letters should be treated differently
|
||||
- Dot All: Whether the dot character should match any character including newlines
|
||||
- Find All: Whether to find all matches or just the first one
|
||||
|
||||
### Outputs
|
||||
- Positive: The extracted text when matches are found
|
||||
- Negative: The original text when no matches are found
|
||||
|
||||
### Possible use case
|
||||
Extracting all email addresses from a document or pulling specific data fields from formatted text entries.
|
||||
|
||||
## Fill Text Template
|
||||
|
||||
### What it is
|
||||
A template-based text formatting tool that creates customized text using provided values.
|
||||
|
||||
### What it does
|
||||
Creates formatted text by inserting provided values into a template structure.
|
||||
|
||||
### How it works
|
||||
The block takes a template with placeholders and fills them with the values you provide, creating a complete text output.
|
||||
|
||||
### Inputs
|
||||
- Values: A collection of named values to insert into the template
|
||||
- Format: The template structure showing where to place the values
|
||||
|
||||
### Outputs
|
||||
- Output: The final formatted text with all values inserted
|
||||
|
||||
### Possible use case
|
||||
Creating personalized email messages by inserting customer names and specific details into a standard template.
|
||||
|
||||
## Combine Texts
|
||||
|
||||
### What it is
|
||||
A text combination tool that joins multiple text pieces into a single text.
|
||||
|
||||
### What it does
|
||||
Merges multiple separate text inputs into one unified text output, with an optional separator between them.
|
||||
|
||||
### How it works
|
||||
The block takes your list of texts and joins them together, optionally placing a delimiter (separator) between each piece.
|
||||
|
||||
### Inputs
|
||||
- Input: List of text pieces to combine
|
||||
- Delimiter: Optional text to insert between combined pieces
|
||||
|
||||
### Outputs
|
||||
- Output: The final combined text
|
||||
|
||||
### Possible use case
|
||||
Combining multiple paragraphs into a single document or joining separate pieces of content with proper spacing or punctuation.
|
||||
90
docs/content/platform/blocks/update/time_blocks.md
Normal file
90
docs/content/platform/blocks/update/time_blocks.md
Normal file
@@ -0,0 +1,90 @@
|
||||
|
||||
# Time Management Blocks
|
||||
|
||||
## Current Time
|
||||
|
||||
### What it is
|
||||
A tool that provides the current time in a customizable format.
|
||||
|
||||
### What it does
|
||||
Returns the current time when triggered, allowing you to specify how the time should be displayed.
|
||||
|
||||
### How it works
|
||||
When activated, it captures the current system time and formats it according to your specifications.
|
||||
|
||||
### Inputs
|
||||
- Trigger: Any input that activates the block
|
||||
- Format: How you want the time displayed (default is hours:minutes:seconds)
|
||||
|
||||
### Outputs
|
||||
- Time: The current time in your specified format
|
||||
|
||||
### Possible use case
|
||||
Creating a digital clock display or adding timestamps to automated messages.
|
||||
|
||||
## Current Date
|
||||
|
||||
### What it is
|
||||
A tool that provides the current date with optional day adjustments.
|
||||
|
||||
### What it does
|
||||
Returns the current date or a date offset by a specified number of days, in your preferred format.
|
||||
|
||||
### How it works
|
||||
Captures today's date and can adjust it forward or backward by a specified number of days before displaying it in your chosen format.
|
||||
|
||||
### Inputs
|
||||
- Trigger: Any input that activates the block
|
||||
- Days Offset: Number of days to adjust from current date
|
||||
- Format: How you want the date displayed (default is YYYY-MM-DD)
|
||||
|
||||
### Outputs
|
||||
- Date: The formatted date based on your specifications
|
||||
|
||||
### Possible use case
|
||||
Calculating due dates for projects or scheduling future events.
|
||||
|
||||
## Current Date and Time
|
||||
|
||||
### What it is
|
||||
A combined tool that provides both the current date and time together.
|
||||
|
||||
### What it does
|
||||
Returns the current date and time in a single, formatted output.
|
||||
|
||||
### How it works
|
||||
Captures the current system date and time and presents them together in your specified format.
|
||||
|
||||
### Inputs
|
||||
- Trigger: Any input that activates the block
|
||||
- Format: How you want the date and time displayed (default is YYYY-MM-DD HH:MM:SS)
|
||||
|
||||
### Outputs
|
||||
- Date and Time: The current date and time in your specified format
|
||||
|
||||
### Possible use case
|
||||
Creating comprehensive timestamps for logging or recording event occurrences.
|
||||
|
||||
## Countdown Timer
|
||||
|
||||
### What it is
|
||||
A timing tool that triggers a message after a specified duration.
|
||||
|
||||
### What it does
|
||||
Waits for a set period and then outputs a custom message.
|
||||
|
||||
### How it works
|
||||
Counts down the specified duration and delivers your message when the time is up.
|
||||
|
||||
### Inputs
|
||||
- Message: The text to output when the timer finishes (default is "timer finished")
|
||||
- Seconds: Number of seconds to wait
|
||||
- Minutes: Number of minutes to wait
|
||||
- Hours: Number of hours to wait
|
||||
- Days: Number of days to wait
|
||||
|
||||
### Outputs
|
||||
- Message: Your specified message, delivered after the countdown completes
|
||||
|
||||
### Possible use case
|
||||
Setting up delayed notifications or scheduling automated actions after a specific waiting period.
|
||||
38
docs/content/platform/blocks/update/youtube.md
Normal file
38
docs/content/platform/blocks/update/youtube.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
# YouTube Blocks
|
||||
|
||||
## YouTube Video Transcriber
|
||||
|
||||
### What it is
|
||||
A tool that converts spoken content from YouTube videos into written text format.
|
||||
|
||||
### What it does
|
||||
Takes a YouTube video URL and produces a text transcript of all spoken content in the video. It can handle various YouTube URL formats, including standard watch URLs, shortened URLs (youtu.be), and embedded video URLs.
|
||||
|
||||
### How it works
|
||||
1. Takes your provided YouTube video URL
|
||||
2. Extracts the unique video identifier from the URL
|
||||
3. Searches for available transcripts for the video
|
||||
4. Retrieves the transcript in the first available language
|
||||
5. Formats the transcript into clean, readable text
|
||||
|
||||
### Inputs
|
||||
- YouTube URL: The web address of the YouTube video you want to transcribe. This can be in any standard YouTube format (e.g., regular watch URL, shortened URL, or embed URL)
|
||||
|
||||
### Outputs
|
||||
- Video ID: The unique identifier for the YouTube video
|
||||
- Transcript: The complete text version of the video's spoken content
|
||||
- Error: A message explaining what went wrong if the transcription fails
|
||||
|
||||
### Possible use cases
|
||||
- A content creator wanting to create subtitles or captions for their videos
|
||||
- A student needing to reference specific parts of a lecture video
|
||||
- A researcher collecting data from educational videos
|
||||
- A marketing team analyzing competitor video content
|
||||
- A journalist quoting from video interviews
|
||||
- Making video content accessible to deaf or hard-of-hearing viewers
|
||||
|
||||
### Notes
|
||||
- The video must have available transcripts (either auto-generated or manually created)
|
||||
- The tool will use the first available language version of the transcript
|
||||
- Works with both public and unlisted videos (as long as you have the URL)
|
||||
Reference in New Issue
Block a user